frostfs-node/pkg/services/audit/report.go

package audit

import (
	"sync"

	"github.com/TrueCloudLab/frostfs-sdk-go/audit"
	cid "github.com/TrueCloudLab/frostfs-sdk-go/container/id"
	oid "github.com/TrueCloudLab/frostfs-sdk-go/object/id"
)

// Report tracks the progress of auditing container data.
type Report struct {
	mu  sync.RWMutex
	res audit.Result
}

// Reporter is an interface of the entity that records
// the data audit report.
type Reporter interface {
	WriteReport(r *Report) error
}

// NewReport creates and returns blank Report instance.
func NewReport(cnr cid.ID) *Report {
	var rep Report
	rep.res.ForContainer(cnr)

	return &rep
}

// Result forms the structure of the data audit result.
func (r *Report) Result() *audit.Result {
	r.mu.RLock()
	defer r.mu.RUnlock()

	return &r.res
}

// Complete completes audit report.
func (r *Report) Complete() {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.Complete()
}

// PassedPoR updates list of passed storage groups.
func (r *Report) PassedPoR(sg oid.ID) {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.SubmitPassedStorageGroup(sg)
}

// FailedPoR updates list of failed storage groups.
func (r *Report) FailedPoR(sg oid.ID) {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.SubmitFailedStorageGroup(sg)
}

// SetPlacementCounters sets counters of compliance with placement.
func (r *Report) SetPlacementCounters(hit, miss, fail uint32) {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.SetHits(hit)
	r.res.SetMisses(miss)
	r.res.SetFailures(fail)
}

// SetPDPResults sets lists of nodes according to their PDP results.
func (r *Report) SetPDPResults(passed, failed [][]byte) {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.SubmitPassedStorageNodes(passed)
	r.res.SubmitFailedStorageNodes(failed)
}

// SetPoRCounters sets amounts of head requests and retries at PoR audit stage.
func (r *Report) SetPoRCounters(requests, retries uint32) {
	r.mu.Lock()
	defer r.mu.Unlock()

	r.res.SetRequestsPoR(requests)
	r.res.SetRetriesPoR(retries)
}