Add meta package for backwards compatibility.

Author: tillahoffmann

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: testcontainers documentation
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup python 3.10
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Cache Python dependencies
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements/3.10.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+      - name: Install Python dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements/3.10.txt
+      - name: Build documentation
+        run: make docs
+      - name: Run doctests
+        run: make doctests

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: testcontainers-python
+name: testcontainers packages
 on:
   push:
     branches: [master]
@@ -52,6 +52,7 @@ jobs:
           - kafka
           - keycloak
           - localstack
+          - meta
           - minio
           - mongodb
           - mssql
@@ -81,10 +82,10 @@ jobs:
             ${{ runner.os }}-
       - name: Install Python dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install wheel
+          pip install --upgrade pip
           pip install -r requirements/${{ matrix.python-version }}.txt
       - name: Run docker diagnostics
+        if: matrix.test-component == 'core'
         run: |
           echo "Build minimal container for docker-in-docker diagnostics"
           docker build -f Dockerfile.diagnostics -t testcontainers-python .
@@ -95,16 +96,12 @@ jobs:
           echo "Container diagnostics with host network"
           docker run --rm -v /var/run/docker.sock:/var/run/docker.sock --network=host testcontainers-python python diagnostics.py
       - name: Lint the code
-        run: flake8
+        run: make ${{ matrix.test-component }}/lint
       - name: Run tests
-        run: >
-          pytest -svx --cov-report=term-missing --cov=testcontainers.${{ matrix.test-component }}
-          --tb=short ${{ matrix.test-component }}/tests
+        if: matrix.test-component != 'meta'
+        run: make ${{ matrix.test-component }}/tests
       - name: Build the package
-        working-directory: ${{ matrix.test-component }}
-        run: |
-          python setup.py bdist_wheel
-          twine check dist/*
+        run: make ${{ matrix.test-component }}/dist
       - name: Publish the package to pypi
         if: >
           github.event_name == 'push'
@@ -114,4 +111,5 @@ jobs:
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-        run: twine upload ${{ matrix.test-component }}/dist/*
+          TWINE_REPOSITORY: pypi
+        run: make ${{ matrix.test-component }}/publish

Makefile

@@ -1,43 +1,66 @@
 PYTHON_VERSIONS = 3.7 3.8 3.9 3.10
+PYTHON_VERSION ?= 3.10
+IMAGE = testcontainers-python:${PYTHON_VERSION}
 REQUIREMENTS = $(addprefix requirements/,${PYTHON_VERSIONS:=.txt})
-TESTS = $(addprefix tests/,${PYTHON_VERSIONS})
-IMAGES = $(addprefix image/,${PYTHON_VERSIONS})
 RUN = docker run --rm -it
+TWINE_REPOSITORY ?= testpypi
+# Get all directories that contain a setup.py and get the directory name.
+PACKAGES = $(subst /,,$(dir $(wildcard */setup.py)))
+
+# All */dist folders for each of the packages.
+DISTRIBUTIONS = $(addsuffix /dist,${PACKAGES})
+UPLOAD = $(addsuffix /upload,${PACKAGES})
+# All */tests folders for each of the test suites.
+TESTS = $(addsuffix /tests,$(filter-out meta,${PACKAGES}))
+TESTS_DIND = $(addsuffix -dind,${TESTS})
+# All linting targets.
+LINT = $(addsuffix /lint,${PACKAGES})
+
+# Targets to build a distribution for each package.
+dist: ${DISTRIBUTIONS}
+${DISTRIBUTIONS} : %/dist : %/setup.py
+	cd $* \
+	&& python setup.py bdist_wheel \
+	&& twine check dist/*
+
+# Targets to run the test suite for each package.
+tests : ${TESTS}
+${TESTS} : %/tests :
+	pytest -svx --cov-report=term-missing --cov=testcontainers.$* --tb=short $*/tests
 
-.PHONY : docs
+# Targets to lint the code.
+lint : ${LINT}
+${LINT} : %/lint :
+	flake8 $*
 
-# Default target
+# Targets to publish packages.
+${UPLOAD} : %/upload :
+	twine upload --non-interactive --repository=${TWINE_REPOSITORY} --skip-existing $*/dist/*
 
-default : tests/3.8
+# Targets to build docker images
+image: requirements/${PYTHON_VERSION}.txt
+	docker build --build-arg version=${PYTHON_VERSION} -t ${IMAGE} .
 
+# Targets to run tests in docker containers
+tests-dind : ${TESTS_DIND}
 
-# Targets to build requirement files
+${TESTS_DIND} : %/tests-dind : image
+	${RUN} -v /var/run/docker.sock:/var/run/docker.sock ${IMAGE} \
+		bash -c "make $*/lint $*/tests"
 
-requirements : ${REQUIREMENTS}
+# Target to build the documentation
+docs :
+	sphinx-build -nW . docs/_build
+
+doctests :
+	sphinx-build -b doctest . docs/_build
 
+# Targets to build requirement files
+requirements : ${REQUIREMENTS}
 ${REQUIREMENTS} : requirements/%.txt : requirements.in */setup.py
 	mkdir -p $(dir $@)
 	${RUN} -w /workspace -v `pwd`:/workspace --platform=linux/amd64 python:$* bash -c \
 		"pip install pip-tools && pip-compile --resolver=backtracking -v --upgrade -o $@ $<"
 
-
-# Targets to build docker images
-
-images : ${IMAGES}
-
-${IMAGES} : image/% : requirements/%.txt
-	docker build --build-arg version=$* -t testcontainers-python:$* .
-
-
-# Targets to run tests in docker containers
-
-tests : ${TESTS}
-
-${TESTS} : tests/% : image/%
-	${RUN} -v /var/run/docker.sock:/var/run/docker.sock testcontainers-python:$* \
-		bash -c "flake8 && pytest -v ${ARGS}"
-
-# Target to build the documentation
-
-docs :
-	sphinx-build -nW . docs/_build
+# Targets that do not generate file-level artifacts.
+.PHONY : dists ${DISTRIBUTIONS} docs doctests image tests ${TESTS}

README.rst

@@ -58,7 +58,7 @@ Installation
 
 The suite of testcontainers packages is available on `PyPI <https://pypi.org/project/testcontainers/>`_, and individual packages can be installed using :code:`pip`. We recommend installing the package you need by running :code:`pip install testcontainers-<feature>`, e.g., :code:`pip install testcontainers-mysql`.
 
-For backwards compatibility, packages can also be installed by specifying `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`_, e.g., :code:`pip install testcontainers[mysql]`.
+For backwards compatibility, packages can also be installed by specifying `extras <https://setuptools.readthedocs.io/en/latest/setuptools.html#declaring-extras-optional-features-with-their-own-dependencies>`__, e.g., :code:`pip install testcontainers[mysql]`.
 
 
 Usage within Docker (e.g., in a CI)

conf.py

@@ -76,7 +76,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', "meta/README.rst"]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

generate_version.py

@@ -0,0 +1 @@
+The :code:`testcontainers` meta package facilitates the installation of the collection of namespace packages that make up the testcontainers ecosystem for python. It follows `Jupyter's approach <https://github.com/jupyter/jupyter/blob/master/setup.py>`__ of installing a collection of packages.

meta/README.rst

@@ -0,0 +1,70 @@
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import setuptools
+
+description = "Python interface for throwaway instances of anything that can run in a Docker " \
+    "container."
+long_description = f"{description} See https://testcontainers-python.readthedocs.io/en/latest/ " \
+    "for details."
+
+setuptools.setup(
+    name="testcontainers",
+    version="4.0.0rc1",
+    description=description,
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    author="Sergey Pirogov",
+    author_email="[email protected]",
+    url="https://github.com/testcontainers/testcontainers-python",
+    keywords=["testing", "logging", "docker", "test automation"],
+    classifiers=[
+        "License :: OSI Approved :: Apache Software License",
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+        "Operating System :: Microsoft :: Windows",
+        "Operating System :: POSIX",
+        "Operating System :: Unix",
+        "Operating System :: MacOS",
+    ],
+    install_requires=[
+        "testcontainers-core",
+    ],
+    extras_require={
+        "arangodb": ["testcontainers-arangodb"],
+        "azurite": ["testcontainers-azurite"],
+        "clickhouse": ["testcontainers-clickhouse"],
+        "docker-compose": ["testcontainers-compose"],
+        "google-cloud-pubsub": ["testcontainers-gcp"],
+        "kafka": ["testcontainers-kafka"],
+        "keycloak": ["testcontainers-keycloak"],
+        "minio": ["testcontainers-minio"],
+        "mongo": ["testcontainers-mongo"],
+        "mssqlserver": ["testcontainers-mssql"],
+        "mysql": ["testcontainers-mysql"],
+        "neo4j": ["testcontainers-neo4j"],
+        "opensearch": ["testcontainers-opensearch"],
+        "oracle": ["testcontainers-oracle"],
+        "postgresql": ["testcontainers-postgres"],
+        "rabbitmq": ["testcontainers-rabbitmq"],
+        "redis": ["testcontainers-redis"],
+        "selenium": ["testcontainers-selenium"],
+    },
+    python_requires=">=3.7",
+)

meta/setup.py

@@ -1,13 +1,14 @@
--e file:core
 -e file:arangodb
 -e file:azurite
 -e file:clickhouse
+-e file:core
 -e file:compose
 -e file:elasticsearch
 -e file:google
 -e file:kafka
 -e file:keycloak
 -e file:localstack
+-e file:meta
 -e file:minio
 -e file:mongodb
 -e file:mssql
@@ -28,3 +29,4 @@ pytest
 pytest-cov
 sphinx
 twine
+wheel

requirements.in

@@ -4,6 +4,8 @@
 #
 #    pip-compile --output-file=requirements/3.10.txt --resolver=backtracking requirements.in
 #
+-e file:meta
+    # via -r requirements.in
 -e file:arangodb
     # via -r requirements.in
 -e file:azurite
@@ -15,6 +17,7 @@
 -e file:core
     # via
     #   -r requirements.in
+    #   testcontainers
     #   testcontainers-arangodb
     #   testcontainers-azurite
     #   testcontainers-clickhouse
@@ -426,6 +429,8 @@ websocket-client==0.59.0
     # via
     #   docker
     #   docker-compose
+wheel==0.38.4
+    # via -r requirements.in
 wrapt==1.14.1
     # via testcontainers-core
 wsproto==1.2.0