feat: Prevent unused flags #4182
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
lukemassa
force-pushed
the
prevent_unused_flags
branch
from
0f482a1 to
bab4f3d
Compare
lukemassa
force-pushed
the
prevent_unused_flags
branch
from
bab4f3d to
42b6fb7
Compare
lukemassa
requested review from
chenrui333,
nitrocode and
X-Guardian
and removed request for
a team
jamengual
previously approved these changes
Jan 29, 2024
|
The CI wasn't running properly so I pushed a small update (cleaned up the verbiage slightly). Merging as is. |
1 task
1 task
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.
what
Add a unit test to make sure that all the values in server.UserConfig appear in server_test.testFlags
why
When you add a flag you're supposed to add it to four places: cmd/server.go as a const, cmd/server.go as part of a map for flags, cmd/server_test.go to test, and the configuration struct in server/server.UserConfig. Per #4063, if you forget some combination of these a unit test already fails (example: https://github.com/runatlantis/atlantis/blob/v0.27.1/cmd/server_test.go#L124). This adds an additional unit test to make sure a different misconfiguration doesn't occur.
tests
Ran unit tests.
references
Partially addresses: #4063
Prevents recurrence of issues like: #4183, #4064