assert.YAMLEq: Document mutlidoc behavior #1791
Merged
Conversation
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
* Identical but invalid YAML is an assertion error. * Subsequent documents are unchecked.
brackendawson
force-pushed
the
YAMLEq-document-multidoc
branch
from
8ea0b9a to
a78e373
Compare
brackendawson
changed the title
brackendawson
changed the title
ccoVeille
reviewed
Sep 11, 2025
ccoVeille
reviewed
Sep 12, 2025
Co-authored-by: ccoVeille <3875889+ccoVeille@users.noreply.github.com>
brackendawson
force-pushed
the
YAMLEq-document-multidoc
branch
from
aa34525 to
2b945c3
Compare
ccoVeille
reviewed
Sep 12, 2025
ccoVeille
approved these changes
Sep 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Document the limitation that YAMLEq only compares the first document.
Changes
Motivation
It would be preferable to fix YAMLEq to compare all documents because that's what it outwardly claims to do and is what one would expect it to do. #1284 would do that, but #1579 as made this practically impossible. So in testify v1 we must document the behavior as is.
Related issues
Addresses but does not resolve #1281