Merge pull request #4723 from kersten/chore/matcherror-in-tests

🌱 (chore): replace errors.As() with MatchError() in error assertions

Author: k8s-ci-robot

pkg/config/store/yaml/store_test.go

@@ -18,6 +18,7 @@ package yaml
 
 import (
 	"errors"
+	"fmt"
 	"os"
 	"testing"
 
@@ -91,31 +92,54 @@ layout: ""
 		It("should fail if no file exists at the default path", func() {
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to read %q file: %w", DefaultPath, &os.PathError{
+					Err:  os.ErrNotExist,
+					Path: DefaultPath,
+					Op:   "open",
+				}),
+			}))
 		})
 
 		It("should fail if unable to identify the version of the file at the default path", func() {
 			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+unversionedFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to determine config version: %w",
+					fmt.Errorf("error unmarshaling JSON: %w",
+						errors.New("while decoding JSON: project version is empty"),
+					),
+				),
+			}))
 		})
 
 		It("should fail if unable to create a Config for the version of the file at the default path", func() {
 			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+nonexistentVersionFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to create config for version %q: %w", "1-alpha", config.UnsupportedVersionError{
+					Version: config.Version{Number: 1, Stage: 2},
+				}),
+			}))
 		})
 
 		It("should fail if unable to unmarshal the file at the default path", func() {
 			Expect(afero.WriteFile(s.fs, DefaultPath, []byte(commentStr+wrongFile), os.ModePerm)).To(Succeed())
 
 			err := s.Load()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to create config for version %q: %w", "2", config.UnsupportedVersionError{
+					Version: config.Version{
+						Number: 2,
+						Stage:  0,
+					},
+				}),
+			}))
 		})
 	})
 
@@ -133,31 +157,53 @@ layout: ""
 		It("should fail if no file exists at the specified path", func() {
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to read %q file: %w", path, &os.PathError{
+					Err:  os.ErrNotExist,
+					Path: path,
+					Op:   "open",
+				}),
+			}))
 		})
 
 		It("should fail if unable to identify the version of the file at the specified path", func() {
 			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+unversionedFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to determine config version: %w",
+					fmt.Errorf("error unmarshaling JSON: %w",
+						errors.New("while decoding JSON: project version is empty"),
+					),
+				),
+			}))
 		})
 
 		It("should fail if unable to create a Config for the version of the file at the specified path", func() {
 			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+nonexistentVersionFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to create config for version %q: %w", "1-alpha", config.UnsupportedVersionError{
+					Version: config.Version{Number: 1, Stage: 2},
+				}),
+			}))
 		})
 
 		It("should fail if unable to unmarshal the file at the specified path", func() {
 			Expect(afero.WriteFile(s.fs, path, []byte(commentStr+wrongFile), os.ModePerm)).To(Succeed())
 
 			err := s.LoadFrom(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.LoadError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.LoadError{
+				Err: fmt.Errorf("unable to create config for version %q: %w", "2", config.UnsupportedVersionError{
+					Version: config.Version{
+						Number: 2,
+					},
+				}),
+			}))
 		})
 	})
 
@@ -184,7 +230,9 @@ layout: ""
 		It("should fail for an empty config", func() {
 			err := s.Save()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.SaveError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.SaveError{
+				Err: errors.New("undefined config, use one of the initializers: New, Load, LoadFrom"),
+			}))
 		})
 
 		It("should fail for a pre-existent file that must not exist", func() {
@@ -194,7 +242,9 @@ layout: ""
 
 			err := s.Save()
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.SaveError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.SaveError{
+				Err: fmt.Errorf("configuration already exists in %q", DefaultPath),
+			}))
 		})
 	})
 
@@ -221,7 +271,9 @@ layout: ""
 		It("should fail for an empty config", func() {
 			err := s.SaveTo(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.SaveError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.SaveError{
+				Err: errors.New("undefined config, use one of the initializers: New, Load, LoadFrom"),
+			}))
 		})
 
 		It("should fail for a pre-existent file that must not exist", func() {
@@ -231,7 +283,9 @@ layout: ""
 
 			err := s.SaveTo(path)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &store.SaveError{})).To(BeTrue())
+			Expect(err).To(MatchError(store.SaveError{
+				Err: fmt.Errorf("configuration already exists in %q", path),
+			}))
 		})
 	})
 })

pkg/config/v3/config_test.go

@@ -17,7 +17,6 @@ limitations under the License.
 package v3
 
 import (
-	"errors"
 	"sort"
 	"testing"
 
@@ -407,13 +406,13 @@ var _ = Describe("Cfg", func() {
 		It("DecodePluginConfig should fail for no plugin config object", func() {
 			err := c0.DecodePluginConfig(key, &pluginCfg)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &config.PluginKeyNotFoundError{})).To(BeTrue())
+			Expect(err).To(MatchError(config.PluginKeyNotFoundError{Key: key}))
 		})
 
 		It("DecodePluginConfig should fail to retrieve data from a non-existent plugin", func() {
 			err := c1.DecodePluginConfig("plugin-y", &pluginCfg)
 			Expect(err).To(HaveOccurred())
-			Expect(errors.As(err, &config.PluginKeyNotFoundError{})).To(BeTrue())
+			Expect(err).To(MatchError(config.PluginKeyNotFoundError{Key: "plugin-y"}))
 		})
 
 		DescribeTable("DecodePluginConfig should retrieve the plugin data correctly",

pkg/machinery/scaffold_test.go

@@ -21,7 +21,6 @@ import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 	"github.com/spf13/afero"
-
 	cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v4/pkg/model/resource"
 )
@@ -168,32 +167,32 @@ var _ = Describe("Scaffold", func() {
 		)
 
 		DescribeTable("file builders related errors",
-			func(setup func() (interface{}, []Builder)) {
+			func(setup func() (error, []Builder)) {
 				errType, files := setup()
 
 				err := s.Execute(files...)
 
 				Expect(err).To(HaveOccurred())
-				Expect(errors.As(err, &errType)).To(BeTrue())
+				Expect(err).To(MatchError(errType))
 			},
-			Entry("should fail if unable to validate a file builder", func() (interface{}, []Builder) {
-				return &ValidateError{}, []Builder{
+			Entry("should fail if unable to validate a file builder", func() (error, []Builder) {
+				return ValidateError{testErr}, []Builder{
 					fakeRequiresValidation{validateErr: testErr},
 				}
 			}),
-			Entry("should fail if unable to set default values for a template", func() (interface{}, []Builder) {
-				return &SetTemplateDefaultsError{}, []Builder{
+			Entry("should fail if unable to set default values for a template", func() (error, []Builder) {
+				return SetTemplateDefaultsError{testErr}, []Builder{
 					&fakeTemplate{err: testErr},
 				}
 			}),
-			Entry("should fail if an unexpected previous model is found", func() (interface{}, []Builder) {
-				return &ModelAlreadyExistsError{}, []Builder{
+			Entry("should fail if an unexpected previous model is found", func() (error, []Builder) {
+				return ModelAlreadyExistsError{path: path}, []Builder{
 					&fakeTemplate{fakeBuilder: fakeBuilder{path: path}},
 					&fakeTemplate{fakeBuilder: fakeBuilder{path: path, ifExistsAction: Error}},
 				}
 			}),
-			Entry("should fail if behavior if-exists-action is not defined", func() (interface{}, []Builder) {
-				return &UnknownIfExistsActionError{}, []Builder{
+			Entry("should fail if behavior if-exists-action is not defined", func() (error, []Builder) {
+				return UnknownIfExistsActionError{path: path, ifExistsAction: -1}, []Builder{
 					&fakeTemplate{fakeBuilder: fakeBuilder{path: path}},
 					&fakeTemplate{fakeBuilder: fakeBuilder{path: path, ifExistsAction: -1}},
 				}
@@ -415,20 +414,20 @@ func init() {
 		)
 
 		DescribeTable("insert strings related errors",
-			func(errType interface{}, files ...Builder) {
+			func(errType error, files ...Builder) {
 				Expect(afero.WriteFile(s.fs, path, []byte{}, 0o666)).To(Succeed())
 
 				err := s.Execute(files...)
 				Expect(err).To(HaveOccurred())
-				Expect(errors.As(err, &errType)).To(BeTrue())
+				Expect(err).To(MatchError(errType))
 			},
 			Entry("should fail if inserting into a model that fails when a file exists and it does exist",
-				&FileAlreadyExistsError{},
+				FileAlreadyExistsError{path: "filename"},
 				&fakeTemplate{fakeBuilder: fakeBuilder{path: "filename", ifExistsAction: Error}},
 				fakeInserter{fakeBuilder: fakeBuilder{path: "filename"}},
 			),
 			Entry("should fail if inserting into a model with unknown behavior if the file exists and it does exist",
-				&UnknownIfExistsActionError{},
+				UnknownIfExistsActionError{path: "filename", ifExistsAction: -1},
 				&fakeTemplate{fakeBuilder: fakeBuilder{path: "filename", ifExistsAction: -1}},
 				fakeInserter{fakeBuilder: fakeBuilder{path: "filename"}},
 			),
@@ -467,7 +466,7 @@ func init() {
 					body:        content,
 				})
 				Expect(err).To(HaveOccurred())
-				Expect(errors.As(err, &FileAlreadyExistsError{})).To(BeTrue())
+				Expect(err).To(MatchError(FileAlreadyExistsError{path: path}))
 			})
 		})
 	})