refactor: improve error formatting

Author: thde

api/config/extension.go

@@ -9,6 +9,7 @@ import (
 
 	infrastructure "github.com/ninech/apis/infrastructure/v1alpha1"
 	"github.com/ninech/nctl/internal/cli"
+	"github.com/ninech/nctl/internal/format"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/client-go/tools/clientcmd"
@@ -21,10 +22,8 @@ const (
 	NctlExtensionContext = "nctl"
 )
 
-var (
-	// ErrExtensionNotFound describes a missing extension in the kubeconfig
-	ErrExtensionNotFound extensionError = "nctl config not found"
-)
+// ErrExtensionNotFound describes a missing extension in the kubeconfig
+var ErrExtensionNotFound extensionError = "nctl config not found"
 
 type extensionError string
 
@@ -208,10 +207,7 @@ func contextNotFoundError[T any](contextName string, contexts map[string]T) erro
 	return cli.ErrorWithContext(fmt.Errorf("could not find context %q in kubeconfig", contextName)).
 		WithExitCode(cli.ExitUsageError).
 		WithAvailable(available...).
-		WithSuggestions(
-			"List available contexts: kubectl config get-contexts",
-			"Login to the API: nctl auth login",
-		)
+		WithSuggestions("Login to the API: " + format.Command().Login())
 }
 
 // clusterNotFoundError returns an error with available clusters listed.

api/util/bucket_test.go

@@ -1,6 +1,7 @@
 package util
 
 import (
+	"strings"
 	"testing"
 
 	storage "github.com/ninech/apis/storage/v1alpha1"
@@ -298,7 +299,7 @@ func TestParseCORSLooseWithMask(t *testing.T) {
 
 			if tt.wantErr != "" {
 				assert.Error(t, err)
-				assert.Contains(t, err.Error(), tt.wantErr)
+				assert.Contains(t, strings.ToLower(err.Error()), strings.ToLower(tt.wantErr))
 				return
 			}
 			assert.NoError(t, err)

auth/set_project.go

@@ -42,7 +42,7 @@ func (s *SetProjectCmd) Run(ctx context.Context, client *api.Client) error {
 			org,
 		)
 		if err := trySwitchOrg(ctx, client, s.Name); err != nil {
-			return fmt.Errorf("failed to switch organization: %w", err)
+			return err
 		}
 
 		org, err = client.Organization()

auth/set_project_test.go

@@ -3,6 +3,7 @@ package auth
 import (
 	"context"
 	"errors"
+	"strings"
 	"testing"
 
 	management "github.com/ninech/apis/management/v1alpha1"
@@ -116,7 +117,7 @@ func TestOrgFromProjectAPIErrors(t *testing.T) {
 			is.NoError(err)
 
 			_, err = orgFromProject(t.Context(), apiClient, "test-prod")
-			is.ErrorContains(err, tc.wantErrContain)
+			is.Contains(strings.ToLower(err.Error()), strings.ToLower(tc.wantErrContain))
 		})
 	}
 }

create/serviceconnection.go

@@ -12,12 +12,23 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
 	"github.com/alecthomas/kong"
+	apps "github.com/ninech/apis/apps/v1alpha1"
+	infrastructure "github.com/ninech/apis/infrastructure/v1alpha1"
 	meta "github.com/ninech/apis/meta/v1alpha1"
 	networking "github.com/ninech/apis/networking/v1alpha1"
+	storage "github.com/ninech/apis/storage/v1alpha1"
 	"github.com/ninech/nctl/api"
 	"github.com/ninech/nctl/internal/cli"
 )
 
+// These might be replaced to fetch compatible resources from the schema.
+var (
+	// allowedSources are the allowed source kinds for a service connection.
+	allowedSources = []string{infrastructure.KubernetesClusterKind, apps.ApplicationKind}
+	// allowedDestinations are the allowed destination kinds for a service connection.
+	allowedDestinations = []string{storage.KeyValueStoreKind, storage.MySQLKind, storage.PostgresKind, storage.MySQLDatabaseKind}
+)
+
 type serviceConnectionCmd struct {
 	resourceCmd
 	Source                   TypedReference           `placeholder:"kind/name" help:"Source of the connection in the form kind/name. Allowed source kinds are: ${allowed_sources}." required:""`
@@ -200,32 +211,26 @@ func groupVersionKindFromKind(kind string) (schema.GroupVersionKind, error) {
 		return schema.GroupVersionKind{}, fmt.Errorf("error creating scheme: %w", err)
 	}
 
-	var availableKinds []string
 	for gvk := range scheme.AllKnownTypes() {
 		if strings.EqualFold(kind, gvk.Kind) {
 			return gvk, nil
 		}
-		// Collect non-list kinds for error message
-		if !strings.HasSuffix(gvk.Kind, "List") && gvk.Kind != "" {
-			availableKinds = append(availableKinds, strings.ToLower(gvk.Kind))
-		}
 	}
 
 	return schema.GroupVersionKind{}, cli.ErrorWithContext(fmt.Errorf("kind %q is invalid", kind)).
 		WithExitCode(cli.ExitUsageError).
-		WithAvailable(availableKinds...).
 		WithSuggestions(
-			"Valid source kinds: kubernetescluster, application",
-			"Valid destination kinds: keyvaluestore, mysql, postgres, mysqldatabase, postgresdatabase",
+			"Valid source kinds: "+strings.Join(allowedSources, ", "),
+			"Valid destination kinds: "+strings.Join(allowedDestinations, ", "),
 		)
 }
 
 // ServiceConnectionKongVars returns all variables which are used in the ServiceConnection
 // create command
 func ServiceConnectionKongVars() kong.Vars {
 	result := make(kong.Vars)
-	result["allowed_sources"] = "kubernetescluster, application"
-	result["allowed_destinations"] = "keyvaluestore, mysql, postgres, mysqldatabase, postgresdatabase"
+	result["allowed_sources"] = strings.Join(allowedSources, ", ")
+	result["allowed_destinations"] = strings.Join(allowedDestinations, ", ")
 	result["label_selector_placeholder"] = "'key1=value1,key2=value2,key3 in (value3)'"
 	result["label_selector_usage"] = "Selector (label query) to filter on, supports '=', '==', '!=', 'in', 'notin'. Matching objects must satisfy all of the specified label constraints."
 	result["label_selector_requirements"] = "Can only be set when the source is a KubernetesCluster."

get/all_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"context"
 	"os"
+	"strings"
 	"testing"
 
 	apps "github.com/ninech/apis/apps/v1alpha1"
@@ -322,7 +323,7 @@ dev      pear    Release      apps.nine.ch
 			if testCase.errorExpected {
 				require.Error(t, err)
 				for _, s := range testCase.errorContains {
-					assert.Contains(t, err.Error(), s)
+					assert.Contains(t, strings.ToLower(err.Error()), strings.ToLower(s))
 				}
 				return
 			}

get/bucket_test.go

@@ -3,6 +3,7 @@ package get
 import (
 	"bytes"
 	"context"
+	"strings"
 	"testing"
 	"time"
 
@@ -258,7 +259,7 @@ func TestBucketGet(t *testing.T) {
 			if tt.wantErr {
 				require.Error(t, err)
 				for _, s := range tt.wantContain {
-					assert.Contains(t, err.Error(), s, "missing expected substring %q in error:\n%s", s, err)
+					assert.Contains(t, strings.ToLower(err.Error()), strings.ToLower(s), "missing expected substring %q in error:\n%s", s, err)
 				}
 				return
 			}

get/bucketuser_test.go

@@ -136,7 +136,7 @@ func TestBucketUser(t *testing.T) {
 			}
 			if tt.wantErr {
 				for _, substr := range tt.wantContain {
-					if !strings.Contains(err.Error(), substr) {
+					if !strings.Contains(strings.ToLower(err.Error()), strings.ToLower(substr)) {
 						t.Errorf("bucketUserCmd.Run() error did not contain %q, err = %v", substr, err)
 					}
 				}

get/cloudvm_test.go

@@ -135,7 +135,7 @@ func TestCloudVM(t *testing.T) {
 			}
 			if tt.wantErr {
 				for _, substr := range tt.wantContain {
-					if !strings.Contains(err.Error(), substr) {
+					if !strings.Contains(strings.ToLower(err.Error()), strings.ToLower(substr)) {
 						t.Errorf("cloudVMCmd.Run() error did not contain %q, err = %v", substr, err)
 					}
 				}

get/database_test.go

@@ -170,7 +170,7 @@ func TestDatabase(t *testing.T) {
 			}
 			if tt.wantErr {
 				for _, substr := range tt.wantContain {
-					if !strings.Contains(err.Error(), substr) {
+					if !strings.Contains(strings.ToLower(err.Error()), strings.ToLower(substr)) {
 						t.Errorf("postgresDatabaseCmd.Run() error did not contain %q, err = %v", substr, err)
 					}
 				}