-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Document why toolsnap churn occurred between PR #1816 and subsequent PRs #1819
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -252,3 +252,63 @@ func TestToolSnapKeysSorted(t *testing.T) { | |||||
| assert.Greater(t, mmmIndex, aaaIndex, "mmm should come after aaa") | ||||||
| assert.Greater(t, zzzIndex, mmmIndex, "zzz should come after mmm") | ||||||
| } | ||||||
|
|
||||||
| func TestStructFieldOrderingSortedAlphabetically(t *testing.T) { | ||||||
| withIsolatedWorkingDir(t) | ||||||
|
|
||||||
| // Given a struct with fields defined in non-alphabetical order | ||||||
| // This test ensures that struct field order doesn't affect the JSON output | ||||||
| type toolWithNonAlphabeticalFields struct { | ||||||
| ZField string `json:"zField"` // Should appear last in JSON | ||||||
| AField string `json:"aField"` // Should appear first in JSON | ||||||
| MField string `json:"mField"` // Should appear in the middle | ||||||
| } | ||||||
|
|
||||||
| tool := toolWithNonAlphabeticalFields{ | ||||||
| ZField: "z value", | ||||||
| AField: "a value", | ||||||
| MField: "m value", | ||||||
| } | ||||||
|
|
||||||
| // When we write the snapshot | ||||||
| t.Setenv("UPDATE_TOOLSNAPS", "true") | ||||||
| err := Test("struct_field_order", tool) | ||||||
| require.NoError(t, err) | ||||||
|
|
||||||
| // Then the snapshot file should have alphabetically sorted keys despite struct field order | ||||||
| snapJSON, err := os.ReadFile("__toolsnaps__/struct_field_order.snap") | ||||||
| require.NoError(t, err) | ||||||
|
|
||||||
| snapStr := string(snapJSON) | ||||||
|
|
||||||
| // Find the positions of each field in the JSON string | ||||||
| aFieldIndex := -1 | ||||||
| mFieldIndex := -1 | ||||||
| zFieldIndex := -1 | ||||||
| for i := 0; i < len(snapStr)-7; i++ { | ||||||
|
||||||
| for i := 0; i < len(snapStr)-7; i++ { | |
| for i := 0; i < len(snapStr)-5; i++ { |
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 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 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 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 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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR description claims to add
TOOLSNAP_CHURN_EXPLANATION.mddocumenting why toolsnaps showed churn, but this file is not present in the changes. The documentation mentioned in the 'What changed' and 'Docs' sections of the PR description is missing. If documentation was intended to be added, it should be included in the PR.