Skip to content

Commit 9093c6b

Browse files
committed
Merge remote-tracking branch 'origin/main' into network
2 parents b523301 + d5b8553 commit 9093c6b

File tree

75 files changed

+4028
-904
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+4028
-904
lines changed

.devcontainer/Dockerfile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
FROM mcr.microsoft.com/devcontainers/python:1-3.11-bookworm
2+
3+
4+
RUN \
5+
apt update && apt install bash-completion -y && \
6+
pip install pre-commit && \
7+
curl -sSL https://install.python-poetry.org | POETRY_HOME=/home/vscode/.local python3 -
8+
9+
10+
RUN \
11+
echo >> /home/vscode/.bashrc && \
12+
# add completions to bashrc
13+
# see how ubuntu does it for reference:
14+
# https://git.launchpad.net/ubuntu/+source/base-files/tree/share/dot.bashrc
15+
# https://stackoverflow.com/a/68566555
16+
echo 'if [ -f /etc/bash_completion ] && ! shopt -oq posix; then' >> /home/vscode/.bashrc && \
17+
echo ' . /etc/bash_completion' >> /home/vscode/.bashrc && \
18+
echo 'fi' >> /home/vscode/.bashrc && \
19+
echo >> /home/vscode/.bashrc && \
20+
echo '. <(poetry completions)' >> /home/vscode/.bashrc
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
echo "Running post-create-command.sh"
22

3-
curl -sSL https://install.python-poetry.org | python3 -
4-
3+
pre-commit install
54
poetry install --all-extras

.devcontainer/devcontainer.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
{
44
"name": "Python 3",
55
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6-
"image": "mcr.microsoft.com/devcontainers/python:1-3.11-bookworm",
6+
"build": {
7+
// Path is relative to the devcontainer.json file.
8+
// We prebuild the image to get poetry into the image
9+
// This saves the user a bit of time, when re-opening containers
10+
"dockerfile": "Dockerfile"
11+
},
12+
713
"features": {
814
"ghcr.io/devcontainers/features/docker-in-docker:2": {
915
"version": "latest",

.github/.release-please-manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
".": "4.0.1"
2+
".": "4.3.1"
33
}

.github/release-please-config.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
22
"release-type": "python",
3-
"bootstrap-sha": "dcb4f6842cbfe6e880a77b0d4aabb3f396c6dc19",
43
"packages": {
54
".": {
65
"package-name": "testcontainers"

.github/settings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ labels:
6363
- { name: '🐧 linux', color: '#3ED4D',, description: '' }
6464
- { name: '👀 requires attention', color: '#fef2c0', description: '' }
6565
- { name: '📖 documentation', color: '#d93f0b', description: '' }
66+
- { name: '📦 package: cassandra', color: '#0052CC', description: '' }
6667
- { name: '📦 package: clickhouse', color: '#0052CC', description: '' }
6768
- { name: '📦 package: compose', color: '#0052CC', description: '' }
6869
- { name: '📦 package: core', color: '#0052CC', description: '' }

.github/workflows/ci-community.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ on:
1414

1515
jobs:
1616
track-modules:
17-
runs-on: ubuntu-latest
17+
runs-on: ubuntu-22.04
1818
steps:
1919
- name: Checkout contents
2020
uses: actions/checkout@v4
@@ -38,14 +38,14 @@ jobs:
3838
outputs:
3939
changed_modules: ${{ steps.compute-changes.outputs.computed_modules }}
4040
test:
41+
runs-on: ubuntu-22.04
4142
needs: [track-modules]
4243
if: ${{ needs.track-modules.outputs.changed_modules != '[]' }}
4344
strategy:
4445
fail-fast: false
4546
matrix:
46-
python-version: [ "3.11" ]
47+
python-version: ["3.9", "3.10", "3.11", "3.12"]
4748
module: ${{ fromJSON(needs.track-modules.outputs.changed_modules) }}
48-
runs-on: ubuntu-latest
4949
steps:
5050
- name: Checkout contents
5151
uses: actions/checkout@v4
@@ -57,3 +57,5 @@ jobs:
5757
run: poetry install -E ${{ matrix.module }}
5858
- name: Run tests
5959
run: make modules/${{ matrix.module }}/tests
60+
- name: Run doctests
61+
run: make modules/${{ matrix.module }}/doctests

.github/workflows/ci-core.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,11 @@ on:
1010

1111
jobs:
1212
test:
13+
runs-on: ubuntu-22.04
1314
strategy:
1415
fail-fast: false
1516
matrix:
16-
os: [ ubuntu ]
1717
python-version: ["3.9", "3.10", "3.11", "3.12"]
18-
runs-on: ${{ matrix.os }}-latest
1918
steps:
2019
- uses: actions/checkout@v4
2120
- name: Set up Python
@@ -28,3 +27,5 @@ jobs:
2827
run: poetry build && poetry run twine check dist/*.tar.gz
2928
- name: Run tests
3029
run: make core/tests
30+
- name: Run doctests
31+
run: make core/doctests

.github/workflows/ci-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010

1111
jobs:
1212
python:
13-
runs-on: ubuntu-latest
13+
runs-on: ubuntu-22.04
1414
steps:
1515
- uses: actions/checkout@v4
1616
- name: Setup Env

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88

99
jobs:
1010
build:
11-
runs-on: ubuntu-latest
11+
runs-on: ubuntu-22.04
1212
steps:
1313
- uses: actions/checkout@v4
1414
- name: Set up Python

.github/workflows/pr-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ permissions:
1313
jobs:
1414
validate:
1515
name: validate-pull-request-title
16-
runs-on: ubuntu-latest
16+
runs-on: ubuntu-22.04
1717
steps:
1818
- name: validate pull request title
1919
uses: kontrolplane/pull-request-title-validator@ab2b54babb5337246f4b55cf8e0a1ecb0575e46d #v1

.github/workflows/release-please.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66

77
jobs:
88
release:
9-
runs-on: ubuntu-latest
9+
runs-on: ubuntu-22.04
1010
outputs:
1111
release_created: ${{ steps.track-release.outputs.release_created }}
1212
steps:
@@ -16,7 +16,7 @@ jobs:
1616
manifest-file: .github/.release-please-manifest.json
1717
config-file: .github/release-please-config.json
1818
publish:
19-
runs-on: ubuntu-latest
19+
runs-on: ubuntu-22.04
2020
environment: release
2121
permissions:
2222
id-token: write

.readthedocs.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ build:
1111
tools:
1212
python: "3.10"
1313

14-
python:
15-
install:
16-
- requirements: requirements/3.10.txt
14+
# https://github.com/readthedocs/readthedocs.org/issues/4912#issuecomment-1143587902s
15+
jobs:
16+
post_install:
17+
- pip install poetry==1.7.1 # match version from poetry.lock
18+
- poetry config virtualenvs.create false
19+
- poetry install --all-extras

CHANGELOG.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,77 @@
11
# Changelog
22

3+
## [4.3.1](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.3.0...testcontainers-v4.3.1) (2024-04-02)
4+
5+
6+
### Bug Fixes
7+
8+
* **core:** env vars not being respected due to constructor call ([#524](https://github.com/testcontainers/testcontainers-python/issues/524)) ([4872ea5](https://github.com/testcontainers/testcontainers-python/commit/4872ea5759347e10150c0d80e4e7bbce3d59c410)), closes [#521](https://github.com/testcontainers/testcontainers-python/issues/521)
9+
* Pin MongoDB images and improve test coverage for maintained versions ([#448](https://github.com/testcontainers/testcontainers-python/issues/448)) ([b5c7a1b](https://github.com/testcontainers/testcontainers-python/commit/b5c7a1b95af5470ee1b5109ed1fb8e1b3af52cf7))
10+
11+
## [4.3.0](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.2.0...testcontainers-v4.3.0) (2024-04-01)
12+
13+
14+
### Features
15+
16+
* **client:** Add custom User-Agent in Docker client as `tc-python/&lt;version&gt;` ([#507](https://github.com/testcontainers/testcontainers-python/issues/507)) ([dd55082](https://github.com/testcontainers/testcontainers-python/commit/dd55082991b3405038a90678a39e8c815f0d1fc8))
17+
18+
19+
### Bug Fixes
20+
21+
* Add CassandraContainer ([#476](https://github.com/testcontainers/testcontainers-python/issues/476)) ([507e466](https://github.com/testcontainers/testcontainers-python/commit/507e466a1fa9ac64c254ceb9ae0d57f6bfd8c89d))
22+
* add chroma container ([#515](https://github.com/testcontainers/testcontainers-python/issues/515)) ([0729bf4](https://github.com/testcontainers/testcontainers-python/commit/0729bf4af957f8b6638cc204b108358745c0cfc9))
23+
* Add Weaviate module ([#492](https://github.com/testcontainers/testcontainers-python/issues/492)) ([90762e8](https://github.com/testcontainers/testcontainers-python/commit/90762e817bf49de6d6366212fb48e7edb67ab0c6))
24+
* **cassandra:** make cassandra dependency optional/test-only ([#518](https://github.com/testcontainers/testcontainers-python/issues/518)) ([bddbaeb](https://github.com/testcontainers/testcontainers-python/commit/bddbaeb20cbd147c429f8020395355402b8a7268))
25+
* **core:** allow setting docker command path for docker compose ([#512](https://github.com/testcontainers/testcontainers-python/issues/512)) ([63fcd52](https://github.com/testcontainers/testcontainers-python/commit/63fcd52ec2d6ded5f6413166a3690c1138e4dae0))
26+
* **google:** add support for Datastore emulator ([#508](https://github.com/testcontainers/testcontainers-python/issues/508)) ([3d891a5](https://github.com/testcontainers/testcontainers-python/commit/3d891a5ec62944d01d1bf3d6f70e6aec83f6e516))
27+
* Improved Oracle DB module ([#363](https://github.com/testcontainers/testcontainers-python/issues/363)) ([6e6d8e3](https://github.com/testcontainers/testcontainers-python/commit/6e6d8e3c919be3efa581704868193e66da54acf3))
28+
* inconsistent test runs for community modules ([#497](https://github.com/testcontainers/testcontainers-python/issues/497)) ([914f1e5](https://github.com/testcontainers/testcontainers-python/commit/914f1e55bcb3b10260788c3affb8426f77eb9036))
29+
* **kafka:** Add redpanda testcontainer module ([#441](https://github.com/testcontainers/testcontainers-python/issues/441)) ([451d278](https://github.com/testcontainers/testcontainers-python/commit/451d27865873bb75f4a09a26442572745408d013))
30+
* **kafka:** wait_for_logs in kafka container to reduce lib requirement ([#377](https://github.com/testcontainers/testcontainers-python/issues/377)) ([909107b](https://github.com/testcontainers/testcontainers-python/commit/909107b221417a39516f961364beb518d2756f45))
31+
* **keycloak:** container should use dedicated API endpoints to determine container readiness ([#490](https://github.com/testcontainers/testcontainers-python/issues/490)) ([2e27225](https://github.com/testcontainers/testcontainers-python/commit/2e272253148797759748bd40c42f797697d3163f))
32+
* **nats:** Client-Free(ish) NATS container ([#462](https://github.com/testcontainers/testcontainers-python/issues/462)) ([302c73d](https://github.com/testcontainers/testcontainers-python/commit/302c73ddaa7a6b5bc071ab0cc36d15461cae348b))
33+
* **new:** add a new Docker Registry test container ([#389](https://github.com/testcontainers/testcontainers-python/issues/389)) ([0f554fb](https://github.com/testcontainers/testcontainers-python/commit/0f554fbaa9511e0221806f57de971abedf1c0bf2))
34+
* pass doctests, s/doctest/doctests/, run them in gha, s/asyncpg/psycopg/ in doctest, fix keycloak flakiness: wait for first user ([#505](https://github.com/testcontainers/testcontainers-python/issues/505)) ([545240d](https://github.com/testcontainers/testcontainers-python/commit/545240dfdcb2a565ad7cef0e9813f03b9b6f910e))
35+
* pass updated keyword args to Publisher/Subscriber client in google/pubsub [#161](https://github.com/testcontainers/testcontainers-python/issues/161) ([#164](https://github.com/testcontainers/testcontainers-python/issues/164)) ([8addc11](https://github.com/testcontainers/testcontainers-python/commit/8addc111c94826c2a619a0880d48550673f4d7b9))
36+
* Qdrant module ([#463](https://github.com/testcontainers/testcontainers-python/issues/463)) ([e8876f4](https://github.com/testcontainers/testcontainers-python/commit/e8876f422abeb29a7236f2174f7e7a324b7d26cb))
37+
* remove accidentally added pip in dev dependencies ([#516](https://github.com/testcontainers/testcontainers-python/issues/516)) ([dee20a7](https://github.com/testcontainers/testcontainers-python/commit/dee20a76c88445b911d38b4704c2380114a66794))
38+
* **ryuk:** Enable Ryuk test suite. Ryuk image 0.5.1 -&gt; 0.7.0. Add RYUK_RECONNECTION_TIMEOUT env variable ([#509](https://github.com/testcontainers/testcontainers-python/issues/509)) ([472b2c2](https://github.com/testcontainers/testcontainers-python/commit/472b2c24aec232a04c00dd7dcd9a9f05f2dfaa66))
39+
40+
## [4.2.0](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.1.0...testcontainers-v4.2.0) (2024-03-24)
41+
42+
43+
### Features
44+
45+
* support influxdb ([#413](https://github.com/testcontainers/testcontainers-python/issues/413)) ([13742a5](https://github.com/testcontainers/testcontainers-python/commit/13742a5dc448c80914953c21f8f2b01177c3fa6c))
46+
47+
48+
### Bug Fixes
49+
50+
* **arangodb:** tests to pass on ARM CPUs - change default image to 3.11.x where ARM image is published ([#479](https://github.com/testcontainers/testcontainers-python/issues/479)) ([7b58a50](https://github.com/testcontainers/testcontainers-python/commit/7b58a50f3a8703c5d5e974a4ff20bc8e52ae93c8))
51+
* **core:** DinD issues [#141](https://github.com/testcontainers/testcontainers-python/issues/141), [#329](https://github.com/testcontainers/testcontainers-python/issues/329) ([#368](https://github.com/testcontainers/testcontainers-python/issues/368)) ([b10d916](https://github.com/testcontainers/testcontainers-python/commit/b10d916848cccc016fc457333f7b382b18a7b3ef))
52+
* **core:** raise an exception when docker compose fails to start [#258](https://github.com/testcontainers/testcontainers-python/issues/258) ([#485](https://github.com/testcontainers/testcontainers-python/issues/485)) ([d61af38](https://github.com/testcontainers/testcontainers-python/commit/d61af383def6eadcd7f2b5ba667eb587c6cc84f1))
53+
* **core:** use auto_remove=True with reaper instance ([#499](https://github.com/testcontainers/testcontainers-python/issues/499)) ([274a400](https://github.com/testcontainers/testcontainers-python/commit/274a4002600ae70662a5785c7a903cf8846b2ffc))
54+
* **docs:** update the non-existent main.yml badge ([#493](https://github.com/testcontainers/testcontainers-python/issues/493)) ([1d10c1c](https://github.com/testcontainers/testcontainers-python/commit/1d10c1ca8c8163b8d68338e1d50d0e26d7b0515e))
55+
* Fix the return type of `DockerContainer.get_logs` ([#487](https://github.com/testcontainers/testcontainers-python/issues/487)) ([cd72f68](https://github.com/testcontainers/testcontainers-python/commit/cd72f6896db3eb1fd5ea60f9c051cb719568a12f))
56+
* **keycloak:** tests on aarch64, use image from [jboss -&gt; quay], change supported version [16+ -> 18+] ([#480](https://github.com/testcontainers/testcontainers-python/issues/480)) ([5758310](https://github.com/testcontainers/testcontainers-python/commit/5758310532b8a8e1303a24bc534fa8aeb0f75eb2))
57+
* **postgres:** doctest ([#473](https://github.com/testcontainers/testcontainers-python/issues/473)) ([c9c6f92](https://github.com/testcontainers/testcontainers-python/commit/c9c6f92348299a2cc04988af8d69a53a23a7c7d5))
58+
* read the docs build works again ([#496](https://github.com/testcontainers/testcontainers-python/issues/496)) ([dfd1781](https://github.com/testcontainers/testcontainers-python/commit/dfd17814a7fc9ede510ae17569004bd92f2a6fa6))
59+
* readthedocs build - take 1 ([#495](https://github.com/testcontainers/testcontainers-python/issues/495)) ([b3b9901](https://github.com/testcontainers/testcontainers-python/commit/b3b990159154857239e2fb86da3cb85a6a13ab8e))
60+
61+
## [4.1.0](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.0.1...testcontainers-v4.1.0) (2024-03-19)
62+
63+
64+
### Features
65+
66+
* **reliability:** integrate the ryuk container for better container cleanup ([#314](https://github.com/testcontainers/testcontainers-python/issues/314)) ([d019874](https://github.com/testcontainers/testcontainers-python/commit/d0198744c3bdc97a7fe41879b54acb2f5ee7becb))
67+
68+
69+
### Bug Fixes
70+
71+
* changelog after release-please ([#469](https://github.com/testcontainers/testcontainers-python/issues/469)) ([dcb4f68](https://github.com/testcontainers/testcontainers-python/commit/dcb4f6842cbfe6e880a77b0d4aabb3f396c6dc19))
72+
* **configuration:** strip whitespaces when reading .testcontainers.properties ([#474](https://github.com/testcontainers/testcontainers-python/issues/474)) ([ade144e](https://github.com/testcontainers/testcontainers-python/commit/ade144ee2888d4044ac0c1dc627f47da92789e06))
73+
* try to fix release-please by setting a bootstrap sha ([#472](https://github.com/testcontainers/testcontainers-python/issues/472)) ([ca65a91](https://github.com/testcontainers/testcontainers-python/commit/ca65a916b719168c57c174d2af77d45fd026ec05))
74+
375
## [4.0.1](https://github.com/testcontainers/testcontainers-python/compare/testcontainers-v4.0.0...testcontainers-v4.0.1) (2024-03-11)
476

577

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ UPLOAD = $(addsuffix /upload,${PACKAGES})
1111
# All */tests folders for each of the test suites.
1212
TESTS = $(addsuffix /tests,$(filter-out meta,${PACKAGES}))
1313
TESTS_DIND = $(addsuffix -dind,${TESTS})
14-
DOCTESTS = $(addsuffix /doctest,$(filter-out meta,${PACKAGES}))
14+
DOCTESTS = $(addsuffix /doctests,$(filter-out modules/README.md,${PACKAGES}))
1515
# All linting targets.
1616
LINT = $(addsuffix /lint,${PACKAGES})
1717

@@ -56,10 +56,10 @@ ${TESTS_DIND} : %/tests-dind : image
5656
docs :
5757
poetry run sphinx-build -nW . docs/_build
5858

59-
doctest : ${DOCTESTS}
59+
doctests : ${DOCTESTS}
6060
poetry run sphinx-build -b doctest . docs/_build
6161

62-
${DOCTESTS} : %/doctest :
62+
${DOCTESTS} : %/doctests :
6363
poetry run sphinx-build -b doctest -c doctests $* docs/_build
6464

6565
# Remove any generated files.

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,13 @@ For more information, see [the docs][readthedocs].
2222
```
2323

2424
The snippet above will spin up a postgres database in a container. The `get_connection_url()` convenience method returns a `sqlalchemy` compatible url we use to connect to the database and retrieve the database version.
25+
26+
## Configuration
27+
28+
| Env Variable | Example | Description |
29+
| --------------------------------------- | --------------------------- | ---------------------------------------------------------------------------------- |
30+
| `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE` | `/var/run/docker.sock` | Path to Docker's socket used by ryuk |
31+
| `TESTCONTAINERS_RYUK_PRIVILEGED` | `false` | Run ryuk as a privileged container |
32+
| `TESTCONTAINERS_RYUK_DISABLED` | `false` | Disable ryuk |
33+
| `RYUK_CONTAINER_IMAGE` | `testcontainers/ryuk:0.7.0` | Custom image for ryuk |
34+
| `RYUK_RECONNECTION_TIMEOUT` | `10s` | Reconnection timeout for Ryuk TCP socket before Ryuk reaps all dangling containers |

conf.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
extensions = [
3232
"sphinx.ext.autodoc",
3333
"sphinx.ext.doctest",
34+
"sphinx.ext.intersphinx",
3435
"sphinx.ext.napoleon",
3536
]
3637

@@ -48,7 +49,7 @@
4849
source_suffix = ".rst"
4950

5051
# The master toctree document.
51-
master_doc = "INDEX"
52+
master_doc = "index"
5253

5354
# General information about the project.
5455
project = "testcontainers"
@@ -74,7 +75,7 @@
7475
# List of patterns, relative to source directory, that match files and
7576
# directories to ignore when looking for source files.
7677
# This patterns also effect to html_static_path and html_extra_path
77-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "meta/README.rst", ".venv"]
78+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv", ".git"]
7879

7980
# The name of the Pygments (syntax highlighting) style to use.
8081
pygments_style = "sphinx"
@@ -156,3 +157,7 @@
156157
"Miscellaneous",
157158
),
158159
]
160+
161+
intersphinx_mapping = {
162+
"python": ("https://docs.python.org/3", None),
163+
}

0 commit comments

Comments
 (0)