zot/pkg/extensions/scrub/scrub.go

//go:build scrub

package scrub

import (
	"context"
	"fmt"
	"path"

	"zotregistry.dev/zot/v2/pkg/log"
	"zotregistry.dev/zot/v2/pkg/storage"
	storageTypes "zotregistry.dev/zot/v2/pkg/storage/types"
)

// RunScrubRepo runs the scrub extension for a repository.
func RunScrubRepo(ctx context.Context, imgStore storageTypes.ImageStore, repo string, log log.Logger) error {
	execMsg := "executing scrub to check manifest/blob integrity for " + path.Join(imgStore.RootDir(), repo)
	log.Info().Msg(execMsg)

	results, err := storage.CheckRepo(ctx, repo, imgStore)
	if err != nil {
		errMessage := "failed to run scrub for " + path.Join(imgStore.RootDir(), repo)
		log.Error().Err(err).Msg(errMessage)
		log.Info().Msg("scrub unsuccessfully completed for " + path.Join(imgStore.RootDir(), repo))

		return err
	}

	for _, result := range results {
		if result.Status == "ok" {
			log.Info().
				Str("image", result.ImageName).
				Str("tag", result.Tag).
				Str("status", result.Status).
				Str("component", "scrub").
				Msg("blobs/manifest ok")
		} else {
			log.Warn().
				Str("image", result.ImageName).
				Str("tag", result.Tag).
				Str("status", result.Status).
				Str("affected blob", result.AffectedBlob).
				Str("error", result.Error).
				Str("component", "scrub").
				Msg("blobs/manifest affected")
		}
	}

	log.Info().Msg("scrub successfully completed for " + path.Join(imgStore.RootDir(), repo))

	return nil
}

type Task struct {
	imgStore storageTypes.ImageStore
	repo     string
	log      log.Logger
}

func NewTask(imgStore storageTypes.ImageStore, repo string, log log.Logger) *Task {
	return &Task{imgStore, repo, log}
}

func (scrubT *Task) DoWork(ctx context.Context) error {
	return RunScrubRepo(ctx, scrubT.imgStore, scrubT.repo, scrubT.log) //nolint: contextcheck
}

func (scrubT *Task) String() string {
	return fmt.Sprintf("{taskGenerator: \"%s\", repo: \"%s\"}",
		"image scrub", // description of generator's task purpose
		scrubT.repo)
}

func (scrubT *Task) Name() string {
	return "ScrubTask"
}