Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: use T.TempDir to create temporary test directory #1686

Merged
merged 1 commit into from
Dec 30, 2022
Merged

test: use T.TempDir to create temporary test directory #1686

merged 1 commit into from
Dec 30, 2022

Conversation

Juneezee
Copy link
Contributor

A testing cleanup.

This pull request replaces os.MkdirTemp with t.TempDir. We can use the T.TempDir function from the testing package to create temporary directory. The directory created by T.TempDir is automatically removed when the test and all its subtests complete.

This saves us at least 2 lines (error check, and cleanup) on every instance.

Reference: https://pkg.go.dev/testing#T.TempDir

func TestFoo(t *testing.T) {
	// before
	tmpDir, err := os.MkdirTemp("", "")
	test.That(t, err, test.ShouldBeNil)
	defer os.RemoveAll(tmpDir)

	// now
	tmpDir := t.TempDir()
}

@CLAassistant
Copy link

CLAassistant commented Dec 17, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

agreenb
agreenb approved these changes Dec 19, 2022
View reviewed changes
Copy link
Contributor

@agreenb agreenb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the cleanup!

@Juneezee
test: use T.TempDir to create temporary test directory
f4a96f4 
This commit replaces `os.MkdirTemp` with `t.TempDir` in tests. The
directory created by `t.TempDir` is automatically removed when the test
and all its subtests complete.

Prior to this commit, temporary directory created using `os.MkdirTemp`
needs to be removed manually by calling `os.RemoveAll`, which is omitted
in some tests. The error handling boilerplate e.g.
	defer func() {
		if err := os.RemoveAll(dir); err != nil {
			t.Fatal(err)
		}
	}
is also tedious, but `t.TempDir` handles this for us nicely.

Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
@Juneezee
Copy link
Contributor Author

Rebased and resolved conflicts in

services/datamanager/builtin/builtin_test.go
services/datamanager/datasync/sync_test.go

@edaniels edaniels added the safe to test This pull request is marked safe to test from a trusted zone label Dec 30, 2022
@github-actions
Copy link
Contributor

Code Coverage

Package Line Rate Delta Health
go.viam.com/rdk/components/arm 56% 0.00% ➖
go.viam.com/rdk/components/arm/universalrobots 41% 0.00% ❌
go.viam.com/rdk/components/arm/xarm 2% 0.00% ❌
go.viam.com/rdk/components/arm/yahboom 7% 0.00% ❌
go.viam.com/rdk/components/audioinput 55% +0.34% ➖
go.viam.com/rdk/components/base 63% 0.00% ➖
go.viam.com/rdk/components/base/agilex 62% 0.00% ➖
go.viam.com/rdk/components/base/boat 41% 0.00% ❌
go.viam.com/rdk/components/base/wheeled 76% 0.00% ✅
go.viam.com/rdk/components/board 68% 0.00% ➖
go.viam.com/rdk/components/board/arduino 10% 0.00% ❌
go.viam.com/rdk/components/board/commonsysfs 47% 0.00% ❌
go.viam.com/rdk/components/board/fake 38% 0.00% ❌
go.viam.com/rdk/components/board/numato 19% 0.00% ❌
go.viam.com/rdk/components/board/pi 50% 0.00% ➖
go.viam.com/rdk/components/camera 66% 0.00% ➖
go.viam.com/rdk/components/camera/align 63% 0.00% ➖
go.viam.com/rdk/components/camera/fake 67% 0.00% ➖
go.viam.com/rdk/components/camera/ffmpeg 77% +1.43% ✅
go.viam.com/rdk/components/camera/transformpipeline 78% +0.33% ✅
go.viam.com/rdk/components/camera/videosource 49% -0.63% ❌
go.viam.com/rdk/components/encoder/fake 77% 0.00% ✅
go.viam.com/rdk/components/gantry 60% 0.00% ➖
go.viam.com/rdk/components/gantry/multiaxis 84% 0.00% ✅
go.viam.com/rdk/components/gantry/oneaxis 86% 0.00% ✅
go.viam.com/rdk/components/generic 83% 0.00% ✅
go.viam.com/rdk/components/gripper 68% 0.00% ➖
go.viam.com/rdk/components/input 87% 0.00% ✅
go.viam.com/rdk/components/input/gpio 84% 0.00% ✅
go.viam.com/rdk/components/motor 77% 0.00% ✅
go.viam.com/rdk/components/motor/dimensionengineering 63% 0.00% ➖
go.viam.com/rdk/components/motor/dmc4000 69% 0.00% ➖
go.viam.com/rdk/components/motor/fake 57% 0.00% ➖
go.viam.com/rdk/components/motor/gpio 64% 0.00% ➖
go.viam.com/rdk/components/motor/gpiostepper 56% -0.59% ➖
go.viam.com/rdk/components/motor/tmcstepper 62% 0.00% ➖
go.viam.com/rdk/components/movementsensor 75% 0.00% ✅
go.viam.com/rdk/components/movementsensor/cameramono 40% 0.00% ❌
go.viam.com/rdk/components/movementsensor/gpsnmea 37% 0.00% ❌
go.viam.com/rdk/components/movementsensor/gpsrtk 28% 0.00% ❌
go.viam.com/rdk/components/posetracker 86% 0.00% ✅
go.viam.com/rdk/components/sensor 86% 0.00% ✅
go.viam.com/rdk/components/sensor/ultrasonic 34% 0.00% ❌
go.viam.com/rdk/components/servo 68% 0.00% ➖
go.viam.com/rdk/components/servo/gpio 71% 0.00% ✅
go.viam.com/rdk/config 76% 0.00% ✅
go.viam.com/rdk/control 57% 0.00% ➖
go.viam.com/rdk/data 79% 0.00% ✅
go.viam.com/rdk/examples/customresources/demos/complexmodule 0% 0.00% ❌
go.viam.com/rdk/examples/customresources/demos/remoteserver 0% 0.00% ❌
go.viam.com/rdk/grpc 25% 0.00% ❌
go.viam.com/rdk/ml 67% 0.00% ➖
go.viam.com/rdk/ml/inference 70% 0.00% ✅
go.viam.com/rdk/module 64% 0.00% ➖
go.viam.com/rdk/module/modmanager 79% 0.00% ✅
go.viam.com/rdk/motionplan 59% -8.62% ➖
go.viam.com/rdk/octree 98% 0.00% ✅
go.viam.com/rdk/operation 82% 0.00% ✅
go.viam.com/rdk/pointcloud 72% 0.00% ✅
go.viam.com/rdk/protoutils 59% 0.00% ➖
go.viam.com/rdk/referenceframe 70% 0.00% ✅
go.viam.com/rdk/registry 89% 0.00% ✅
go.viam.com/rdk/resource 84% 0.00% ✅
go.viam.com/rdk/rimage 78% 0.00% ✅
go.viam.com/rdk/rimage/depthadapter 94% 0.00% ✅
go.viam.com/rdk/rimage/transform 73% 0.00% ✅
go.viam.com/rdk/rimage/transform/cmd/extrinsic_calibration 67% 0.00% ➖
go.viam.com/rdk/robot 85% 0.00% ✅
go.viam.com/rdk/robot/client 82% 0.00% ✅
go.viam.com/rdk/robot/framesystem 68% 0.00% ➖
go.viam.com/rdk/robot/impl 81% -0.22% ✅
go.viam.com/rdk/robot/server 59% +0.63% ➖
go.viam.com/rdk/robot/web 62% 0.00% ➖
go.viam.com/rdk/robot/web/stream 87% 0.00% ✅
go.viam.com/rdk/services/armremotecontrol 71% 0.00% ✅
go.viam.com/rdk/services/armremotecontrol/builtin 52% 0.00% ➖
go.viam.com/rdk/services/baseremotecontrol 71% 0.00% ✅
go.viam.com/rdk/services/baseremotecontrol/builtin 79% 0.00% ✅
go.viam.com/rdk/services/datamanager 79% 0.00% ✅
go.viam.com/rdk/services/datamanager/builtin 78% 0.00% ✅
go.viam.com/rdk/services/datamanager/datacapture 70% 0.00% ✅
go.viam.com/rdk/services/datamanager/datasync 0% 0.00% ❌
go.viam.com/rdk/services/motion 63% 0.00% ➖
go.viam.com/rdk/services/motion/builtin 88% 0.00% ✅
go.viam.com/rdk/services/navigation 53% 0.00% ➖
go.viam.com/rdk/services/sensors 77% 0.00% ✅
go.viam.com/rdk/services/sensors/builtin 97% 0.00% ✅
go.viam.com/rdk/services/shell 14% 0.00% ❌
go.viam.com/rdk/services/slam 84% 0.00% ✅
go.viam.com/rdk/services/slam/builtin 73% 0.00% ✅
go.viam.com/rdk/services/vision 80% 0.00% ✅
go.viam.com/rdk/services/vision/builtin 74% 0.00% ✅
go.viam.com/rdk/session 97% 0.00% ✅
go.viam.com/rdk/spatialmath 83% 0.00% ✅
go.viam.com/rdk/subtype 92% 0.00% ✅
go.viam.com/rdk/utils 72% +0.18% ✅
go.viam.com/rdk/vision 26% 0.00% ❌
go.viam.com/rdk/vision/chess 80% 0.00% ✅
go.viam.com/rdk/vision/delaunay 87% 0.00% ✅
go.viam.com/rdk/vision/keypoints 92% 0.00% ✅
go.viam.com/rdk/vision/objectdetection 82% 0.00% ✅
go.viam.com/rdk/vision/odometry 60% 0.00% ➖
go.viam.com/rdk/vision/odometry/cmd 0% 0.00% ❌
go.viam.com/rdk/vision/segmentation 49% 0.00% ❌
go.viam.com/rdk/web/server 25% 0.00% ❌
Summary 66% (20722 / 31623) -0.54% ➖

@edaniels edaniels merged commit d6f0a73 into viamrobotics:main Dec 30, 2022
@edaniels
Copy link
Contributor

Thanks @Juneezee! Keeping it clean.

@bazile-clyde bazile-clyde mentioned this pull request Feb 7, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@agreenb agreenb agreenb approved these changes

Assignees
No one assigned
Labels
safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Juneezee @CLAassistant @edaniels @agreenb