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

artefacts/cli/utils_ros.py

@@ -1,11 +1,18 @@
 from junitparser import JUnitXml, Attr, Element
 
+from artefacts.cli.i18n import localise
+
 
 class FailureElement(Element):
     _tag = "failure"
     message = Attr()
 
 
+class ErrorElement(Element):
+    _tag = "error"
+    message = Attr()
+
+
 def get_TestSuite_error_result(test_suite_name, name, error_msg):
     return {
         "suite": test_suite_name,
@@ -15,8 +22,8 @@ def get_TestSuite_error_result(test_suite_name, name, error_msg):
         "details": [
             {
                 "name": name,
-                "failure_message": error_msg,
-                "result": "failure",
+                "error_message": error_msg,
+                "result": "error",
             }
         ],
     }
@@ -36,13 +43,30 @@ def parse_tests_results(file):
             case_details = {
                 "name": case.name,
             }
-            try:
-                case_details["failure_message"] = case.child(FailureElement).message
-                case_details["result"] = "failure"
-                success = False
-            except AttributeError:
+
+            test_result_found = False
+
+            # We look for failures or errors first
+            for element_class, result_status, message in [
+                (FailureElement, "failure", "failure_message"),
+                (ErrorElement, "error", "error_message"),
+            ]:
+                try:
+                    element = case.child(element_class)
+                    case_details[message] = element.message
+                    case_details["result"] = result_status
+                    success = False
+                    test_result_found = True
+                    break
+                except AttributeError:
+                    pass
+
+            # No Fail or Error = success
+            if not test_result_found:
                 case_details["result"] = "success"
+
             details.append(case_details)
+
         suite_results["details"] = details
         results.append(suite_results)
 
@@ -64,8 +88,10 @@ def parse_tests_results(file):
         return results, success
 
     except Exception as e:
-        print(f"[Exception in parse_tests_results] {e}")
-        print("Test result xml could not be loaded, marking success as False")
+        print(
+            localise("[Exception in parse_tests_results] {message}".format(message=e))
+        )
+        print(localise("Test result xml could not be loaded, marking success as False"))
         result = get_TestSuite_error_result(
             "unittest.suite.TestSuite",
             "Error parsing XML test results",

artefacts/cli/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.8.0'
-__version_tuple__ = version_tuple = (0, 8, 0)
+__version__ = version = '0.9.2'
+__version_tuple__ = version_tuple = (0, 9, 2)

artefacts/copava/__init__.py

@@ -0,0 +1 @@
+from artefacts_copava import *

{artefacts_cli-0.8.0.dist-info → artefacts_cli-0.9.2.dist-info}/METADATA

@@ -1,26 +1,28 @@
 Metadata-Version: 2.4
 Name: artefacts_cli
-Version: 0.8.0
+Version: 0.9.2
 Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
+License-Expression: Apache-2.0
 Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
 Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues
 Project-URL: Changelog, https://github.com/art-e-fact/artefacts-client/CHANGELOG.md
 Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 Requires-Dist: artefacts-c2d>=1.7.1
 Requires-Dist: artefacts-copava>=0.1.11
-Requires-Dist: click>=8.0.4
+Requires-Dist: artefacts-click
 Requires-Dist: gitignore_parser>=0.1.11
 Requires-Dist: junitparser>=2.5
 Requires-Dist: mcap
 Requires-Dist: mcap-ros2-support
 Requires-Dist: PyYAML>=6.0
 Requires-Dist: requests>=2.27.1
+Requires-Dist: rospkg
 Provides-Extra: dev
 Requires-Dist: awscli; extra == "dev"
+Requires-Dist: babel==2.17.0; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: docker; extra == "dev"
 Requires-Dist: lark; extra == "dev"
@@ -37,6 +39,7 @@ Requires-Dist: pytest-env; extra == "dev"
 Requires-Dist: pytest-mock; extra == "dev"
 Requires-Dist: python-markdown-math; extra == "dev"
 Requires-Dist: ruff>=0.9.2; extra == "dev"
+Requires-Dist: setuptools_scm>=8; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 
 # Artefacts CLI
@@ -102,3 +105,7 @@ mkdocs serve -a 127.0.0.1:7000
 ```
 
 The docs are automatically deployed by the documentation workflow.
+
+## Development notes
+
+We use Pyre for static analysis. If it does not work out of the box, please consider adapting the `.pyre_configuration` file included with this repository. One assumption is that developers work in a virtual environment under `./venv`.

artefacts_cli-0.9.2.dist-info/RECORD

@@ -0,0 +1,33 @@
+artefacts/__init__.py,sha256=VLmogtpRQeJjQjAORV8ClSJ5qF-57Hxx3apvgy9H1zk,76
+artefacts/cli/__init__.py,sha256=H_HWGto-Emwy7YJwk0hqONKkq5oBTLqnlde85PDLg_Y,13554
+artefacts/cli/app.py,sha256=EhRqZ8_8_sawYBtmObMNvq6wrpsHk-23W6SvbDFFUCc,25344
+artefacts/cli/app_containers.py,sha256=oTWEAIE0m0nQQV7d33q75OL9-Bql0gDEnWGkmgCBnWE,8503
+artefacts/cli/app_containers.pyi,sha256=3fBxcSppJr6EOEcUojvflG3Eegg7lv2Qp0dNQQILrP4,63
+artefacts/cli/bagparser.py,sha256=aegvhIgwF-C1giGQWKB-cn0I2fW_iVamFwYm7YkfIyo,3738
+artefacts/cli/config.py,sha256=_9j5yn_A3GF2pLdpORzrNIC78tfR64eFr_7QzypAOc8,2170
+artefacts/cli/constants.py,sha256=l7xoXiKaZIpcn3JFwf5Tf5Kprfmf9x63AUfdTQQ3zGA,435
+artefacts/cli/errors.py,sha256=BiCRo3IwVjtEotaFtmwsGTZiX-TRE69KqLrEQItLsag,34
+artefacts/cli/helpers.py,sha256=OIoJcJzsGBpqSLE8pN5tEzPStC_nzYoZ0aP0NJ0jJsw,1335
+artefacts/cli/i18n.py,sha256=qcTt_u1rdASzUfG1ANigGgqoqw3igt28AVO2VqFCV20,913
+artefacts/cli/logger.py,sha256=PklhdEs-T8p9eogX7O_i6Gmw3v707y1Z0vgVwxBu96Q,792
+artefacts/cli/other.py,sha256=c1rbtVkJ7DnmlPAf0bbkT_PNDcEoXbMqD2JIg_ShBaE,1391
+artefacts/cli/parameters.py,sha256=msf2aG-tmw0ahxwrPpB2W6KqdMj5A-nw9DPG9flkHTg,788
+artefacts/cli/ros1.py,sha256=tE6WK8SQZPPdWwFnOdIDTNv7chhr6AXY53gDYOEHJhY,9995
+artefacts/cli/ros2.py,sha256=7iP7gtl7wLHo-7eIZPkFNRMHDrp5z-oexVmczed11Ks,8619
+artefacts/cli/utils.py,sha256=-lMkPo5UtvnYG1D8NGnbOwO8jT4GXhYuwMxs29A393Q,4239
+artefacts/cli/utils_ros.py,sha256=lOQSMtcRl3OHZ1t_dpZZnP5YdeydLBlcVNs9h91ZXa4,2845
+artefacts/cli/version.py,sha256=eeYYTSIkrgfRwSQ7LKo_py3xs3DvzgfWiAtK4K1JM4A,511
+artefacts/cli/containers/__init__.py,sha256=x3g6nz5TLRtF1bU0mlIN0aDd0Gwv3V3skE1aW9uVK5k,2274
+artefacts/cli/containers/docker_cm.py,sha256=vOd6qoXc-WEA9ZXDkV-nHF7j5MXmaKFw8bz_qsdakqk,6480
+artefacts/cli/containers/docker_utils.py,sha256=jGZJy0kapWnFwo5BBudtgI1gY9PXhLTgKCgecNsFUZ8,2966
+artefacts/cli/containers/utils.py,sha256=O86S4SE-Ajd07f4GnwwFjqGQWu2s-KeB829DkWYJJbQ,2408
+artefacts/cli/locales/art.pot,sha256=W3s62uHTSWPNAqmnZ9p_19npQW2oonoc28j8Bj96Eo0,13967
+artefacts/cli/locales/base.pot,sha256=Pd3ojlQiqsbS3RXrFkJWckyepU3K10hEKBH0dIb5iHg,27188
+artefacts/cli/locales/click.pot,sha256=nWt25hFB8_U87KeTIgSMucVZqw6mo8oQGrw3KvcFmVA,13852
+artefacts/copava/__init__.py,sha256=rBf3JxQob2YHGnhuQPoMQQ06fzL-j2BCrLzqF_aZBSw,31
+artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
+artefacts_cli-0.9.2.dist-info/METADATA,sha256=e2L4g9PTOE72GRR1VTNRsM7YP9pdhouE6cBo750-npU,3529
+artefacts_cli-0.9.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+artefacts_cli-0.9.2.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
+artefacts_cli-0.9.2.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
+artefacts_cli-0.9.2.dist-info/RECORD,,

{artefacts_cli-0.8.0.dist-info → artefacts_cli-0.9.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

artefacts/cli/containers/docker.py

@@ -1,119 +0,0 @@
-from collections.abc import Generator
-import json
-import os
-from pathlib import Path
-import platform
-from typing import Any, Tuple
-from uuid import uuid4
-
-from artefacts.cli.constants import DEFAULT_API_URL
-from artefacts.cli.containers import CMgr
-from artefacts.cli.utils import ensure_available
-
-ensure_available("docker")
-
-import docker  # noqa: E402
-from docker import APIClient  # noqa: E402
-
-
-class DockerManager(CMgr):
-    def __init__(self):
-        self.client = APIClient()
-
-    def build(self, **kwargs) -> Tuple[str, Generator]:
-        kwargs["tag"] = kwargs.pop("name")
-        # Ensure `path` is a string, the Docker package does not support pathlib.
-        kwargs["path"] = str(kwargs.pop("path"))
-        # Remove intermediate containers
-        kwargs["rm"] = True
-        logs = []
-        img_id = None
-        for entry in self.client.build(**kwargs):
-            line_data = [
-                json.loads(v) for v in entry.decode("utf-8").split("\r\n") if len(v) > 0
-            ]
-            for data in line_data:
-                if "stream" in data:
-                    line = data["stream"].strip()
-                    if not line.startswith("---") and len(line) > 0:
-                        print(f"[{kwargs['tag'].split('/')[-1]}] {line}")
-                        logs.append(line)
-                elif "aux" in data and "ID" in data["aux"]:
-                    img_id = data["aux"]["ID"]
-        if img_id is None:
-            img_id = self.client.inspect_image(kwargs["tag"])["Id"]
-        return img_id, iter(logs)
-
-    def check(
-        self,
-        image: str,
-    ) -> bool:
-        return len(self.client.images(name=image)) > 0
-
-    def run(
-        self,
-        image: str,
-        project: str,
-        jobname: str = None,
-        artefacts_dir: str = Path("~/.artefacts").expanduser(),
-        api_url: str = DEFAULT_API_URL,
-        api_key: str = None,
-        with_gui: bool = False,
-    ) -> Tuple[Any, Generator]:
-        """
-        Run an application as an Artefacts-enabled container in a Docker engine
-
-        The arguments are considered straightforward, except the different
-        priorities between `artefacts_dir` and `api_key`:
-        * `api_key` has the highest priority. When specified, `artefacts_dir`
-          is ignored. The container will rely on the key as an environment
-          variable (ARTEFACTS_KEY).
-        * Whenever `api_key` is not provided, the container gets `artefacts_dir`
-          mounted as volume. The directory must contain a valid configuration
-          with the project's key.
-        """
-        env = {
-            "JOB_ID": str(uuid4()),
-            "ARTEFACTS_JOB_NAME": jobname,
-            "ARTEFACTS_API_URL": api_url,
-        }
-
-        env["ARTEFACTS_KEY"] = self._get_artefacts_api_key(project, artefacts_dir)
-        if env["ARTEFACTS_KEY"] is None:
-            return None, iter(
-                [
-                    f"Missing API key for the project. Does `{artefacts_dir}/config` exist and contain your key? Alternatively ARTEFACTS_KEY can be set with the key."
-                ]
-            )
-        try:
-            if platform.system() in ["Darwin", "Windows"]:
-                # Assume we run in Docker Desktop
-                env["DISPLAY"] = "host.docker.internal:0"
-            else:
-                env["DISPLAY"] = os.environ.get("DISPLAY", ":0")
-
-            if not with_gui:
-                env["QT_QPA_PLATFORM"] = "offscreen"
-
-            container_conf = dict(
-                image=image,
-                environment=env,
-                detach=False,
-                host_config=self.client.create_host_config(
-                    network_mode="host",
-                ),
-            )
-
-            container = self.client.create_container(**container_conf)
-            self.client.start(container=container.get("Id"))
-
-            for entry in self.client.logs(container=container.get("Id"), stream=True):
-                print(entry.decode("utf-8").strip())
-
-            return container, iter([])
-        except docker.errors.ImageNotFound:
-            return None, iter(
-                [f"Image {image} not found by Docker. Perhaps need to build first?"]
-            )
-        except Exception as e:
-            return None, iter([f"Failed to run from {image}. All we know: {e}"])

artefacts_cli-0.8.0.dist-info/RECORD

@@ -1,24 +0,0 @@
-artefacts/__init__.py,sha256=VLmogtpRQeJjQjAORV8ClSJ5qF-57Hxx3apvgy9H1zk,76
-artefacts/cli/__init__.py,sha256=qIHUUf51UoviMtChkO5Qn-9ZzC5nH7vPE-QlqC30cRE,12080
-artefacts/cli/app.py,sha256=2ogpU_zZuynCu3lz5Ai2PqFiVFiGVdBZojeD7qNZqyk,24831
-artefacts/cli/app_containers.py,sha256=sRjm-z1Bbp81UE-GFrXv-0XiB6bCDsiMcsEOuT24dww,6413
-artefacts/cli/bagparser.py,sha256=FE_QaztC9pg4hQzTjGSdyve6mzZbHJbyqa3wqvZSbxE,3702
-artefacts/cli/constants.py,sha256=bvsVDwqkAc49IZN7j6k6IL6EG87bECHd_VINtKJqbv8,320
-artefacts/cli/errors.py,sha256=BiCRo3IwVjtEotaFtmwsGTZiX-TRE69KqLrEQItLsag,34
-artefacts/cli/logger.py,sha256=PklhdEs-T8p9eogX7O_i6Gmw3v707y1Z0vgVwxBu96Q,792
-artefacts/cli/other.py,sha256=Jp15jLjttMk0JW15EAU5hgQNAkbX7vMGyjdWectehlw,1317
-artefacts/cli/parameters.py,sha256=msf2aG-tmw0ahxwrPpB2W6KqdMj5A-nw9DPG9flkHTg,788
-artefacts/cli/ros1.py,sha256=rKepZckAuy5O_qraF2CW5GiTmTZHar7LRD4pvESy6T0,9622
-artefacts/cli/ros2.py,sha256=UMC1-6h0LhUhvXZist134WG18Tgm0y1DZeHqFNDOEKk,8495
-artefacts/cli/utils.py,sha256=oy56o3N361srwhIvbMxwSPg8I_-tC7xcWtTSINTF2rE,4125
-artefacts/cli/utils_ros.py,sha256=D6NSsF-5EfkQjCa6KAL7pFNRpu3JyH3nb0UEEz2SEqQ,2156
-artefacts/cli/version.py,sha256=fSm5pLlwHxfTD7vBTVEqChJUua9ilUsdQYNN_V3u3iE,511
-artefacts/cli/containers/__init__.py,sha256=K0efkJXNCqXH-qYBqhCE_8zVUCHbVmeuKH-y_fE8s4M,2254
-artefacts/cli/containers/docker.py,sha256=R0yA-aIZCyYWN7gzim_Dhn1owpKI9ekMu6qbz5URYbQ,4311
-artefacts/cli/containers/utils.py,sha256=bILX0uvazUJq7hoqKk4ztRzI_ZerYs04XQdKdx1ltjk,2002
-artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
-artefacts_cli-0.8.0.dist-info/METADATA,sha256=D2FpCO_zKGpEeeoRiUnaMLV5mcZS14Wu-rc4MpVq7zs,3183
-artefacts_cli-0.8.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-artefacts_cli-0.8.0.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
-artefacts_cli-0.8.0.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
-artefacts_cli-0.8.0.dist-info/RECORD,,