pluginkit

type APICallCounter struct {
	// contains filtered or unexported fields
}

type APICallReporter interface {
	APICallCount() int
}

type ApplyFunc func(interface{}) (interface{}, error)

type BenchmarkReport struct {
	Schema        string `json:"schema" yaml:"schema"`
	PluginName    string `json:"plugin-name" yaml:"plugin-name"`
	PluginVersion string `json:"plugin-version" yaml:"plugin-version"`
	ServiceName   string `json:"service-name" yaml:"service-name"`

	Loaders         []LoaderTiming `json:"loaders" yaml:"loaders"`
	Suites          []SuiteTiming  `json:"suites" yaml:"suites"`
	TotalDurationNs int64          `json:"total-duration-ns" yaml:"total-duration-ns"`
	APICalls        *int           `json:"api-calls,omitempty" yaml:"api-calls,omitempty"`
	WallClockNs     int64          `json:"wall-clock-ns,omitempty" yaml:"wall-clock-ns,omitempty"`
}

type Change struct {
	// TargetName is the name or ID of the resource or configuration that is to be changed
	TargetName string `yaml:"target-name"`
	// Description is a human-readable description of the change
	Description string `yaml:"description"`

	// TargetObject is an optional representation of the object that is being changed
	TargetObject interface{} `yaml:"target-object,omitempty"`
	// Applied is true if the change was successfully applied at least once
	Applied bool `yaml:"applied,omitempty"`
	// Reverted is true if the change was successfully reverted and not applied again
	Reverted bool `yaml:"reverted,omitempty"`
	// Error is used if any error occurred during the change
	Error error `yaml:"error,omitempty"`
	// CorruptedState is true if something went wrong during apply or revert, indicating that the system may be in a bad state
	CorruptedState bool `yaml:"bad-state,omitempty"`
	// contains filtered or unexported fields
}

type ChangeManager struct {
	// Changes is a map of change names to Change objects, so that multiple changes can be tracked and reused.
	Changes map[string]*Change `yaml:"changes"`
	// Allowed must be set to true before any change can be applied.
	Allowed bool `yaml:"allowed,omitempty"`
	// CorruptedState is true if any change has failed to apply or revert, indicating that the system may be in a bad state.
	CorruptedState bool `yaml:"bad-state,omitempty"`
}

type DataLoader func(*config.Config) (any, error)

type EvaluatesDeclaration struct {
	Catalog        string   `json:"catalog"`         // "<namespace>/<catalog_id>"
	CatalogVersion string   `json:"catalog_version"` //nolint:tagliatelle // wire contract
	RequirementIDs []string `json:"requirement_ids"` //nolint:tagliatelle // wire contract
}

type EvaluationOrchestrator struct {
	ServiceName   string `json:"service-name" yaml:"service-name"`
	PluginName    string `json:"plugin-name" yaml:"plugin-name"`
	PluginUri     string `json:"plugin-uri" yaml:"plugin-uri"`
	PluginVersion string `json:"plugin-version" yaml:"plugin-version"`
	// Publisher is the grc.store author/org id that owns this plugin (and, by
	// convention, the catalogs it evaluates). With PluginName it forms the publish
	// coordinate <Publisher>/<PluginName>, and it is the namespace of every
	// evaluated catalog in the publish manifest. Inert at run time; required only
	// to publish (a plugin runs without it, but cannot be published without it).
	Publisher string `json:"publisher,omitempty" yaml:"publisher,omitempty"`
	// License is the plugin's publication license as an SPDX expression
	// (e.g. "Apache-2.0", or "Apache-2.0 OR MIT"; use a LicenseRef-… token for a
	// custom license). grc.store requires it on every publication and it is
	// recorded in the signed plugin config. Like Publisher it is inert at run time
	// and required only to publish; pvtr validates and canonicalizes it (via
	// grc-store-protocol/spdx) at publish time, so the plugin only declares the
	// raw string here.
	License string `json:"license,omitempty" yaml:"license,omitempty"`
	// CatalogNamespaces optionally maps a reference-catalog id to the grc.store
	// namespace that owns it, for plugins that evaluate catalogs published by
	// someone else (e.g. a community plugin evaluating ossf/osps-baseline).
	// Catalogs not listed here are assumed to live under Publisher.
	CatalogNamespaces map[string]string  `json:"catalog-namespaces,omitempty" yaml:"catalog-namespaces,omitempty"`
	Payload           any                `json:"payload,omitempty" yaml:"payload,omitempty"`
	Evaluation_Suites []*EvaluationSuite `json:"evaluation-suites" yaml:"evaluation-suites"` // EvaluationSuite is a map of evaluations to their catalog names
	// contains filtered or unexported fields
}

type EvaluationSuite struct {
	Name   string        `json:"name" yaml:"name"`     // Name is the name of the suite
	Result gemara.Result `json:"result" yaml:"result"` // Result is Passed if all evaluations in the suite passed

	CatalogId string `json:"catalog-id" yaml:"catalog-id"` // CatalogId associates this suite with a catalog
	StartTime string `json:"start-time" yaml:"start-time"` // StartTime is the time the plugin started
	EndTime   string `json:"end-time" yaml:"end-time"`     // EndTime is the time the plugin ended

	CorruptedState bool `json:"corrupted-state" yaml:"corrupted-state"` // CorruptedState is true if any testSet failed to revert at the end of the evaluation

	EvaluationLog gemara.EvaluationLog `json:"control-evaluations" yaml:"control-evaluations"` // EvaluationLog is a slice of evaluations to be executed
	// contains filtered or unexported fields
}

type LoaderTiming struct {
	// Scope is "orchestrator" or "suite:<catalog-id>".
	Scope      string `json:"scope" yaml:"scope"`
	Func       string `json:"func" yaml:"func"`
	DurationNs int64  `json:"duration-ns" yaml:"duration-ns"`
}

type PublishManifest struct {
	// Coordinate is the plugin's grc.store coordinate "<publisher>/<plugin_id>".
	Coordinate string `json:"coordinate"`
	// License is the plugin's declared publication license, the raw SPDX
	// expression from orchestrator.License. It is carried verbatim here; pvtr
	// validates and canonicalizes it at publish time (grc-store-protocol/spdx is
	// not imported into the plugin binary).
	License string `json:"license"`
	// Evaluates is the control-catalog linkage, deterministically ordered.
	Evaluates []EvaluatesDeclaration `json:"evaluates"`
}

type RevertFunc func(interface{}) error

type StepTiming struct {
	ControlId     string `json:"control-id" yaml:"control-id"`
	RequirementId string `json:"requirement-id" yaml:"requirement-id"`
	StepIndex     int    `json:"step-index" yaml:"step-index"`
	Step          string `json:"step" yaml:"step"`
	Result        string `json:"result" yaml:"result"`
	DurationNs    int64  `json:"duration-ns" yaml:"duration-ns"`
}

type SuiteTiming struct {
	CatalogId  string       `json:"catalog-id" yaml:"catalog-id"`
	DurationNs int64        `json:"duration-ns" yaml:"duration-ns"`
	Steps      []StepTiming `json:"steps" yaml:"steps"`
}

type TargetBuilder func(*config.Config) gemara.Resource

type TestSet func() (result gemara.ControlEvaluation)

type TypedAssessmentStep[T any] func(T) (gemara.Result, string, gemara.ConfidenceLevel)