common

Documentation

Index

• Constants
• Variables
• func GetBool(msg *structpb.Struct, fieldName string) (bool, bool)
• func GetString(msg *structpb.Struct, fieldName string) (string, bool)
• func PrintDesc(descFlag, description string, result *CheckResult, expected bool)
• func PromptYesNo(label string, def bool) bool
• func UnmarshalReq(value *structpb.Value, msg proto.Message) error
• type CheckResult
  • func (cr *CheckResult) PrintCSV(w *csv.Writer, index int, expected bool, checkType CheckType, ...)
  • func (cr *CheckResult) PrintCSVHeader(w *csv.Writer)
  • func (cr *CheckResult) PrintTable(w io.Writer, index int, expected bool, checkType CheckType, noColor bool)
• type CheckType
  • func GetCheckType(msg *structpb.Struct) CheckType
• type SaveContext
• type TestExecCmd
• type TestResults
  • func NewTestResults(assertions []json.RawMessage) *TestResults
  • func (t *TestResults) Errored() int32
  • func (t *TestResults) Failed() int32
  • func (t *TestResults) IncrErrored()
  • func (t *TestResults) IncrFailed()
  • func (t *TestResults) IncrPassed()
  • func (t *TestResults) IncrSkipped()
  • func (t *TestResults) IncrTotal()
  • func (t *TestResults) Passed(passed bool)
  • func (t *TestResults) PrintSummary(w io.Writer)
• type TestRunner
  • func NewAuthorizerTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, azConfig *azc.Config) (*TestRunner, error)
  • func NewDirectoryTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, dsConfig *dsc.Config) (*TestRunner, error)
  • func NewTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, azConfig *azc.Config, dsConfig *dsc.Config) (*TestRunner, error)
  • func (runner *TestRunner) Run(c *cc.CommonCtx) error

Constants

const (
	TestOutputTable string = "table"
	TestOutputCSV   string = "csv"
	Expected        string = "expected"
	Description     string = "description"
	DescOff         string = "off"
	DescOn          string = "on"
	DescOnError     string = "on-error"
	Passed          string = "PASS"
	Failed          string = "FAIL"
	Errored         string = "ERR "
)

const (
	CheckStr           string = "check"
	CheckRelationStr   string = "check_relation"
	CheckPermissionStr string = "check_permission"
	CheckDecisionStr   string = "check_decision"
)

const (
	CLIConfigurationFile = "topaz.json"
)

Variables

var (
	ErrSkippedAuthorizerAssertion = cerr.NewAsertoError("T10001", codes.Internal, http.StatusInternalServerError, "no authorizer client")
	ErrSkippedDirectoryAssertion  = cerr.NewAsertoError("T10002", codes.Internal, http.StatusInternalServerError, "no directory client")
)

var CheckTypeMap = map[string]CheckType{
	CheckStr:           Check,
	CheckRelationStr:   CheckRelation,
	CheckPermissionStr: CheckPermission,
	CheckDecisionStr:   CheckDecision,
}

var CheckTypeMapStr = map[CheckType]string{
	Check:           CheckStr,
	CheckRelation:   CheckRelationStr,
	CheckPermission: CheckPermissionStr,
	CheckDecision:   CheckDecisionStr,
}

Functions

func GetBool

func GetBool(msg *structpb.Struct, fieldName string) (bool, bool)

func GetString

func GetString(msg *structpb.Struct, fieldName string) (string, bool)

func PrintDesc

func PrintDesc(descFlag, description string, result *CheckResult, expected bool)

func PromptYesNo

func PromptYesNo(label string, def bool) bool

func UnmarshalReq

func UnmarshalReq(value *structpb.Value, msg proto.Message) error

Types

type CheckResult

type CheckResult struct {
	Outcome  bool
	Duration time.Duration
	Err      error
	Str      string
}

func (*CheckResult) PrintCSV

func (cr *CheckResult) PrintCSV(w *csv.Writer, index int, expected bool, checkType CheckType, description string)

func (*CheckResult) PrintCSVHeader

func (cr *CheckResult) PrintCSVHeader(w *csv.Writer)

func (*CheckResult) PrintTable

func (cr *CheckResult) PrintTable(w io.Writer, index int, expected bool, checkType CheckType, noColor bool)

type CheckType

type CheckType int

const (
	CheckUnknown CheckType = iota
	Check
	CheckRelation
	CheckPermission
	CheckDecision
)

func GetCheckType

func GetCheckType(msg *structpb.Struct) CheckType

type SaveContext

type SaveContext bool

var (
	Save                  SaveContext
	RestrictedNamePattern = regexp.MustCompile(`^[a-z0-9][a-z0-9_.-]*$`)
)

type TestExecCmd

type TestExecCmd struct {
	Files   []string `arg:""  default:"assertions.json" help:"path to assertions file" sep:"none" optional:""`
	Stdin   bool     `flag:"" default:"false" help:"read assertions from --stdin"`
	Summary bool     `flag:"" default:"false" help:"display test summary"`
	Format  string   `flag:"" default:"table" help:"output format (table|csv)" enum:"table,csv"`
	Desc    string   `flag:"" default:"off" enum:"off,on,on-error" help:"output descriptions (off|on|on-error)"`
}

type TestResults

type TestResults struct {
	// contains filtered or unexported fields
}

func NewTestResults

func NewTestResults(assertions []json.RawMessage) *TestResults

func (*TestResults) Errored

func (t *TestResults) Errored() int32

func (*TestResults) Failed

func (t *TestResults) Failed() int32

func (*TestResults) IncrErrored

func (t *TestResults) IncrErrored()

func (*TestResults) IncrFailed

func (t *TestResults) IncrFailed()

func (*TestResults) IncrPassed

func (t *TestResults) IncrPassed()

func (*TestResults) IncrSkipped

func (t *TestResults) IncrSkipped()

func (*TestResults) IncrTotal

func (t *TestResults) IncrTotal()

func (*TestResults) Passed

func (t *TestResults) Passed(passed bool)

func (*TestResults) PrintSummary

func (t *TestResults) PrintSummary(w io.Writer)

type TestRunner

type TestRunner struct {
	// contains filtered or unexported fields
}

func NewAuthorizerTestRunner

func NewAuthorizerTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, azConfig *azc.Config) (*TestRunner, error)

func NewDirectoryTestRunner

func NewDirectoryTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, dsConfig *dsc.Config) (*TestRunner, error)

func NewTestRunner

func NewTestRunner(c *cc.CommonCtx, cmd *TestExecCmd, azConfig *azc.Config, dsConfig *dsc.Config) (*TestRunner, error)

func (*TestRunner) Run

func (runner *TestRunner) Run(c *cc.CommonCtx) error