Merge pull request #524 from testcontainers/release/0.15

Author: thomaseizinger

.github/docker.override.conf

@@ -0,0 +1,5 @@
+# This is a systemd unit override file that enables the Docker Remote API on localhost.
+# To take effect, it should be placed at /etc/systemd/system/docker.service.d/override.conf.
+[Service]
+ExecStart=
+ExecStart=/usr/bin/dockerd -H fd:// -H tcp://127.0.0.1:2375

.github/workflows/ci.yml

@@ -1,53 +1,66 @@
 name: Continuous Integration
+
 on:
   pull_request:
+  merge_group:
   push:
-    branches: [master, dev, trying, staging]
+    branches: [master, dev]
+
 jobs:
   msrv:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        cargo-cmd:
+          - build --all-features
+          - build --no-default-features
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Get current MSRV from Cargo.toml
         id: current_msrv
         run: |
           msrv=$(cat testcontainers/Cargo.toml | grep rust-version | sed 's/.* = "//; s/"//')
           echo "::set-output name=msrv::$msrv"
-      - uses: actions-rs/toolchain@v1
-        id: toolchain
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
           toolchain: ${{steps.current_msrv.outputs.msrv}}
-          override: true
-      - uses: Swatinem/[email protected]
-      - run: cargo build
+      - uses: Swatinem/[email protected]
+      - run: cargo ${{ matrix['cargo-cmd'] }}
+
   test:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        cargo-cmd:
+          - test --all-features
+          - test --no-default-features
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
-        id: toolchain
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: Swatinem/[email protected]
-      - run: cargo test
+      - uses: actions/checkout@v4
+      - name: Enable Docker Remote API on Localhost
+        shell: bash
+        run: |
+          sudo mkdir -p /etc/systemd/system/docker.service.d/
+          sudo cp ./.github/docker.override.conf /etc/systemd/system/docker.service.d/override.conf
+          sudo systemctl daemon-reload
+          sudo systemctl restart docker
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/[email protected]
+      - run: cargo ${{ matrix['cargo-cmd'] }}
+
   style:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: dprint/[email protected]
+      - uses: actions/checkout@v4
+      - uses: dprint/[email protected]
+
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions-rs/toolchain@v1
-        id: toolchain
+      - uses: actions/checkout@v4
+      - uses: dtolnay/[email protected]
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
           components: clippy
-      - uses: Swatinem/rust-cache@v1.4.0
+      - uses: Swatinem/rust-cache@v2.7.0
       - run: cargo clippy --all-targets -- -D warnings

.github/workflows/nightly.yml

@@ -4,25 +4,25 @@ jobs:
   nightly-tests:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions-rs/toolchain@v1
         id: toolchain
         with:
           profile: minimal
           toolchain: nightly
           override: true
-      - uses: Swatinem/rust-cache@v1.4.0
+      - uses: Swatinem/rust-cache@v2.7.0
       - run: cargo test
   nightly-lints:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: actions-rs/toolchain@v1
         id: toolchain
         with:
           profile: minimal
           toolchain: nightly
           override: true
           components: clippy
-      - uses: Swatinem/rust-cache@v1.4.0
+      - uses: Swatinem/rust-cache@v2.7.0
       - run: cargo clippy --all-targets -- -D warnings

.github/workflows/publish-new-release.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout merge commit
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.merge_commit_sha }}
 
@@ -65,7 +65,7 @@ jobs:
           echo "::set-output name=version::$VERSION"
 
       - name: Create pull request for merging release-branch back into dev
-        uses: thomaseizinger/create-pull-request@1.2.2
+        uses: thomaseizinger/create-pull-request@1.3.1
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           head: release/${{ steps.extract-version.outputs.version }}

CHANGELOG.md

@@ -5,7 +5,27 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [0.15.0] - 2023-09-28
+
+### Added
+
+- Added `privileged` parameter to `RunnableImage`
+- Added `shm_size` (shared memory size) parameter to `RunnableImage`
+- Added logging of an error when starting a container fails
+
+### Changed
+
+- `Container::exec` changed to be synchronous and return `ExecOutput`
+- MSRV is now 1.63.
+- Fixed `get_bridge_ip_address` not to use outdated properties
+- `Docker` trait is declared to be `Send + Sync`
+
+### Removed
+
+- Removed all pre-defined images from the library to escape unbounded maintenance work.
+  See https://github.com/testcontainers/testcontainers-rs/issues/471 for details.
+- Removed explicit support for podman.
+  See https://github.com/testcontainers/testcontainers-rs/issues/422 for details.
 
 ## [0.14.0] - 2022-05-30
 

CONTRIBUTING.md

@@ -2,12 +2,6 @@
 
 First, thank you for contributing to `testcontainers-rs`.
 
-Most likely, your contribution is about adding support for a new docker image.
-Docker images are contained within the [images](./src/images) folder.
-Each file represents a docker image.
-The files follow the name of the image on DockerHub.
-Please follow this convention while developing new images.
-
 ## Licensing
 
 Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

DESIGN_PRINCIPLES.md

@@ -0,0 +1,32 @@
+# Design principles
+
+This document aims to capture the design principles that went into this library.
+It should serve as a reference point when making decisions on what features to include or exclude.
+
+## Simple
+
+One of the most important goals that we want to adhere to is creating a _simple_ API.
+Overall, this means keeping the API as small as possible to get the task done.
+When in doubt, we'd rather not add flags or configuration options for certain use cases.
+
+Tests should be easier to write, easy to understand and easy to maintain.
+`testcontainers` aims to support this as much as possible.
+Having too many configuration options makes it harder for users to achieve this goal.
+
+Another advantage of a small, public API is that we have to make fewer breaking changes.
+This makes upgrades easier for our users.
+
+## Reliable
+
+Tests need to be reliable to provide value.
+We strive to make `testcontainers` as reliable as possible and try to control as many aspects of the container to make sure they work consistently.
+
+One consequence of this decision is that the container _tag_ is typically not configurable for images that ship with `testcontainers`.
+Whilst an image behind a tag can also change, image authors tend to preserve compatibility there.
+If we were to allow users to change the `tag` of an image, we wouldn't be able to guarantee that it works because we cannot test all combinations.
+
+## Ease of use
+
+The library should be easy to use.
+For example, users should be able to make their own implementation of `Image` without much boilerplate.
+In fact, the path forward may very well be that we stop shipping a lot of images in the crate and instead require users to create their own images.

README.md

@@ -11,10 +11,19 @@ Testcontainers-rs is the official Rust language fork of [http://testcontainers.o
 
 ## Usage
 
+### `testcontainers` is the core crate
+
+The crate provides an API for working with containers in a test environment.
+
 1. Depend on `testcontainers`
-2. Import `use testcontainers::*`.
+2. Implement `testcontainers::core::Image` for necessary docker-images
+3. Run it with any available client `testcontainers::clients::*`
+
+### Ready-to-use images
+
+The easiest way to use `testcontainers` is to depend on ready-to-use images (aka modules).
 
-Check [the integration tests](./testcontainers/tests) on how to use the library.
+Modules are available as a community-maintained crate: [testcontainers-modules](https://github.com/testcontainers/testcontainers-rs-modules-community)
 
 ## License