Improve Jenkins tests #35
Open
Conversation
This file contains hidden or 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 makes all the remaining tests in `jobcontrol` package to use the same structure for test cases (mapping strings to test cases). Now all these tests are similar to the tests for `jobcontrol.Job`, and the ones in the `slack` package.
After these changes, the tests for Jenkins are easier to read, understand, and write. The expected jobs available are now also global to all the Jenkins tests, reducing the cognitive load.
This removes some cognitive load in Jenkins tests.
Most of the lists compared in these tests are slices of strings, or something very similar. This provides a couple of helpers to convert the types to string lists and another one to compare string lists easily.
This function provides the most complex and common fixtures to tests, making the tests code easy to write and read.
ifosch
force-pushed
the
improve-jenkins-tests
branch
from
1408f62 to
7805055
Compare
| os.Getenv("JENKINS_URL"), | ||
| os.Getenv("JENKINS_USER"), | ||
| os.Getenv("JENKINS_PASSWORD"), | ||
| &jobcontrol.JenkinsJobServer{}, |
Collaborator
There was a problem hiding this comment.
It should be fine to construct the Jenkins object manually when testing instead of using the NewJenkins function. I'm not sure if adding this to the public signature of jobcontrol.NewJenkins is an improvement. It brings the question of control over JenkinsJobServer, and if the user needs any control there.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This improves testing code in
jenkins_test.goto follow similar approaches injob_control.Job:Use string to test case maps when multiple tcs (jobcontrol):
This makes all the remaining tests in
jobcontrolpackage to usethe same structure for test cases (mapping strings to test
cases). Now all these tests are similar to the tests for
jobcontrol.Job, and the ones in theslackpackage.Use NewJenkins in tests after injecting IJobServer: After these
changes, the tests for Jenkins are easier to read, understand, and
write. The expected jobs available are now also global to all the
Jenkins tests, reducing the cognitive load.
Replace loadTC with simple variables: This removes some
cognitive load in Jenkins tests.
Simplify string comparisons in tests
Use t.Run in TestDescribe: This function provides the most
complex and common fixtures to tests, making the tests code easy to
write and read.
Simplify tests by grouping common stuff in a setup func
Reorganize the Jenkins tests code
Add better detail to test error message
Adjust some lines' length to improve readability