Fix formatter test setup and ignore condition #132
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
This commit addresses the issue where the test logic wrongfully inverted the ignore rule condition: 1. A file naming typo (`003.ignroe` corrected to `003.ignore`) has been fixed, ensuring `.ignore` files are now properly recognized. Previously, the misnamed file caused certain test cases to be compared against expected outputs when they should have been ignored. 2. The test logic within `formatter_test.go` that determined whether to ignore discrepancies based on `.ignore` file presence was inverted. Before the fix, the presence of an `.ignore` file led to a test error upon output mismatch, while its absence merely logged the difference without failing the test. The corrected logic now reflects the intended behavior: when an `.ignore` file is present, the differing outputs are logged for review rather than causing the test to fail.
This commit updates `formatter_test.go` to address an issue where each test case was not receiving a fresh `formatEnvironment`. Previously, a single `formatEnvironment` instance was reused across multiple test cases, leading to potential dependencies on prior tests' states, such as indentation levels, that could result in unintended test failures.
|
thank you |
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.
While extending the parser functionality, I encountered some issues with the existing formatter test suite:
The
formatter_test.gowas sharing aformatEnvironmentacross test cases. This led to state-related bugs due to shared state between tests. Now, a newformatEnvironmentis created for each test to ensure independence and prevent errors that could arise from shared state.There was a typo in the
.ignorefile naming (003.ignroe), and the ignore condition logic was incorrect. The tests incorrectly reported failures when an.ignorefile was present and an output mismatch occurred. This has been remedied so that now, presence of an.ignorefile will result in the output being logged instead of causing a failing test.