Adds support to run lightweight kubernetes testcontainer using k3s

.github/workflows/main.yml

@@ -38,6 +38,7 @@ jobs:
           - rabbitmq
           - redis
           - selenium
+          - k3s
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

README.rst

@@ -34,6 +34,7 @@ testcontainers-python facilitates the use of Docker containers for functional an
     rabbitmq/README
     redis/README
     selenium/README
+    k3s/README
 
 Getting Started
 ---------------

k3s/README.rst

@@ -0,0 +1 @@
+.. autoclass:: testcontainers.k3s.K3SContainer

k3s/setup.py

@@ -0,0 +1,17 @@
+from setuptools import setup, find_namespace_packages
+
+description = "K3S component of testcontainers-python."
+
+setup(
+    name="testcontainers-k3s",
+    version="0.0.1rc1",
+    packages=find_namespace_packages(),
+    description=description,
+    long_description=description,
+    long_description_content_type="text/x-rst",
+    url="https://github.com/testcontainers/testcontainers-python",
+    install_requires=[
+        "testcontainers-core",
+    ],
+    python_requires=">=3.7",
+)

k3s/testcontainers/k3s/__init__.py

@@ -0,0 +1,60 @@
+#
+#    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.
+
+from testcontainers.core.config import MAX_TRIES
+from testcontainers.core.container import DockerContainer
+from testcontainers.core.waiting_utils import wait_for_logs
+
+
+class K3SContainer(DockerContainer):
+    """
+    K3S container.
+
+    Example:
+
+        .. doctest::
+
+            >>> import json
+            >>> import urllib
+            >>> from testcontainers.k3s import K3SContainer
+
+            >>> with K3SContainer() as k3s:
+            ...     config_yaml = k3s.config_yaml()
+    """
+
+    KUBE_SECURE_PORT = 6443
+    RANCHER_WEBHOOK_PORT = 8443
+
+    def __init__(self, image="rancher/k3s:latest", **kwargs) -> None:
+        super(K3SContainer, self).__init__(image, **kwargs)
+        self.with_exposed_ports(self.KUBE_SECURE_PORT, self.RANCHER_WEBHOOK_PORT)
+        self.with_env("K3S_URL",
+                      'https://localhost:{}'.format(self.KUBE_SECURE_PORT))
+        self.with_command("server --disable traefik --tls-san=" + self.get_container_host_ip())
+        self.with_kwargs(privileged=True, tmpfs={"/run": "", "/var/run": ""})
+        self.with_volume_mapping("/sys/fs/cgroup", "/sys/fs/cgroup", "rw")
+
+    def _connect(self) -> None:
+        wait_for_logs(self, predicate="Node controller sync successful", timeout=MAX_TRIES)
+
+    def start(self) -> "K3SContainer":
+        super().start()
+        self._connect()
+        return self
+
+    def config_yaml(self) -> str:
+        output = self.get_wrapped_container().exec_run(['cat', '/etc/rancher/k3s/k3s.yaml'])
+        config_yaml = output.output.decode('utf-8') \
+            .replace('https://127.0.0.1:{}'.format(self.KUBE_SECURE_PORT), 'https://localhost:{}'
+                     .format(self.get_exposed_port(self.KUBE_SECURE_PORT)))
+        return config_yaml

k3s/tests/test_k3s.py

@@ -0,0 +1,10 @@
+# The versions below were the current supported versions at time of writing (2022-08-11)
+
+from testcontainers.k3s import K3SContainer
+
+
+def test_docker_run_elasticsearch():
+    with K3SContainer() as k3s:
+        exposed_port = k3s.get_exposed_port(k3s.KUBE_SECURE_PORT)
+        server_url_in_config_yaml = 'https://localhost:{}'.format(exposed_port)
+        assert server_url_in_config_yaml in k3s.config_yaml()

requirements.in

@@ -21,6 +21,7 @@
 -e file:rabbitmq
 -e file:redis
 -e file:selenium
+-e file:k3s
 codecov>=2.1.0
 cryptography<37
 flake8<3.8.0  # 3.8.0 adds a dependency on importlib-metadata which conflicts with other packages.

requirements/3.10.txt

@@ -24,6 +24,7 @@
     #   testcontainers-compose
     #   testcontainers-elasticsearch
     #   testcontainers-gcp
+    #   testcontainers-k3s
     #   testcontainers-kafka
     #   testcontainers-keycloak
     #   testcontainers-localstack
@@ -43,6 +44,8 @@
     # via -r requirements.in
 -e file:google
     # via -r requirements.in
+-e file:k3s
+    # via -r requirements.in
 -e file:kafka
     # via -r requirements.in
 -e file:keycloak
@@ -90,10 +93,8 @@ attrs==22.2.0
     #   pytest
     #   trio
 azure-core==1.26.3
-    # via
-    #   azure-storage-blob
-    #   msrest
-azure-storage-blob==12.14.1
+    # via azure-storage-blob
+azure-storage-blob==12.15.0
     # via testcontainers-azurite
 babel==2.11.0
     # via sphinx
@@ -106,7 +107,6 @@ cachetools==5.3.0
 certifi==2022.12.7
     # via
     #   minio
-    #   msrest
     #   opensearch-py
     #   requests
     #   selenium
@@ -120,7 +120,7 @@ clickhouse-driver==0.2.5
     # via testcontainers-clickhouse
 codecov==2.1.12
     # via -r requirements.in
-coverage[toml]==7.1.0
+coverage[toml]==7.2.0
     # via
     #   codecov
     #   pytest-cov
@@ -162,7 +162,7 @@ flake8==3.7.9
     # via -r requirements.in
 google-api-core[grpc]==2.11.0
     # via google-cloud-pubsub
-google-auth==2.16.0
+google-auth==2.16.1
     # via google-api-core
 google-cloud-pubsub==1.7.2
     # via testcontainers-gcp
@@ -175,7 +175,7 @@ greenlet==2.0.2
     # via sqlalchemy
 grpc-google-iam-v1==0.12.6
     # via google-cloud-pubsub
-grpcio==1.51.1
+grpcio==1.51.3
     # via
     #   google-api-core
     #   googleapis-common-protos
@@ -198,7 +198,7 @@ importlib-metadata==6.0.0
 iniconfig==2.0.0
     # via pytest
 isodate==0.6.1
-    # via msrest
+    # via azure-storage-blob
 jaraco-classes==3.2.3
     # via keyring
 jeepney==0.8.0
@@ -213,7 +213,7 @@ kafka-python==2.0.2
     # via testcontainers-kafka
 keyring==23.13.1
     # via twine
-markdown-it-py==2.1.0
+markdown-it-py==2.2.0
     # via rich
 markupsafe==2.1.2
     # via jinja2
@@ -225,12 +225,8 @@ minio==7.1.13
     # via testcontainers-minio
 more-itertools==9.0.0
     # via jaraco-classes
-msrest==0.7.1
-    # via azure-storage-blob
 neo4j==5.5.0
     # via testcontainers-neo4j
-oauthlib==3.2.2
-    # via requests-oauthlib
 opensearch-py==2.1.1
     # via testcontainers-opensearch
 outcome==1.2.0
@@ -297,7 +293,7 @@ pytest==7.2.1
     #   pytest-cov
 pytest-cov==4.0.0
     # via -r requirements.in
-python-arango==7.5.6
+python-arango==7.5.7
     # via testcontainers-arangodb
 python-dateutil==2.8.2
     # via pg8000
@@ -327,16 +323,12 @@ requests==2.28.2
     #   docker
     #   docker-compose
     #   google-api-core
-    #   msrest
     #   opensearch-py
     #   python-arango
     #   python-keycloak
-    #   requests-oauthlib
     #   requests-toolbelt
     #   sphinx
     #   twine
-requests-oauthlib==1.3.1
-    # via msrest
 requests-toolbelt==0.9.1
     # via
     #   python-arango
@@ -354,7 +346,7 @@ scramp==1.4.4
     # via pg8000
 secretstorage==3.3.3
     # via keyring
-selenium==4.8.0
+selenium==4.8.2
     # via testcontainers-selenium
 six==1.16.0
     # via
@@ -387,7 +379,7 @@ sphinxcontrib-qthelp==1.0.3
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
-sqlalchemy==2.0.3
+sqlalchemy==2.0.4
     # via
     #   testcontainers-mssql
     #   testcontainers-mysql
@@ -410,6 +402,7 @@ twine==4.0.2
 typing-extensions==4.5.0
     # via
     #   azure-core
+    #   azure-storage-blob
     #   sqlalchemy
 tzdata==2022.7
     # via pytz-deprecation-shim
@@ -437,7 +430,7 @@ wrapt==1.14.1
     # via testcontainers-core
 wsproto==1.2.0
     # via trio-websocket
-zipp==3.13.0
+zipp==3.15.0
     # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file: