Merge pull request #68 from knz/20210413-go116

Fix support for Go 1.16.

Author: knz

.travis.yml

@@ -4,3 +4,4 @@ go:
 - 1.13.x
 - 1.14.x
 - 1.15.x
+- 1.16.x

errbase/adapters.go

@@ -191,9 +191,11 @@ func init() {
 	ws := pkgErr.WithStack(baseErr)
 	RegisterWrapperEncoder(GetTypeKey(ws), encodePkgWithStack)
 
+	registerOsPathErrorMigration() // Needed for Go 1.16.
 	pKey := GetTypeKey(&os.PathError{})
 	RegisterWrapperEncoder(pKey, encodePathError)
 	RegisterWrapperDecoder(pKey, decodePathError)
+
 	pKey = GetTypeKey(&os.LinkError{})
 	RegisterWrapperEncoder(pKey, encodeLinkError)
 	RegisterWrapperDecoder(pKey, decodeLinkError)

errbase/adapters_test.go

@@ -180,13 +180,13 @@ func TestAdaptOsErrors(t *testing.T) {
 
 	origErr = &os.PathError{Op: "hello", Path: "world", Err: goErr.New("woo")}
 	newErr := network(t, origErr)
-	tt.Check(reflect.DeepEqual(newErr, origErr))
+	tt.CheckDeepEqual(newErr, origErr)
 
 	origErr = &os.LinkError{Op: "hello", Old: "world", New: "universe", Err: goErr.New("woo")}
 	newErr = network(t, origErr)
-	tt.Check(reflect.DeepEqual(newErr, origErr))
+	tt.CheckDeepEqual(newErr, origErr)
 
 	origErr = &os.SyscallError{Syscall: "hello", Err: goErr.New("woo")}
 	newErr = network(t, origErr)
-	tt.Check(reflect.DeepEqual(newErr, origErr))
+	tt.CheckDeepEqual(newErr, origErr)
 }

errbase/oserror_go116.go

@@ -0,0 +1,24 @@
+// Copyright 2021 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+// +build go1.16
+
+package errbase
+
+import "io/fs"
+
+func registerOsPathErrorMigration() {
+	// The os.PathError type was migrated to io.fs.PathError in Go 1.16.
+	RegisterTypeMigration("os", "*os.PathError", &fs.PathError{})
+}

errbase/oserror_pre116.go

@@ -0,0 +1,19 @@
+// Copyright 2021 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+// +build !go1.16
+
+package errbase
+
+func registerOsPathErrorMigration() {}

fmttests/datadriven_test_go116.go

@@ -0,0 +1,22 @@
+// Copyright 2021 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+// +build go1.16
+
+package fmttests
+
+func fakeGo116(s string) string {
+	// We are at 1.16 already. Nothing to fake.
+	return s
+}

fmttests/datadriven_test_pre116.go

@@ -0,0 +1,31 @@
+// Copyright 2021 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+// +build !go1.16
+
+package fmttests
+
+import "strings"
+
+func fakeGo116(s string) string {
+	// In Go 1.16, the canonical type for os.PathError is io/fs/*fs.PathError.
+	// So when running the tests with a pre-1.16 runtime, the strings
+	// emitted by printing out the error objects don't match the output
+	// expected in the tests, which was generated with go 1.16.
+	s = strings.ReplaceAll(s, "os/*os.PathError (*::)", "io/fs/*fs.PathError (os/*os.PathError::)")
+	s = strings.ReplaceAll(s, " *os.PathError", " *fs.PathError")
+	s = strings.ReplaceAll(s, "\n*os.PathError", "\n*fs.PathError")
+	s = strings.ReplaceAll(s, "&os.PathError", "&fs.PathError")
+	return s
+}

fmttests/format_error_test.go

@@ -367,6 +367,15 @@ func fmtClean(spv string) string {
 	spv = stackref.ReplaceAllString(spv, `&stack{...}`)
 	spv = hexref.ReplaceAllString(spv, "0xAAAABBBB")
 	spv = strings.ReplaceAll(spv, "\t", "<tab>")
+
+	// When running the tests with a Go version before 1.16,
+	// the reference test output wrt fs.PathError will not match what the
+	// Go runtime thinks (os.PathError was a separate type).
+	//
+	// In that case, we translate the test output as per the old
+	// runtime into the shape expected in 1.16 or later.
+	spv = fakeGo116(spv)
+
 	return spv
 }
 

fmttests/testdata/format/wrap-fmt

@@ -2330,7 +2330,7 @@ accept %\#v via Formattable.*IRREGULAR: not same as %\#v
 
 require (?s)
 ----
-&os.PathError{
+&fs.PathError{
     Op:   "link",
     Path: "/path/to/file",
     Err:  &fmttests.errFmt{msg:"innerone\ninnertwo"},
@@ -2339,7 +2339,7 @@ require (?s)
 ===== non-redactable formats
 =====
 == %#v
-&os.PathError{Op:"link", Path:"/path/to/file", Err:&fmttests.errFmt{msg:"innerone\ninnertwo"}}
+&fs.PathError{Op:"link", Path:"/path/to/file", Err:&fmttests.errFmt{msg:"innerone\ninnertwo"}}
 == Error()
 link /path/to/file: innerone
 innertwo
@@ -2350,7 +2350,7 @@ innertwo
 == %X = HEX Error(), good
 == %+v = Error(), ok
 == %#v via Formattable() (IRREGULAR: not same as %#v)
-&os.PathError{
+&fs.PathError{
     Op:   "link",
     Path: "/path/to/file",
     Err:  &fmttests.errFmt{msg:"innerone\ninnertwo"},
@@ -2366,7 +2366,7 @@ Wraps: (2) innerone
   | -- this is innerone
   | innertwo's
   | multi-line leaf payload
-Error types: (1) *os.PathError (2) *fmttests.errFmt
+Error types: (1) *fs.PathError (2) *fmttests.errFmt
 =====
 ===== redactable formats
 =====
@@ -2386,7 +2386,7 @@ Wraps: (2) ‹innerone›‹›
 ‹  | -- this is innerone›
 ‹  | innertwo's›
 ‹  | multi-line leaf payload›
-Error types: (1) *os.PathError (2) *fmttests.errFmt
+Error types: (1) *fs.PathError (2) *fmttests.errFmt
 =====
 ===== Sentry reporting
 =====
@@ -2395,10 +2395,10 @@ link ×: ×
 ×
 --
 *fmttests.errFmt
-*os.PathError
+*fs.PathError
 == Extra "error types"
 github.com/cockroachdb/errors/fmttests/*fmttests.errFmt (*::)
-os/*os.PathError (*::)
+io/fs/*fs.PathError (os/*os.PathError::)
 == Exception 1 (Module: "error domain: <none>")
 Type: "*fmttests.errFmt"
 Title: "link ×: ×\n×"

fmttests/testdata/format/wrap-fmt-via-network

@@ -2992,7 +2992,7 @@ accept %\#v via Formattable.*IRREGULAR: not same as %\#v
 
 require (?s)innerone.*innertwo
 ----
-&os.PathError{
+&fs.PathError{
     Op:   "link",
     Path: "/path/to/file",
     Err:  &errbase.opaqueLeaf{
@@ -3009,7 +3009,7 @@ require (?s)innerone.*innertwo
 ===== non-redactable formats
 =====
 == %#v
-&os.PathError{Op:"link", Path:"/path/to/file", Err:&errbase.opaqueLeaf{
+&fs.PathError{Op:"link", Path:"/path/to/file", Err:&errbase.opaqueLeaf{
     msg:     "innerone\ninnertwo",
     details: errorspb.EncodedErrorDetails{
         OriginalTypeName:  "github.com/cockroachdb/errors/fmttests/*fmttests.errFmt",
@@ -3028,7 +3028,7 @@ innertwo
 == %X = HEX Error(), good
 == %+v = Error(), ok
 == %#v via Formattable() (IRREGULAR: not same as %#v)
-&os.PathError{
+&fs.PathError{
     Op:   "link",
     Path: "/path/to/file",
     Err:  &errbase.opaqueLeaf{
@@ -3052,7 +3052,7 @@ Wraps: (2) innerone
   |
   | (opaque error leaf)
   | type name: github.com/cockroachdb/errors/fmttests/*fmttests.errFmt
-Error types: (1) *os.PathError (2) *errbase.opaqueLeaf
+Error types: (1) *fs.PathError (2) *errbase.opaqueLeaf
 =====
 ===== redactable formats
 =====
@@ -3072,7 +3072,7 @@ Wraps: (2) ‹innerone›
   |
   | (opaque error leaf)
   | type name: github.com/cockroachdb/errors/fmttests/*fmttests.errFmt
-Error types: (1) *os.PathError (2) *errbase.opaqueLeaf
+Error types: (1) *fs.PathError (2) *errbase.opaqueLeaf
 =====
 ===== Sentry reporting
 =====
@@ -3081,10 +3081,10 @@ link ×: ×
 ×
 --
 *fmttests.errFmt
-*os.PathError
+*fs.PathError
 == Extra "error types"
 github.com/cockroachdb/errors/fmttests/*fmttests.errFmt (*::)
-os/*os.PathError (*::)
+io/fs/*fs.PathError (os/*os.PathError::)
 == Exception 1 (Module: "error domain: <none>")
 Type: "*fmttests.errFmt"
 Title: "link ×: ×\n×"