chore: use testcontainers

Author: miparnisari

cmd/spicedb/integration/migrate_integration_test.go

@@ -4,14 +4,17 @@ package integration_test
 
 import (
 	"bytes"
+	"context"
 	"fmt"
+	"io"
 	"slices"
+	"strings"
 	"testing"
 
 	"github.com/google/uuid"
-	"github.com/ory/dockertest/v3"
-	"github.com/ory/dockertest/v3/docker"
 	"github.com/stretchr/testify/require"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/network"
 
 	testdatastore "github.com/authzed/spicedb/internal/testserver/datastore"
 	"github.com/authzed/spicedb/pkg/datastore"
@@ -20,18 +23,14 @@ import (
 var toSkip = []string{"memory"}
 
 func TestMigrate(t *testing.T) {
+	ctx := context.Background()
 	bridgeNetworkName := fmt.Sprintf("bridge-%s", uuid.New().String())
 
-	pool, err := dockertest.NewPool("")
-	require.NoError(t, err)
-
 	// Create a bridge network for testing.
-	network, err := pool.Client.CreateNetwork(docker.CreateNetworkOptions{
-		Name: bridgeNetworkName,
-	})
+	net, err := network.New(ctx, network.WithDriver("bridge"), network.WithLabels(map[string]string{"name": bridgeNetworkName}))
 	require.NoError(t, err)
 	t.Cleanup(func() {
-		_ = pool.Client.RemoveNetwork(network.ID)
+		_ = net.Remove(ctx)
 	})
 
 	for _, engineKey := range datastore.Engines {
@@ -45,43 +44,43 @@ func TestMigrate(t *testing.T) {
 			r := testdatastore.RunDatastoreEngineWithBridge(t, engineKey, bridgeNetworkName)
 			db := r.NewDatabase(t)
 
-			envVars := []string{}
+			envVars := map[string]string{}
 			if wev, ok := r.(testdatastore.RunningEngineForTestWithEnvVars); ok {
-				envVars = wev.ExternalEnvVars()
+				for _, env := range wev.ExternalEnvVars() {
+					parts := strings.SplitN(env, "=", 2)
+					if len(parts) == 2 {
+						envVars[parts[0]] = parts[1]
+					}
+				}
 			}
 
 			// Run the migrate command and wait for it to complete.
-			resource, err := pool.RunWithOptions(&dockertest.RunOptions{
-				Repository: "authzed/spicedb",
-				Tag:        "ci",
-				Cmd:        []string{"migrate", "head", "--datastore-engine", engineKey, "--datastore-conn-uri", db},
-				NetworkID:  bridgeNetworkName,
-				Env:        envVars,
-			}, func(config *docker.HostConfig) {
-				config.RestartPolicy = docker.RestartPolicy{
-					Name: "no",
-				}
+			container, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+				ContainerRequest: testcontainers.ContainerRequest{
+					Image:    "authzed/spicedb:ci",
+					Cmd:      []string{"migrate", "head", "--datastore-engine", engineKey, "--datastore-conn-uri", db},
+					Networks: []string{bridgeNetworkName},
+					Env:      envVars,
+				},
+				Started: true,
 			})
 			require.NoError(t, err)
 			t.Cleanup(func() {
-				_ = pool.Purge(resource)
+				_ = container.Terminate(ctx)
 			})
 
 			// Ensure the command completed successfully.
-			status, err := pool.Client.WaitContainerWithContext(resource.Container.ID, t.Context())
+			state, err := container.State(ctx)
 			require.NoError(t, err)
 
-			if status != 0 {
+			if state.ExitCode != 0 {
 				stream := new(bytes.Buffer)
 
-				lerr := pool.Client.Logs(docker.LogsOptions{
-					Context:      t.Context(),
-					OutputStream: stream,
-					ErrorStream:  stream,
-					Stdout:       true,
-					Stderr:       true,
-					Container:    resource.Container.ID,
-				})
+				logReader, lerr := container.Logs(ctx)
+				require.NoError(t, lerr)
+				defer logReader.Close()
+
+				_, lerr = io.Copy(stream, logReader)
 				require.NoError(t, lerr)
 
 				require.Fail(t, "Got non-zero exit code", stream.String())

cmd/spicedb/integration/restgateway_integration_test.go

@@ -8,17 +8,16 @@ import (
 	"net/http"
 	"testing"
 
-	"github.com/ory/dockertest/v3"
 	"github.com/stretchr/testify/require"
+	"github.com/testcontainers/testcontainers-go"
 )
 
 func TestRESTGateway(t *testing.T) {
 	require := require.New(t)
 
 	tester, err := newTester(t,
-		&dockertest.RunOptions{
-			Repository:   "authzed/spicedb",
-			Tag:          "ci",
+		testcontainers.ContainerRequest{
+			Image:        "authzed/spicedb:ci",
 			Cmd:          []string{"serve", "--log-level", "debug", "--grpc-preshared-key", "somerandomkeyhere", "--http-enabled"},
 			ExposedPorts: []string{"50051/tcp", "8443/tcp"},
 		},

cmd/spicedb/integration/schemawatch_integration_test.go

@@ -5,14 +5,16 @@ package integration_test
 import (
 	"context"
 	"fmt"
+	"io"
+	"strings"
 	"testing"
 	"time"
 
 	"github.com/google/uuid"
-	"github.com/ory/dockertest/v3"
-	"github.com/ory/dockertest/v3/docker"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"github.com/testcontainers/testcontainers-go"
+	"github.com/testcontainers/testcontainers-go/network"
 
 	testdatastore "github.com/authzed/spicedb/internal/testserver/datastore"
 	"github.com/authzed/spicedb/pkg/datastore"
@@ -33,83 +35,75 @@ func TestSchemaWatch(t *testing.T) {
 		}
 
 		t.Run(driverName, func(t *testing.T) {
+			ctx := context.Background()
 			bridgeNetworkName := fmt.Sprintf("bridge-%s", uuid.New().String())
 
-			pool, err := dockertest.NewPool("")
-			require.NoError(t, err)
-
 			// Create a bridge network for testing.
-			network, err := pool.Client.CreateNetwork(docker.CreateNetworkOptions{
-				Name: bridgeNetworkName,
-			})
+			net, err := network.New(ctx, network.WithDriver("bridge"), network.WithLabels(map[string]string{"name": bridgeNetworkName}))
 			require.NoError(t, err)
 			t.Cleanup(func() {
-				_ = pool.Client.RemoveNetwork(network.ID)
+				_ = net.Remove(ctx)
 			})
 
 			engine := testdatastore.RunDatastoreEngineWithBridge(t, driverName, bridgeNetworkName)
 
-			envVars := []string{}
+			envVars := map[string]string{}
 			if wev, ok := engine.(testdatastore.RunningEngineForTestWithEnvVars); ok {
-				envVars = wev.ExternalEnvVars()
+				for _, env := range wev.ExternalEnvVars() {
+					parts := strings.SplitN(env, "=", 2)
+					if len(parts) == 2 {
+						envVars[parts[0]] = parts[1]
+					}
+				}
 			}
 
 			// Run the migrate command and wait for it to complete.
 			db := engine.NewDatabase(t)
-			migrateResource, err := pool.RunWithOptions(&dockertest.RunOptions{
-				Repository: "authzed/spicedb",
-				Tag:        "ci",
-				Cmd:        []string{"migrate", "head", "--datastore-engine", driverName, "--datastore-conn-uri", db},
-				NetworkID:  bridgeNetworkName,
-				Env:        envVars,
-			}, func(config *docker.HostConfig) {
-				config.RestartPolicy = docker.RestartPolicy{
-					Name: "no",
-				}
+			migrateContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+				ContainerRequest: testcontainers.ContainerRequest{
+					Image:    "authzed/spicedb:ci",
+					Cmd:      []string{"migrate", "head", "--datastore-engine", driverName, "--datastore-conn-uri", db},
+					Networks: []string{bridgeNetworkName},
+					Env:      envVars,
+				},
+				Started: true,
 			})
 			require.NoError(t, err)
 			t.Cleanup(func() {
-				_ = pool.Purge(migrateResource)
+				_ = migrateContainer.Terminate(ctx)
 			})
 
 			// Ensure the command completed successfully.
-			status, err := pool.Client.WaitContainerWithContext(migrateResource.Container.ID, t.Context())
+			exitCode, err := migrateContainer.State(ctx)
 			require.NoError(t, err)
-			require.Equal(t, 0, status)
+			require.Equal(t, 0, exitCode.ExitCode)
 
 			// Run a serve and immediately close, ensuring it shuts down gracefully.
-			serveResource, err := pool.RunWithOptions(&dockertest.RunOptions{
-				Repository: "authzed/spicedb",
-				Tag:        "ci",
-				Cmd:        []string{"serve", "--grpc-preshared-key", "firstkey", "--datastore-engine", driverName, "--datastore-conn-uri", db, "--datastore-gc-interval", "1s", "--telemetry-endpoint", "", "--log-level", "trace", "--enable-experimental-watchable-schema-cache"},
-				NetworkID:  bridgeNetworkName,
-				Env:        envVars,
-			}, func(config *docker.HostConfig) {
-				config.RestartPolicy = docker.RestartPolicy{
-					Name: "no",
-				}
+			serveContainer, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
+				ContainerRequest: testcontainers.ContainerRequest{
+					Image:    "authzed/spicedb:ci",
+					Cmd:      []string{"serve", "--grpc-preshared-key", "firstkey", "--datastore-engine", driverName, "--datastore-conn-uri", db, "--datastore-gc-interval", "1s", "--telemetry-endpoint", "", "--log-level", "trace", "--enable-experimental-watchable-schema-cache"},
+					Networks: []string{bridgeNetworkName},
+					Env:      envVars,
+				},
+				Started: true,
 			})
 			require.NoError(t, err)
 			t.Cleanup(func() {
-				_ = pool.Purge(serveResource)
+				_ = serveContainer.Terminate(ctx)
 			})
 
 			ww := &watchingWriter{make(chan bool, 1), "starting watching cache"}
 
-			// Grab logs and ensure GC has run before starting a graceful shutdown.
-			opts := docker.LogsOptions{
-				Context:      context.Background(),
-				Stderr:       true,
-				Stdout:       true,
-				Follow:       true,
-				Timestamps:   true,
-				RawTerminal:  true,
-				Container:    serveResource.Container.ID,
-				OutputStream: ww,
-			}
-
+			// Grab logs and ensure schema watch has started before graceful shutdown.
 			go (func() {
-				err = pool.Client.Logs(opts)
+				logReader, err := serveContainer.Logs(ctx)
+				if err != nil {
+					assert.NoError(t, err)
+					return
+				}
+				defer logReader.Close()
+				_, err = io.Copy(ww, logReader)
 				assert.NoError(t, err)
 			})()
 
@@ -121,7 +115,7 @@ func TestSchemaWatch(t *testing.T) {
 				require.Fail(t, "timed out waiting for schema watch to run")
 			}
 
-			require.True(t, gracefulShutdown(pool, serveResource))
+			require.True(t, gracefulShutdown(ctx, serveContainer))
 		})
 	}
 }