fix: lint error

flanksource · Apr 1, 2024 · 747c52c · 747c52c
1 parent 9e4b75f
commit 747c52c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/checks/kubernetes_resource.go b/checks/kubernetes_resource.go
@@ -43,35 +43,36 @@ func (c *KubernetesResourceChecker) Run(ctx *context.Context) pkg.Results {
 	return results
 }
 
-func (c *KubernetesResourceChecker) applyKubeconfig(ctx *context.Context, kubeConfig types.EnvVar) error {
+func (c *KubernetesResourceChecker) applyKubeconfig(ctx *context.Context, kubeConfig types.EnvVar) (*context.Context, error) {
 	val, err := ctx.GetEnvValueFromCache(kubeConfig)
 	if err != nil {
-		return fmt.Errorf("failed to get kubeconfig from env: %w", err)
+		return nil, fmt.Errorf("failed to get kubeconfig from env: %w", err)
 	}
 
 	if strings.HasPrefix(val, "/") {
 		kClient, kube, err := pkg.NewKommonsClientWithConfigPath(val)
 		if err != nil {
-			return fmt.Errorf("failed to initialize kubernetes client from the provided kubeconfig: %w", err)
+			return nil, fmt.Errorf("failed to initialize kubernetes client from the provided kubeconfig: %w", err)
 		}
 
 		ctx = ctx.WithDutyContext(ctx.WithKommons(kClient))
 		ctx = ctx.WithDutyContext(ctx.WithKubernetes(kube))
 	} else {
 		kClient, kube, err := pkg.NewKommonsClientWithConfig(val)
 		if err != nil {
-			return fmt.Errorf("failed to initialize kubernetes client from the provided kubeconfig: %w", err)
+			return nil, fmt.Errorf("failed to initialize kubernetes client from the provided kubeconfig: %w", err)
 		}
 
 		ctx = ctx.WithDutyContext(ctx.WithKommons(kClient))
 		ctx = ctx.WithDutyContext(ctx.WithKubernetes(kube))
 	}
 
-	return nil
+	return ctx, nil
 }
 
 func (c *KubernetesResourceChecker) Check(ctx *context.Context, check v1.KubernetesResourceCheck) pkg.Results {
 	result := pkg.Success(check, ctx.Canary)
+	var err error
 	var results pkg.Results
 	results = append(results, result)
 
@@ -92,7 +93,8 @@ func (c *KubernetesResourceChecker) Check(ctx *context.Context, check v1.Kuberne
 	}
 
 	if check.Kubeconfig != nil {
-		if err := c.applyKubeconfig(ctx, *check.Kubeconfig); err != nil {
+		ctx, err = c.applyKubeconfig(ctx, *check.Kubeconfig)
+		if err != nil {
 			return results.Failf("failed to apply kube config: %v", err)
 		}
 	}

diff --git a/config/deploy/crd.yaml b/config/deploy/crd.yaml
@@ -4986,6 +4986,11 @@ spec:
                       checks:
                         description: Checks to run against the kubernetes resources.
                         items:
+                          description: |-
+                            KubernetesResourceChecks is the canary spec.
+                            NOTE: It's only created to make crd generation possible.
+                            embedding CanarySpec into KubernetesResourceCheck.checks
+                            directly generates an invalid crd.
                           type: object
                         type: array
                         x-kubernetes-preserve-unknown-fields: true

diff --git a/config/deploy/manifests.yaml b/config/deploy/manifests.yaml
@@ -4985,6 +4985,11 @@ spec:
                       checks:
                         description: Checks to run against the kubernetes resources.
                         items:
+                          description: |-
+                            KubernetesResourceChecks is the canary spec.
+                            NOTE: It's only created to make crd generation possible.
+                            embedding CanarySpec into KubernetesResourceCheck.checks
+                            directly generates an invalid crd.
                           type: object
                         type: array
                         x-kubernetes-preserve-unknown-fields: true