Add a commented-out CopySuite.TestRunShell #320
Merged
Conversation
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
integration/copy_test.go
Outdated
| TestRunShell is not really a test; it is a convenient way to use the registry setup code | ||
| in openshift.go and CopySuite to get an interactive environment for experimentation. | ||
|
|
||
| To use it, uncomment the “test” below, and run: |
There was a problem hiding this comment.
should "test" be "the TestRunShell() function"?
There was a problem hiding this comment.
It could be; but really commenting out the code is pretty cumbersome (we also have to comment out an import), so I have rewritten this to use a build tag instead.
We are maintaining code to set up and run registries, including the fairly complex setup for Atomic Registry, in the integration tests. This is all useful for experimentation in shell, and the easiest way to do that is to add a “test” which, after all the set up is done, simply starts a shell. This is gated by a build tag, so it does not affect normal test runs. A possible alternative would be to convert all of the setup code not to depend on check.C and testing.T, but that would be fairly cumbersome due to how prevalent c.Logf and c.Assert are throughout the setup code. Especially the natural replacement of c.Assert with a panic() would be pretty ugly, and adding real error handling to all of that would make the code noticeably longer. The build tag and copy&pasting a command works just as well, at least for now. (It is not conveniently possible to create a new “main program” which manually creates a check.C and testing.T just for the purpose of running the setup code either; check.C can be created given a testing.T, but testing.T is only created by testing.MainStart, which does not allow us to submit a non-test method; and testing.MainStart is excluded from the Go compatibility promise.)
|
LGTM |
|
Modified this to use a build tag instead asking the user to manually uncomment a function. That should be easier to both use and maintain. (Alternatively, we could use |
|
@runcom Sorry, PTAL at the new version. |
|
@mtrmac build tag looks good to me as well. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
We are maintaining code to set up and run registries, including the fairly complex setup for Atomic Registry, in the integration tests. This is all useful for experimentation in shell, and the easiest way to
do that is to add a “test” which, after all the set up is done, simply starts a shell.
Obviously this is commented out and thus does not affect ordinary test runs.
A possible alternative would be to convert all of the setup code not to depend on
check.Candtesting.T, but that would be fairly cumbersome due to how prevalentc.Logfandc.Assertare throughout the setup code. Especially the natural replacement ofc.Assertwith apanic()would bepretty ugly, and adding real error handling to all of that would make the code noticeably longer. Commenting/uncommenting a function and copy&pasting a command works just as well, at least for now.
(It is not conveniently possible to create a new “main program” which manually creates a
check.Candtesting.Tjust for the purpose of running the setup code either;check.Ccan be created given atesting.T, buttesting.Tis only created bytesting.MainStart, which does not allow us to submit a non-test method andtesting.MainStartis excluded from the Go compatibility promise.)