conformanceprofile

Documentation

Index

• func BuildVerification(raw any) (report.Record, int, error)
• func List(raw any) ([]string, error)
• func Markdown(profile ProfileReport) string
• type Binding
• type ExpectedManifest
• type Input
• type Manifest
• type Policy
• type Profile
• type ProfileReport
  • func (profile ProfileReport) JSONValue() map[string]any
• type ProofContract
• type Result
  • func BuildProfile(raw any, profileID string) (Result, error)
• type Surface
• type VerificationResult
  • func Verify(raw any) VerificationResult
• type WitnessRef

Functions

func BuildVerification

func BuildVerification(raw any) (report.Record, int, error)

func List

func List(raw any) ([]string, error)

func Markdown

func Markdown(profile ProfileReport) string

Types

type Binding

type Binding struct {
	BlockingStatus             string
	ProofContractState         string
	RequiredEnvironmentClasses []string
	RequirementID              string
	ScenarioID                 string
	SurfaceID                  string
	VerifyCommands             []string
	WitnessRefs                []WitnessRef
}

type ExpectedManifest

type ExpectedManifest struct {
	AuthorityState       string
	ContractID           string
	ContractKind         string
	NonClaims            []string
	NormalizationProfile string
	SourceContract       string
}

type Input

type Input struct {
	Manifest      Manifest
	Policy        Policy
	ProfileID     string
	ProofContract ProofContract
}

type Manifest

type Manifest struct {
	AuthorityState       string
	ContractID           string
	ContractKind         string
	NonClaims            []string
	NormalizationProfile string
	Profiles             []Profile
	SourceContract       string
}

type Policy

type Policy struct {
	AllowedProofContractStates     map[string]struct{}
	BlockingStatuses               map[string]struct{}
	ExpectedManifest               ExpectedManifest
	FailOnUnusedAllowedEnvironment bool
	KnownEnvironmentClasses        map[string]struct{}
	LocalEnvironmentClasses        map[string]struct{}
}

type Profile

type Profile struct {
	AllowedEnvironmentClasses []string
	NonClaims                 []string
	OptionalSurfaceIDs        []string
	PreconditionPolicy        string
	ProfileID                 string
	Purpose                   string
	RequiredSurfaceIDs        []string
}

type ProfileReport

type ProfileReport struct {
	CommandCount                   int
	CommandExecutionState          string
	EnvironmentClasses             []string
	Failures                       []string
	NonClaims                      []string
	OptionalSurfaceCount           int
	PreconditionedRequirementCount int
	ProfileID                      string
	ProfileResolutionState         string
	Purpose                        string
	RequirementCount               int
	RequiredSurfaceCount           int
	ScenarioCount                  int
	SurfaceCount                   int
	Surfaces                       []string
	VerifyCommands                 []string
	WitnessMappingCount            int
}

func (ProfileReport) JSONValue

func (profile ProfileReport) JSONValue() map[string]any

type ProofContract

type ProofContract struct {
	Bindings   []Binding
	ContractID string
	Surfaces   []Surface
}

type Result

type Result struct {
	ExitCode      int
	ProfileReport ProfileReport
	Report        report.Record
}

func BuildProfile

func BuildProfile(raw any, profileID string) (Result, error)

type Surface

type Surface struct {
	PreconditionedEnvironmentClasses []string
	RequiredEnvironmentClasses       []string
	SurfaceID                        string
}

type VerificationResult

type VerificationResult struct {
	Failures     []string
	NonClaims    []string
	ProfileCount int
}

func Verify

func Verify(raw any) VerificationResult

type WitnessRef

type WitnessRef struct {
	Role     string
	Selector string
}