break: return error from Customize request option (testcontainers#2267)

* chore!: return error from Customize

Change ContainerCustomizer.Customize method to return an error so that
options can handle errors gracefully instead of relying on panic or just
a log entry, neither of which are user friendly.

Enable errcheck linter to ensure that errors that aren't handled are
reported.

Run go mod tidy on k3s and weaviate to allow tests to be run using go
1.22.

Run gofumpt on a few files to satisfy golangci-lint.

Fix direct comparison with http.ErrServerClosed flagged by errcheck.

Fixes testcontainers#2266

BREAKING CHANGE: `ContainerCustomizer.Customize` now returns an error.

* fix(mongodb): captured loop variable

Fix captured loop variable in mongodb test reported by govet.

* fix(k3s): test formatting

Fix formatting in test file reported by gci during linting.

* chore: add missing Customize error returns

Add missing error returns for implementations of CustomizeRequestOption.

* chore: update modules with the new error API

* fix: use logger

* fix: update modulegen tests

* chore: fix lint

* chore: handle customise errors

* chore: update new host port access option

* docs: move new error API to the right doc

* docs: move customise request to the bottom

* docs: sync functional options

* chore: avoid panics in localstack

* chore: require no error in test

* chore: ignore error in copy API, using nolint:errcheck

* chore: convert log into error

---------

Co-authored-by: Manuel de la Peña <mdelapenya@gmail.com>

Author: stevenh

mongodb.go

@@ -36,7 +36,9 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 	}
 
 	for _, opt := range opts {
-		opt.Customize(&genericContainerReq)
+		if err := opt.Customize(&genericContainerReq); err != nil {
+			return nil, err
+		}
 	}
 	username := req.Env["MONGO_INITDB_ROOT_USERNAME"]
 	password := req.Env["MONGO_INITDB_ROOT_PASSWORD"]
@@ -59,17 +61,21 @@ func RunContainer(ctx context.Context, opts ...testcontainers.ContainerCustomize
 // It is used in conjunction with WithPassword to set a username and its password.
 // It will create the specified user with superuser power.
 func WithUsername(username string) testcontainers.CustomizeRequestOption {
-	return func(req *testcontainers.GenericContainerRequest) {
+	return func(req *testcontainers.GenericContainerRequest) error {
 		req.Env["MONGO_INITDB_ROOT_USERNAME"] = username
+
+		return nil
 	}
 }
 
 // WithPassword sets the initial password of the user to be created when the container starts
 // It is used in conjunction with WithUsername to set a username and its password.
 // It will set the superuser password for MongoDB.
 func WithPassword(password string) testcontainers.CustomizeRequestOption {
-	return func(req *testcontainers.GenericContainerRequest) {
+	return func(req *testcontainers.GenericContainerRequest) error {
 		req.Env["MONGO_INITDB_ROOT_PASSWORD"] = password
+
+		return nil
 	}
 }
 

mongodb_test.go

@@ -33,12 +33,13 @@ func TestMongoDB(t *testing.T) {
 	}
 
 	for _, tc := range testCases {
-		t.Run(tc.image, func(t *testing.T) {
+		image := tc.image
+		t.Run(image, func(t *testing.T) {
 			t.Parallel()
 
 			ctx := context.Background()
 
-			mongodbContainer, err := mongodb.RunContainer(ctx, testcontainers.WithImage(tc.image))
+			mongodbContainer, err := mongodb.RunContainer(ctx, testcontainers.WithImage(image))
 			if err != nil {
 				t.Fatalf("failed to start container: %s", err)
 			}