harnessrelease

Documentation

Overview

Package harnessrelease captures a checksum-verified released harness clean-room receipt.

Package harnessrelease captures a release-backed external harness clean-room witness.

Index

• Constants
• func Extract(archive, dir string) error
• func VerifyChecksum(archive, sidecar string) (string, error)
• type CommandReceipt
• type Options
• type Receipt
  • func Run(ctx context.Context, opts Options) (Receipt, error)

Constants

const Schema = "fak.harness-release-witness/v1alpha1"

Functions

func Extract

func Extract(archive, dir string) error

func VerifyChecksum

func VerifyChecksum(archive, sidecar string) (string, error)

Types

type CommandReceipt

type CommandReceipt struct {
	Command        []string `json:"command"`
	ExitCode       int      `json:"exit_code"`
	ElapsedSeconds float64  `json:"elapsed_seconds"`
	Output         string   `json:"output,omitempty"`
}

type Options

type Options struct {
	Archive         string
	Checksum        string
	Target          string
	ProductDir      string
	Module          string
	Receipt         string
	RollbackCommand string
}

type Receipt

type Receipt struct {
	Schema              string           `json:"schema"`
	Outcome             string           `json:"outcome"`
	Target              string           `json:"target"`
	Archive             string           `json:"archive"`
	ArchiveSHA256       string           `json:"archive_sha256"`
	BinarySHA256        string           `json:"binary_sha256"`
	ProductDir          string           `json:"product_dir"`
	Module              string           `json:"module"`
	Generator           string           `json:"generator"`
	ContractVersion     string           `json:"contract_version"`
	FAKModule           string           `json:"fak_module"`
	FAKVersion          string           `json:"fak_version"`
	UpgradeCommand      string           `json:"upgrade_command"`
	RollbackCommand     string           `json:"rollback_command"`
	UserConfigSHA256    string           `json:"user_config_sha256"`
	UserConfigPreserved bool             `json:"user_config_preserved"`
	ElapsedSeconds      float64          `json:"elapsed_seconds"`
	Commands            []CommandReceipt `json:"commands"`
}

func Run

func Run(ctx context.Context, opts Options) (Receipt, error)