objectstore

Documentation

Index

• func ProbeSignedReadiness(ctx context.Context, configuration LiveConfiguration) error
• func PublicError(err error, _ LiveConfiguration) error
• func WriteRunSummary(path string, result RunResult) error
• type Candidate
• type CandidateResult
  • func EvaluateCandidate(candidate Candidate) CandidateResult
• type Catalog
  • func DecodeCatalog(reader io.Reader) (Catalog, error)
• type CommandEvidence
• type DistributionEvidence
• type Evaluation
  • func EvaluateCatalog(catalog Catalog) (Evaluation, error)
• type ImageEvidence
• type LicenseEvidence
• type LiveConfiguration
  • func LiveConfigurationFromEnvironment() (LiveConfiguration, bool)
• type MaintenanceEvidence
• type OfflineEvidence
• type PlatformDigest
• type PrimarySourceEvidence
• type ReadinessEvidence
• type RunResult
  • func RunS3Conformance(ctx context.Context, configuration LiveConfiguration) (RunResult, error)
  • func VerifyRestartPersistence(ctx context.Context, configuration LiveConfiguration) (RunResult, error)
• type Selection
• type SupplyChainEvidence

Functions

func ProbeSignedReadiness

func ProbeSignedReadiness(ctx context.Context, configuration LiveConfiguration) error

func PublicError

func PublicError(err error, _ LiveConfiguration) error

func WriteRunSummary

func WriteRunSummary(path string, result RunResult) error

Types

type Candidate

type Candidate struct {
	ID            string                `json:"id"`
	Name          string                `json:"name"`
	Version       string                `json:"version"`
	PrimarySource PrimarySourceEvidence `json:"primary_source"`
	License       LicenseEvidence       `json:"license"`
	Maintenance   MaintenanceEvidence   `json:"maintenance"`
	Image         ImageEvidence         `json:"image"`
	Readiness     ReadinessEvidence     `json:"readiness"`
	S3Conformance CommandEvidence       `json:"s3_conformance"`
	Offline       OfflineEvidence       `json:"offline"`
	SupplyChain   SupplyChainEvidence   `json:"supply_chain"`
	Distribution  DistributionEvidence  `json:"distribution"`
}

type CandidateResult

type CandidateResult struct {
	ID       string
	Complete bool
	Eligible bool
	Issues   []string
}

func EvaluateCandidate

func EvaluateCandidate(candidate Candidate) CandidateResult

type Catalog

type Catalog struct {
	SchemaVersion int         `json:"schema_version"`
	ResearchedAt  string      `json:"researched_at"`
	Selection     Selection   `json:"selection"`
	Candidates    []Candidate `json:"candidates"`
}

func DecodeCatalog

func DecodeCatalog(reader io.Reader) (Catalog, error)

type CommandEvidence

type CommandEvidence struct {
	Command string `json:"command"`
}

type DistributionEvidence

type DistributionEvidence struct {
	Status        string `json:"status"`
	PolicyConcern string `json:"policy_concern"`
}

type Evaluation

type Evaluation struct {
	Selected   CandidateResult
	Candidates []CandidateResult
}

func EvaluateCatalog

func EvaluateCatalog(catalog Catalog) (Evaluation, error)

type ImageEvidence

type ImageEvidence struct {
	TagReference string           `json:"tag_reference"`
	IndexDigest  string           `json:"index_digest"`
	Platforms    []PlatformDigest `json:"platforms"`
}

type LicenseEvidence

type LicenseEvidence struct {
	SPDX       string `json:"spdx"`
	ReceiptURL string `json:"receipt_url"`
}

type LiveConfiguration

type LiveConfiguration struct {
	Endpoint    string
	AccessKey   string
	SecretKey   string
	RunID       string
	Iteration   int
	SummaryPath string
	GitCommit   string
	SourceTree  string
}

func LiveConfigurationFromEnvironment

func LiveConfigurationFromEnvironment() (LiveConfiguration, bool)

type MaintenanceEvidence

type MaintenanceEvidence struct {
	Active     *bool  `json:"active"`
	CheckedAt  string `json:"checked_at"`
	Status     string `json:"status"`
	ReceiptURL string `json:"receipt_url"`
}

type OfflineEvidence

type OfflineEvidence struct {
	ExportCommand string `json:"export_command"`
	ImportCommand string `json:"import_command"`
	Claim         string `json:"claim"`
}

type PlatformDigest

type PlatformDigest struct {
	OS           string `json:"os"`
	Architecture string `json:"architecture"`
	Digest       string `json:"digest"`
}

type PrimarySourceEvidence

type PrimarySourceEvidence struct {
	URL    string `json:"url"`
	Commit string `json:"commit"`
}

type ReadinessEvidence

type ReadinessEvidence struct {
	Command   string `json:"command"`
	Semantics string `json:"semantics"`
}

type RunResult

type RunResult struct {
	SchemaVersion int
	GitCommit     string
	SourceTree    string
	RunID         string
	Iteration     int
	Phase         string
	Cases         map[string]time.Duration
	BytesVerified int64
}

func RunS3Conformance

func RunS3Conformance(ctx context.Context, configuration LiveConfiguration) (RunResult, error)

func VerifyRestartPersistence

func VerifyRestartPersistence(ctx context.Context, configuration LiveConfiguration) (RunResult, error)

type Selection

type Selection struct {
	CandidateID        string `json:"candidate_id"`
	ImmutableReference string `json:"immutable_reference"`
	Scope              string `json:"scope"`
	ReleaseRequirement string `json:"release_requirement"`
}

type SupplyChainEvidence

type SupplyChainEvidence struct {
	CheckedAt   string `json:"checked_at"`
	Status      string `json:"status"`
	CheckMethod string `json:"check_method"`
}