Documentation
¶
Overview ¶
Package v1 contains the v1 version of the testkit package. This is meant to aid developers in testing out minder rule types and other components.
Index ¶
- Variables
- type Option
- type TestKit
- func (*TestKit) CanImplement(_ minderv1.ProviderType) bool
- func (*TestKit) Clone(_ context.Context, _ string, _ string) (*git.Repository, error)
- func (*TestKit) CreationOptions(_ minderv1.Entity) *provv1.EntityCreationOptions
- func (*TestKit) DeregisterEntity(_ context.Context, _ minderv1.Entity, _ *properties.Properties) error
- func (tk *TestKit) Do(ctx context.Context, req *http.Request) (*http.Response, error)
- func (*TestKit) FetchAllProperties(_ context.Context, _ *properties.Properties, _ minderv1.Entity, ...) (*properties.Properties, error)
- func (*TestKit) FetchProperty(_ context.Context, _ *properties.Properties, _ minderv1.Entity, _ string) (*properties.Property, error)
- func (*TestKit) GetBaseURL() string
- func (*TestKit) GetConfig() protoreflect.ProtoMessage
- func (*TestKit) GetEntityName(_ minderv1.Entity, _ *properties.Properties) (string, error)
- func (*TestKit) GetType() string
- func (tk *TestKit) Ingest(ctx context.Context, ent protoreflect.ProtoMessage, params map[string]any) (*interfaces.Ingested, error)
- func (*TestKit) NewRequest(method, url string, body any) (*http.Request, error)
- func (*TestKit) PropertiesToProtoMessage(_ minderv1.Entity, _ *properties.Properties) (protoreflect.ProtoMessage, error)
- func (*TestKit) ProviderClassInfo() *minderv1.ProviderClassInfo
- func (*TestKit) RegisterEntity(_ context.Context, _ minderv1.Entity, props *properties.Properties) (*properties.Properties, error)
- func (tk *TestKit) RoundTrip(req *http.Request) (*http.Response, error)
- func (tk *TestKit) ShouldOverrideIngest() bool
- func (*TestKit) SupportsEntity(_ minderv1.Entity) bool
- type VoidResultSink
Constants ¶
This section is empty.
Variables ¶
var ( // ErrIngestUnimplemented is returned when the ingester is not implemented ErrIngestUnimplemented = errors.New("ingester not implemented") )
var ( // ErrNotIngesterOverridden is returned when a provider trait is not overridden. ErrNotIngesterOverridden = errors.New("ingester not overridden") )
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*TestKit)
Option is a functional option type for TestKit
func WithGitDir ¶
WithGitDir is a functional option to set the git directory. It eagerly creates an osfs.Filesystem rooted at dir.
func WithGitFiles ¶ added in v0.2.0
WithGitFiles is a functional option to configure the TestKit with a mocked in-memory filesystem for git ingestion testing. Each key is a file path and each value is the file content.
func WithHandlerFunc ¶ added in v0.2.0
func WithHandlerFunc(hf http.HandlerFunc) Option
WithHandlerFunc is a functional option to configure the TestKit to use a specific Handler
type TestKit ¶
type TestKit struct {
// contains filtered or unexported fields
}
TestKit implements a set of interfaces for testing purposes. e.g. for testing rule types.
func (*TestKit) CanImplement ¶
func (*TestKit) CanImplement(_ minderv1.ProviderType) bool
CanImplement implements the Provider interface. It returns true since we don't have any restrictions on the provider.
func (*TestKit) Clone ¶
Clone implements the Git interface. TestKit relies on fakeGit and Ingest for filesystem operations.
func (*TestKit) CreationOptions ¶ added in v0.1.2
func (*TestKit) CreationOptions(_ minderv1.Entity) *provv1.EntityCreationOptions
CreationOptions implements the Provider interface.
func (*TestKit) DeregisterEntity ¶
func (*TestKit) DeregisterEntity(_ context.Context, _ minderv1.Entity, _ *properties.Properties) error
DeregisterEntity implements the Provider interface.
func (*TestKit) FetchAllProperties ¶
func (*TestKit) FetchAllProperties( _ context.Context, _ *properties.Properties, _ minderv1.Entity, _ *properties.Properties, ) (*properties.Properties, error)
FetchAllProperties implements the Provider interface.
func (*TestKit) FetchProperty ¶
func (*TestKit) FetchProperty( _ context.Context, _ *properties.Properties, _ minderv1.Entity, _ string) (*properties.Property, error)
FetchProperty implements the Provider interface.
func (*TestKit) GetBaseURL ¶
GetBaseURL implements the REST interface.
func (*TestKit) GetConfig ¶
func (*TestKit) GetConfig() protoreflect.ProtoMessage
GetConfig returns the config for the ingester
func (*TestKit) GetEntityName ¶
func (*TestKit) GetEntityName(_ minderv1.Entity, _ *properties.Properties) (string, error)
GetEntityName implements the Provider interface.
func (*TestKit) Ingest ¶
func (tk *TestKit) Ingest( ctx context.Context, ent protoreflect.ProtoMessage, params map[string]any, ) (*interfaces.Ingested, error)
Ingest is a stub implementation of the ingester
func (*TestKit) NewRequest ¶
NewRequest implements the REST interface.
func (*TestKit) PropertiesToProtoMessage ¶
func (*TestKit) PropertiesToProtoMessage(_ minderv1.Entity, _ *properties.Properties) (protoreflect.ProtoMessage, error)
PropertiesToProtoMessage implements the Provider interface.
func (*TestKit) ProviderClassInfo ¶ added in v0.2.0
func (*TestKit) ProviderClassInfo() *minderv1.ProviderClassInfo
ProviderClassInfo implements the Provider interface.
func (*TestKit) RegisterEntity ¶
func (*TestKit) RegisterEntity(_ context.Context, _ minderv1.Entity, props *properties.Properties, ) (*properties.Properties, error)
RegisterEntity implements the Provider interface.
func (*TestKit) ShouldOverrideIngest ¶
ShouldOverrideIngest returns true if the ingester should override the ingest
type VoidResultSink ¶
type VoidResultSink struct{}
VoidResultSink is a result sink that does nothing
func NewVoidResultSink ¶
func NewVoidResultSink() *VoidResultSink
NewVoidResultSink creates a new void result sink
func (VoidResultSink) SetIngestResult ¶
func (VoidResultSink) SetIngestResult(_ *interfaces.Ingested)
SetIngestResult implements the ResultSink interface
Source Files