feat: introduce logging and errors packages

errors/errors.go

@@ -0,0 +1,163 @@
+/*
+Copyright 2023 The Crossplane 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.
+*/
+
+// Package errors is a github.com/pkg/errors compatible API for native errors.
+//
+// Copied over from github.com/crossplane/crossplane-runtime/pkg/errors for
+// better discoverability and possibly diverge in the future.
+package errors
+
+import (
+ "errors"
+ "fmt"
+
+ kerrors "k8s.io/apimachinery/pkg/util/errors"
+)
+
+// New returns an error that formats as the given text. Each call to New returns
+// a distinct error value even if the text is identical.
+func New(text string) error { return errors.New(text) }
+
+// Is reports whether any error in err's chain matches target.
+//
+// The chain consists of err itself followed by the sequence of errors obtained
+// by repeatedly calling Unwrap.
+//
+// An error is considered to match a target if it is equal to that target or if
+// it implements a method Is(error) bool such that Is(target) returns true.
+//
+// An error type might provide an Is method so it can be treated as equivalent
+// to an existing error. For example, if MyError defines
+//
+// func (m MyError) Is(target error) bool { return target == fs.ErrExist }
+//
+// then Is(MyError{}, fs.ErrExist) returns true. See syscall.Errno.Is for
+// an example in the standard library.
+func Is(err, target error) bool { return errors.Is(err, target) }
+
+// As finds the first error in err's chain that matches target, and if so, sets
+// target to that error value and returns true. Otherwise, it returns false.
+//
+// The chain consists of err itself followed by the sequence of errors obtained
+// by repeatedly calling Unwrap.
+//
+// An error matches target if the error's concrete value is assignable to the
+// value pointed to by target, or if the error has a method As(any) bool
+// such that As(target) returns true. In the latter case, the As method is
+// responsible for setting target.
+//
+// An error type might provide an As method so it can be treated as if it were a
+// different error type.
+//
+// As panics if target is not a non-nil pointer to either a type that implements
+// error, or to any interface type.
+func As(err error, target any) bool { return errors.As(err, target) }
+
+// Unwrap returns the result of calling the Unwrap method on err, if err's type
+// contains an Unwrap method returning error. Otherwise, Unwrap returns nil.
+func Unwrap(err error) error { return errors.Unwrap(err) }
+
+// Errorf formats according to a format specifier and returns the string as a
+// value that satisfies error.
+//
+// If the format specifier includes a %w verb with an error operand, the
+// returned error will implement an Unwrap method returning the operand. It is
+// invalid to include more than one %w verb or to supply it with an operand that
+// does not implement the error interface. The %w verb is otherwise a synonym
+// for %v.
+func Errorf(format string, a ...any) error { return fmt.Errorf(format, a...) }
+
+// WithMessage annotates err with a new message. If err is nil, WithMessage
+// returns nil.
+func WithMessage(err error, message string) error {
+ if err == nil {
+ return nil
+ }
+ return fmt.Errorf("%s: %w", message, err)
+}
+
+// WithMessagef annotates err with the format specifier. If err is nil,
+// WithMessagef returns nil.
+func WithMessagef(err error, format string, args ...any) error {
+ if err == nil {
+ return nil
+ }
+ return fmt.Errorf("%s: %w", fmt.Sprintf(format, args...), err)
+}
+
+// Wrap is an alias for WithMessage.
+func Wrap(err error, message string) error {
+ return WithMessage(err, message)
+}
+
+// Wrapf is an alias for WithMessagef
+func Wrapf(err error, format string, args ...any) error {
+ return WithMessagef(err, format, args...)
+}
+
+// Cause calls Unwrap on each error it finds. It returns the first error it
+// finds that does not have an Unwrap method - i.e. the first error that was not
+// the result of a Wrap call, a Wrapf call, or an Errorf call with %w wrapping.
+func Cause(err error) error {
+ type wrapped interface {
+ Unwrap() error
+ }
+
+ for err != nil {
+ //nolint:errorlint // We actually do want to check the outermost error.
+ w, ok := err.(wrapped)
+ if !ok {
+ return err
+ }
+ err = w.Unwrap()
+ }
+
+ return err
+}
+
+// MultiError is an error that wraps multiple errors.
+type MultiError interface {
+ error
+ Unwrap() []error
+}
+
+// Join returns an error that wraps the given errors. Any nil error values are
+// discarded. Join returns nil if errs contains no non-nil values. The error
+// formats as the concatenation of the strings obtained by calling the Error
+// method of each element of errs and formatting like:
+//
+// [first error, second error, third error]
+//
+// Note: aggregating errors should not be the default. Usually, return only the
+// first error, and only aggregate if there is clear value to the user.
+func Join(errs ...error) MultiError {
+ err := kerrors.NewAggregate(errs)
+ if err == nil {
+ return nil
+ }
+ return multiError{aggregate: err}
+}
+
+type multiError struct {
+ aggregate kerrors.Aggregate
+}
+
+func (m multiError) Error() string {
+ return m.aggregate.Error()
+}
+func (m multiError) Unwrap() []error {
+ return m.aggregate.Errors()
+}

errors/errors_test.go

@@ -0,0 +1,126 @@
+/*
+Copyright 2023 The Crossplane 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.
+*/
+
+package errors
+
+import (
+ "testing"
+
+ "github.com/google/go-cmp/cmp"
+
+ "github.com/crossplane/crossplane-runtime/pkg/test"
+)
+
+func TestWrap(t *testing.T) {
+ type args struct {
+ err error
+ message string
+ }
+ cases := map[string]struct {
+ args args
+ want error
+ }{
+ "NilError": {
+ args: args{
+ err: nil,
+ message: "very useful context",
+ },
+ want: nil,
+ },
+ "NonNilError": {
+ args: args{
+ err: New("boom"),
+ message: "very useful context",
+ },
+ want: Errorf("very useful context: %w", New("boom")),
+ },
+ }
+
+ for name, tc := range cases {
+ t.Run(name, func(t *testing.T) {
+ got := Wrap(tc.args.err, tc.args.message)
+ if diff := cmp.Diff(tc.want, got, test.EquateErrors()); diff != "" {
+ t.Errorf("Wrap(...): -want, +got:\n%s", diff)
+ }
+ })
+ }
+}
+
+func TestWrapf(t *testing.T) {
+ type args struct {
+ err error
+ message string
+ args []any
+ }
+ cases := map[string]struct {
+ args args
+ want error
+ }{
+ "NilError": {
+ args: args{
+ err: nil,
+ message: "very useful context",
+ },
+ want: nil,
+ },
+ "NonNilError": {
+ args: args{
+ err: New("boom"),
+ message: "very useful context about %s",
+ args: []any{"ducks"},
+ },
+ want: Errorf("very useful context about %s: %w", "ducks", New("boom")),
+ },
+ }
+
+ for name, tc := range cases {
+ t.Run(name, func(t *testing.T) {
+ got := Wrapf(tc.args.err, tc.args.message, tc.args.args...)
+ if diff := cmp.Diff(tc.want, got, test.EquateErrors()); diff != "" {
+ t.Errorf("Wrapf(...): -want, +got:\n%s", diff)
+ }
+ })
+ }
+}
+
+func TestCause(t *testing.T) {
+ cases := map[string]struct {
+ err error
+ want error
+ }{
+ "NilError": {
+ err: nil,
+ want: nil,
+ },
+ "BareError": {
+ err: New("boom"),
+ want: New("boom"),
+ },
+ "WrappedError": {
+ err: Wrap(Wrap(New("boom"), "interstitial context"), "very important context"),
+ want: New("boom"),
+ },
+ }
+
+ for name, tc := range cases {
+ t.Run(name, func(t *testing.T) {
+ got := Cause(tc.err)
+ if diff := cmp.Diff(tc.want, got, test.EquateErrors()); diff != "" {
+ t.Errorf("Cause(...): -want, +got:\n%s", diff)
+ }
+ })
+ }
+}

go.mod

@@ -5,7 +5,9 @@ go 1.20
 require (
  github.com/bufbuild/buf v1.26.1
  github.com/crossplane/crossplane-runtime v1.13.0
+ github.com/go-logr/logr v1.2.4
  github.com/go-logr/zapr v1.2.4
+ github.com/google/go-cmp v0.5.9
  github.com/pkg/errors v0.9.1
  go.uber.org/zap v1.26.0
  google.golang.org/grpc v1.58.2
@@ -23,32 +25,43 @@ require (
  github.com/bufbuild/protocompile v0.6.0 // indirect
  github.com/containerd/stargz-snapshotter/estargz v0.14.3 // indirect
  github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+ github.com/davecgh/go-spew v1.1.1 // indirect
  github.com/docker/cli v24.0.4+incompatible // indirect
  github.com/docker/distribution v2.8.2+incompatible // indirect
  github.com/docker/docker v24.0.4+incompatible // indirect
  github.com/docker/docker-credential-helpers v0.8.0 // indirect
  github.com/docker/go-connections v0.4.0 // indirect
  github.com/docker/go-units v0.5.0 // indirect
+ github.com/emicklei/go-restful/v3 v3.10.2 // indirect
+ github.com/evanphx/json-patch/v5 v5.6.0 // indirect
  github.com/felixge/fgprof v0.9.3 // indirect
  github.com/go-chi/chi/v5 v5.0.10 // indirect
- github.com/go-logr/logr v1.2.4 // indirect
  github.com/go-logr/stdr v1.2.2 // indirect
+ github.com/go-openapi/jsonpointer v0.19.6 // indirect
+ github.com/go-openapi/jsonreference v0.20.2 // indirect
+ github.com/go-openapi/swag v0.22.3 // indirect
  github.com/gofrs/uuid/v5 v5.0.0 // indirect
  github.com/gogo/protobuf v1.3.2 // indirect
  github.com/golang/protobuf v1.5.3 // indirect
+ github.com/google/gnostic v0.6.9 // indirect
+ github.com/google/gnostic-models v0.6.8 // indirect
  github.com/google/go-containerregistry v0.15.2 // indirect
  github.com/google/gofuzz v1.2.0 // indirect
  github.com/google/pprof v0.0.0-20230705174524-200ffdc848b8 // indirect
+ github.com/google/uuid v1.3.0 // indirect
  github.com/inconshreveable/mousetrap v1.1.0 // indirect
  github.com/jdxcode/netrc v0.0.0-20221124155335-4616370d1a84 // indirect
+ github.com/josharian/intern v1.0.0 // indirect
  github.com/json-iterator/go v1.1.12 // indirect
  github.com/klauspost/compress v1.16.7 // indirect
  github.com/klauspost/pgzip v1.2.6 // indirect
+ github.com/mailru/easyjson v0.7.7 // indirect
  github.com/mitchellh/go-homedir v1.1.0 // indirect
  github.com/moby/term v0.5.0 // indirect
  github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
  github.com/modern-go/reflect2 v1.0.2 // indirect
  github.com/morikuni/aec v1.0.0 // indirect
+ github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
  github.com/opencontainers/go-digest v1.0.0 // indirect
  github.com/opencontainers/image-spec v1.1.0-rc4 // indirect
  github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 // indirect
@@ -66,23 +79,29 @@ require (
  go.opentelemetry.io/otel/sdk v1.16.0 // indirect
  go.opentelemetry.io/otel/trace v1.16.0 // indirect
  go.uber.org/atomic v1.11.0 // indirect
- go.uber.org/goleak v1.2.1 // indirect
  go.uber.org/multierr v1.11.0 // indirect
  golang.org/x/crypto v0.11.0 // indirect
  golang.org/x/mod v0.12.0 // indirect
  golang.org/x/net v0.13.0 // indirect
+ golang.org/x/oauth2 v0.10.0 // indirect
  golang.org/x/sync v0.3.0 // indirect
  golang.org/x/sys v0.10.0 // indirect
  golang.org/x/term v0.10.0 // indirect
  golang.org/x/text v0.11.0 // indirect
+ golang.org/x/time v0.3.0 // indirect
  golang.org/x/tools v0.11.0 // indirect
+ google.golang.org/appengine v1.6.7 // indirect
  google.golang.org/genproto/googleapis/rpc v0.0.0-20230711160842-782d3b101e98 // indirect
  gopkg.in/inf.v0 v0.9.1 // indirect
  gopkg.in/yaml.v2 v2.4.0 // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect
  k8s.io/api v0.27.3 // indirect
+ k8s.io/client-go v0.27.3 // indirect
  k8s.io/klog/v2 v2.100.1 // indirect
+ k8s.io/kube-openapi v0.0.0-20230717233707-2695361300d9 // indirect
  k8s.io/utils v0.0.0-20230505201702-9f6742963106 // indirect
+ sigs.k8s.io/controller-runtime v0.15.0 // indirect
  sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
  sigs.k8s.io/structured-merge-diff/v4 v4.2.3 // indirect
+ sigs.k8s.io/yaml v1.3.0 // indirect
 )