YAMLEq: multi documents are not checked

[pipiobjo]

Asserting nested yaml documents will always pass.

I would expect following test to fail.

package main

import (
	"github.com/stretchr/testify/assert"
	"testing"
)

func TestMultipleYAMLDocuments(t *testing.T) {

	expectedYaml := `
Director:
  name: Spielberg
  Movies:
    - Movie:
        title: E.T.
        year: 1975
    - Movie:
        title: Jaws
        year: 1982
---
Director:
  name: Spielberg
  Movies:
    - Movie:
        title: E.T.
        year: 1975
    - Movie:
        title: Jaws
        year: 1982

`
	actualYaml := `
Director:
  name: Spielberg
  Movies:
    - Movie:
        title: E.T.
        year: 1975
    - Movie:
        title: Jaws
        year: 1982
---
Director:
  name: Spielberg
  Movies:
    - Movie:
        title: E.T.
        year: 1975


`
	assert.YAMLEq(t, expectedYaml, actualYaml, "yaml should be the same")
}

[brackendawson]

Because #1579 exposes the internal implementation of YAMLEq is is no longer possible to cleanly fix this issue. We need to document that in v1; YAMLEq only asserts that the first documents in the YAML string are equal.

[dolmen]

Behavior documented in #1791.