Custom Deployment quality of life improvements (pass t, config) (matrix-org#778)

Spawning from a real use-case with a custom `Deployment`/`Deployer` (Element-internal). I think this is the first working example of a custom deployment so it makes sense that we ran into a couple oversights.

This PR introduces some quality of life for working with a custom `Deployment`. For reference, custom deployments were introduced in matrix-org#750.

 - Pass `t` to allow the custom deployment creation callback (`complement.WithDeployment(callback)`) to handle errors gracefully
 - Also pass in `complement.Config` so the custom Deployment can align behavior to what's configured

Author: MadLittleMods

internal/docker/builder.go

@@ -47,7 +47,10 @@ type Builder struct {
 }
 
 func NewBuilder(cfg *config.Complement) (*Builder, error) {
-	cli, err := client.NewEnvClient()
+	cli, err := client.NewClientWithOpts(
+		client.FromEnv,
+		client.WithAPIVersionNegotiation(),
+	)
 	if err != nil {
 		return nil, err
 	}

internal/docker/deployer.go

@@ -56,7 +56,10 @@ type Deployer struct {
 }
 
 func NewDeployer(deployNamespace string, cfg *config.Complement) (*Deployer, error) {
-	cli, err := client.NewEnvClient()
+	cli, err := client.NewClientWithOpts(
+		client.FromEnv,
+		client.WithAPIVersionNegotiation(),
+	)
 	if err != nil {
 		return nil, err
 	}

test_main.go

@@ -6,32 +6,40 @@ import (
 	"testing"
 
 	"github.com/matrix-org/complement/b"
+	"github.com/matrix-org/complement/config"
 	"github.com/matrix-org/complement/ct"
 )
 
 var (
 	testPackage    *TestPackage
-	customDeployer func(numServers int) Deployment
+	customDeployer func(t ct.TestLike, numServers int, config *config.Complement) Deployment
 )
 
 type complementOpts struct {
-	cleanup          func()
-	customDeployment func(numServers int) Deployment
+	// Args:
+	// - We pass in the Complement config (`testPackage.Config`) so the deployer can inspect
+	// `DebugLoggingEnabled`, `SpawnHSTimeout`, `PackageNamespace` etc.
+	cleanup func(config *config.Complement)
+	// Args:
+	// - We pass in `t` as there needs to be a way to handle an error in the custom deployer.
+	// - We pass in the Complement config (`testPackage.Config`) so the deployer can inspect
+	// `DebugLoggingEnabled`, `SpawnHSTimeout`, `PackageNamespace`, etc.
+	customDeployment func(t ct.TestLike, numServers int, config *config.Complement) Deployment
 }
 type opt func(*complementOpts)
 
 // WithCleanup adds a cleanup function which is called prior to terminating the test suite.
 // It is called BEFORE Complement containers are destroyed.
 // This function should be used for per-suite cleanup operations e.g tearing down containers, killing
 // child processes, etc.
-func WithCleanup(fn func()) opt {
+func WithCleanup(fn func(config *config.Complement)) opt {
 	return func(co *complementOpts) {
 		co.cleanup = fn
 	}
 }
 
 // WithDeployment adds a custom mechanism to deploy homeservers.
-func WithDeployment(fn func(numServers int) Deployment) opt {
+func WithDeployment(fn func(t ct.TestLike, numServers int, config *config.Complement) Deployment) opt {
 	return func(co *complementOpts) {
 		co.customDeployment = fn
 	}
@@ -64,7 +72,7 @@ func TestMain(m *testing.M, namespace string, customOpts ...opt) {
 	}
 	exitCode := m.Run()
 	if opts.cleanup != nil {
-		opts.cleanup()
+		opts.cleanup(testPackage.Config)
 	}
 	testPackage.Cleanup()
 	os.Exit(exitCode)
@@ -91,7 +99,7 @@ func Deploy(t ct.TestLike, numServers int) Deployment {
 		ct.Fatalf(t, "Deploy: testPackage not set, did you forget to call complement.TestMain?")
 	}
 	if customDeployer != nil {
-		return customDeployer(numServers)
+		return customDeployer(t, numServers, testPackage.Config)
 	}
 	return testPackage.Deploy(t, numServers)
 }