chore: run tests on windows workers #2449

mdelapenya · 2024-03-26T09:44:54Z

What does this PR do?

In order to make testcontainers-go works on Windows, bringing Windows workers to the CI, this PR does the following:

standardises the docker image for bash in tests, from latest to a pinned version (5.2.26)
sets the gitatributes to avoid the CRLF conversion when cloning the repository in Windows
cleans up config test cases simplifying them, as they were testing too much
defers the closing of the Docker client in some tests, to avoid a leak
leverages the container lifecycle to create files in the CopyFile tests
removes the context with timeout in the CopyFile tests, as it was not needed
skips tests using host network mode, as it's not supported in Windows
enhances the test for reusing container in subprocess, as it was not using the right Docker socket
cleans up the way the default docker socket and docker socket scheme is calculated when the library is bootstrapped
removes an internal constant that was adding complexity. Instead we add two other variables to make the code more readable
extracts the checks for the Docker socket to a helper function that is testable. This allows to test the logic for the default Docker socket.It will use the Docker client infrastructure to get the correct path:
- If the Docker client is running in a local Docker host, it will return "/var/run/docker.sock" on Unix, or "//./pipe/docker_engine" on Windows.
- If the Docker client is running in Docker Desktop, it will return "/var/run/docker.sock" on Unix, or "//./pipe/docker_engine" on Windows.
- If the Docker client is running in a remote Docker host, it will return "/var/run/docker.sock" on Unix, or "//var/run/docker.sock" on Windows.
- If the Docker client is running in a rootless Docker, it will return the proper path depending on the rootless Docker configuration. Not available for windows.
- If the Docker info cannot be retrieved, the program will panic.
extends the mock for the Docker client to include the OSType and infoErr fields. They will allow reproduce the different scenarios in the tests to cover the calculation of the default Docker socket
adds unit tests for the default Docker socket calculation, leveraging the above mock
skips tests that are flaky in Windows
do not default to the bridge driver when creating a network, instead letting the docker client decide
runs the core library tests (not the modules) for pull requests only on ubuntu, and on all platforms (Windows, MacOS and Ubuntu) for merge commits on main.
uses Testcontainers Cloud GH action for running the core library tests (not the modules) on Windows and MacOS, but only for merge commits on main.
it updates the Docker auth tests to create a default config.json file if it does not exist. We discovered that GH actions MacOS workers don't have that file created.

Why is it important?

Run tests on more platforms, verifying the library works on other OSs. It also "dogfoods" the usage of Testcontainers Cloud for the non-linux tests on CI.

Related issues

Closes chore: run tests on windows workers #2398

* main: feat: add module to support InfluxDB v1.x (#1703) feat: authenticate docker on PullImage (#2446) feat: add distribution-registry module (#2341) chore(deps): Bumping ChromaGo client version (#2402) chore(deps): bump github.com/docker/docker from 25.0.3+incompatible to 25.0.5+incompatible (#2444) feat: support passing io.Reader as ContainerFile (#2401)

a Please enter the commit message for your changes. Lines starting

netlify · 2024-03-26T09:45:10Z

✅ Deploy Preview for testcontainers-go ready!

Name	Link
🔨 Latest commit	`6e468bc`
🔍 Latest deploy log	https://app.netlify.com/sites/testcontainers-go/deploys/66044f3c810f0e0008d45dd5
😎 Deploy Preview	https://deploy-preview-2449--testcontainers-go.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

This reverts commit 10ea4dd.

Let the Docker client to choose

Windows could be slower, and I do not see a real reason to timeout in these tests

When this repo is cloned on a Windows machine, the shell scripts will change its line ending settings

This reverts commit 19612a4.

This reverts commit 11905eb.

This reverts commit b50dbd9.

This reverts commit d874b4b.

This reverts commit a46f5db.

mdelapenya · 2024-03-27T10:33:26Z

internal/core/docker_socket_test.go

+		checkDefaultDockerSocket(context.Background(), mockCli{infoErr: errors.New("info should panic")}, "")
+	})
+
+	t.Run("Local Docker on Unix", func(tt *testing.T) {


@kiview could you double check that these expectations are correct?

In Github Actions + MacOS workers, we detected it does not exist, causing the tests to file because the default config is not found

This reverts commit 853b194.

mdelapenya added 11 commits March 18, 2024 17:07

chore: run core on windows

b6785c6

revert: simplify pipeline

a46f5db

chore: do not use bridge driver on Windows

4045675

docs: document driver

ddb0d94

chore: convert to constant

27becea

chore: remove duplicated variable

c07b9ee

chore: do not expose windows constant

a989e10

revert: run only on windows workers

d874b4b

a Please enter the commit message for your changes. Lines starting

fix: always detect OS and Docker Server version

1c36f14

feat: run windows tests in Testcontainers Cloud

977c28a

mdelapenya requested a review from a team as a code owner March 26, 2024 09:44

mdelapenya added 17 commits March 26, 2024 12:18

chore: inherit secrets in the reusable workflow

0f263ef

chore: properly close docker client in tests

2da2575

chore: do not apply nat driver on tcc

e5652c3

chore: skip test for windows

10ea4dd

fix: use docker socket from testcontainers in subtests

82309e1

Revert "chore: skip test for windows"

2a497c2

This reverts commit 10ea4dd.

chore: skip provider test on windows

96a8ee7

chore: better config tests for single initialisation

17414f6

fix: proper cleanup of docker client in tests

0b6ef18

fix: do not set bridge as default network driver

8b76f65

Let the Docker client to choose

chore: check for remote host properly

50aa2b6

fix: use extracted socket

2f303a1

chore: simplify conditions

d56bb5e

fix: typo

75705b0

chore: extract docker socket path verification to a function

5a7e0e9

chore: add test for windows remote

7748feb

chore: skip host network tests on windows

4bf55ac

mdelapenya added 15 commits March 26, 2024 18:24

revert: log for errors

b50dbd9

chore: skip socket check tests

22c76de

fix: do not timeout in tests

efef173

Windows could be slower, and I do not see a real reason to timeout in these tests

chore: skip test on Windows

9c0d768

chore: use pinned bash image

dcd2737

revert: print container logs

11905eb

chore: leverage container lifecycle to create paths

db46e94

revert: use string

19612a4

chore: force LF line endings in Git

39c107d

When this repo is cloned on a Windows machine, the shell scripts will change its line ending settings

Revert "revert: use string"

07e2781

This reverts commit 19612a4.

Revert "revert: print container logs"

b8b7800

This reverts commit 11905eb.

Revert "revert: log for errors"

0c9736e

This reverts commit b50dbd9.

Revert "revert: run only on windows workers"

fe32906

This reverts commit d874b4b.

Revert "revert: simplify pipeline"

02ac372

This reverts commit a46f5db.

fix: update tests

8f93deb

mdelapenya commented Mar 27, 2024

View reviewed changes

mdelapenya added 14 commits March 27, 2024 11:56

chore: run core tests for PRs+Ubuntu or merge-commits+all platforms

e8ac173

revert: force always running tests

b142495

fix: bring back removed modules

37463ff

fix: pass secrets to reusable workflows

7acaea8

chore: proper calculation of rootless socket

8a55ec3

fix: create a default docker config.json file if it does not exists

4756134

In Github Actions + MacOS workers, we detected it does not exist, causing the tests to file because the default config is not found

fix: update comment on rootless

05e52b6

chore: honour rootless socket path

70bd817

revert: log env for subprocess

51c2ceb

fix: use proper docker host in subprocess test

2c91259

chore: simplify test

20caafd

chore: initialise DockerSocketPath on init

853b194

Revert "chore: initialise DockerSocketPath on init"

0ed8418

This reverts commit 853b194.

fix: testcontainers socket override checks

6e468bc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: run tests on windows workers #2449

chore: run tests on windows workers #2449

mdelapenya commented Mar 26, 2024 •

edited

netlify bot commented Mar 26, 2024 •

edited

mdelapenya Mar 27, 2024

chore: run tests on windows workers #2449

Are you sure you want to change the base?

chore: run tests on windows workers #2449

Conversation

mdelapenya commented Mar 26, 2024 • edited

What does this PR do?

Why is it important?

Related issues

netlify bot commented Mar 26, 2024 • edited

✅ Deploy Preview for testcontainers-go ready!

mdelapenya Mar 27, 2024

Choose a reason for hiding this comment

mdelapenya commented Mar 26, 2024 •

edited

netlify bot commented Mar 26, 2024 •

edited