#193: Add push and build test-container CLI commands (#194)

* Adddd push and build test-container CLI commands
* Refactored test resources
* Adddd API for build and push test container, because the API compatibility test expect that

Co-authored-by: Christoph Kuhnke <[email protected]>

Author: tkilias

doc/changes/changes_0.17.0.md

@@ -8,3 +8,5 @@
 from .upload import upload
 from .security_scan import security_scan
 from .install_starter_scripts import install_starter_scripts
+from .build_test_container import build_test_container
+from .push_test_container import push_test_container

exasol_script_languages_container_tool/cli/commands/__init__.py

@@ -0,0 +1,65 @@
+from typing import Tuple, Optional
+
+from exasol_integration_test_docker_environment.cli.cli import cli
+from exasol_integration_test_docker_environment.cli.options.build_options import build_options
+from exasol_integration_test_docker_environment.cli.options.docker_repository_options import docker_repository_options
+from exasol_integration_test_docker_environment.cli.options.system_options import system_options
+from exasol_integration_test_docker_environment.cli.termination_handler import TerminationHandler
+from exasol_integration_test_docker_environment.lib.api.common import add_options
+
+from exasol_script_languages_container_tool.cli.options.test_container_options import test_container_options
+from exasol_script_languages_container_tool.lib import api
+
+
+@cli.command(short_help="Builds the test container docker image.")
+@add_options(test_container_options)
+@add_options(build_options)
+@add_options(docker_repository_options)
+@add_options(system_options)
+def build_test_container(
+        test_container_folder: str,
+        force_rebuild: bool,
+        force_rebuild_from: Tuple[str, ...],
+        force_pull: bool,
+        output_directory: str,
+        temporary_base_directory: str,
+        log_build_context_content: bool,
+        cache_directory: Optional[str],
+        build_name: Optional[str],
+        source_docker_repository_name: str,
+        source_docker_tag_prefix: str,
+        source_docker_username: Optional[str],
+        source_docker_password: Optional[str],
+        target_docker_repository_name: str,
+        target_docker_tag_prefix: str,
+        target_docker_username: Optional[str],
+        target_docker_password: Optional[str],
+        workers: int,
+        task_dependencies_dot_file: Optional[str]):
+    """
+    Builds the test container docker image.
+
+    The test container is used during tests of the Script-Language-Container.
+    """
+    with TerminationHandler():
+        api.build_test_container(
+            test_container_folder=test_container_folder,
+            force_rebuild=force_rebuild,
+            force_rebuild_from=force_rebuild_from,
+            force_pull=force_pull,
+            output_directory=output_directory,
+            temporary_base_directory=temporary_base_directory,
+            log_build_context_content=log_build_context_content,
+            cache_directory=cache_directory,
+            build_name=build_name,
+            source_docker_repository_name=source_docker_repository_name,
+            source_docker_tag_prefix=source_docker_tag_prefix,
+            source_docker_username=source_docker_username,
+            source_docker_password=source_docker_password,
+            target_docker_repository_name=target_docker_repository_name,
+            target_docker_tag_prefix=target_docker_tag_prefix,
+            target_docker_username=target_docker_username,
+            target_docker_password=target_docker_password,
+            workers=workers,
+            task_dependencies_dot_file=task_dependencies_dot_file
+        )

exasol_script_languages_container_tool/cli/commands/build_test_container.py

@@ -0,0 +1,64 @@
+from typing import Tuple, Optional
+
+from exasol_integration_test_docker_environment.cli.cli import cli
+from exasol_integration_test_docker_environment.cli.options.build_options import build_options
+from exasol_integration_test_docker_environment.cli.options.docker_repository_options import docker_repository_options
+from exasol_integration_test_docker_environment.cli.options.system_options import system_options
+from exasol_integration_test_docker_environment.cli.termination_handler import TerminationHandler
+from exasol_integration_test_docker_environment.lib.api.common import add_options
+
+from exasol_script_languages_container_tool.cli.options.test_container_options import test_container_options
+from exasol_script_languages_container_tool.lib import api
+
+
+@cli.command(short_help="Pushes the test container docker image to the registry.")
+@add_options(test_container_options)
+@add_options(build_options)
+@add_options(docker_repository_options)
+@add_options(system_options)
+def push_test_container(
+        test_container_folder: str,
+        force_rebuild: bool,
+        force_rebuild_from: Tuple[str, ...],
+        force_pull: bool,
+        output_directory: str,
+        temporary_base_directory: str,
+        log_build_context_content: bool,
+        cache_directory: Optional[str],
+        build_name: Optional[str],
+        source_docker_repository_name: str,
+        source_docker_tag_prefix: str,
+        source_docker_username: Optional[str],
+        source_docker_password: Optional[str],
+        target_docker_repository_name: str,
+        target_docker_tag_prefix: str,
+        target_docker_username: Optional[str],
+        target_docker_password: Optional[str],
+        workers: int,
+        task_dependencies_dot_file: Optional[str]):
+    """
+    Push the test container docker image to the registry.
+
+    The test container is used during tests of the Script-Language-Container.
+    """
+    with TerminationHandler():
+        api.push_test_container(
+            test_container_folder=test_container_folder,
+            force_rebuild=force_rebuild,
+            force_rebuild_from=force_rebuild_from,
+            force_pull=force_pull,
+            output_directory=output_directory,
+            temporary_base_directory=temporary_base_directory,
+            log_build_context_content=log_build_context_content,
+            cache_directory=cache_directory,
+            build_name=build_name,
+            source_docker_repository_name=source_docker_repository_name,
+            source_docker_tag_prefix=source_docker_tag_prefix,
+            source_docker_username=source_docker_username,
+            source_docker_password=source_docker_password,
+            target_docker_repository_name=target_docker_repository_name,
+            target_docker_tag_prefix=target_docker_tag_prefix,
+            target_docker_username=target_docker_username,
+            target_docker_password=target_docker_password,
+            workers=workers,
+            task_dependencies_dot_file=task_dependencies_dot_file)

exasol_script_languages_container_tool/cli/commands/push_test_container.py

@@ -12,6 +12,8 @@
 from exasol_integration_test_docker_environment.cli.options.system_options import system_options
 from exasol_integration_test_docker_environment.cli.options.test_environment_options import test_environment_options, \
     docker_db_options, external_db_options
+
+from exasol_script_languages_container_tool.cli.options.test_container_options import test_container_options
 from exasol_script_languages_container_tool.lib import api
 from exasol_script_languages_container_tool.lib.api import api_errors
 
@@ -70,9 +72,7 @@
 @click.option('--reuse-test-environment/--no-reuse-test-environment', default=False,
               help="Reuse the whole test environment with docker network, test container, "
                    "database, database setup and uploaded container")
-@click.option('--test-container-folder', type=click.Path(exists=True, file_okay=False, dir_okay=True),
-              default="./test_container",
-              help="Test folder containing 'Dockerfile', tests and test-data.")
+@add_options(test_container_options)
 @add_options(build_options)
 @add_options(docker_repository_options)
 @add_options(system_options)

exasol_script_languages_container_tool/cli/commands/run_db_tests.py

@@ -0,0 +1,9 @@
+import click
+
+TEST_CONTAINER_DEFAULT_DIRECTORY = "./test_container"
+
+test_container_options = [
+    click.option('--test-container-folder', type=click.Path(exists=True, file_okay=False, dir_okay=True),
+                 default=TEST_CONTAINER_DEFAULT_DIRECTORY,
+                 help="Test folder containing 'Dockerfile', tests and test-data.")
+]

exasol_script_languages_container_tool/cli/options/test_container_options.py

@@ -9,3 +9,5 @@
 from .upload import upload
 from .security_scan import security_scan
 from .install_starter_scripts import install_starter_scripts
+from .build_test_container import build_test_container
+from .push_test_container import push_test_container

exasol_script_languages_container_tool/lib/api/__init__.py

@@ -0,0 +1,56 @@
+from typing import Tuple, Optional
+
+from exasol_integration_test_docker_environment.lib import api
+from exasol_integration_test_docker_environment.lib.api.common import cli_function
+from exasol_integration_test_docker_environment.lib.docker.images.image_info import ImageInfo
+
+from exasol_script_languages_container_tool.cli.options.test_container_options import TEST_CONTAINER_DEFAULT_DIRECTORY
+from exasol_script_languages_container_tool.lib.tasks.test.test_container_content import build_test_container_content
+
+
+@cli_function
+def build_test_container(
+        test_container_folder: str = TEST_CONTAINER_DEFAULT_DIRECTORY,
+        force_rebuild: bool = False,
+        force_rebuild_from: Tuple[str, ...] = tuple(),
+        force_pull: bool = False,
+        output_directory: str = ".build_output",
+        temporary_base_directory: str = "/tmp",
+        log_build_context_content: bool = False,
+        cache_directory: Optional[str] = None,
+        build_name: Optional[str] = None,
+        source_docker_repository_name: str = 'exasol/script-language-container',
+        source_docker_tag_prefix: str = '',
+        source_docker_username: Optional[str] = None,
+        source_docker_password: Optional[str] = None,
+        target_docker_repository_name: str = 'exasol/script-language-container',
+        target_docker_tag_prefix: str = '',
+        target_docker_username: Optional[str] = None,
+        target_docker_password: Optional[str] = None,
+        workers: int = 5,
+        task_dependencies_dot_file: Optional[str] = None) -> ImageInfo:
+    """
+    Build the test container docker image.
+
+    The test container is used during tests of the Script-Language-Container.
+    """
+    return api.build_test_container(
+        test_container_content=build_test_container_content(test_container_folder),
+        force_rebuild=force_rebuild,
+        force_rebuild_from=force_rebuild_from,
+        force_pull=force_pull,
+        output_directory=output_directory,
+        temporary_base_directory=temporary_base_directory,
+        log_build_context_content=log_build_context_content,
+        cache_directory=cache_directory,
+        build_name=build_name,
+        source_docker_repository_name=source_docker_repository_name,
+        source_docker_tag_prefix=source_docker_tag_prefix,
+        source_docker_username=source_docker_username,
+        source_docker_password=source_docker_password,
+        target_docker_repository_name=target_docker_repository_name,
+        target_docker_tag_prefix=target_docker_tag_prefix,
+        target_docker_username=target_docker_username,
+        target_docker_password=target_docker_password,
+        workers=workers,
+        task_dependencies_dot_file=task_dependencies_dot_file)

exasol_script_languages_container_tool/lib/api/build_test_container.py

@@ -0,0 +1,56 @@
+from typing import Tuple, Optional
+
+from exasol_integration_test_docker_environment.lib import api
+from exasol_integration_test_docker_environment.lib.api.common import cli_function
+from exasol_integration_test_docker_environment.lib.docker.images.image_info import ImageInfo
+
+from exasol_script_languages_container_tool.cli.options.test_container_options import TEST_CONTAINER_DEFAULT_DIRECTORY
+from exasol_script_languages_container_tool.lib.tasks.test.test_container_content import build_test_container_content
+
+
+@cli_function
+def push_test_container(
+        test_container_folder: str = TEST_CONTAINER_DEFAULT_DIRECTORY,
+        force_rebuild: bool = False,
+        force_rebuild_from: Tuple[str, ...] = tuple(),
+        force_pull: bool = False,
+        output_directory: str = ".build_output",
+        temporary_base_directory: str = "/tmp",
+        log_build_context_content: bool = False,
+        cache_directory: Optional[str] = None,
+        build_name: Optional[str] = None,
+        source_docker_repository_name: str = 'exasol/script-language-container',
+        source_docker_tag_prefix: str = '',
+        source_docker_username: Optional[str] = None,
+        source_docker_password: Optional[str] = None,
+        target_docker_repository_name: str = 'exasol/script-language-container',
+        target_docker_tag_prefix: str = '',
+        target_docker_username: Optional[str] = None,
+        target_docker_password: Optional[str] = None,
+        workers: int = 5,
+        task_dependencies_dot_file: Optional[str] = None) -> ImageInfo:
+    """
+    Push the test container docker image to the registry.
+
+    The test container is used during tests of the Script-Language-Container.
+    """
+    return api.push_test_container(
+        test_container_content=build_test_container_content(test_container_folder),
+        force_rebuild=force_rebuild,
+        force_rebuild_from=force_rebuild_from,
+        force_pull=force_pull,
+        output_directory=output_directory,
+        temporary_base_directory=temporary_base_directory,
+        log_build_context_content=log_build_context_content,
+        cache_directory=cache_directory,
+        build_name=build_name,
+        source_docker_repository_name=source_docker_repository_name,
+        source_docker_tag_prefix=source_docker_tag_prefix,
+        source_docker_username=source_docker_username,
+        source_docker_password=source_docker_password,
+        target_docker_repository_name=target_docker_repository_name,
+        target_docker_tag_prefix=target_docker_tag_prefix,
+        target_docker_username=target_docker_username,
+        target_docker_password=target_docker_password,
+        workers=workers,
+        task_dependencies_dot_file=task_dependencies_dot_file)