integration

Integration

Integration is a golang library for running integration tests on the local machine and in the Gitlab pipelines. It is responsible for creating spanner emulator as a docker container and it runs provided gRPC server in the background.

Installation

go get gitlab.com/picnic-app/backend/libs/golang/integration@<branch-name/tag>

Getting started

This project includes a Makefile that allows you to test and build the project with simple commands. To see all available options:

make help

Usage

func TestSomething(t *testing.T) {
	ctx := context.Background()
	client := integration.GetGrpcClient(t, v1.NewBlacklistAPIServiceClient)

	_, err := client.Upsert(ctx, &v1.UpsertRequest{
		Id: getRandomString(),
	})

	assert.Error(t, err)
	code, ok := status.FromError(err)
	assert.True(t, ok)
	assert.Equal(t, codes.NotFound, code.Code())
}

func TestMain(m *testing.M) {
	ctx := context.Background()
	// First we should create emulator config.
	// The names of project/instance/database can be random.
	emulatorConfig := integration.EmulatorConfig{
		Project:  "test-project",
		Instance: "test-instance",
		Database: "test-database",
	}

	// Next we should run Setup method which creates emulator as a docker container and 
	// it runs specified func(context.Context, *grpc.Server) in the background.
	emulator, err := integration.Setup(ctx, emulatorConfig, func(ctx context.Context, server *grpc.Server) {
		client, err := repository.NewSpannerClient(ctx, emulatorConfig.URI(), "")
		if err != nil {
			log.Fatalf("Could not create new Spanner client: %v", err)
		}

		svc := handlers.NewGrpcServer(repository.NewSpannerRepository(client))
		v1.RegisterBlacklistAPIServiceServer(server, svc)
	})
	if err != nil {
		log.Fatalf("Could not set up testing environment: %v", err)
	}

	// We should remember about destroying the emulator container.
	defer func() {
		_ = emulator.Terminate(ctx)
	}()

	os.Exit(m.Run())
}