chore: run tests on windows workers

.gitattributes

@@ -0,0 +1 @@
+*.sh text eol=lf

.github/workflows/ci-test-go.yml

@@ -37,6 +37,9 @@ on:
         type: boolean
         default: false
         description: "Disable the ryuk container for the test."
+    secrets:
+      TC_CLOUD_TOKEN:
+        required: true
 
 permissions:
   contents: read
@@ -92,15 +95,18 @@ jobs:
         working-directory: ./${{ inputs.project-directory }}
         run: make tools-tidy
 
+      - name: Setup Testcontainers Cloud Client
+        # Use Testcontainers Cloud for Windows and MacOS, but only for merge commits on main
+        if: ${{ inputs.run-tests && (inputs.platform == 'windows-latest' || inputs.platform == 'macos-latest') }}
+        uses: atomicjar/testcontainers-cloud-setup-action@v1
+        with:
+          token: ${{ secrets.TC_CLOUD_TOKEN }}
+
       - name: ensure compilation
         working-directory: ./${{ inputs.project-directory }}
         run: go build
 
       - name: go test
-        # only run tests on linux, there are a number of things that won't allow the tests to run on anything else
-        # many (maybe, all?) images used can only be build on Linux, they don't have Windows in their manifest, and
-        # we can't put Windows Server in "Linux Mode" in Github actions
-        # another, host mode is only available on Linux, and we have tests around that, do we skip them?
         if: ${{ inputs.run-tests }}
         working-directory: ./${{ inputs.project-directory }}
         timeout-minutes: 30

.github/workflows/ci.yml

@@ -27,15 +27,16 @@ jobs:
     strategy:
       matrix:
         go-version: [1.21.x, 1.x]
-        platform: [ubuntu-latest, macos-latest]
+        platform: [ubuntu-latest, macos-latest, windows-latest]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
       platform: ${{ matrix.platform }}
       project-directory: "."
       rootless-docker: false
-      run-tests: ${{ matrix.platform == 'ubuntu-latest' }}
+      run-tests: true
       ryuk-disabled: false
 
   # The job below is a copy of the job above, but with ryuk disabled.
@@ -46,6 +47,7 @@ jobs:
       matrix:
         go-version: [1.21.x, 1.x]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: false
@@ -64,6 +66,7 @@ jobs:
         go-version: [1.21.x, 1.x]
         platform: [ubuntu-latest]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: false
@@ -79,6 +82,7 @@ jobs:
         go-version: [1.21.x, 1.x]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: true
@@ -96,6 +100,7 @@ jobs:
         platform: [ubuntu-latest]
         module: [artemis, cassandra, chroma, clickhouse, cockroachdb, compose, consul, couchbase, elasticsearch, gcloud, inbucket, influxdb, k3s, k6, kafka, localstack, mariadb, milvus, minio, mockserver, mongodb, mssql, mysql, nats, neo4j, ollama, openfga, openldap, opensearch, postgres, pulsar, qdrant, rabbitmq, redis, redpanda, registry, surrealdb, vault, weaviate]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: ${{ matrix.go-version }}
       fail-fast: false
@@ -111,6 +116,7 @@ jobs:
       matrix:
         module: [nginx, toxiproxy]
     uses: ./.github/workflows/ci-test-go.yml
+    secrets: inherit
     with:
       go-version: "1.21.x"
       fail-fast: true

config_test.go

@@ -25,21 +25,13 @@ func TestReadConfig(t *testing.T) {
 	t.Run("Config is read just once", func(t *testing.T) {
 		t.Setenv("HOME", "")
 		t.Setenv("USERPROFILE", "") // Windows support
-		t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "true")
-
-		cfg := testcontainers.ReadConfig()
-
-		expected := testcontainers.TestcontainersConfig{
-			RyukDisabled: true,
-			Config: config.Config{
-				RyukDisabled: true,
-			},
-		}
 
-		assert.Equal(t, expected, cfg)
+		t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "true")
+		cfg1 := testcontainers.ReadConfig()
 
 		t.Setenv("TESTCONTAINERS_RYUK_DISABLED", "false")
-		cfg = testcontainers.ReadConfig()
-		assert.Equal(t, expected, cfg)
+		cfg2 := testcontainers.ReadConfig()
+
+		assert.Equal(t, cfg1, cfg2)
 	})
 }

docker_auth_test.go

@@ -26,137 +26,152 @@ var indexDockerIO = core.IndexDockerIO
 func TestGetDockerConfig(t *testing.T) {
 	const expectedErrorMessage = "Expected to find %s in auth configs"
 
+	t.Setenv("DOCKER_CONFIG", t.TempDir())
+
 	// Verify that the default docker config file exists before any test in this suite runs.
-	// Then, we can safely run the tests that rely on it.
+	// Then, we can safely run the tests that rely on it. If it does not exist, we create it
+	// using the content of the testdata/.docker/config.json file into a temporary directory.
 	defaultCfg, err := dockercfg.LoadDefaultConfig()
-	require.NoError(t, err)
-	require.NotEmpty(t, defaultCfg)
+	if err != nil {
+		// create docker config file
+		bs, err := os.ReadFile(filepath.Join(testDockerConfigDirPath, "config.json"))
+		require.NoError(t, err)
 
-	t.Run("without DOCKER_CONFIG env var retrieves default", func(t *testing.T) {
-		t.Setenv("DOCKER_CONFIG", "")
+		defaultCfgPath, err := dockercfg.ConfigPath()
+		require.NoError(t, err)
 
-		cfg, err := getDockerConfig()
+		// write file to default location
+		err = os.WriteFile(defaultCfgPath, bs, 0644)
 		require.NoError(t, err)
-		require.NotEmpty(t, cfg)
 
-		assert.Equal(t, defaultCfg, cfg)
+		defaultCfg, err = dockercfg.LoadDefaultConfig()
+		require.NoError(t, err)
+	}
+	require.NotEmpty(t, defaultCfg)
+
+	t.Run("without DOCKER_CONFIG env var retrieves default", func(tt *testing.T) {
+		cfg, err := getDockerConfig()
+		require.NoError(tt, err)
+		require.NotEmpty(tt, cfg)
+
+		assert.Equal(tt, defaultCfg, cfg)
 	})
 
-	t.Run("with DOCKER_CONFIG env var pointing to a non-existing file raises error", func(t *testing.T) {
-		t.Setenv("DOCKER_CONFIG", filepath.Join(testDockerConfigDirPath, "non-existing"))
+	t.Run("with DOCKER_CONFIG env var pointing to a non-existing file raises error", func(tt *testing.T) {
+		tt.Setenv("DOCKER_CONFIG", filepath.Join(testDockerConfigDirPath, "non-existing"))
 
 		cfg, err := getDockerConfig()
-		require.Error(t, err)
-		require.Empty(t, cfg)
+		require.Error(tt, err)
+		require.Empty(tt, cfg)
 	})
 
-	t.Run("with DOCKER_CONFIG env var", func(t *testing.T) {
-		t.Setenv("DOCKER_CONFIG", testDockerConfigDirPath)
+	t.Run("with DOCKER_CONFIG env var", func(tt *testing.T) {
+		tt.Setenv("DOCKER_CONFIG", testDockerConfigDirPath)
 
 		cfg, err := getDockerConfig()
-		require.NoError(t, err)
-		require.NotEmpty(t, cfg)
+		require.NoError(tt, err)
+		require.NotEmpty(tt, cfg)
 
-		assert.Len(t, cfg.AuthConfigs, 3)
+		assert.Len(tt, cfg.AuthConfigs, 3)
 
 		authCfgs := cfg.AuthConfigs
 
 		if _, ok := authCfgs[indexDockerIO]; !ok {
-			t.Errorf(expectedErrorMessage, indexDockerIO)
+			tt.Errorf(expectedErrorMessage, indexDockerIO)
 		}
 		if _, ok := authCfgs["https://example.com"]; !ok {
-			t.Errorf(expectedErrorMessage, "https://example.com")
+			tt.Errorf(expectedErrorMessage, "https://example.com")
 		}
 		if _, ok := authCfgs["https://my.private.registry"]; !ok {
-			t.Errorf(expectedErrorMessage, "https://my.private.registry")
+			tt.Errorf(expectedErrorMessage, "https://my.private.registry")
 		}
 	})
 
-	t.Run("DOCKER_AUTH_CONFIG env var takes precedence", func(t *testing.T) {
-		t.Setenv("DOCKER_AUTH_CONFIG", `{
+	t.Run("DOCKER_AUTH_CONFIG env var takes precedence", func(tt *testing.T) {
+		tt.Setenv("DOCKER_AUTH_CONFIG", `{
 			"auths": {
 					"`+exampleAuth+`": {}
 			},
 			"credsStore": "desktop"
 		}`)
-		t.Setenv("DOCKER_CONFIG", testDockerConfigDirPath)
+		tt.Setenv("DOCKER_CONFIG", testDockerConfigDirPath)
 
 		cfg, err := getDockerConfig()
-		require.NoError(t, err)
-		require.NotEmpty(t, cfg)
+		require.NoError(tt, err)
+		require.NotEmpty(tt, cfg)
 
-		assert.Len(t, cfg.AuthConfigs, 1)
+		assert.Len(tt, cfg.AuthConfigs, 1)
 
 		authCfgs := cfg.AuthConfigs
 
 		if _, ok := authCfgs[indexDockerIO]; ok {
-			t.Errorf("Not expected to find %s in auth configs", indexDockerIO)
+			tt.Errorf("Not expected to find %s in auth configs", indexDockerIO)
 		}
 		if _, ok := authCfgs[exampleAuth]; !ok {
-			t.Errorf(expectedErrorMessage, exampleAuth)
+			tt.Errorf(expectedErrorMessage, exampleAuth)
 		}
 	})
 
-	t.Run("retrieve auth with DOCKER_AUTH_CONFIG env var", func(t *testing.T) {
+	t.Run("retrieve auth with DOCKER_AUTH_CONFIG env var", func(tt *testing.T) {
 		base64 := "Z29waGVyOnNlY3JldA==" // gopher:secret
 
-		t.Setenv("DOCKER_AUTH_CONFIG", `{
+		tt.Setenv("DOCKER_AUTH_CONFIG", `{
 			"auths": {
 					"`+exampleAuth+`": { "username": "gopher", "password": "secret", "auth": "`+base64+`" }
 			},
 			"credsStore": "desktop"
 		}`)
 
 		registry, cfg, err := DockerImageAuth(context.Background(), exampleAuth+"/my/image:latest")
-		require.NoError(t, err)
-		require.NotEmpty(t, cfg)
+		require.NoError(tt, err)
+		require.NotEmpty(tt, cfg)
 
-		assert.Equal(t, exampleAuth, registry)
-		assert.Equal(t, "gopher", cfg.Username)
-		assert.Equal(t, "secret", cfg.Password)
-		assert.Equal(t, base64, cfg.Auth)
+		assert.Equal(tt, exampleAuth, registry)
+		assert.Equal(tt, "gopher", cfg.Username)
+		assert.Equal(tt, "secret", cfg.Password)
+		assert.Equal(tt, base64, cfg.Auth)
 	})
 
-	t.Run("match registry authentication by host", func(t *testing.T) {
+	t.Run("match registry authentication by host", func(tt *testing.T) {
 		base64 := "Z29waGVyOnNlY3JldA==" // gopher:secret
 		imageReg := "example-auth.com"
 		imagePath := "/my/image:latest"
 
-		t.Setenv("DOCKER_AUTH_CONFIG", `{
+		tt.Setenv("DOCKER_AUTH_CONFIG", `{
 			"auths": {
 					"`+exampleAuth+`": { "username": "gopher", "password": "secret", "auth": "`+base64+`" }
 			},
 			"credsStore": "desktop"
 		}`)
 
 		registry, cfg, err := DockerImageAuth(context.Background(), imageReg+imagePath)
-		require.NoError(t, err)
-		require.NotEmpty(t, cfg)
+		require.NoError(tt, err)
+		require.NotEmpty(tt, cfg)
 
-		assert.Equal(t, imageReg, registry)
-		assert.Equal(t, "gopher", cfg.Username)
-		assert.Equal(t, "secret", cfg.Password)
-		assert.Equal(t, base64, cfg.Auth)
+		assert.Equal(tt, imageReg, registry)
+		assert.Equal(tt, "gopher", cfg.Username)
+		assert.Equal(tt, "secret", cfg.Password)
+		assert.Equal(tt, base64, cfg.Auth)
 	})
 
-	t.Run("fail to match registry authentication due to invalid host", func(t *testing.T) {
+	t.Run("fail to match registry authentication due to invalid host", func(tt *testing.T) {
 		base64 := "Z29waGVyOnNlY3JldA==" // gopher:secret
 		imageReg := "example-auth.com"
 		imagePath := "/my/image:latest"
 		invalidRegistryURL := "://invalid-host"
 
-		t.Setenv("DOCKER_AUTH_CONFIG", `{
+		tt.Setenv("DOCKER_AUTH_CONFIG", `{
 			"auths": {
 					"`+invalidRegistryURL+`": { "username": "gopher", "password": "secret", "auth": "`+base64+`" }
 			},
 			"credsStore": "desktop"
 		}`)
 
 		registry, cfg, err := DockerImageAuth(context.Background(), imageReg+imagePath)
-		require.Equal(t, err, dockercfg.ErrCredentialsNotFound)
-		require.Empty(t, cfg)
+		require.Equal(tt, err, dockercfg.ErrCredentialsNotFound)
+		require.Empty(tt, cfg)
 
-		assert.Equal(t, imageReg, registry)
+		assert.Equal(tt, imageReg, registry)
 	})
 }
 

docker_client_test.go

@@ -13,6 +13,10 @@ func TestGetDockerInfo(t *testing.T) {
 		ctx := context.Background()
 		c, err := NewDockerClientWithOpts(ctx)
 		require.NoError(t, err)
+		t.Cleanup(func() {
+			err := c.Close()
+			require.NoError(t, err)
+		})
 
 		info, err := c.Info(ctx)
 		require.NoError(t, err)
@@ -23,6 +27,10 @@ func TestGetDockerInfo(t *testing.T) {
 		ctx := context.Background()
 		c, err := NewDockerClientWithOpts(ctx)
 		require.NoError(t, err)
+		t.Cleanup(func() {
+			err := c.Close()
+			require.NoError(t, err)
+		})
 
 		count := 1024
 		wg := sync.WaitGroup{}