cmd

Documentation

Overview

Package cmd contains run cobra command factory function.

Index

• func New(levelVar *slog.LevelVar) (*cobra.Command, error)
• type Check
• type Compliance

Functions

func New

func New(levelVar *slog.LevelVar) (*cobra.Command, error)

New creates new cobra command for exec command.

Types

type Check

type Check struct {
	// Textual explanation of the check result.
	Details string `json:"details,omitempty" mapstructure:"details,omitempty" yaml:"details,omitempty"`

	// The ID of the checker.
	// It identifies the method of check, not the execution of the check.
	ID string `json:"id" mapstructure:"id" yaml:"id"`

	// The result of the check.
	// A true value of the passed property indicates a successful check, while a false
	// value indicates a failure.
	Passed bool `json:"passed" mapstructure:"passed" yaml:"passed"`
}

Check is the result of a particular inspection.

type Compliance

type Compliance struct {
	// Results of individual checks.
	Checks []Check `json:"checks,omitempty" mapstructure:"checks,omitempty" yaml:"checks,omitempty"`

	// Compliance check timestamp in Unix time
	Timestamp int64 `json:"timestamp" mapstructure:"timestamp" yaml:"timestamp"`
}

Compliance is the result of the extension's k6 compliance checks.