Update toml-test

Author: arp242

error_test.go

@@ -47,9 +47,10 @@ At line 9, column 3-8:
 		{"datetime/trailing-t.toml", `
 toml: error: Invalid TOML Datetime: "2006-01-30T".
 
-At line 1, column 4-15:
+At line 2, column 4-15:
 
-      1 | d = 2006-01-30T
+      1 | # Date cannot end with trailing T
+      2 | d = 2006-01-30T
               ^^^^^^^^^^^`},
 	}
 

internal/toml-test/.gitignore

@@ -195,6 +195,19 @@ An example implementation can be found in the BurnSushi/toml:
 - [Add tags](https://github.com/BurntSushi/toml/blob/master/internal/tag/add.go)
 - [Remove tags](https://github.com/BurntSushi/toml/blob/master/internal/tag/rm.go)
 
+Implementation-defined behaviour
+--------------------------------
+This only tests behaviour that's should be true for every encoder implementing
+TOML; a few things are left up to implementations, and are not tested here.
+
+- Millisecond precision (4 digits) is required for datetimes and times, and
+  further precision is implementation-specific, and any greater precision than
+  is supported must be truncated (not rounded).
+
+  This tests only millisecond precision, and not any further precision or the
+  truncation of it.
+
+
 Assumptions of Truth
 --------------------
 The following are taken as ground truths by `toml-test`:

internal/toml-test/README.md

@@ -1,6 +1,3 @@
-//go:build go1.16
-// +build go1.16
-
 package tomltest
 
 import (
@@ -9,13 +6,15 @@ import (
 	"time"
 )
 
-// cmpJSON consumes the recursive structure of both want and have
-// simultaneously. If anything is unequal, the result has failed and comparison
-// stops.
+// CompareJSON compares the given arguments.
+//
+// The returned value is a copy of Test with Failure set to a (human-readable)
+// description of the first element that is unequal. If both arguments are
+// equal, Test is returned unchanged.
 //
 // reflect.DeepEqual could work here, but it won't tell us how the two
 // structures are different.
-func (r Test) cmpJSON(want, have interface{}) Test {
+func (r Test) CompareJSON(want, have interface{}) Test {
 	switch w := want.(type) {
 	case map[string]interface{}:
 		return r.cmpJSONMaps(w, have)
@@ -67,7 +66,7 @@ func (r Test) cmpJSONMaps(want map[string]interface{}, have interface{}) Test {
 
 	// Okay, now make sure that each value is equivalent.
 	for k := range want {
-		if sub := r.kjoin(k).cmpJSON(want[k], haveMap[k]); sub.Failed() {
+		if sub := r.kjoin(k).CompareJSON(want[k], haveMap[k]); sub.Failed() {
 			return sub
 		}
 	}
@@ -93,7 +92,7 @@ func (r Test) cmpJSONArrays(want, have interface{}) Test {
 			r.Key, len(wantSlice), len(haveSlice))
 	}
 	for i := 0; i < len(wantSlice); i++ {
-		if sub := r.cmpJSON(wantSlice[i], haveSlice[i]); sub.Failed() {
+		if sub := r.CompareJSON(wantSlice[i], haveSlice[i]); sub.Failed() {
 			return sub
 		}
 	}

internal/toml-test/gen-multi.py

@@ -1,6 +1,3 @@
-//go:build go1.16
-// +build go1.16
-
 //go:generate ./gen-multi.py
 
 package tomltest
@@ -310,7 +307,7 @@ func (t Test) runValid(p Parser, fsys fs.FS) Test {
 			//return t.fail("decode TOML from encoder %q:\n  %s", cmd, err)
 			return t.fail("decode TOML from encoder:\n  %s", err)
 		}
-		return t.cmpTOML(want, have)
+		return t.CompareTOML(want, have)
 	}
 
 	// Compare for decoder test
@@ -324,7 +321,7 @@ func (t Test) runValid(p Parser, fsys fs.FS) Test {
 		return t.fail("decode JSON output from parser:\n  %s", err)
 	}
 
-	return t.cmpJSON(want, have)
+	return t.CompareJSON(want, have)
 }
 
 // ReadInput reads the file sent to the encoder.

internal/toml-test/json.go

@@ -0,0 +1 @@
+comment-cr = "Carriage return in comment" # 

internal/toml-test/runner.go

@@ -1 +1,2 @@
+# No months with 50 days.
 d = 2006-01-50T00:00:00Z

internal/toml-test/tests/invalid/control/bare-null.toml

@@ -1 +1,2 @@
+# Day "5" instead of "05"; the leading zero is required.
 with-milli = 1987-07-5T17:45:00.12Z

internal/toml-test/tests/invalid/control/comment-cr.toml

@@ -1 +1,2 @@
+# Month "7" instead of "07"; the leading zero is required.
 no-leads = 1987-7-05T17:45:00Z

internal/toml-test/tests/invalid/control/control.multi

@@ -1 +1,2 @@
+# No seconds in time.
 no-secs = 1987-07-05T17:45Z

internal/toml-test/tests/invalid/datetime/impossible-date.toml

@@ -1 +1,2 @@
+# No "t" or "T" between the date and time.
 no-t = 1987-07-0517:45:00Z

internal/toml-test/tests/invalid/datetime/no-leads-with-milli.toml

@@ -0,0 +1,2 @@
+# Leading 0 is always required.
+d = 01:32:0

internal/toml-test/tests/invalid/datetime/no-leads.toml

@@ -0,0 +1,2 @@
+# Leading 0 is always required.
+d = 1:32:00

internal/toml-test/tests/invalid/datetime/no-secs.toml

@@ -1 +1,2 @@
+# Date cannot end with trailing T
 d = 2006-01-30T

internal/toml-test/tests/invalid/datetime/no-t.toml

@@ -0,0 +1,4 @@
+# trailing underscore in integer part is not allowed
+trailing-us-exp = 1_e2
+# trailing underscore in float part is not allowed
+trailing-us-exp2 = 1.2_e2

internal/toml-test/tests/invalid/datetime/time-no-leads-2.toml

@@ -0,0 +1,2 @@
+# Duplicate keys within an inline table are invalid
+a={b=1, b=2}

internal/toml-test/tests/invalid/datetime/time-no-leads.toml

@@ -1,7 +1,9 @@
 leading-zero-1 = 01
 leading-zero-2 = 00
+leading-zero-3 = 0_0
 leading-zero-sign-1 = -01
 leading-zero-sign-2 = +01
+leading-zero-sign-3 = +0_1
 
 double-sign-plus = ++99
 double-sign-nex = --99

internal/toml-test/tests/invalid/datetime/trailing-t.toml

@@ -0,0 +1 @@
+leading-zero-3 = 0_0

internal/toml-test/tests/invalid/float/trailing-us-exp.toml

@@ -0,0 +1 @@
+leading-zero-sign-3 = +0_1

internal/toml-test/tests/invalid/inline-table/duplicate-key.toml

@@ -0,0 +1,2 @@
+invalid-escape = "This string has a bad \  escape character."
+

internal/toml-test/tests/invalid/integer/integer.multi

@@ -0,0 +1,2 @@
+k = """t\a"""
+

internal/toml-test/tests/invalid/integer/leading-zero-3.toml

@@ -0,0 +1,2 @@
+# \<Space> is not a valid escape.
+k = """t\ t"""

internal/toml-test/tests/invalid/integer/leading-zero-sign-3.toml

@@ -0,0 +1,3 @@
+# \<Space> is not a valid escape.
+k = """t\ """
+

internal/toml-test/tests/invalid/string/bad-escape.toml renamed to internal/toml-test/tests/invalid/string/bad-escape-1.toml

@@ -0,0 +1,17 @@
+# First a.b.c defines a table: a.b.c = {z=9}
+#
+# Then we define a.b.c.t = "str" to add a str to the above table, making it:
+#
+#   a.b.c = {z=9, t="..."}
+#
+# While this makes sense, logically, it was decided this is not valid TOML as
+# it's too confusing/convoluted.
+# 
+# See: https://github.com/toml-lang/toml/issues/846
+#      https://github.com/toml-lang/toml/pull/859
+
+[a.b.c]
+  z = 9
+
+[a]
+  b.c.t = "Using dotted keys to add to [a.b.c] after explicitly defining it above is not allowed"

internal/toml-test/tests/invalid/string/bad-escape-2.toml

@@ -0,0 +1,8 @@
+# This is the same issue as in injection-1.toml, except that nests one level
+# deeper. See that file for a more complete description.
+
+[a.b.c.d]
+  z = 9
+
+[a]
+  b.c.d.k.t = "Using dotted keys to add to [a.b.c.d] after explicitly defining it above is not allowed"

internal/toml-test/tests/invalid/string/multiline-bad-escape-1.toml

@@ -1,18 +1,18 @@
 {
   "utc1": {
     "type": "datetime",
-    "value": "1987-07-05T17:45:56.123456Z"
+    "value": "1987-07-05T17:45:56.1234Z"
   },
   "utc2": {
     "type": "datetime",
-    "value": "1987-07-05T17:45:56.600000Z"
+    "value": "1987-07-05T17:45:56.6000Z"
   },
   "wita1": {
     "type": "datetime",
-    "value": "1987-07-05T17:45:56.123456+08:00"
+    "value": "1987-07-05T17:45:56.1234+08:00"
   },
   "wita2": {
     "type": "datetime",
-    "value": "1987-07-05T17:45:56.600000+08:00"
+    "value": "1987-07-05T17:45:56.6000+08:00"
   }
 }

internal/toml-test/tests/invalid/string/multiline-bad-escape-2.toml

@@ -1,4 +1,4 @@
-utc1  = 1987-07-05T17:45:56.123456Z
+utc1  = 1987-07-05T17:45:56.1234Z
 utc2  = 1987-07-05T17:45:56.6Z
-wita1 = 1987-07-05T17:45:56.123456+08:00
+wita1 = 1987-07-05T17:45:56.1234+08:00
 wita2 = 1987-07-05T17:45:56.6+08:00

internal/toml-test/tests/invalid/string/multiline-bad-escape-3.toml

@@ -1,29 +1,29 @@
 {
-  "f1": {
+  "zero": {
     "type": "float",
     "value": "0"
   },
-  "f2": {
+  "signed-pos": {
     "type": "float",
     "value": "0"
   },
-  "f3": {
+  "signed-neg": {
     "type": "float",
     "value": "0"
   },
-  "f4": {
+  "exponent": {
     "type": "float",
     "value": "0"
   },
-  "f5": {
+  "exponent-two-0": {
     "type": "float",
     "value": "0"
   },
-  "f6": {
+  "exponent-signed-pos": {
     "type": "float",
     "value": "0"
   },
-  "f7": {
+  "exponent-signed-neg": {
     "type": "float",
     "value": "0"
   }

internal/toml-test/tests/invalid/table/append-with-dotted-keys-1.toml

@@ -1,7 +1,7 @@
-f1 = 0.0
-f2 = +0.0
-f3 = -0.0
-f4 = 0e0
-f5 = 0e00
-f6 = +0e0
-f7 = -0e0
+zero = 0.0
+signed-pos = +0.0
+signed-neg = -0.0
+exponent = 0e0
+exponent-two-0 = 0e00
+exponent-signed-pos = +0e0
+exponent-signed-neg = -0e0

internal/toml-test/tests/invalid/table/append-with-dotted-keys-2.toml

@@ -1,8 +1,13 @@
 # NOTE: this file includes some literal tab characters.
 
 multiline_empty_one = """"""
+
+# A newline immediately following the opening delimiter will be trimmed.
 multiline_empty_two = """
 """
+
+# \ at the end of line trims newlines as well; note that last \ is followed by
+# two spaces, which are ignored.
 multiline_empty_three = """\
     """
 multiline_empty_four = """\
@@ -33,6 +38,7 @@ whitespace-after-bs = """\
 no-space = """a\
     b"""
 
+# Has tab character.
 keep-ws-before = """a   	\
    b"""
 

internal/toml-test/tests/valid/datetime/milliseconds.json

@@ -1,6 +1,11 @@
+# Single ' should be allowed.
 oneline = '''This string has a ' quote character.'''
+
+# A newline immediately following the opening delimiter will be trimmed.
 firstnl = '''
 This string has a ' quote character.'''
+
+# All other whitespace and newline characters remain intact.
 multiline = '''
 This string
 has ' a quote character

internal/toml-test/tests/valid/datetime/milliseconds.toml

@@ -1,20 +1,19 @@
-//go:build go1.16
-// +build go1.16
-
 package tomltest
 
 import (
 	"math"
 	"reflect"
 )
 
-// cmpTOML consumes the recursive structure of both want and have
-// simultaneously. If anything is unequal the result has failed and comparison
-// stops.
+// CompareTOML compares the given arguments.
+//
+// The returned value is a copy of Test with Failure set to a (human-readable)
+// description of the first element that is unequal. If both arguments are equal
+// Test is returned unchanged.
 //
-// reflect.DeepEqual could work here, but it won't tell us how the two
+// Reflect.DeepEqual could work here, but it won't tell us how the two
 // structures are different.
-func (r Test) cmpTOML(want, have interface{}) Test {
+func (r Test) CompareTOML(want, have interface{}) Test {
 	if isTomlValue(want) {
 		if !isTomlValue(have) {
 			return r.fail("Type for key '%s' differs:\n"+
@@ -64,7 +63,7 @@ func (r Test) cmpTOMLMap(want map[string]interface{}, have interface{}) Test {
 
 	// Okay, now make sure that each value is equivalent.
 	for k := range want {
-		if sub := r.kjoin(k).cmpTOML(want[k], haveMap[k]); sub.Failed() {
+		if sub := r.kjoin(k).CompareTOML(want[k], haveMap[k]); sub.Failed() {
 			return sub
 		}
 	}
@@ -96,7 +95,7 @@ func (r Test) cmpTOMLArrays(want []interface{}, have interface{}) Test {
 			r.Key, want, haveSlice, len(want), len(haveSlice))
 	}
 	for i := 0; i < len(want); i++ {
-		if sub := r.cmpTOML(want[i], haveSlice[i]); sub.Failed() {
+		if sub := r.CompareTOML(want[i], haveSlice[i]); sub.Failed() {
 			return sub
 		}
 	}

internal/toml-test/tests/valid/float/zero.json

@@ -281,7 +281,16 @@ func TestToml(t *testing.T) {
 			SkipTests: []string{
 				// This one is annoying to fix, and such an obscure edge case
 				// it's okay to leave it like this for now.
+				// https://github.com/BurntSushi/toml/issues/329
 				"invalid/encoding/bad-utf8-at-end",
+
+				// TODO: fix this.
+				"invalid/table/append-with-dotted*",
+				"invalid/datetime/time-no-leads",        // https://github.com/BurntSushi/toml/issues/320
+				"invalid/control/bare-null",             // https://github.com/BurntSushi/toml/issues/317
+				"invalid/control/comment-cr",            // https://github.com/BurntSushi/toml/issues/321
+				"invalid/integer/leading-zero-3",        // https://github.com/BurntSushi/toml/issues/326
+				"invalid/string/multiline-bad-escape-3", // https://github.com/BurntSushi/toml/issues/322
 			},
 		}