Documentation ¶
Index ¶
- func NewAPIServerTestParams() runtime.Params
- type TestRuntime
- func (t *TestRuntime) AddrToURL(addr string) (string, error)
- func (t *TestRuntime) GetDataWithInput(path string, input interface{}) ([]byte, error)
- func (t *TestRuntime) GetDataWithInputTyped(path string, input interface{}, response interface{}) error
- func (t *TestRuntime) GetDataWithRawInput(url string, input io.Reader) (io.Reader, error)
- func (t *TestRuntime) HealthCheck(url string, params ...string) error
- func (t *TestRuntime) RunAPIServerBenchmarks(m *testing.M) int
- func (t *TestRuntime) RunAPIServerTests(m *testing.M) int
- func (t *TestRuntime) RunTests(m *testing.M) int
- func (t *TestRuntime) URL() string
- func (t *TestRuntime) UploadData(data io.Reader) error
- func (t *TestRuntime) UploadPolicy(name string, policy io.Reader) error
- func (t *TestRuntime) WaitForServer() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewAPIServerTestParams ¶
NewAPIServerTestParams creates a new set of runtime.Params with enough default values filled in to start the server. Options can/should be customized for the test case.
Types ¶
type TestRuntime ¶
type TestRuntime struct { Params runtime.Params Runtime *runtime.Runtime Ctx context.Context Cancel context.CancelFunc Client *http.Client // contains filtered or unexported fields }
TestRuntime holds metadata and provides helper methods to interact with the runtime being tested.
func NewTestRuntime ¶
func NewTestRuntime(params runtime.Params) (*TestRuntime, error)
NewTestRuntime returns a new TestRuntime which
func WrapRuntime ¶ added in v0.20.0
func WrapRuntime(ctx context.Context, cancel context.CancelFunc, rt *runtime.Runtime) *TestRuntime
WrapRuntime creates a new TestRuntime by wrapping an existing runtime
func (*TestRuntime) AddrToURL ¶ added in v0.20.0
func (t *TestRuntime) AddrToURL(addr string) (string, error)
AddrToURL generates a full URL from an address, as configured on the runtime. This can include fully qualified urls, just host/ip, with port, or only port (eg, "localhost", ":8181", "http://foo", etc). If the runtime is configured with HTTPS certs it will generate an appropriate URL.
func (*TestRuntime) GetDataWithInput ¶
func (t *TestRuntime) GetDataWithInput(path string, input interface{}) ([]byte, error)
GetDataWithInput will use the v1 data API and POST with the given input. The returned value is the full response body.
func (*TestRuntime) GetDataWithInputTyped ¶ added in v0.14.0
func (t *TestRuntime) GetDataWithInputTyped(path string, input interface{}, response interface{}) error
GetDataWithInputTyped returns an unmarshalled response from GetDataWithInput.
func (*TestRuntime) GetDataWithRawInput ¶ added in v0.22.0
GetDataWithRawInput will use the v1 data API and POST with the given input. The returned value is the full response body.
func (*TestRuntime) HealthCheck ¶ added in v0.20.0
func (t *TestRuntime) HealthCheck(url string, params ...string) error
HealthCheck will query /health and return an error if the server is not healthy
func (*TestRuntime) RunAPIServerBenchmarks ¶
func (t *TestRuntime) RunAPIServerBenchmarks(m *testing.M) int
RunAPIServerBenchmarks will start the OPA runtime and do `m.Run()` similar to how RunAPIServerTests works. This will suppress logging output on stdout to prevent the tests from being overly verbose. If log output is desired set the `test.v` flag. Deprecated: Use RunTests instead
func (*TestRuntime) RunAPIServerTests ¶
func (t *TestRuntime) RunAPIServerTests(m *testing.M) int
RunAPIServerTests will start the OPA runtime serving with a given configuration. This is essentially a wrapper for `m.Run()` that handles starting and stopping the local API server. The return value is what should be used as the code in `os.Exit` in the `TestMain` function. Deprecated: Use RunTests instead
func (*TestRuntime) RunTests ¶ added in v0.22.0
func (t *TestRuntime) RunTests(m *testing.M) int
RunTests will start the OPA runtime serving with a given configuration. This is essentially a wrapper for `m.Run()` that handles starting and stopping the local API server. The return value is what should be used as the code in `os.Exit` in the `TestMain` function.
func (*TestRuntime) URL ¶
func (t *TestRuntime) URL() string
URL will return the URL that the server is listening on. If the server hasn't started listening this will return an empty string. It is not expected for the URL to change throughout the lifetime of the TestRuntime. Runtimes configured with >1 address will only get the first URL.
func (*TestRuntime) UploadData ¶
func (t *TestRuntime) UploadData(data io.Reader) error
UploadData will upload the given data to the runtime via the v1 data API
func (*TestRuntime) UploadPolicy ¶
func (t *TestRuntime) UploadPolicy(name string, policy io.Reader) error
UploadPolicy will upload the given policy to the runtime via the v1 policy API
func (*TestRuntime) WaitForServer ¶ added in v0.20.0
func (t *TestRuntime) WaitForServer() error
WaitForServer will block until the server is running and passes a health check.