mask helm conflict errors

Signed-off-by: Per Goncalves da Silva <[email protected]>

Author: Per Goncalves da Silva

go.mod

@@ -14,6 +14,8 @@ require (
 	github.com/operator-framework/helm-operator-plugins v0.2.2-0.20240520180534-f463c36fedf9
 	github.com/operator-framework/operator-registry v1.44.0
 	github.com/operator-framework/rukpak v0.24.0
+	github.com/pkg/errors v0.9.1
+	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/pflag v1.0.5
 	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.27.0
@@ -190,7 +192,6 @@ require (
 	github.com/otiai10/copy v1.14.0 // indirect
 	github.com/peterbourgon/diskv v2.0.1+incompatible // indirect
 	github.com/pjbgf/sha1cd v0.3.0 // indirect
-	github.com/pkg/errors v0.9.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/prometheus/client_golang v1.19.1 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
@@ -201,7 +202,6 @@ require (
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
 	github.com/shopspring/decimal v1.3.1 // indirect
-	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/skeema/knownhosts v1.2.2 // indirect
 	github.com/spf13/cast v1.5.0 // indirect
 	github.com/spf13/cobra v1.8.1 // indirect

internal/controllers/clusterextension_controller.go

@@ -74,6 +74,7 @@ import (
 	catalogfilter "github.com/operator-framework/operator-controller/internal/catalogmetadata/filter"
 	catalogsort "github.com/operator-framework/operator-controller/internal/catalogmetadata/sort"
 	"github.com/operator-framework/operator-controller/internal/conditionsets"
+	olmv1error "github.com/operator-framework/operator-controller/internal/error"
 	"github.com/operator-framework/operator-controller/internal/httputil"
 	"github.com/operator-framework/operator-controller/internal/labels"
 )
@@ -338,7 +339,7 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 		case stateNeedsInstall:
 			err := preflight.Install(ctx, desiredRel)
 			if err != nil {
-				setInstalledStatusConditionFailed(ext, fmt.Sprintf("%s:%v", ocv1alpha1.ReasonInstallationFailed, err))
+				setInstalledStatusConditionFailed(ext, fmt.Sprintf("%s:%v", ocv1alpha1.ReasonInstallationFailed, olmv1error.AsOlmErr(err)))
 				return ctrl.Result{}, err
 			}
 		case stateNeedsUpgrade:
@@ -358,7 +359,8 @@ func (r *ClusterExtensionReconciler) reconcile(ctx context.Context, ext *ocv1alp
 			return nil
 		}, helmclient.AppendInstallPostRenderer(post))
 		if err != nil {
-			setInstalledStatusConditionFailed(ext, fmt.Sprintf("%s:%v", ocv1alpha1.ReasonInstallationFailed, err))
+			log.FromContext(ctx).Error(err, "failed to install bundle")
+			setInstalledStatusConditionFailed(ext, fmt.Sprintf("%s:%v", ocv1alpha1.ReasonInstallationFailed, olmv1error.AsOlmErr(err)))
 			return ctrl.Result{}, err
 		}
 	case stateNeedsUpgrade:

internal/error/errors.go

@@ -0,0 +1,84 @@
+package error
+
+import (
+	"fmt"
+	"regexp"
+
+	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
+)
+
+const (
+	installConflictErrorPattern        = `Unable to continue with install: (\w+) "(.*)" in namespace "(.*)" exists and cannot be imported into the current release.*`
+	installConflictErrorGeneralPattern = `Unable to continue with install: .*`
+)
+
+// InstallConflictErr indicates one or more resources already exist in the cluster
+type InstallConflictErr error
+
+// UnknownErr indicates an error that cannot be classified
+type UnknownErr error
+
+func AsOlmErr(err error) error {
+	if err == nil {
+		return nil
+	}
+	for _, rule := range rules {
+		if matches := rule.MatchError(err); len(matches) > 0 {
+			// first index is the full match
+			logrus.Debugf("found match with params %v\n", matches)
+			return rule.TranslateError(err, matches[1:]...)
+		}
+	}
+
+	// let's mark any unmatched errors as unknown
+	return UnknownErr(err)
+}
+
+// errorTranslator is a function that translates an error into a more specific error
+// typically to hide implementation details
+type errorTranslator func(error, ...string) error
+
+// errorMatcher is a function that matches an error to a specific pattern and extracts any
+// relevant information - if nil is returned, no match was found
+type errorMatcher func(error) []string
+
+// rule links a matcher to a translator
+type rule struct {
+	matchFunc  errorMatcher
+	translator errorTranslator
+}
+
+func (r rule) MatchError(err error) []string {
+	return r.matchFunc(err)
+}
+
+func (r rule) TranslateError(err error, params ...string) error {
+	return r.translator(err, params...)
+}
+
+// rules is a list of rules for error translation
+var rules = []rule{
+	{regexErrorMatcher(installConflictErrorPattern), installConflictErrorTranslator},
+	{regexErrorMatcher(installConflictErrorGeneralPattern), installConflictErrorTranslator},
+}
+
+// installConflictErrorTranslator c
+func installConflictErrorTranslator(_ error, params ...string) error {
+	msg := "A conflict prevented the installation from proceeding. Please ensure there are no conflicting resources already present in the cluster."
+	if len(params) == 3 {
+		kind := params[0]
+		name := params[1]
+		namespace := params[2]
+		msg = fmt.Sprintf("%s '%s' already exists in namespace '%s'", kind, name, namespace)
+	}
+	return InstallConflictErr(errors.New(msg))
+}
+
+// takes a valid regexp and calls FindStringSubmatch to assert match and extract parameters
+func regexErrorMatcher(regex string) errorMatcher {
+	re := regexp.MustCompile(regex)
+	return func(err error) []string {
+		return re.FindStringSubmatch(err.Error())
+	}
+}

internal/error/errors_test.go

@@ -0,0 +1,44 @@
+package error
+
+import (
+	"fmt"
+	"testing"
+)
+
+func TestAsOlmErr(t *testing.T) {
+	tests := []struct {
+		name     string
+		err      error
+		expected error
+	}{
+		{
+			name:     "Install conflict error (match)",
+			err:      fmt.Errorf("Unable to continue with install: Deployment \"my-deploy\" in namespace \"my-namespace\" exists and cannot be imported into the current release"),
+			expected: InstallConflictErr(fmt.Errorf("Deployment 'my-deploy' already exists in namespace 'my-namespace'")),
+		},
+		{
+			name:     "Install conflict error (no match)",
+			err:      fmt.Errorf("Unable to continue with install: because of something"),
+			expected: InstallConflictErr(fmt.Errorf("A conflict prevented the installation from proceeding. Please ensure there are no conflicting resources already present in the cluster.")),
+		},
+		{
+			name:     "Unknown error",
+			err:      fmt.Errorf("some unknown error"),
+			expected: UnknownErr(fmt.Errorf("some unknown error")),
+		},
+		{
+			name:     "Nil error",
+			err:      nil,
+			expected: nil,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			result := AsOlmErr(tt.err)
+			if result != nil && result.Error() != tt.expected.Error() {
+				t.Errorf("Expected: %v, got: %v", tt.expected, result)
+			}
+		})
+	}
+}