artefacts-cli 0.8.0__py3-none-any.whl → 0.9.2__py3-none-any.whl

artefacts/cli/containers/utils.py

@@ -1,9 +1,9 @@
 import sys
 
-from collections.abc import Generator
+from collections.abc import Iterator
 from typing import Any, Tuple
 
-from artefacts.cli import errors
+from artefacts.cli import errors, localise
 from artefacts.cli.containers import CMgr
 from artefacts.cli.logger import logger
 
@@ -19,7 +19,11 @@ class ContainerMgr:
         self.mgr = self._configure()
         if self.mgr is None:
             self.logger.error(
-                f"Failed to find supported container stack. Please install and start one of {list(self.SUPPORTED_PRIORITISED_ENGINES.values())}, with default settings (custom sockets not supported at this stage)"
+                localise(
+                    "Failed to find supported container stack. Please install and start one of {engines}, with default settings (custom sockets not supported at this stage)".format(
+                        engines=list(self.SUPPORTED_PRIORITISED_ENGINES.values())
+                    )
+                )
             )
             sys.exit(errors.CONTAINER_ENGINE_NOT_FOUND)
 
@@ -32,18 +36,26 @@ class ContainerMgr:
                 manager = handler()
             except AttributeError:
                 self.logger.warning(
-                    f"Tried to detect an unsupported engine: {engine}. WIP? Ignore and continue."
+                    localise(
+                        "Tried to detect an unsupported engine: {engine}. WIP? Ignore and continue.".format(
+                            engine=engine
+                        )
+                    )
                 )
             except Exception as e:
                 self.logger.warning(
-                    f"Problem in detecting {engine} ({e}) Ignore and continue."
+                    localise(
+                        "Problem in detecting {engine} ({message}) Ignore and continue.".format(
+                            engine=engine, message=e
+                        )
+                    )
                 )
             if manager is not None:
                 break
         return manager
 
     def _configure_docker(self):
-        from artefacts.cli.containers.docker import DockerManager
+        from artefacts.cli.containers.docker_cm import DockerManager
 
         return DockerManager()
 
@@ -51,11 +63,11 @@ class ContainerMgr:
     #     from artefacts.cli.containers import podman
     #     return PodmanManager()
 
-    def build(self, **kwargs) -> Tuple[str, Generator]:
+    def build(self, **kwargs) -> Tuple[str, Iterator]:
         return self.mgr.build(**kwargs)
 
     def check(self, image: str) -> bool:
         return self.mgr.check(image)
 
-    def run(self, **kwargs) -> Tuple[Any, Generator]:
+    def run(self, **kwargs) -> Tuple[Any, Iterator]:
         return self.mgr.run(**kwargs)

artefacts/cli/helpers.py

@@ -0,0 +1,55 @@
+import configparser
+import os
+import subprocess
+
+from artefacts.cli.constants import CONFIG_PATH, CONFIG_DIR
+
+
+def get_git_revision_hash() -> str:
+    try:
+        return (
+            subprocess.check_output(["git", "rev-parse", "HEAD"])
+            .decode("ascii")
+            .strip()
+        )
+    except subprocess.CalledProcessError:
+        return ""
+
+
+def get_git_revision_branch() -> str:
+    try:
+        return (
+            subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
+            .decode("ascii")
+            .strip()
+        )
+    except subprocess.CalledProcessError:
+        return ""
+
+
+def get_conf_from_file():
+    config = configparser.ConfigParser()
+    if not os.path.isfile(CONFIG_PATH):
+        os.makedirs(CONFIG_DIR, exist_ok=True)
+        config["DEFAULT"] = {}
+        with open(CONFIG_PATH, "w") as f:
+            config.write(f)
+    config.read(CONFIG_PATH)
+    return config
+
+
+def get_artefacts_api_url(project_profile):
+    return os.environ.get(
+        "ARTEFACTS_API_URL",
+        project_profile.get(
+            "ApiUrl",
+            "https://app.artefacts.com/api",
+        ),
+    )
+
+
+def add_key_to_conf(project_name, api_key):
+    config = get_conf_from_file()
+    config[project_name] = {"ApiKey": api_key}
+    with open(CONFIG_PATH, "w") as f:
+        config.write(f)

artefacts/cli/i18n.py

@@ -0,0 +1,35 @@
+import gettext
+import importlib.resources
+import os
+import locale
+import sys
+
+
+# Ensure env var requirements for gettext are fulfilled
+if sys.platform.startswith("win"):
+    if os.getenv("LANG") is None:
+        lang, _ = locale.getdefaultlocale()
+        os.environ["LANG"] = lang
+
+
+# Get path to the locale directory
+try:
+    _localedir = importlib.resources.files("artefacts.cli") / "locales"
+except FileNotFoundError:
+    #
+    # Encountered in our trials with Python 3.10 and 3.11, so fallback to pkg_resources
+    #
+    # pkg_resources is removed from setuptools in Python 3.12. From there, importlib works.
+    #
+    from pkg_resources import resource_filename
+
+    _localedir = str(resource_filename("artefacts.cli", "locales"))
+
+
+# Setup the GNU gettext API
+gettext.bindtextdomain("artefacts", _localedir)
+gettext.textdomain("artefacts")
+
+
+# Expose for other modules to import
+localise = gettext.gettext

artefacts/cli/locales/art.pot

@@ -0,0 +1,524 @@
+# Translations template for artefacts.
+# Copyright (C) 2025 Asteria ART
+# This file is distributed under the same license as the artefacts project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: artefacts 0.9.2.dev8\n"
+"Report-Msgid-Bugs-To: dev@artefacts.com\n"
+"POT-Creation-Date: 2025-05-12 11:10+0900\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+#: artefacts/cli/__init__.py:28
+#, python-brace-format
+msgid "Could not determine package version: {error_message}. Default to 0.0.0"
+msgstr ""
+
+#: artefacts/cli/__init__.py:99
+#, python-brace-format
+msgid "Error on job creation: {status_code}"
+msgstr ""
+
+#: artefacts/cli/__init__.py:179
+#, python-brace-format
+msgid "Error on scenario creation: {status_code}"
+msgstr ""
+
+#: artefacts/cli/__init__.py:290
+msgid ""
+"Files generated by the job are not uploaded to Artefacts, including the "
+"ones specified in output_dirs"
+msgstr ""
+
+#: artefacts/cli/__init__.py:302
+#, python-brace-format
+msgid "Uploading {file_name} ({file_size:.2f} MB)"
+msgstr ""
+
+#: artefacts/cli/__init__.py:316
+#, python-brace-format
+msgid "File too large: {file_name} could not be uploaded"
+msgstr ""
+
+#: artefacts/cli/__init__.py:324
+#, python-brace-format
+msgid "Error uploading {file_name}: {error_message}, skipping"
+msgstr ""
+
+#: artefacts/cli/app.py:57 artefacts/cli/app.py:104 artefacts/cli/app.py:117
+msgid "PROJECT_NAME"
+msgstr ""
+
+#: artefacts/cli/app.py:76
+#, python-brace-format
+msgid "Opening the project settings page: {url}"
+msgstr ""
+
+#: artefacts/cli/app.py:81
+#, python-brace-format
+msgid "Please enter your API KEY for {project}"
+msgstr ""
+
+#: artefacts/cli/app.py:88
+#, python-brace-format
+msgid "API KEY saved for {project}"
+msgstr ""
+
+#: artefacts/cli/app.py:91
+msgid ""
+"Would you like to download the generated artefacts.yaml file? This will "
+"overwrite any existing config file in the current directory."
+msgstr ""
+
+#: artefacts/cli/app.py:113
+#, python-brace-format
+msgid "{project} config removed"
+msgstr ""
+
+#: artefacts/cli/app.py:133 artefacts/cli/app.py:635 artefacts/cli/app.py:641
+#, python-brace-format
+msgid "Error getting project info: {message}"
+msgstr ""
+
+#: artefacts/cli/app.py:144 artefacts/cli/app.py:518
+#: artefacts/cli/app_containers.py:187
+msgid "JOBNAME"
+msgstr ""
+
+#: artefacts/cli/app.py:149 artefacts/cli/app.py:502
+msgid "Artefacts configuration file."
+msgstr ""
+
+#: artefacts/cli/app.py:155
+msgid "Run with no tracking nor test execution"
+msgstr ""
+
+#: artefacts/cli/app.py:161
+msgid "Skip configuring a simulator resource provided by Artefacts"
+msgstr ""
+
+#: artefacts/cli/app.py:168
+msgid "Do not upload to Artefacts files generated during a run (e.g. rosbags)"
+msgstr ""
+
+#: artefacts/cli/app.py:176
+msgid ""
+"Break the 'middleware network' isolation between the test suite and the "
+"host (in ROS1: --reuse-master flag; in ROS2: --disable-isolation flag). "
+"Primarily for debugging"
+msgstr ""
+
+#: artefacts/cli/app.py:182 artefacts/cli/app.py:507
+msgid "Optional description for this run"
+msgstr ""
+
+#: artefacts/cli/app.py:190 artefacts/cli/app.py:515
+msgid ""
+"Skip configuration validation, so that unsupported settings can be tried "
+"out, e.g. non-ROS settings or simulators like SAPIEN."
+msgstr ""
+
+#: artefacts/cli/app.py:198
+msgid ""
+"[Experimental] Run the job inside a package container. The container "
+"image is build if it does not exist yet, with default name as "
+"\"artefacts\" (please use --with-image to override the image name). This "
+"option overrides (for now) --dryrun, --nosim, --noisolation and "
+"--description."
+msgstr ""
+
+#: artefacts/cli/app.py:205
+msgid ""
+"[Experimental] Path to a custom Dockerfile. Defaults to Dockerfile in the"
+" run directory. This flag is only used together with `--in-container`"
+msgstr ""
+
+#: artefacts/cli/app.py:212
+msgid ""
+"[Deprecated and unused from 0.8.0; Image names are now internally "
+"managed] Run the job using the image name passed here. Only used when "
+"running with --in-container set."
+msgstr ""
+
+#: artefacts/cli/app.py:220
+msgid ""
+"[Experimental] Override the default behaviour to always rebuild the "
+"container image (as we assume incremental testing)."
+msgstr ""
+
+#: artefacts/cli/app.py:228
+msgid ""
+"Show any GUI if any is created by the test runs. By default, UI elements "
+"are run but hidden---only test logs are returned. Please note GUI often "
+"assume X11 (e.g. ROS), typically with Qt, so this may not work without a "
+"appropriate environment."
+msgstr ""
+
+#: artefacts/cli/app.py:277
+msgid "Checking container image"
+msgstr ""
+
+#: artefacts/cli/app.py:285
+msgid "Container image ready"
+msgstr ""
+
+#: artefacts/cli/app.py:286
+msgid "Run in container"
+msgstr ""
+
+#: artefacts/cli/app.py:296
+msgid "Starting tests"
+msgstr ""
+
+#: artefacts/cli/app.py:299
+msgid "Error: Job name not defined"
+msgstr ""
+
+#: artefacts/cli/app.py:309
+#, python-brace-format
+msgid "Job type not supported: {jt}"
+msgstr ""
+
+#: artefacts/cli/app.py:321
+#, python-brace-format
+msgid "The selected framework '{framework}' is deprecated. Using '{alt}' instead."
+msgstr ""
+
+#: artefacts/cli/app.py:330
+#, python-brace-format
+msgid ""
+"WARNING: framework: '{framework}' is not officially supported. Attempting"
+" run."
+msgstr ""
+
+#: artefacts/cli/app.py:339
+#, python-brace-format
+msgid "AWS BATCH ARRAY DETECTED, batch_index={index}"
+msgstr ""
+
+#: artefacts/cli/app.py:368
+msgid ""
+"Unable to authenticate (Stage: Job initialisation), please check your "
+"project name and API key"
+msgstr ""
+
+#: artefacts/cli/app.py:379
+#, python-brace-format
+msgid "Starting scenario {sid}/{num}: {name}"
+msgstr ""
+
+#: artefacts/cli/app.py:389
+msgid ""
+"Unable to authenticate (Stage: Job run), please check your project name "
+"and API key"
+msgstr ""
+
+#: artefacts/cli/app.py:402
+msgid "Test launch file not specified for ros2 project"
+msgstr ""
+
+#: artefacts/cli/app.py:408
+msgid "launch_test file not specified error"
+msgstr ""
+
+#: artefacts/cli/app.py:410
+msgid ""
+"Please specify a `ros_testfile` in the artefacts.yaml scenario "
+"configuration."
+msgstr ""
+
+#: artefacts/cli/app.py:416 artefacts/cli/app.py:459 artefacts/cli/app.py:477
+msgid "Performing dry run"
+msgstr ""
+
+#: artefacts/cli/app.py:427
+msgid "Artefacts failed to execute the tests"
+msgstr ""
+
+#: artefacts/cli/app.py:439
+msgid ""
+"Not able to execute tests. Make sure that ROS2 is sourced and that your "
+"launch file syntax is correct."
+msgstr ""
+
+#: artefacts/cli/app.py:453
+msgid "Test launch file not specified for ros1 project"
+msgstr ""
+
+#: artefacts/cli/app.py:471
+msgid "run command not specified for scenario"
+msgstr ""
+
+#: artefacts/cli/app.py:491
+msgid "Done"
+msgstr ""
+
+#: artefacts/cli/app.py:530 artefacts/cli/app_containers.py:231
+#, python-brace-format
+msgid "Project config file not found: {config}"
+msgstr ""
+
+#: artefacts/cli/app.py:542
+#, python-brace-format
+msgid "Can't find a job named '{jobname}' in config '{config}'"
+msgstr ""
+
+#: artefacts/cli/app.py:562
+msgid "Packaging source..."
+msgstr ""
+
+#: artefacts/cli/app.py:608
+#, python-brace-format
+msgid ""
+"Apologies, problem in interacting with the Artefacts backend: "
+"{status_code} {reason}. Response text: {detail}."
+msgstr ""
+
+#: artefacts/cli/app.py:622
+#, python-brace-format
+msgid "Missing access! Please make sure your API key is added at {url}/settings"
+msgstr ""
+
+#: artefacts/cli/app.py:629
+#, python-brace-format
+msgid "Billing issue, please go to {url}/settings to correct: {error}"
+msgstr ""
+
+#: artefacts/cli/app.py:648
+#, python-brace-format
+msgid ""
+"Error getting project info: {status_code} {reason}. Response text: "
+"{detail}."
+msgstr ""
+
+#: artefacts/cli/app.py:664
+msgid "Testing local source"
+msgstr ""
+
+#: artefacts/cli/app.py:713
+#, python-brace-format
+msgid "Uploading complete! The new job will show up shortly at {url}"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:28
+msgid ""
+"[Deprecated since 0.8.0; please see --root] Path to the root of the "
+"project."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:34
+msgid "Path to the root of the project."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:40
+msgid ""
+"Path to a custom Dockerfile. Defaults to Dockerfile under `path` (see "
+"option of the same name)."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:47
+msgid ""
+"[Deprecated since 0.8.0; not used and will disappear after 0.8.0] Name "
+"for the generated image"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:55 artefacts/cli/app_containers.py:193
+msgid ""
+"Path to the Artefacts configuration file. It defaults to "
+"`./artefacts.yaml`"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:64
+msgid "Optional list of job names to process. The default is to process all jobs."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:82
+#, python-brace-format
+msgid ""
+"Project config file not found: {config}. Please provide an Artefacts "
+"configuration file to proceed (running `artefacts init` allows to "
+"generate one)."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:106
+#, python-brace-format
+msgid ""
+"Dockerfile `{dockerfile}` not found. Please ensure the file exits. "
+"Automatic Dockerfile generation may also work by dropping the "
+"--dockerfile option."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:123
+#, python-brace-format
+msgid ""
+"No {dockerfile} found here. Let's generate one per scenario based on "
+"artefacts.yaml. They will be available under the `{dest_root}` folder and"
+" used from there."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:143
+#, python-brace-format
+msgid "Using generated Dockerfile at: {dockerfile}"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:161
+msgid "No Dockerfile, nothing to do."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:165
+msgid "IMAGE_NAME"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:175
+#, python-brace-format
+msgid "Container image {name} exists and ready to use."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:201
+msgid ""
+"Show any GUI if any is created by the test runs. By default, UI elements "
+"are run but hidden---only test logs are returned. Please note GUI often "
+"assume an X11 environment, typically with Qt, so this may not work "
+"without a appropriate environment."
+msgstr ""
+
+#: artefacts/cli/app_containers.py:249
+#, python-brace-format
+msgid "Container run complete: Container Id for inspection: {container_id}"
+msgstr ""
+
+#: artefacts/cli/app_containers.py:255
+msgid "Package run failed:"
+msgstr ""
+
+#: artefacts/cli/config.py:31
+#, python-brace-format
+msgid "No API KEY set. Please run `artefacts config add {project_name}`"
+msgstr ""
+
+#: artefacts/cli/config.py:50 artefacts/cli/config.py:58
+#, python-brace-format
+msgid "Connecting to {api_url} using {auth_type}"
+msgstr ""
+
+#: artefacts/cli/ros1.py:55
+msgid ""
+"[warning in generate_rosbag_args] rosbag_record asks for 'subscriptions' "
+"but they are not specified. Falling back to default: no rosbag will be "
+"recorded"
+msgstr ""
+
+#: artefacts/cli/ros1.py:108
+#, python-brace-format
+msgid "[Exception in get_result_path()] {message}"
+msgstr ""
+
+#: artefacts/cli/ros1.py:112
+#, python-brace-format
+msgid ""
+"Unable to parse the ros1 .launch specified ({testfile}) and the <test> "
+"tag within to find the unittest test method's name."
+msgstr ""
+
+#: artefacts/cli/ros1.py:119
+msgid ""
+"Please ensure all ROS and unittest naming conventions are respected. "
+"Exiting.."
+msgstr ""
+
+#: artefacts/cli/ros1.py:227
+#, python-brace-format
+msgid "New rosbag found: {file_name}"
+msgstr ""
+
+#: artefacts/cli/ros1.py:233
+msgid "starting rosbag postprocess"
+msgstr ""
+
+#: artefacts/cli/ros2.py:73
+msgid ""
+"Problem with parameter name. Please ensure params are in the format "
+"`node/param`"
+msgstr ""
+
+#: artefacts/cli/utils.py:81
+#, python-brace-format
+msgid "Project config file {file_name} not found."
+msgstr ""
+
+#: artefacts/cli/utils_ros.py:70
+#, python-brace-format
+msgid "[Exception in parse_tests_results] {message}"
+msgstr ""
+
+#: artefacts/cli/utils_ros.py:72
+msgid "Test result xml could not be loaded, marking success as False"
+msgstr ""
+
+#: artefacts/cli/containers/docker_cm.py:82
+#, python-brace-format
+msgid ""
+"Missing API key for the project. Does `{path}/config` exist and contain "
+"your key? Alternatively ARTEFACTS_KEY can be set with the key."
+msgstr ""
+
+#: artefacts/cli/containers/docker_cm.py:160
+#, python-brace-format
+msgid "Image {image} not found by Docker. Perhaps need to build first?"
+msgstr ""
+
+#: artefacts/cli/containers/docker_cm.py:170
+#, python-brace-format
+msgid "Failed to run from {image}. All we know: {message}"
+msgstr ""
+
+#: artefacts/cli/containers/docker_utils.py:28
+#, python-brace-format
+msgid ""
+"Invalid GPU device for Docker: {g} ({e}). Accepted device formats are "
+"all, device=1 and \"device=1,2\" (with a list of devices, quotes must be "
+"included"
+msgstr ""
+
+#: artefacts/cli/containers/docker_utils.py:38
+#, python-brace-format
+msgid ""
+"Invalid GPU device for Docker: {g}. List of devices must be double-"
+"quoted. Accepted device formats are all, device=1 and \"device=1,2\" "
+"(with a list of devices, quotes must be included"
+msgstr ""
+
+#: artefacts/cli/containers/docker_utils.py:49
+#, python-brace-format
+msgid ""
+"Invalid GPU device for Docker: {g}. Accepted device formats are all, "
+"device=1 and \"device=1,2\" (with a list of devices, quotes must be "
+"included"
+msgstr ""
+
+#: artefacts/cli/containers/utils.py:23
+#, python-brace-format
+msgid ""
+"Failed to find supported container stack. Please install and start one of"
+" {engines}, with default settings (custom sockets not supported at this "
+"stage)"
+msgstr ""
+
+#: artefacts/cli/containers/utils.py:40
+#, python-brace-format
+msgid "Tried to detect an unsupported engine: {engine}. WIP? Ignore and continue."
+msgstr ""
+
+#: artefacts/cli/containers/utils.py:48
+#, python-brace-format
+msgid "Problem in detecting {engine} ({message}) Ignore and continue."
+msgstr ""
+