input

package

v0.4.2 Latest Latest Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/enterprise-contract/ec-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ValidateInput(ctx context.Context, fpath string, policy policy.Policy, detailed bool) (*output.Output, error)
type Input
type Report
- func NewReport(inputs []Input, policy policy.Policy, data any, policyInput [][]byte) (Report, error)
- func (r Report) WriteAll(targets []string, p format.TargetParser) (allErrors error)
type TestReport

Constants ¶

View Source

const (
	JSON    = "json"
	YAML    = "yaml"
	Summary = "summary"
)

Possible formats the report can be written as.

Variables ¶

This section is empty.

Functions ¶

func ValidateInput ¶

func ValidateInput(ctx context.Context, fpath string, policy policy.Policy, detailed bool) (*output.Output, error)

Types ¶

type Input ¶

type Input struct {
	FilePath     string             `json:"filepath"`
	Violations   []evaluator.Result `json:"violations"`
	Warnings     []evaluator.Result `json:"warnings"`
	Successes    []evaluator.Result `json:"successes"`
	Success      bool               `json:"success"`
	SuccessCount int                `json:"success-count"`
}

type Report ¶

type Report struct {
	Success bool `json:"success"`

	FilePaths     []Input                          `json:"filepaths"`
	Policy        ecc.EnterpriseContractPolicySpec `json:"policy"`
	EcVersion     string                           `json:"ec-version"`
	Data          any                              `json:"-"`
	EffectiveTime time.Time                        `json:"effective-time"`
	PolicyInput   [][]byte                         `json:"-"`
	// contains filtered or unexported fields
}

func NewReport ¶

func NewReport(inputs []Input, policy policy.Policy, data any, policyInput [][]byte) (Report, error)

WriteReport returns a new instance of Report representing the state of the filepaths provided.

func (Report) WriteAll ¶

func (r Report) WriteAll(targets []string, p format.TargetParser) (allErrors error)

WriteAll writes the report to all the given targets.

type TestReport ¶

type TestReport struct {
	Timestamp string `json:"timestamp"`
	Namespace string `json:"namespace"`
	Successes int    `json:"successes"`
	Failures  int    `json:"failures"`
	Warnings  int    `json:"warnings"`
	Result    string `json:"result"`
	Note      string `json:"note,omitempty"`
}

TestReport represents the standardized TEST_OUTPUT format. The `Namespace` attribute is required for the appstudio results API. However, it is always an empty string from the ec-cli as a way to indicate all namespaces were used.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL