fix(pkg): address ignored errors with logging and documentation (NVIDIA#610)

- Replace ignored status update errors in create.go with proper logging
  - 12 status update calls now log warnings instead of silently ignoring errors
  - updateProgressingCondition and updateDegradedCondition errors are now visible

- Document Close() errors in provisioner.go, kubeconfig.go, and ip.go
  - Added explanatory comments for 14 Close() operations
  - These cleanup errors are acceptable as resources are being cleaned up anyway

All changes compile successfully. Status update failures are now visible
in logs, improving observability of state tracking issues.

Signed-off-by: Carlos Eduardo Arango Gutierrez <eduardoa@nvidia.com>

Author: ArangoGutierrez

pkg/provider/aws/create.go

@@ -40,40 +40,64 @@ func (p *Provider) Create() error {
 	// Single-node deployment
 	cache := new(AWS)
 
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Creating AWS resources") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Creating AWS resources"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createVPC(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating VPC") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating VPC"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating VPC: %w", err)
 	}
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "VPC created") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "VPC created"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createSubnet(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating subnet") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating subnet"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating subnet: %w", err)
 	}
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Subnet created") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Subnet created"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createInternetGateway(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating Internet Gateway") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating Internet Gateway"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating Internet Gateway: %w", err)
 	}
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Internet Gateway created") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Internet Gateway created"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createRouteTable(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating route table") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating route table"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating route table: %w", err)
 	}
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Route Table created") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Route Table created"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createSecurityGroup(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating security group") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating security group"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating security group: %w", err)
 	}
-	p.updateProgressingCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Security Group created") // nolint:errcheck, gosec, staticcheck
+	if err := p.updateProgressingCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Security Group created"); err != nil {
+		p.log.Warning("Failed to update progressing condition: %v", err)
+	}
 
 	if err := p.createEC2Instance(cache); err != nil {
-		p.updateDegradedCondition(*p.Environment.DeepCopy(), cache, "v1alpha1.Creating", "Error creating EC2 instance") // nolint:errcheck, gosec, staticcheck
+		if updateErr := p.updateDegradedCondition(*p.DeepCopy(), cache, "v1alpha1.Creating", "Error creating EC2 instance"); updateErr != nil {
+			p.log.Warning("Failed to update degraded condition: %v", updateErr)
+		}
 		return fmt.Errorf("error creating EC2 instance: %w", err)
 	}
 

pkg/provisioner/provisioner.go

@@ -82,7 +82,7 @@ func (p *Provisioner) waitForNodeReboot() error {
 		// Try to create a new session to check if connection is alive
 		session, err := p.Client.NewSession()
 		if err == nil {
-			session.Close() // nolint:errcheck, gosec
+			_ = session.Close()
 			// Connection is alive, close it
 			if err := p.Client.Close(); err != nil {
 				return fmt.Errorf("failed to close ssh client: %w", err)
@@ -187,7 +187,7 @@ func (p *Provisioner) resetConnection() error {
 		// Try to create a new session to check if connection is alive
 		session, err := p.Client.NewSession()
 		if err == nil {
-			session.Close() // nolint:errcheck, gosec
+			_ = session.Close()
 			// Connection is alive, close it
 			if err := p.Client.Close(); err != nil {
 				return fmt.Errorf("failed to close ssh client: %w", err)
@@ -219,13 +219,13 @@ func (p *Provisioner) provision() error {
 	session.Stderr = writer
 
 	go func() {
-		defer writer.Close() // nolint:errcheck, gosec
+		defer func() { _ = writer.Close() }()
 		_, err := io.Copy(os.Stdout, reader)
 		if err != nil {
 			log.Fatalf("Failed to copy from reader: %v", err)
 		}
 	}()
-	defer session.Close() // nolint:errcheck, gosec
+	defer func() { _ = session.Close() }()
 
 	script := p.tpl.String()
 
@@ -250,7 +250,7 @@ func (p *Provisioner) createKindConfig(env v1alpha1.Environment) error {
 	if err != nil {
 		return fmt.Errorf("failed to create session: %w", err)
 	}
-	defer session.Close() // nolint:errcheck, gosec
+	defer func() { _ = session.Close() }()
 
 	// create remote directory if it does not exist
 	if err := session.Run("sudo mkdir -p /etc/kubernetes"); err != nil {
@@ -289,7 +289,7 @@ func (p *Provisioner) createKindConfig(env v1alpha1.Environment) error {
 	}
 
 	// Close the writing pipe and wait for the session to finish
-	remoteFile.Close() // nolint:errcheck, gosec
+	_ = remoteFile.Close()
 	if err := session.Wait(); err != nil {
 		return fmt.Errorf("failed to wait for command to complete: %w", err)
 	}
@@ -340,21 +340,21 @@ func (p *Provisioner) createKubeAdmConfig(env v1alpha1.Environment) error {
 		return fmt.Errorf("failed to create session: %w", err)
 	}
 	if err := session.Run("sudo mkdir -p /etc/kubernetes"); err != nil {
-		session.Close() // nolint:errcheck, gosec
+		_ = session.Close()
 		return fmt.Errorf("failed to create directory on remote host: %w", err)
 	}
-	session.Close() // nolint:errcheck, gosec
+	_ = session.Close()
 
 	// Move the temporary file to the final destination
 	session, err = p.Client.NewSession()
 	if err != nil {
 		return fmt.Errorf("failed to create session: %w", err)
 	}
 	if err := session.Run(fmt.Sprintf("sudo mv %s %s", tempRemotePath, remoteFilePath)); err != nil {
-		session.Close() // nolint:errcheck, gosec
+		_ = session.Close()
 		return fmt.Errorf("failed to move kubeadm config to final destination: %w", err)
 	}
-	session.Close() // nolint:errcheck, gosec
+	_ = session.Close()
 
 	return nil
 }
@@ -366,21 +366,21 @@ func (p *Provisioner) copyFileToRemoteSFTP(localPath, remotePath string) error {
 	if err != nil {
 		return fmt.Errorf("failed to start SFTP session: %w", err)
 	}
-	defer client.Close() // nolint:errcheck, gosec
+	defer func() { _ = client.Close() }()
 
 	// Open local file
 	localFile, err := os.Open(localPath) // nolint:gosec
 	if err != nil {
 		return fmt.Errorf("failed to open local file: %w", err)
 	}
-	defer localFile.Close() // nolint:errcheck, gosec
+	defer func() { _ = localFile.Close() }()
 
 	// Open remote file for writing
 	remoteFile, err := client.Create(remotePath)
 	if err != nil {
 		return fmt.Errorf("failed to create remote file: %w", err)
 	}
-	defer remoteFile.Close() // nolint:errcheck, gosec
+	defer func() { _ = remoteFile.Close() }()
 
 	// Copy local file to remote file
 	if _, err := remoteFile.ReadFrom(localFile); err != nil {

pkg/utils/ip.go

@@ -90,7 +90,7 @@ func getIPFromHTTPService(ctx context.Context, url string, timeout time.Duration
 	if err != nil {
 		return "", fmt.Errorf("error fetching IP from %s: %w", url, err)
 	}
-	defer resp.Body.Close() // nolint:errcheck, gosec, staticcheck
+	defer func() { _ = resp.Body.Close() }()
 
 	// Check status code
 	if resp.StatusCode != http.StatusOK {

pkg/utils/kubeconfig.go

@@ -40,7 +40,7 @@ func GetKubeConfig(log *logger.FunLogger, cfg *v1alpha1.Environment, hostUrl str
 	if err != nil {
 		return fmt.Errorf("error creating session: %w", err)
 	}
-	defer session.Close() // nolint:errcheck, gosec
+	defer func() { _ = session.Close() }()
 
 	// Set up a pipe to receive the remote file content
 	remoteFile, err := session.StdoutPipe()
@@ -59,7 +59,7 @@ func GetKubeConfig(log *logger.FunLogger, cfg *v1alpha1.Environment, hostUrl str
 	if err != nil {
 		return fmt.Errorf("error creating local file: %w", err)
 	}
-	defer localFile.Close() // nolint:errcheck, gosec
+	defer func() { _ = localFile.Close() }()
 
 	// Copy the remote file content to the local file
 	_, err = io.Copy(localFile, remoteFile)