fix(doctests): Ensure paths are correct

Author: CarliJoy

docs/community/generic.rst

@@ -11,7 +11,7 @@ FastAPI container that is using :code:`ServerContainer`
     >>> from testcontainers.core.waiting_utils import wait_for_logs
     >>> from testcontainers.core.image import DockerImage
 
-    >>> with DockerImage(path="./tests/community/generic/samples/fastapi", tag="fastapi-test:latest") as image:
+    >>> with DockerImage(path=f"{TEST_DIR}/community/generic/samples/fastapi", tag="fastapi-test:latest") as image:
     ...     with ServerContainer(port=80, image=image) as fastapi_server:
     ...         delay = wait_for_logs(fastapi_server, "Uvicorn running on http://0.0.0.0:80")
     ...         fastapi_server.get_api_url = lambda: fastapi_server._create_connection_url() + "/api/v1/"
@@ -31,7 +31,7 @@ A more advance use-case, where we are using a FastAPI container that is using Re
     ...     redis_container_port = redis.port
     ...     redis_container_ip_address = redis.get_docker_client().bridge_ip(redis._container.id)
 
-    ...     with DockerImage(path="./tests/community/generic/samples/advance_1", tag="advance-1:latest") as image:
+    ...     with DockerImage(path=f"{TEST_DIR}/community/generic/samples/advance_1", tag="advance-1:latest") as image:
     ...         web_server = ServerContainer(port=80, image=image)
     ...         web_server.with_env(key="REDIS_HOST", value=redis_container_ip_address)
     ...         web_server.with_env(key="REDIS_PORT", value=redis_container_port)

docs/conf.py

@@ -18,6 +18,10 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+from pathlib import Path
+
+BASE_DIR = Path(__file__).parent.parent.resolve()
+TEST_DIR = BASE_DIR / "tests"
 
 # -- General configuration ------------------------------------------------
 
@@ -170,3 +174,5 @@
     ("py:class", "docker.models.containers.ExecResult"),
     ("py:class", "testcontainers.core.docker_client.ContainerInspectInfo"),
 ]
+
+doctest_global_setup = f"TEST_DIR = '{TEST_DIR}'"

docs/core/README.rst

@@ -45,7 +45,7 @@ Using `DockerContainer` and `DockerImage` to create a container:
     >>> from testcontainers.core.waiting_utils import wait_for_logs
     >>> from testcontainers.core.image import DockerImage
 
-    >>> with DockerImage(path="./core/tests/image_fixtures/sample/", tag="test-sample:latest") as image:
+    >>> with DockerImage(path=f"{TEST_DIR}/core/image_fixtures/sample/", tag="test-sample:latest") as image:
     ...     with DockerContainer(str(image)) as container:
     ...         delay = wait_for_logs(container, "Test Sample Image")
 

doctests/conf.py

@@ -1,5 +1,12 @@
+from pathlib import Path
+
+BASE_DIR = Path(__file__).parent.parent.resolve()
+TEST_DIR = BASE_DIR / "tests"
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
 ]
 master_doc = "README"
+
+doctest_global_setup = f"TEST_DIR = '{TEST_DIR}'"

src/testcontainers/community/aws/aws_lambda.py

@@ -24,7 +24,7 @@ class AWSLambdaContainer(ServerContainer):
             >>> from testcontainers.core.waiting_utils import wait_for_logs
             >>> from testcontainers.core.image import DockerImage
 
-            >>> with DockerImage(path="./modules/aws/tests/lambda_sample", tag="test-lambda:latest") as image:
+            >>> with DockerImage(path=f"{TEST_DIR}/community/aws/lambda_sample", tag="test-lambda:latest") as image:
             ...     with AWSLambdaContainer(image=image, port=8080) as func:
             ...         response = func.send_request(data={'payload': 'some data'})
             ...         assert response.status_code == 200

src/testcontainers/community/generic/server.py

@@ -21,7 +21,7 @@ class ServerContainer(DockerContainer):
         >>> from testcontainers.core.waiting_utils import wait_for_logs
         >>> from testcontainers.core.image import DockerImage
 
-        >>> with DockerImage(path="./modules/generic/tests/samples/python_server", tag="test-srv:latest") as image:
+        >>> with DockerImage(path=f"{TEST_DIR}/community/generic/samples/python_server", tag="test-srv:latest") as image:
         ...     with ServerContainer(port=9000, image=image) as srv:
         ...         url = srv._create_connection_url()
         ...         response = httpx.get(f"{url}", timeout=5)

src/testcontainers/community/mysql/__init__.py

@@ -38,7 +38,7 @@ class MySqlContainer(DbContainer):
             >>> import sqlalchemy
             >>> from testcontainers.community.mysql import MySqlContainer
 
-            >>> with MySqlContainer("mysql:5.7.17", dialect="pymysql") as mysql:
+            >>> with MySqlContainer("mysql:8.0", dialect="pymysql") as mysql:
             ...     engine = sqlalchemy.create_engine(mysql.get_connection_url())
             ...     with engine.begin() as connection:
             ...         result = connection.execute(sqlalchemy.text("select version()"))
@@ -50,12 +50,13 @@ class MySqlContainer(DbContainer):
         automatically.
 
         .. doctest::
+
             >>> import sqlalchemy
             >>> from testcontainers.community.mysql import MySqlContainer
-            >>> with MySqlContainer(seed="../../tests/seeds/") as mysql:
+            >>> with MySqlContainer(seed=f"{TEST_DIR}/community/mysql/seeds/", dialect="pymysql") as mysql:
             ...     engine = sqlalchemy.create_engine(mysql.get_connection_url())
             ...     with engine.begin() as connection:
-            ...         query = "select * from stuff"  # Can now rely on schema/data
+            ...         query = "select name from stuff"
             ...         result = connection.execute(sqlalchemy.text(query))
             ...         first_stuff, = result.fetchone()
 

src/testcontainers/community/sftp/__init__.py

@@ -199,7 +199,7 @@ class SFTPContainer(DockerContainer):
             ...     host_port = sftp_container.get_exposed_sftp_port()
             ...     ssh = paramiko.SSHClient()
             ...     ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
-            ...     ssh.connect(host_ip, host_port, "basic", "password")
+            ...     ssh.connect(host_ip, host_port, "basic", "password", allow_agent=False, look_for_keys=False)
             ...     # ssh.get(...)
             ...     # ssh.listdir()
             ...     # ssh.chdir("upload")
@@ -219,7 +219,7 @@ class SFTPContainer(DockerContainer):
             ...     ssh = paramiko.SSHClient()
             ...     ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())
             ...     private_key_file = sftp_container.users[1].private_key_file
-            ...     ssh.connect(host_ip, host_port, "keypair", key_filename=private_key_file)
+            ...     ssh.connect(host_ip, host_port, "keypair", key_filename=private_key_file, allow_agent=False)
             ...     # ssh.listdir()
             ...     # ssh.get(...)
             ...     # ssh.chdir("upload")

src/testcontainers/compose/compose.py

@@ -232,7 +232,7 @@ class DockerCompose:
 
             >>> from testcontainers.compose import DockerCompose
 
-            >>> compose = DockerCompose("core/tests/compose_fixtures/basic", compose_file_name="hello.yaml",
+            >>> compose = DockerCompose(f"{TEST_DIR}/core/compose_fixtures/basic", compose_file_name="hello.yaml",
             ...                         pull=True)
             >>> with compose:
             ...     stdout, stderr = compose.get_logs()

src/testcontainers/core/image.py

@@ -27,7 +27,7 @@ class DockerImage:
 
             >>> from testcontainers.core.image import DockerImage
 
-            >>> with DockerImage(path="./core/tests/image_fixtures/sample/", tag="test-image") as image:
+            >>> with DockerImage(path=f"{TEST_DIR}/core/image_fixtures/sample/", tag="test-image") as image:
             ...    logs = image.get_logs()
 
     :param path: Path to the build context