#253: Fixed help text for exaslct (#262)

tomuben · tkilias · web-flow · commit df455892980d · 2025-01-29T08:07:32.000-03:00
fixes #253 Co-authored-by: Torsten Kilias <tkilias@users.noreply.github.com>
diff --git a/doc/changes/changes_1.1.0.md b/doc/changes/changes_1.1.0.md
@@ -16,3 +16,4 @@ t.b.d.
  - #257: Updated formating rules
  - #256: Fixed type hints
  - #358: Minimize disk space during export
+ - #253: Fixed help text for exaslct
diff --git a/exasol/slc/tool/cli.py b/exasol/slc/tool/cli.py
@@ -0,0 +1,21 @@
+import click
+
+
+@click.group()
+def cli():
+    """
+    EXASLCT - Exasol Script Languages Container Tool
+
+    Build, deploy, push and test Exasol Script-Languages-Container
+
+    Examples:
+
+        Print this help message:
+
+            $ exaslct --help
+
+        Build a script-languages-container:
+
+            $ exaslct build --flavor-path ./flavors/my_flavor
+    """
+    pass
diff --git a/exasol/slc/tool/commands/build.py b/exasol/slc/tool/commands/build.py
@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -18,6 +17,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import goal_options
 
diff --git a/exasol/slc/tool/commands/build_test_container.py b/exasol/slc/tool/commands/build_test_container.py
@@ -1,6 +1,5 @@
 from typing import Optional, Tuple
 
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -17,6 +16,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.test_container_options import test_container_options
 
 
diff --git a/exasol/slc/tool/commands/clean.py b/exasol/slc/tool/commands/clean.py
@@ -1,6 +1,5 @@
 from typing import Optional, Tuple
 
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.docker_repository_options import (
     simple_docker_repository_options,
 )
@@ -15,6 +14,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 
 
diff --git a/exasol/slc/tool/commands/deploy.py b/exasol/slc/tool/commands/deploy.py
@@ -3,7 +3,6 @@
 from typing import Any, Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli  # type: ignore
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -20,6 +19,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import release_options
 
diff --git a/exasol/slc/tool/commands/export.py b/exasol/slc/tool/commands/export.py
@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -18,6 +17,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import release_options
 
diff --git a/exasol/slc/tool/commands/generate_language_activation.py b/exasol/slc/tool/commands/generate_language_activation.py
@@ -1,8 +1,8 @@
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import single_flavor_options
 
 
diff --git a/exasol/slc/tool/commands/push.py b/exasol/slc/tool/commands/push.py
@@ -1,6 +1,5 @@
 from typing import Optional, Tuple
 
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -20,6 +19,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import goal_options
 
diff --git a/exasol/slc/tool/commands/push_test_container.py b/exasol/slc/tool/commands/push_test_container.py
@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli  # type: ignore
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -18,6 +17,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.test_container_options import test_container_options
 
 
diff --git a/exasol/slc/tool/commands/run_db_tests.py b/exasol/slc/tool/commands/run_db_tests.py
@@ -1,7 +1,6 @@
 from typing import Any, Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -24,6 +23,7 @@
 
 from exasol.slc import api
 from exasol.slc.api import api_errors
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import release_options
 from exasol.slc.tool.options.test_container_options import test_container_options
diff --git a/exasol/slc/tool/commands/save.py b/exasol/slc/tool/commands/save.py
@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -18,6 +17,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import goal_options
 
diff --git a/exasol/slc/tool/commands/security_scan.py b/exasol/slc/tool/commands/security_scan.py
@@ -1,6 +1,5 @@
 from typing import Optional, Tuple
 
-from exasol_integration_test_docker_environment.cli.cli import cli  # type: ignore
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -17,6 +16,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 
 
diff --git a/exasol/slc/tool/commands/upload.py b/exasol/slc/tool/commands/upload.py
@@ -1,7 +1,6 @@
 from typing import Optional, Tuple
 
 import click
-from exasol_integration_test_docker_environment.cli.cli import cli  # type: ignore
 from exasol_integration_test_docker_environment.cli.options.build_options import (
     build_options,
 )
@@ -18,6 +17,7 @@
 from exasol_integration_test_docker_environment.lib.api.common import add_options
 
 from exasol.slc import api
+from exasol.slc.tool.cli import cli
 from exasol.slc.tool.options.flavor_options import flavor_options
 from exasol.slc.tool.options.goal_options import release_options
 
diff --git a/exasol/slc/tool/main.py b/exasol/slc/tool/main.py
@@ -1,9 +1,7 @@
 #! /usr/bin/env python3
 
-import exasol_integration_test_docker_environment.cli.commands  # type: ignore
-from exasol_integration_test_docker_environment.cli.cli import cli  # type: ignore
-
 import exasol.slc.tool.commands
+from exasol.slc.tool.cli import cli
 
 
 def main():
diff --git a/test/test_docker_upload.py b/test/test_docker_upload.py
@@ -14,19 +14,21 @@ def setUpClass(cls):
         cls.test_environment = exaslct_utils.ExaslctTestEnvironmentWithCleanUp(
             cls, exaslct_utils.EXASLCT_DEFAULT_BIN
         )
+        cls.itde_test_environment = exaslct_utils.ExaslctApiTestEnvironmentWithCleanup(
+            cls, False
+        )
         cls.test_environment.clean_images()
+
         cls.docker_environment_name = cls.__name__
-        cls.docker_environments = cls.test_environment.spawn_docker_test_environments(
-            cls.docker_environment_name
+        cls.docker_environment = (
+            cls.itde_test_environment.spawn_docker_test_environment(
+                cls.docker_environment_name
+            )
         )
-        if "GOOGLE_CLOUD_BUILD" in os.environ:
-            cls.docker_environment = cls.docker_environments.google_cloud_environment
-        else:
-            cls.docker_environment = cls.docker_environments.on_host_docker_environment
 
     @classmethod
     def tearDownClass(cls):
-        utils.close_environments(cls.docker_environments, cls.test_environment)
+        utils.close_environments(cls.docker_environment, cls.test_environment)
 
     def test_docker_upload_with_path_in_bucket(self):
         self.path_in_bucket = "test"
diff --git a/test/test_run_db_test_external_db.py b/test/test_run_db_test_external_db.py
@@ -13,20 +13,19 @@ def setUp(self):
         self.test_environment = exaslct_utils.ExaslctTestEnvironmentWithCleanUp(
             self, exaslct_utils.EXASLCT_DEFAULT_BIN
         )
+        self.itde_test_environment = exaslct_utils.ExaslctApiTestEnvironmentWithCleanup(
+            self, False
+        )
         self.test_environment.clean_images()
         self.docker_environment_name = self.__class__.__name__
-        self.docker_environments = self.test_environment.spawn_docker_test_environments(
-            self.docker_environment_name
+        self.docker_environment = (
+            self.itde_test_environment.spawn_docker_test_environment(
+                self.docker_environment_name
+            )
         )
-        # localhost gets translated in exaslct to the Gateway address of the docker environment network,
-        # because thats typically the IP Adress of the bridge to the host,
-        # for google cloud this means it should be able to connect to the db
-        # via the port forwards from the test container
-        # TODO check alternative of ip address on default bridge
-        self.docker_environment = self.docker_environments.on_host_docker_environment
 
     def tearDown(self):
-        utils.close_environments(self.docker_environments, self.test_environment)
+        utils.close_environments(self.docker_environment, self.test_environment)
 
     def test_run_db_tests_external_db(self):
         arguments = " ".join(
