Introduce test harness into unit tests #69544
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| load("@io_bazel_rules_go//go:def.bzl", "go_library") | ||
|
|
||
| go_library( | ||
| name = "go_default_library", | ||
| srcs = ["harness.go"], | ||
| importpath = "k8s.io/kubernetes/test/utils/harness", | ||
| visibility = ["//visibility:public"], | ||
| deps = ["//vendor/github.com/golang/glog:go_default_library"], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "package-srcs", | ||
| srcs = glob(["**"]), | ||
| tags = ["automanaged"], | ||
| visibility = ["//visibility:private"], | ||
| ) | ||
|
|
||
| filegroup( | ||
| name = "all-srcs", | ||
| srcs = [":package-srcs"], | ||
| tags = ["automanaged"], | ||
| visibility = ["//visibility:public"], | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| Copyright 2018 The Kubernetes Authors. | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package harness | ||
|
|
||
| import ( | ||
| "io/ioutil" | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/golang/glog" | ||
| ) | ||
|
|
||
| // Harness adds some functionality to testing.T, in particular resource cleanup. | ||
| // It embeds testing.T, so should have the same signature. | ||
| // | ||
| // Example usage: | ||
| // ``` | ||
| // func MyTest(tt *testing.T) { | ||
| // t := harness.For(tt) | ||
| // defer t.Close() | ||
| // ... | ||
| // } | ||
| // ``` | ||
| type Harness struct { | ||
| *testing.T | ||
| defers []func() error | ||
| } | ||
|
|
||
| // For creates a Harness from a testing.T | ||
| // Callers must call Close on the Harness so that resources can be cleaned up | ||
| func For(t *testing.T) *Harness { | ||
| h := &Harness{T: t} | ||
| return h | ||
| } | ||
|
|
||
| // Close cleans up any owned resources, and should be called in a defer block after For | ||
| func (h *Harness) Close() { | ||
| for _, d := range h.defers { | ||
| if err := d(); err != nil { | ||
| glog.Warningf("error closing harness: %v", err) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // TempDir is a wrapper around ioutil.TempDir for tests. | ||
| // It automatically fails the test if we can't create a temp file, | ||
| // and deletes the temp directory when Close is called on the Harness | ||
| func (h *Harness) TempDir(baseDir string, prefix string) string { | ||
|
There was a problem hiding this comment. @justinsb nice pattern for cleaning tempdirs. I think we could use this harness pattern to cleanup any other resources we allocate . Would be interesting to see where else can we leverage this |
||
| tempDir, err := ioutil.TempDir(baseDir, prefix) | ||
| if err != nil { | ||
| h.Fatalf("unable to create tempdir: %v", err) | ||
| } | ||
| h.defers = append(h.defers, func() error { | ||
| return os.RemoveAll(tempDir) | ||
| }) | ||
| return tempDir | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Maybe make
Harnessan interface andTempDirCleanupHarnessa concrete type ofHarness? That way folks can implement different types of Harnesses?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So the reason not to is because Harness embeds
testing.T, so we can use it more interchangeably with existing code that wants atesting.T. I do agree that once we've got it so that everyone is using the harness, we should move to an interface!