Data driven tests for internal/libyaml

Refactored from @colinjlacy's #184

Use super clean, simple, consistent and documented foo_test.yaml files
for test data, and minimal foo_test.go files for the code running the
tests.

Author: ingydotnet

.github/workflows/check-commit-message.yaml

@@ -13,7 +13,7 @@ jobs:
     if: github.event.pull_request.user.login != 'dependabot[bot]'
     steps:
     - name: Checkout code
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         fetch-depth: 0  # Fetch all history to ensure all SHAs are available
         persist-credentials: false

.github/workflows/codeql.yaml

@@ -28,20 +28,20 @@ jobs:
           build-mode: autobuild
     steps:
     - name: Checkout repository
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/init@fe4161a26a8629af62121b670040955b330f9af2  # v4.31.6
+      uses: github/codeql-action/init@0499de31b99561a6d14a36a5f662c2a54f91beee  # v4.31.2
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
 
     - name: Perform CodeQL Analysis
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/analyze@fe4161a26a8629af62121b670040955b330f9af2  # v4.31.6
+      uses: github/codeql-action/analyze@0499de31b99561a6d14a36a5f662c2a54f91beee  # v4.31.2
       with:
         category: /language:${{matrix.language}}

.github/workflows/files.yaml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout-action
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
 
@@ -24,7 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout-action
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
 
@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout-action
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
 
@@ -49,9 +49,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: checkout-action
-      uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
 
     - name: typos-action
-      uses: crate-ci/typos@2d0ce569feab1f8752f1dde43cc2f2aa53236e06  # v1.40.0
+      uses: crate-ci/typos@07d900b8fa1097806b8adb6391b0d3e0ac2fdea7  # v1.39.0

.github/workflows/go.yaml

@@ -12,19 +12,19 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
     - name: Set up Go
-      uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c  # v6.1.0
+      uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00  # v6.0.0
       with:
         go-version: stable
     - name: Install golangci-lint
       run: |
         make golangci-lint-install
         echo "${{ github.workspace }}/.cache/local/bin" >> "$GITHUB_PATH"
     # yamllint disable-line rule:line-length
-    - uses: golangci/golangci-lint-action@e7fa5ac41e1cf5b7d48e45e42232ce7ada589601  # v9.1.0
+    - uses: golangci/golangci-lint-action@4afd733a84b1f43292c63897423277bb7f4313a9  # v8.0.0
       with:
         install-mode: none
   go-versions:
@@ -33,9 +33,9 @@ jobs:
     outputs:
       matrix: ${{ steps.versions.outputs.matrix }}
     steps:
-    - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
     # yamllint disable-line rule:line-length
-    - uses: arnested/go-version-action@978371bd4d8cad0f54106c8be4273e2fcdd74f57  # v1.1.23
+    - uses: arnested/go-version-action@1f4135a30a2498f919e428c81c342f9334b3a93d  # v1.1.22
       id: versions
   build:
     runs-on: ubuntu-latest
@@ -45,11 +45,11 @@ jobs:
       matrix:
         go-versions: ${{ fromJSON(needs.go-versions.outputs.matrix) }}
     steps:
-    - uses: actions/checkout@1af3b93b6815bc44a9784bd300feb67ff0d1eeb3  # v6.0.0
+    - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8  # v5.0.0
       with:
         persist-credentials: false
     - name: Set up Go
-      uses: actions/setup-go@4dc6199c7b1a012772edbd06daecab0f50c9053c  # v6.1.0
+      uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00  # v6.0.0
       with:
         go-version: ${{ matrix.go-versions }}
     - name: Run yaml-test-suit tests

GNUmakefile

@@ -66,7 +66,7 @@ count ?= 1
 
 # Test rules:
 test: $(GO-DEPS)
-	go test$(if $v, -v) -vet=off .
+	go test$(if $v, -v) -vet=off --cover . ./internal/...
 
 test-data: $(YTS-DIR)
 

decode.go

@@ -216,8 +216,7 @@ func (p *parser) alias() *Node {
 	n := p.node(AliasNode, "", "", string(p.event.Anchor))
 	n.Alias = p.anchors[n.Value]
 	if n.Alias == nil {
-		msg := fmt.Sprintf("unknown anchor '%s' referenced", n.Value)
-		fail(&ParserError{msg, n.Line, n.Column})
+		failf("unknown anchor '%s' referenced", n.Value)
 	}
 	p.expect(libyaml.ALIAS_EVENT)
 	return n

decode_test.go

@@ -927,15 +927,6 @@ var unmarshalTests = []struct {
 		"true #" + strings.Repeat(" ", 512*3),
 		"true",
 	},
-	// C1 Control characters
-	{
-		"\u0080",
-		"\u0080",
-	},
-	{
-		"\u009F",
-		"\u009F",
-	},
 
 	// CRLF
 	{
@@ -1134,13 +1125,13 @@ var unmarshalErrorTests = []struct {
 	{"v: [A,", "yaml: line 1: did not find expected node content"},
 	{"v:\n- [A,", "yaml: line 2: did not find expected node content"},
 	{"a:\n- b: *,", "yaml: line 2: did not find expected alphabetic or numeric character"},
-	{"a: *b\n", "yaml: line 1: unknown anchor 'b' referenced"},
+	{"a: *b\n", "yaml: unknown anchor 'b' referenced"},
 	{"a: &a\n  b: *a\n", "yaml: anchor 'a' value contains itself"},
 	{"value: -", "yaml: block sequence entries are not allowed in this context"},
 	{"a: !!binary ==", "yaml: !!binary value contains invalid base64 data"},
 	{"{[.]}", `yaml: cannot use '\[\]interface \{\}\{"\."\}' as a map key; try decoding into yaml.Node`},
 	{"{{.}}", `yaml: cannot use 'map\[string]interface \{\}\{".":interface \{\}\(nil\)\}' as a map key; try decoding into yaml.Node`},
-	{"b: *a\na: &a {c: 1}", `yaml: line 1: unknown anchor 'a' referenced`},
+	{"b: *a\na: &a {c: 1}", `yaml: unknown anchor 'a' referenced`},
 	{"%TAG !%79! tag:yaml.org,2002:\n---\nv: !%79!int '1'", "yaml: did not find expected whitespace"},
 	{"a:\n  1:\nb\n  2:", ".*could not find expected ':'"},
 	{"a: 1\nb: 2\nc 2\nd: 3\n", "^yaml: line 3: could not find expected ':'$"},
@@ -2132,31 +2123,6 @@ a:
 	}
 }
 
-func TestParserErrorUnknownAnchorPosition(t *testing.T) {
-	tests := []struct {
-		data   string
-		line   int
-		column int
-	}{
-		{"*x", 1, 1},
-		{"a: *x", 1, 4},
-		{"a:\n  b: *x", 2, 6},
-	}
-
-	for _, test := range tests {
-		var n yaml.Node
-		err := yaml.Unmarshal([]byte(test.data), &n)
-		asErr := new(yaml.ParserError)
-		assert.ErrorAs(t, err, &asErr)
-		expected := &yaml.ParserError{
-			Message: "unknown anchor 'x' referenced",
-			Line:    test.line,
-			Column:  test.column,
-		}
-		assert.DeepEqual(t, expected, asErr)
-	}
-}
-
 //var data []byte
 //func init() {
 //	var err error

encode_test.go

@@ -36,6 +36,7 @@ var marshalTests = []struct {
 	value any
 	data  string
 }{
+	// Basic types.
 	{
 		nil,
 		"null\n",
@@ -136,6 +137,18 @@ var marshalTests = []struct {
 		map[string]any{"v": ""},
 		"v: \"\"\n",
 	},
+
+	// Issue 65: Validate handling newlines at the start.
+	{
+		map[string]any{"v": "\nhi"},
+		"v: |-\n\n    hi\n",
+	},
+	{
+		map[string][]any{"v": {map[string]any{"v1": "\nhi"}}},
+		"v:\n    - v1: |-\n\n        hi\n",
+	},
+
+	// Validate multiline strings.
 	{
 		map[string][]string{"v": {"A", "B"}},
 		"v:\n    - A\n    - B\n",
@@ -942,6 +955,18 @@ a:
       - c: 1
         d: 2
 `),
+
+	normal(`
+v:
+    - v1: |-
+
+        hi
+`): compact(`
+v:
+  - v1: |-
+
+        hi
+`),
 }
 
 func TestEncoderCompactIndents(t *testing.T) {
@@ -978,7 +1003,7 @@ func TestNewLinePreserved(t *testing.T) {
 	data, err = yaml.Marshal(obj)
 	assert.NoError(t, err)
 	// the newline at the start of the file should be preserved
-	assert.Equal(t, "_: |4\n\n    a:\n            b:\n                    c: d\n", string(data))
+	assert.Equal(t, "_: |\n\n    a:\n            b:\n                    c: d\n", string(data))
 }
 
 func TestScalarStyleRules(t *testing.T) {

go.mod

@@ -1,3 +1,5 @@
 module go.yaml.in/yaml/v4
 
 go 1.18
+
+require go.yaml.in/yaml/v3 v3.0.4

go.sum

@@ -0,0 +1,4 @@
+go.yaml.in/yaml/v3 v3.0.4 h1:tfq32ie2Jv2UxXFdLJdh3jXuOzWiL1fo0bu/FbuKpbc=
+go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=