docs: document known behavioral differences in go_test_suite .sync_ignore#964
Open
He-Pin wants to merge 2 commits into
Open
docs: document known behavioral differences in go_test_suite .sync_ignore#964He-Pin wants to merge 2 commits into
He-Pin wants to merge 2 commits into
Conversation
…nore
Motivation:
The .sync_ignore file was empty, providing no documentation about which
upstream go-jsonnet tests have known behavioral differences in sjsonnet.
This makes it harder for contributors to understand test coverage gaps.
Modification:
Add documented entries for 7 tests across 3 categories:
- Path-dependent: std.thisFile, std.thisFile2, stdlib_smoke_test
(sjsonnet returns filename-only, go-jsonnet returns full relative path)
- Float rendering: builtin_escapeStringJson, builtin_manifestTomlEx, pow6
(sjsonnet uses shortest round-trip, go-jsonnet uses more digits)
- Semantic: parseYaml
(std.parseYaml("---") returns null vs [null] in go-jsonnet)
Result:
Each ignored test has a comment explaining the behavioral difference
and whether sjsonnet's behavior is correct or needs further review.
parseYaml now correctly wraps single-doc YAML with explicit --- in array, matching go-jsonnet behavior. The semantic difference entry is no longer needed.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
The
go_test_suite/.sync_ignorefile was empty (header comments only), providing no documentation about which upstream go-jsonnet tests have known behavioral differences in sjsonnet.Modification
Add documented entries for 6 tests across 2 categories:
std.thisFile,std.thisFile2,stdlib_smoke_test— test harness working directory differencebuiltin_escapeStringJson,builtin_manifestTomlEx,pow6— sjsonnet/jrsonnet use shortest round-trip renderingThe
parseYamlentry was intentionally excluded since the document marker handling was fixed to match go-jsonnet behavior (see PR #968).Result
Each remaining ignored test has a comment explaining the behavioral difference and which implementations agree, making it clear which ignores are intentional vs. tracking real divergence.
No code changes; documentation only.
Test plan
.sync_ignorefile documents all 6 remaining ignored testsparseYamlentry removed (fixed by PR fix: std.parseYaml YAML 1.2 octal (0o777) and document marker handling #968)