comptest

README

comptest

API will be unstable until major release.

The package aims to make component testing easier by providing a set of helper functions.

• Build binary from your code and run it
• Inject migrations with seed data
• Run migrations up and down
• Wait for database, mocks and main service to be ready
• Prepare and use gcp pubsub. Send messages to pubsub.

Quickstart

Get package

go get github.com/ingridhq/comptest

And start using it:

func TestMain(t *testing.M) {
	// Initialize comptest lib.

	ctx, cancel := context.WithTimeout(context.Background(), 40 * time.Second)
	defer cancel()

	c := comptest.New(ctx)

	c.HealthChecks(
		waitfor.TCP(os.Getenv("PUBSUB_EMULATOR_HOST")),
	)

	c.BuildAndRun("../main.go", waitfor.HTTP(fmt.Sprintf("http://%s/readiness", cfg.ReadinessPort)))

	t.Run()
}

func Test_response(t *testing.T) {
	resp, _ := http.Get("http://localhost:8080/")

	if resp.StatusCode != http.StatusOK {
		t.Fatalf("unexpected status code : %v", resp.StatusCode)
	}
}

Full example can be found in _example directory. There you will learn how to use most of the package's functionality. You can run it with make.

---

Read more

You can read more about component testing here:

• https://tech.ingrid.com/component-testing/

Documentation

Index

• func CreateGRPCConn(addr string) (*grpc.ClientConn, error)
• func MustCreateGRPCConn(addr string) *grpc.ClientConn
• func MustStartGRPCServer(addr string, regFn func(s *grpc.Server))
• func New(ctx context.Context) *comptest
• func PubsubMessageToProtoMessage(m *pubsub.Message) (ptypes.DynamicAny, error)
• type CleanupFunc

Functions

func CreateGRPCConn

func CreateGRPCConn(addr string) (*grpc.ClientConn, error)

CreateGRPCConn will create grpc conn with disabled TLS.

func MustCreateGRPCConn

func MustCreateGRPCConn(addr string) *grpc.ClientConn

func MustStartGRPCServer

func MustStartGRPCServer(addr string, regFn func(s *grpc.Server))

MustStartGRPCServer will register and start grpc server.

func New

func New(ctx context.Context) *comptest

New create new comptests suite.

func PubsubMessageToProtoMessage

func PubsubMessageToProtoMessage(m *pubsub.Message) (ptypes.DynamicAny, error)

Types

type CleanupFunc

type CleanupFunc func()