testsuite: add longer test descriptions for some of the more complex test scenarios #548
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
wihobbs
approved these changes
Dec 26, 2024
t/t1001-mf-priority-basic.t
Outdated
| @@ -156,6 +161,9 @@ test_expect_success 'submit a job using default bank' ' | |||
| flux cancel ${jobid} | |||
| ' | |||
|
|
|||
| # The following two tests ensure job subimssions are rejected when a user | |||
Problem: There is no space between the test that allows guest access to testexec in a couple of the files in the testsuite. Add a space between the tests to match the format of the rest of the testsuite.
Problem: Some of the tests in the testsuite can be somewhat complex and simulate a scenario that might take multiple steps; it would be helpful if descriptions were added that went into more detail than what is described in the one-liner for each test. Add some more thorough test descriptions in a couple of the test files explaining what is being tested, particularly for the scenarios that are broken up over multiple tests.
Problem: There is a test in t1005-max-jobs-limits.t that submits two jobs to the priority plugin under the same bank using two different methods: by default and by explicitly setting it with --setattr. However, the test description is confusing and could be worded better. Update the test description to more concisely describe what is happening in the test.
Problem: One of the tests in t1011-job-archive-interface.t has a lengthy comment explaining in more detail what is being checked in the test itself, but it is missing an important "not" when describing the effect on the job usage value for an association. Fix this comment by adding a "not" to the sentence.
cmoussa1
force-pushed
the
add.test.descriptions
branch
from
23d7314 to
3f6e1ea
Compare
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.
Problem
Some of the tests in the testsuite can be somewhat complex and simulate a scenario that might take multiple steps; it would be helpful if descriptions were added that went into more detail than what is described in the one-liner for each test.
This PR makes a number of minor test description improvements in the flux-accounting testsuite, most notably adding some more thorough test descriptions in a couple of the test files explaining what is being tested, particularly for the scenarios that are broken up over multiple tests.
I've also fixed a couple of mistakes in the test description and in already-existing test comments.
Lastly, I've just added a space between the
"allow guest access..."tests to match the format of the rest of the testsuite.Built on top of #547