Merge pull request #1791 from brackendawson/YAMLEq-document-multidoc

assert.YAMLEq: Document mutlidoc behavior

Author: brackendawson

assert/assertion_format.go

@@ -1880,7 +1880,19 @@ func JSONEq(t TestingT, expected string, actual string, msgAndArgs ...interface{
 	return Equal(t, expectedJSONAsInterface, actualJSONAsInterface, msgAndArgs...)
 }
 
-// YAMLEq asserts that two YAML strings are equivalent.
+// YAMLEq asserts that the first documents in the two YAML strings are equivalent.
+//
+//	expected := `---
+//	key: value
+//	---
+//	key: this is a second document, it is not evaluated
+//	`
+//	actual := `---
+//	key: value
+//	---
+//	key: this is a subsequent document, it is not evaluated
+//	`
+//	assert.YAMLEq(t, expected, actual)
 func YAMLEq(t TestingT, expected string, actual string, msgAndArgs ...interface{}) bool {
 	if h, ok := t.(tHelper); ok {
 		h.Helper()

assert/assertion_forward.go

@@ -2868,6 +2868,31 @@ func TestYAMLEq_ArraysOfDifferentOrder(t *testing.T) {
 	False(t, YAMLEq(mockT, `["foo", {"hello": "world", "nested": "hash"}]`, `[{ "hello": "world", "nested": "hash"}, "foo"]`))
 }
 
+func TestYAMLEq_OnlyFirstDocument(t *testing.T) {
+	t.Parallel()
+
+	mockT := new(testing.T)
+	True(t, YAMLEq(mockT,
+		`---
+doc1: same
+---
+doc2: different
+`,
+		`---
+doc1: same
+---
+doc2: notsame
+`,
+	))
+}
+
+func TestYAMLEq_InvalidIdenticalYAML(t *testing.T) {
+	t.Parallel()
+
+	mockT := new(testing.T)
+	False(t, YAMLEq(mockT, `}`, `}`))
+}
+
 type diffTestingStruct struct {
 	A string
 	B int