Make ErrBadName checkable via errors.Is() (#1462)

cjellick · imjasonh · web-flow · commit a0f66878d012 · 2022-10-14T11:44:06.000-04:00
* Make ErrBadName checkable via errors.Is()

The function IsErrBadName says it is deprecated and directs the user to
use errors.Is(), but that will never return true because this error is
custom based on the tag value.

This fixes that problem by implementing an Is() function on ErrBadName
so that errors.Is() can properly identify the error as an ErrBadName.
Usage can now be: errors.Is(err, &amp;ErrBadName{})

Signed-off-by: Craig Jellick &lt;craig@acorn.io&gt;

* Update pkg/name/errors_test.go

Co-authored-by: Jason Hall &lt;jason@chainguard.dev&gt;

Signed-off-by: Craig Jellick &lt;craig@acorn.io&gt;
Co-authored-by: Jason Hall &lt;jason@chainguard.dev&gt;
diff --git a/pkg/name/errors.go b/pkg/name/errors.go
@@ -28,6 +28,12 @@ func (e *ErrBadName) Error() string {
 	return e.info
 }
 
+// Is reports whether target is an error of type ErrBadName
+func (e *ErrBadName) Is(target error) bool {
+	var berr *ErrBadName
+	return errors.As(target, &berr)
+}
+
 // newErrBadName returns a ErrBadName which returns the given formatted string from Error().
 func newErrBadName(fmtStr string, args ...interface{}) *ErrBadName {
 	return &ErrBadName{fmt.Sprintf(fmtStr, args...)}
diff --git a/pkg/name/errors_test.go b/pkg/name/errors_test.go
@@ -31,4 +31,7 @@ func TestBadName(t *testing.T) {
 	if err.Error() != "could not parse reference: @@" {
 		t.Errorf("Unexpected string: %v", err)
 	}
+	if !errors.Is(err, &ErrBadName{}) {
+		t.Errorf("Not an ErrBadName using errors.Is: %v", err)
+	}
 }

Original file line number	Diff line number	Diff line change
`@@ -31,4 +31,7 @@ func TestBadName(t *testing.T) {`
`31`	`31`	`if err.Error() != "could not parse reference: @@" {`
`32`	`32`	`t.Errorf("Unexpected string: %v", err)`
`33`	`33`	`}`
	`34`	`+ if !errors.Is(err, &ErrBadName{}) {`
	`35`	`+ t.Errorf("Not an ErrBadName using errors.Is: %v", err)`
	`36`	`+ }`
`34`	`37`	`}`