package tester

import "github.com/open-policy-agent/opa/tester"

Package tester contains utilities for executing Rego tests.

Index ¶

• Constants
• type PrettyReporter
• func (r PrettyReporter) Report(ch chan *Result) error
• type Result
• func Run(ctx context.Context, path ...string) ([]*Result, error)
• func (r Result) Pass() bool
• func (r *Result) String() string
• type Runner
• func NewRunner() *Runner
• func (r *Runner) Modules(ctx context.Context, modules map[string]*ast.Module) (ch chan *Result, err error)
• func (r *Runner) Paths(ctx context.Context, path ...string) (ch chan *Result, err error)
• func (r *Runner) SetCompiler(compiler *ast.Compiler) *Runner

Constants ¶

const TestPrefix = "test_"

TestPrefix declares the prefix for all rules.

Types ¶

type PrettyReporter ¶

type PrettyReporter struct {
	Output  io.Writer
	Verbose bool
}

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 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 Run ¶

func Run(ctx context.Context, path ...string) ([]*Result, error)

Run executes all test cases found under files in path.

func (Result) Pass ¶

func (r Result) Pass() bool

Pass returns true if the test case passed.

func (*Result) String ¶

func (r *Result) String() string

type Runner ¶

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

Runner implements simple test discovery and execution.

func NewRunner ¶

func NewRunner() *Runner

NewRunner returns a new runner.

func (*Runner) Modules ¶

func (r *Runner) Modules(ctx context.Context, modules map[string]*ast.Module) (ch chan *Result, err error)

Modules executes all tests contained in the specified modules.

func (*Runner) Paths ¶

func (r *Runner) Paths(ctx context.Context, path ...string) (ch chan *Result, err error)

Paths executes all tests contained in policies under the specified paths.

func (*Runner) SetCompiler ¶

func (r *Runner) SetCompiler(compiler *ast.Compiler) *Runner

SetCompiler sets the compiler used by the runner.

Source Files ¶

reporter.go runner.go