#273: Added option "use-existing-container" to run-db-test task (#274)

fixes #273
fixes #275
fixes #276

Author: tomuben

.github/workflows/checks.yml

@@ -17,6 +17,8 @@ jobs:
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          poetry-version: 2.1.2
 
       - name: Check Version(s)
         run: |
@@ -43,6 +45,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
+          poetry-version: 2.1.2
 
       - name: Run lint
         run: poetry run nox -s lint:code
@@ -70,6 +73,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
+          poetry-version: 2.1.2
 
       - name: Run type-check
         run: poetry run nox -s lint:typing
@@ -90,6 +94,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
+          poetry-version: 2.1.2
 
       - name: Run security linter
         run: poetry run nox -s lint:security

.github/workflows/main.yml

@@ -23,7 +23,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: '${{ matrix.python_version }}'
-          poetry-version: '1.8.2'
+          poetry-version: '2.1.2'
 
       - name: Test exaslct
         run: poetry run exaslct --help
@@ -59,7 +59,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: '${{ matrix.python_version }}'
-          poetry-version: '1.8.2'
+          poetry-version: '2.1.2'
 
       - name: Allow unprivileged user namespaces
         run: sudo sysctl -w kernel.apparmor_restrict_unprivileged_userns=0

.github/workflows/matrix-python.yml

@@ -18,6 +18,8 @@ jobs:
 
       - name: Setup Python & Poetry Environment
         uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          poetry-version: 2.1.2
 
       - name: Generate matrix
         run: poetry run nox -s matrix:python

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
         uses: exasol/python-toolbox/.github/actions/[email protected]
         with:
           python-version: '3.10'
-          poetry-version: '1.8.2'
+          poetry-version: '2.1.2'
 
       - name: Build Artifacts
         run: poetry build

doc/changes/unreleased.md

@@ -1 +1,8 @@
 # Unreleased
+
+## Features
+ - #273: Added option "use-existing-container" to run-db-test task
+
+## Refactorings
+ - #275: Updated to poetry 2.1.2
+ - #276: Fix type hints in task generator functions

doc/dependencies.md

@@ -5,7 +5,7 @@
 
 | Package | Version |
 |---------|---------|
-| poetry  | 1.8.2   |
+| poetry  | 2.1.2   |
 | Python  | 3.10    |
 
 ## Runtime Dependencies

doc/user_guide/user_guide.md

@@ -139,6 +139,22 @@ exaslct run-db-test --flavor-path=flavors/<flavor-name>
 
 **Note: you need docker in privileged mode to execute the tests**
 
+### Testing an existing container file
+
+You can test an existing container file (*.tar.gz) with the following command:
+
+```bash
+exaslct run-db-test --flavor-path=flavors/<flavor-name> --use-existing-container <path-to-file>
+```
+
+With this additional option, `exaslct` won't build and export the container again, which might be a faster approach if you have access to the container file, but for some reason the internal cache and/or the docker image has been deleted.
+
+
+**Note**:
+1. `exaslct` won't check if the given container file is compatible with the given flavor path. If this is not the case, the tests probably will fail.
+2. As `exaslct` cannot check if the file was changed during different executions of `run-db-test` with options `--reuse-uploaded-container` or `--reuse-test-environment`, `exaslct` will always skip the upload if those options are set and the file already exists in BucketFS.
+
+
 ## Cleaning up after you are finished
 
 The creation of scripting language container creates or downloads several docker images

exasol/slc/api/run_db_tests.py

@@ -75,6 +75,7 @@ def run_db_test(
     reuse_uploaded_container: bool = False,
     reuse_test_container: bool = False,
     reuse_test_environment: bool = False,
+    use_existing_container: Optional[str] = None,
     test_container_folder: str = "./test_container",
     force_rebuild: bool = False,
     force_rebuild_from: Tuple[str, ...] = tuple(),
@@ -165,6 +166,7 @@ def root_task_generator() -> DependencyLoggerBaseTask:
             reuse_database_setup=reuse_database_setup,
             reuse_test_container=reuse_test_container,
             reuse_database=reuse_database,
+            use_existing_container=use_existing_container,
             db_os_access=DbOsAccess[db_os_access],
             no_test_container_cleanup_after_success=reuse_test_container,
             no_test_container_cleanup_after_failure=reuse_test_container,

exasol/slc/internal/tasks/test/container_file_under_test_info.py

@@ -0,0 +1,8 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class ContainerFileUnderTestInfo:
+    target_name: str
+    container_file: str
+    is_new: bool

exasol/slc/internal/tasks/test/run_db_generic_language_tests.py

@@ -48,12 +48,7 @@ def run_task(self) -> Generator[BaseTask, None, None]:
 
     def run_test(
         self, language: str, test_folder: str
-    ) -> Generator[BaseTask, Any, RunDBTestDirectoryResult]:
-        #
-        # Correct return type is Generator[RunDBTestsInDirectory, Any, RunDBTestDirectoryResult]
-        # TODO: Fix after https://github.com/exasol/integration-test-docker-environment/issues/445
-        #
-
+    ) -> Generator[RunDBTestsInDirectory, Any, RunDBTestDirectoryResult]:
         task = self.create_child_task_with_common_params(
             RunDBTestsInDirectory,
             language=language,