Skip to content

Allow Ryuk container when testing with Docker Desktop #2440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timyates merged 3 commits into from
May 24, 2024
Merged

Allow Ryuk container when testing with Docker Desktop #2440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f55ca0b
Allow Ryuk container when testing with Docker Desktop
timyates May 24, 2024
7102c02
Add windows instructions as well
timyates May 24, 2024
4e0d25d
Merge branch 'develop' into feature-2439/allow-ryuk-for-docker-desktop
mkimberlin May 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/getting-started/setup/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,9 @@ You should be using Yarn 1.22.19 or later.

# Install Podman

> If you are using Docker Desktop, you can skip this section, and set an environment variable via `export USE_DOCKER_DESKTOP=1` in your shell profile.
> This will enable Ryuk for cleaning up old containers under testing.

Copy link
Member

@mkimberlin mkimberlin May 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to affect all environments, so should we add something to the windowsos.md as well?

Copy link
Contributor Author

@timyates timyates May 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! Pushed 7102c02

This project uses [Podman](https://podman.io/) for containerization. Podman is a daemonless container engine for developing, managing, and running Open Container Initiative containers. It is an alternative to Docker and is available without fee for macOS via Homebrew.

To install Podman, run:
Expand Down
3 changes: 3 additions & 0 deletions docs/getting-started/setup/windowsos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ choco install yarn

This project uses [Podman](https://podman.io/) for containerization.

> If you are using Docker Desktop, you can skip this section, and set an environment variable via `USE_DOCKER_DESKTOP=1` in your Windows environment variables.
> This will enable Ryuk for cleaning up old containers under testing.

Install Podman Desktop: https://podman-desktop.io/

The setup process will ask if you want to install Podman and Podman Compose for the cli.
Expand Down
17 changes: 9 additions & 8 deletions server/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,17 +104,18 @@ dependencies {
}

test {
OperatingSystem os = DefaultNativePlatform.currentOperatingSystem
if (os.isLinux()) {
def uid = ["id", "-u"].execute().text.trim()
environment "DOCKER_HOST", "unix:///run/user/$uid/podman/podman.sock"
} else if (os.isMacOsX()) {
environment "DOCKER_HOST", "unix:///tmp/podman.sock"
if (!System.env['USE_DOCKER_DESKTOP']) {
OperatingSystem os = DefaultNativePlatform.currentOperatingSystem
if (os.isLinux()) {
def uid = ["id", "-u"].execute().text.trim()
environment "DOCKER_HOST", "unix:///run/user/$uid/podman/podman.sock"
} else if (os.isMacOsX()) {
environment "DOCKER_HOST", "unix:///tmp/podman.sock"
}
environment "TESTCONTAINERS_RYUK_DISABLED", "true"
}
environment "TESTCONTAINERS_RYUK_DISABLED", "true"
}


jacocoTestReport {
dependsOn test // tests are required to run before generating the report
reports {
Expand Down