cleanup: address golangci 'errcheck' issues

Many reports are about closing or removing files. In some cases it is
possible to report an error in the logs, in other cases the error can be
ignored without potential issues.

Test cases have been modified to not remove the temporary files. The
temporary directory that is provided by the testing package, is removed
once the tests are done.

Signed-off-by: Niels de Vos <ndevos@ibm.com>

internal/util/conn_pool_test.go

@@ -79,14 +79,13 @@ func TestConnPool(t *testing.T) {
 	defer cp.Destroy()
 
 	// create a keyfile with some contents
-	keyfile := "/tmp/conn_utils.keyfile"
+	keyfile := t.TempDir() + "/conn_utils.keyfile"
 	err := os.WriteFile(keyfile, []byte("the-key"), 0o600)
 	if err != nil {
 		t.Errorf("failed to create keyfile: %v", err)
 
 		return
 	}
-	defer os.Remove(keyfile)
 
 	var conn *rados.Conn
 	var unique string

internal/util/credentials.go

@@ -81,8 +81,7 @@ func NewUserCredentialsWithMigration(secrets map[string]string) (*Credentials, e
 
 // DeleteCredentials removes the KeyFile.
 func (cr *Credentials) DeleteCredentials() {
-	// don't complain about unhandled error
-	_ = os.Remove(cr.KeyFile)
+	os.Remove(cr.KeyFile) //nolint:errcheck,gosec // no way to return/report the issue here
 }
 
 func storeKey(key string) (string, error) {
@@ -92,8 +91,7 @@ func storeKey(key string) (string, error) {
 	}
 	defer func() {
 		if err != nil {
-			// don't complain about unhandled error
-			_ = os.Remove(tmpfile.Name())
+			os.Remove(tmpfile.Name()) //nolint:errcheck,gosec // no way to return/report the issue here
 		}
 	}()
 

internal/util/cryptsetup/cryptsetup.go

@@ -116,13 +116,13 @@ func (l *luksWrapper) AddKey(devicePath, passphrase, newPassphrase, slot string)
 	if err != nil {
 		return err
 	}
-	defer os.Remove(passFile.Name())
+	defer os.Remove(passFile.Name()) //nolint:errcheck // failed to delete temp file :-(
 
 	newPassFile, err := file.CreateTempFile("luks-", newPassphrase)
 	if err != nil {
 		return err
 	}
-	defer os.Remove(newPassFile.Name())
+	defer os.Remove(newPassFile.Name()) //nolint:errcheck // failed to delete temp file :-(
 
 	_, stderr, err := l.execCryptsetupCommand(
 		nil,
@@ -185,7 +185,7 @@ func (l *luksWrapper) RemoveKey(devicePath, passphrase, slot string) error {
 	if err != nil {
 		return err
 	}
-	defer os.Remove(keyFile.Name())
+	defer os.Remove(keyFile.Name()) //nolint:errcheck // failed to delete temp file :-(
 
 	_, stderr, err := l.execCryptsetupCommand(
 		nil,
@@ -212,7 +212,7 @@ func (l *luksWrapper) VerifyKey(devicePath, passphrase, slot string) (bool, erro
 	if err != nil {
 		return false, err
 	}
-	defer os.Remove(keyFile.Name())
+	defer os.Remove(keyFile.Name()) //nolint:errcheck // failed to delete temp file :-(
 
 	_, stderr, err := l.execCryptsetupCommand(
 		nil,

internal/util/csiconfig_test.go

@@ -28,24 +28,19 @@ import (
 )
 
 var (
-	basePath     = "./test_artifacts"
-	csiClusters  = "csi-clusters.json"
-	pathToConfig = basePath + "/" + csiClusters
-	clusterID1   = "test1"
-	clusterID2   = "test2"
+	csiClusters = "csi-clusters.json"
+	clusterID1  = "test1"
+	clusterID2  = "test2"
 )
 
-func cleanupTestData() {
-	os.RemoveAll(basePath)
-}
-
 func TestCSIConfig(t *testing.T) {
 	t.Parallel()
 	var err error
 	var data string
 	var content string
 
-	defer cleanupTestData()
+	basePath := t.TempDir() + "/test_artifacts"
+	pathToConfig := basePath + "/" + csiClusters
 
 	err = os.MkdirAll(basePath, 0o700)
 	if err != nil {

internal/util/file/file.go

@@ -34,6 +34,7 @@ func CreateTempFile(prefix, contents string) (*os.File, error) {
 	// In case of error, remove the file if it was created
 	defer func() {
 		if err != nil {
+			//nolint:errcheck // temporary file failed to remove, shrug
 			_ = os.Remove(file.Name())
 		}
 	}()

internal/util/fscrypt/fscrypt.go

@@ -135,7 +135,7 @@ func fsyncEncryptedDirectory(dirPath string) error {
 	if err != nil {
 		return err
 	}
-	defer dir.Close()
+	defer dir.Close() //nolint:errcheck // still open? sync may have returned an error too
 
 	return dir.Sync()
 }
@@ -284,7 +284,7 @@ func getInodeEncryptedAttribute(p string) (bool, error) {
 	if err != nil {
 		return false, err
 	}
-	defer file.Close()
+	defer file.Close() //nolint:errcheck // failed to close, assume SYS_IOCTL returned an error too
 
 	var attr int
 	_, _, errno := unix.Syscall(unix.SYS_IOCTL, file.Fd(), unix.FS_IOC_GETFLAGS,

internal/util/log/log_utils.go

@@ -36,13 +36,13 @@ func GzipLogFile(pathToFile string) error {
 	if err != nil {
 		return err
 	}
-	defer gf.Close() // #nosec:G307, error on close is not critical here
+	defer gf.Close() //nolint:errcheck,nosec // G307, error on close is not critical here
 
 	// Write compressed data.
 	w := gzip.NewWriter(gf)
-	defer w.Close()
+	defer w.Close() //nolint:errcheck // error on close is not critical here
 	if _, err = w.Write(content); err != nil {
-		os.Remove(newExt) // #nosec:G104, not important error to handle
+		os.Remove(newExt) //nolint:errcheck,gosec // G104: not important error to handle
 
 		return err
 	}

internal/util/log/log_utils_test.go

@@ -31,7 +31,6 @@ func TestGzipLogFile(t *testing.T) {
 	if err != nil {
 		fmt.Println(err)
 	}
-	defer os.Remove(logFile.Name())
 
 	if err = GzipLogFile(logFile.Name()); err != nil {
 		t.Errorf("GzipLogFile failed: %v", err)
@@ -41,6 +40,4 @@ func TestGzipLogFile(t *testing.T) {
 	if _, err = os.Stat(newExt); errors.Is(err, os.ErrNotExist) {
 		t.Errorf("compressed logFile (%s) not found: %v", newExt, err)
 	}
-
-	os.Remove(newExt)
 }

internal/util/pidlimit.go

@@ -45,7 +45,7 @@ func getCgroupPidsFile() (string, error) {
 	if err != nil {
 		return "", err
 	}
-	defer cgroup.Close() // #nosec: error on close is not critical here
+	defer cgroup.Close() //nolint:errcheck,nosec // error on close is not critical here
 
 	pidsMax := ""
 	scanner := bufio.NewScanner(cgroup)
@@ -88,7 +88,7 @@ func GetPIDLimit() (int, error) {
 	if err != nil {
 		return 0, err
 	}
-	defer f.Close() // #nosec: error on close is not critical here
+	defer f.Close() //nolint:errcheck,nosec // error on close is not critical here
 
 	maxPidsStr, err := bufio.NewReader(f).ReadString('\n')
 	if err != nil && !errors.Is(err, io.EOF) {
@@ -128,7 +128,7 @@ func SetPIDLimit(limit int) error {
 
 	_, err = f.WriteString(limitStr)
 	if err != nil {
-		f.Close() // #nosec: a write error will be more useful to return
+		f.Close() //nolint:errcheck,gosec // a write error will be more useful to return
 
 		return err
 	}