refactor: simplify update a checksum file

aquaproj · Jan 31, 2025 · 1dd7fb7 · 1dd7fb7
1 parent d9d49de
commit 1dd7fb7
Show file tree

Hide file tree

Showing 10 changed files with 72 additions and 135 deletions.
diff --git a/pkg/checksum/type.go b/pkg/checksum/type.go
@@ -10,6 +10,7 @@ import (
 	"strings"
 	"sync"
 
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/afero"
 )
 
@@ -29,6 +30,25 @@ func New() *Checksums {
 	}
 }
 
+func Open(logE *logrus.Entry, fs afero.Fs, cfgFilePath string, enabled bool) (*Checksums, func(), error) {
+	if !enabled {
+		return nil, func() {}, nil
+	}
+	checksumFilePath, err := GetChecksumFilePathFromConfigFilePath(fs, cfgFilePath)
+	if err != nil {
+		return nil, nil, err //nolint:wrapcheck
+	}
+	checksums := New()
+	if err := checksums.ReadFile(fs, checksumFilePath); err != nil {
+		return nil, nil, fmt.Errorf("read a checksum JSON: %w", err)
+	}
+	return checksums, func() {
+		if err := checksums.UpdateFile(fs, checksumFilePath); err != nil {
+			logE.WithError(err).Error("update a checksum file")
+		}
+	}, nil
+}
+
 func (c *Checksums) EnableOutput() {
 	c.stdout = os.Stdout
 }

diff --git a/pkg/controller/cp/install.go b/pkg/controller/cp/install.go
@@ -15,22 +15,13 @@ import (
 )
 
 func (c *Controller) install(ctx context.Context, logE *logrus.Entry, findResult *which.FindResult, policyConfigs []*policy.Config, param *config.Param) error {
-	var checksums *checksum.Checksums
-	if findResult.Config.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, findResult.ConfigFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, findResult.ConfigFilePath,
+		findResult.Config.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	if err := c.packageInstaller.InstallPackage(ctx, logE, &installpackage.ParamInstallPackage{
 		Pkg:             findResult.Package,

diff --git a/pkg/controller/exec/exec.go b/pkg/controller/exec/exec.go
@@ -83,22 +83,13 @@ func (c *Controller) updateTimestamp(pkg *config.Package) error {
 }
 
 func (c *Controller) install(ctx context.Context, logE *logrus.Entry, findResult *which.FindResult, policies []*policy.Config, param *config.Param) error {
-	var checksums *checksum.Checksums
-	if findResult.Config.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, findResult.ConfigFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, findResult.ConfigFilePath,
+		findResult.Config.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	if err := c.packageInstaller.InstallPackage(ctx, logE, &installpackage.ParamInstallPackage{
 		Pkg:             findResult.Package,

diff --git a/pkg/controller/generate/generate.go b/pkg/controller/generate/generate.go
@@ -72,22 +72,13 @@ func (c *Controller) getConfigFile(param *config.Param) (string, error) {
 }
 
 func (c *Controller) listPkgs(ctx context.Context, logE *logrus.Entry, param *config.Param, cfg *aqua.Config, cfgFilePath string, args ...string) ([]*aqua.Package, error) {
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return nil, err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return nil, fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return nil, fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {

diff --git a/pkg/controller/install/install.go b/pkg/controller/install/install.go
@@ -93,22 +93,11 @@ func (c *Controller) install(ctx context.Context, logE *logrus.Entry, cfgFilePat
 		return err //nolint:wrapcheck
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(logE, c.fs, cfgFilePath, cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {

diff --git a/pkg/controller/list/list.go b/pkg/controller/list/list.go
@@ -24,22 +24,13 @@ func (c *Controller) List(ctx context.Context, logE *logrus.Entry, param *config
 		return err //nolint:wrapcheck
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {

diff --git a/pkg/controller/remove/remove.go b/pkg/controller/remove/remove.go
@@ -55,22 +55,13 @@ func (c *Controller) Remove(ctx context.Context, logE *logrus.Entry, param *conf
 		return fmt.Errorf("read a configuration file: %w", err)
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {

diff --git a/pkg/controller/update/update.go b/pkg/controller/update/update.go
@@ -79,22 +79,13 @@ func (c *Controller) update(ctx context.Context, logE *logrus.Entry, param *conf
 		return fmt.Errorf("read a configuration file: %w", err)
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	// Update packages before registries because if registries are updated before packages the function needs to install new registries then checksums of new registrires aren't added to aqua-checksums.json.
 

diff --git a/pkg/controller/vacuum/initialize/init.go b/pkg/controller/vacuum/initialize/init.go
@@ -41,22 +41,13 @@ func (c *Controller) create(ctx context.Context, logE *logrus.Entry, cfgFilePath
 		return err //nolint:wrapcheck
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {

diff --git a/pkg/controller/which/which.go b/pkg/controller/which/which.go
@@ -86,22 +86,13 @@ func (c *Controller) findExecFile(ctx context.Context, logE *logrus.Entry, param
 		return nil, err //nolint:wrapcheck
 	}
 
-	var checksums *checksum.Checksums
-	if cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum) {
-		checksums = checksum.New()
-		checksumFilePath, err := checksum.GetChecksumFilePathFromConfigFilePath(c.fs, cfgFilePath)
-		if err != nil {
-			return nil, err //nolint:wrapcheck
-		}
-		if err := checksums.ReadFile(c.fs, checksumFilePath); err != nil {
-			return nil, fmt.Errorf("read a checksum JSON: %w", err)
-		}
-		defer func() {
-			if err := checksums.UpdateFile(c.fs, checksumFilePath); err != nil {
-				logE.WithError(err).Error("update a checksum file")
-			}
-		}()
+	checksums, updateChecksum, err := checksum.Open(
+		logE, c.fs, cfgFilePath,
+		cfg.ChecksumEnabled(param.EnforceChecksum, param.Checksum))
+	if err != nil {
+		return nil, fmt.Errorf("read a checksum JSON: %w", err)
 	}
+	defer updateChecksum()
 
 	registryContents, err := c.registryInstaller.InstallRegistries(ctx, logE, cfg, cfgFilePath, checksums)
 	if err != nil {