Documentation
¶
Overview ¶
Package tester contains utilities for executing Rego tests.
Index ¶
Constants ¶
const TestPrefix = "test_"
TestPrefix declares the prefix for all rules.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type JSONCoverageReporter ¶ added in v0.8.0
type JSONCoverageReporter struct {
Cover *cover.Cover
Modules map[string]*ast.Module
Output io.Writer
}
JSONCoverageReporter reports coverage as a JSON structure.
func (JSONCoverageReporter) Report ¶ added in v0.8.0
func (r JSONCoverageReporter) Report(ch chan *Result) error
Report prints the test report to the reporter's output. If any tests fail or encounter errors, this function returns an error.
type JSONReporter ¶ added in v0.8.0
JSONReporter reports test results as array of JSON objects.
func (JSONReporter) Report ¶ added in v0.8.0
func (r JSONReporter) Report(ch chan *Result) error
Report prints the test report to the reporter's output.
type PrettyReporter ¶
PrettyReporter reports test results in a simple human readable format.
func (PrettyReporter) Report ¶
func (r PrettyReporter) Report(ch chan *Result) error
Report prints the test report to the reporter's output.
type Reporter ¶ added in v0.8.0
type Reporter interface {
// Report is called with a channel that will contain test results.
Report(ch chan *Result) error
}
Reporter defines the interface for reporting test results.
type Result ¶
type Result struct {
Location *ast.Location `json:"location"`
Package string `json:"package"`
Name string `json:"name"`
Fail *interface{} `json:"fail,omitempty"`
Error error `json:"error,omitempty"`
Duration time.Duration `json:"duration"`
}
Result represents a single test case result.
func RunWithFilter ¶ added in v0.8.2
RunWithFilter executes all test cases found under files in path. The filter will be applied to exclude files that should not be included.
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
Runner implements simple test discovery and execution.
func (*Runner) Run ¶ added in v0.5.9
func (r *Runner) Run(ctx context.Context, modules map[string]*ast.Module) (ch chan *Result, err error)
Run executes all tests contained in supplied modules.
func (*Runner) SetCompiler ¶
SetCompiler sets the compiler used by the runner.
Source Files