tests

Documentation

Index

• func StartServer(t testing.TB, cfg *serverconfig.Config)
• func StartServerWithContext(t testing.TB, cfg *serverconfig.Config, serverCtx *run.ServerContext)
• type ClientInterface
  • func BuildClientInterface(t *testing.T, engine string, experimentals []string) ClientInterface
• type TestClientBootstrapper

Functions

func StartServer

func StartServer(t testing.TB, cfg *serverconfig.Config)

StartServer calls StartServerWithContext. See the docs for that.

func StartServerWithContext

func StartServerWithContext(t testing.TB, cfg *serverconfig.Config, serverCtx *run.ServerContext)

StartServerWithContext starts a server in random ports and with a specific ServerContext and waits until it is healthy. When the test ends, all resources are cleaned.

Types

type ClientInterface

type ClientInterface interface {
	TestClientBootstrapper
	Check(ctx context.Context, in *openfgav1.CheckRequest, opts ...grpc.CallOption) (*openfgav1.CheckResponse, error)
	ListUsers(ctx context.Context, in *openfgav1.ListUsersRequest, opts ...grpc.CallOption) (*openfgav1.ListUsersResponse, error)
	ListObjects(ctx context.Context, in *openfgav1.ListObjectsRequest, opts ...grpc.CallOption) (*openfgav1.ListObjectsResponse, error)
	StreamedListObjects(ctx context.Context, in *openfgav1.StreamedListObjectsRequest, opts ...grpc.CallOption) (openfgav1.OpenFGAService_StreamedListObjectsClient, error)
}

ClientInterface defines client interface for running tests.

func BuildClientInterface

func BuildClientInterface(t *testing.T, engine string, experimentals []string) ClientInterface

BuildClientInterface sets up test client interface to be used for matrix test.

type TestClientBootstrapper

type TestClientBootstrapper interface {
	CreateStore(ctx context.Context, in *openfgav1.CreateStoreRequest, opts ...grpc.CallOption) (*openfgav1.CreateStoreResponse, error)
	WriteAuthorizationModel(ctx context.Context, in *openfgav1.WriteAuthorizationModelRequest, opts ...grpc.CallOption) (*openfgav1.WriteAuthorizationModelResponse, error)
	Write(ctx context.Context, in *openfgav1.WriteRequest, opts ...grpc.CallOption) (*openfgav1.WriteResponse, error)
}

TestClientBootstrapper defines a client interface definition that can be used by tests to bootstrap OpenFGA resources (stores, models, relationship tuples, etc.), needed to execute tests.