artefacts-cli 0.7.2__tar.gz → 0.8.0__tar.gz

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2025-04-04
+
 ### Added
 
 - Run in containers with only an artefacts.yaml configuration file. No need to
@@ -16,6 +18,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New logging messages and format.
 
+### Fixed
+
+- Logging correctly filters between logs for stderr and stdout
+- Client now correctly handles rosbags not saved to the top level of a project.
+- Fixed error formatting of test error(s).
+
+## [0.7.3] - 2025-03-26
+
+### Fixed
+
+- Handle nested ROS params in the configuration file.
 
 ## [0.7.2] - 2025-03-19
 

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: artefacts_cli
-Version: 0.7.2
+Version: 0.8.0
 Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
 Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
 Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/__init__.py

@@ -133,6 +133,7 @@ class WarpRun:
         self.output_path = self.params.get(
             "output_path", f"{self.job.output_path}/{self.run_n}"
         )
+        self.logger = logger
         os.makedirs(self.output_path, exist_ok=True)
         data = {
             "job_id": job.job_id,
@@ -155,10 +156,10 @@ class WarpRun:
         if response.status_code != 200:
             if response.status_code == 403:
                 msg = response.json()["message"]
-                logger.warning(msg)
+                self.logger.warning(msg)
                 raise AuthenticationError(msg)
-            logger.warning(f"Error on scenario creation: {response.status_code}")
-            logger.warning(response.text)
+            self.logger.warning(f"Error on scenario creation: {response.status_code}")
+            self.logger.warning(response.text)
             raise AuthenticationError(str(response.status_code))
         return
 
@@ -275,9 +276,11 @@ class WarpRun:
                         files=files,
                     )
                 except OverflowError:
-                    logger.warning(f"File too large: {file_name} could not be uploaded")
+                    self.logger.warning(
+                        f"File too large: {file_name} could not be uploaded"
+                    )
                 except Exception as e:
-                    logger.warning(f"Error uploading {file_name}: {e}, skipping")
+                    self.logger.warning(f"Error uploading {file_name}: {e}, skipping")
 
 
 def init_job(

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/app.py

@@ -244,6 +244,11 @@ def hello(project_name):
     default=False,
     help='[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.',
 )
+@click.option(
+    "--dockerfile",
+    default="Dockerfile",
+    help="[Experimental] Path to a custom Dockerfile. Defaults to Dockerfile in the run directory. This flag is only used together with `--in-container`",
+)
 @click.option(
     "--with-image",
     default=None,
@@ -274,6 +279,7 @@ def run(
     description="",
     skip_validation=False,
     in_container: bool = False,
+    dockerfile: str = "Dockerfile",
     with_image: str = "artefacts",
     no_rebuild: bool = False,
     with_gui: bool = False,
@@ -283,6 +289,12 @@ def run(
 
     * Directly in the shell by default.
     * Inside a packaged container when using the --in-container option.
+
+    In container mode:
+    * Images are built automatically if missing.
+    * Currently 1 image per job found in artefacts.yaml.
+    * Images are rebuilt at each run (relatively fast when no change).
+    * `dockerfile` allows to specify an alternative Dockerfile.
     """
     warpconfig = read_config(config)
     project_id = warpconfig["project"]
@@ -296,6 +308,8 @@ def run(
             ctx.invoke(
                 containers.build,
                 root=".",
+                dockerfile=dockerfile,
+                only=[jobname],
             )
             click.echo(f"[{jobname}] Container image ready")
         click.echo(f"[{jobname}] Run in container")

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/app_containers.py

@@ -1,5 +1,6 @@
 import os
 from pathlib import Path
+from typing import Optional
 
 import click
 
@@ -45,6 +46,13 @@ def containers(ctx: click.Context, debug: bool):
     default="artefacts.yaml",
     help="Path to the Artefacts configuration file. It defaults to `./artefacts.yaml`",
 )
+@click.option(
+    "--only",
+    required=False,
+    type=Optional[list],
+    default=None,
+    help="Optional list of job names to process. The default is to process all jobs.",
+)
 @click.pass_context
 def build(
     ctx: click.Context,
@@ -53,6 +61,7 @@ def build(
     dockerfile: str,
     name: str,
     config: str,
+    only: Optional[list] = None,
 ):
     try:
         artefacts_config = read_config(config)
@@ -63,7 +72,11 @@ def build(
     prefix = artefacts_config["project"].strip().lower()
     dockerfiles = []
     if os.path.exists(dockerfile):
-        for job_name in artefacts_config["jobs"]:
+        if only:
+            jobs = only
+        else:
+            jobs = artefacts_config["jobs"]
+        for job_name in jobs:
             dockerfiles.append(
                 dict(
                     path=root,
@@ -71,6 +84,11 @@ def build(
                     name=f"{prefix}/{job_name.strip().lower()}",
                 )
             )
+    elif dockerfile != "Dockerfile" and not os.path.exists(dockerfile):
+        # The user asks explicitly for using a specific Dockerfile, so fast fail if we cannot find it
+        raise click.ClickException(
+            f"Dockerfile `{dockerfile}` not found. Please ensure the file exits. Automatic Dockerfile generation may also work by dropping the --dockerfile option."
+        )
     else:
         # The split on `prefix` is to ensure there is no slash (project names are org/project) confusing the path across supported OS.
         dest_root = (
@@ -90,6 +108,8 @@ def build(
         scenarios = Converter().process(config, as_text=False)
         for idx, df in enumerate(scenarios.values()):
             job_name = df.job_name.strip().lower()
+            if only and job_name not in only:
+                continue
             dest = dest_root / Path(job_name)
             dest.mkdir(parents=True, exist_ok=True)
             _dockerfile = os.path.join(dest, "Dockerfile")

artefacts_cli-0.8.0/artefacts/cli/logger.py

@@ -0,0 +1,26 @@
+import logging
+import sys
+
+logger = logging.getLogger("artefacts")
+logger.setLevel(logging.INFO)  # Allow INFO and above
+
+
+# INFO and WARNING messages go to stdout
+class InfoWarningFilter(logging.Filter):
+    def filter(self, record):
+        return record.levelno in [logging.INFO, logging.WARNING]
+
+
+info_handler = logging.StreamHandler(stream=sys.stdout)
+info_handler.setLevel(logging.INFO)
+info_handler.addFilter(InfoWarningFilter())
+info_handler.setFormatter(logging.Formatter("%(message)s"))
+
+# ERROR and above go to stderr
+error_handler = logging.StreamHandler(stream=sys.stderr)
+error_handler.setLevel(logging.ERROR)
+error_handler.setFormatter(logging.Formatter("%(levelname)s: %(message)s"))
+
+logger.addHandler(info_handler)
+logger.addHandler(error_handler)
+logger.propagate = False

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/other.py

@@ -16,6 +16,9 @@ def generate_parameter_output(params: dict):
 
 
 def run_other_tests(run):
+    """Note: parameter names will be set as environment variables
+    (must be letters, numbers and underscores), and saved into yaml and json files
+    """
     scenario = run.params
     if "params" in scenario:
         generate_parameter_output(scenario["params"])

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/ros2.py

@@ -2,7 +2,6 @@ import yaml
 from glob import glob
 import os
 import shutil
-
 from .utils import run_and_save_logs
 from .utils_ros import parse_tests_results, get_TestSuite_error_result
 from .parameters import TMP_SCENARIO_PARAMS_YAML
@@ -70,7 +69,14 @@ def generate_scenario_parameter_output(params: dict, param_file: str):
             return
         if node not in content:
             content[node] = {"ros__parameters": {}}
-        content[node]["ros__parameters"][pname] = v
+        # handles nested keys for params in the form of dot notation
+        current_level = content[node]["ros__parameters"]
+        keys = pname.split(".")
+        for key in keys[:-1]:
+            if key not in current_level:
+                current_level[key] = {}
+            current_level = current_level[key]
+        current_level[keys[-1]] = v
     with open(param_file, "w") as f:
         yaml.dump(content, f)
 
@@ -86,8 +92,11 @@ def run_ros2_tests(run):
         generate_scenario_parameter_output(
             run.params["params"], TMP_SCENARIO_PARAMS_YAML
         )
-
-    preexisting_rosbags = glob("rosbag2*")
+    # We look for the directory as drilling down will find both
+    # the directory as well as the rosbag itself.
+    preexisting_rosbags = [
+        path for path in glob("**/rosbag2*", recursive=True) if os.path.isdir(path)
+    ]
     test_result_file_path = f"{run.output_path}/tests_junit.xml"
     launch_arguments = [
         f"{k}:={v}" for k, v in run.params.get("launch_arguments", {}).items()
@@ -175,33 +184,40 @@ def run_ros2_tests(run):
     for output in scenario.get("output_dirs", []):
         run.log_artifacts(output)
 
-    # check if any rosbag was created
-    rosbags = glob("rosbag2*")
+    # Checks for a new rosbag after test completions. We look for the directory
+    # as drilling down will find both the directory as well as the rosbag itself.
+    rosbags = [
+        path for path in glob("**/rosbag2*", recursive=True) if os.path.isdir(path)
+    ]
     new_rosbags = set(rosbags).difference(set(preexisting_rosbags))
     from artefacts.cli.bagparser import BagFileParser
 
+    run.logger.info(f"Found new rosbags: {new_rosbags}")
     if len(new_rosbags) > 0:
-        rosbag_path = new_rosbags.pop()
-        run.log_artifacts(rosbag_path, "rosbag")
+        rosbag_dir = new_rosbags.pop()
+        run.log_artifacts(rosbag_dir, "rosbag")
         if "metrics" in run.params:
-            # TODO should go inside BagFileParser?
-            db_files = glob(f"{rosbag_path}/*.mcap")  # Ros2 Default
+            # Search for database files in the directory
+            # TODO: should go inside BagFileParser?
+            db_files = glob(f"{rosbag_dir}/*.mcap")  # Ros2 Default
             if not db_files:
-                db_files = glob(f"{rosbag_path}/*.db3")  # Legacy
+                db_files = glob(f"{rosbag_dir}/*.db3")  # Legacy
             if not db_files:
                 raise FileNotFoundError(
-                    "No .mcap or .db3 files found in the specified path."
+                    "No .mcap or .db3 files found in the specified path. Attempted to find in "
+                    f"{rosbag_dir}/*.mcap and {rosbag_dir}/*.db3"
                 )
             db_file = db_files[0]
+
             bag = BagFileParser(db_file)
             for metric in run.params["metrics"]:
                 try:
                     last_value = bag.get_last_message(metric)[1].data
                     run.log_metric(metric, last_value)
                 except KeyError:
-                    print(f"Metric {metric} not found in rosbag, skipping.")
+                    run.logger.error(f"Metric {metric} not found in rosbag, skipping.")
                 except TypeError or IndexError:
-                    print(
+                    run.logger.error(
                         f"Metric {metric} not found. Is it being published?. Skipping."
                     )
 

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/utils_ros.py

@@ -66,9 +66,9 @@ def parse_tests_results(file):
     except Exception as e:
         print(f"[Exception in parse_tests_results] {e}")
         print("Test result xml could not be loaded, marking success as False")
-        results = get_TestSuite_error_result(
+        result = get_TestSuite_error_result(
             "unittest.suite.TestSuite",
             "Error parsing XML test results",
             f"The test may have timed out. Exception: {e}",
         )
-        return results, None
+        return [result], None

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts/cli/version.py

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

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: artefacts_cli
-Version: 0.7.2
+Version: 0.8.0
 Author-email: FD <fabian@artefacts.com>, AGC <alejandro@artefacts.com>, TN <tomo@artefacts.com>, EP <eric@artefacts.com>
 Project-URL: Homepage, https://github.com/art-e-fact/artefacts-client
 Project-URL: Bug Tracker, https://github.com/art-e-fact/artefacts-client/issues

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/artefacts_cli.egg-info/SOURCES.txt

@@ -57,6 +57,7 @@ tests/cli/test_parameters.py
 tests/cli/test_ros1.py
 tests/cli/test_ros2.py
 tests/cli/test_utils.py
+tests/cli/test_utils_ros.py
 tests/cli/test_warp.py
 tests/cli/containers/__init__.py
 tests/cli/containers/test_utils.py

{artefacts_cli-0.7.2 → artefacts_cli-0.8.0}/tests/cli/test_ros2.py

@@ -1,6 +1,6 @@
 import os
 import yaml
-from unittest.mock import patch
+from unittest.mock import patch, MagicMock
 import pytest
 
 from artefacts.cli import WarpJob, WarpRun
@@ -18,12 +18,28 @@ from artefacts.cli.ros2 import (
 
 
 def test_generate_parameter_output(tmp_path):
-    params = {"turtle/speed": 5}
+    params = {
+        "turtle/speed": 5,
+        "turtle/color.rgb.r": 255,
+        "controller_server/FollowPath.critics": ["RotateToGoal", "Oscillation"],
+    }
     file_path = tmp_path / "params.yaml"
     generate_scenario_parameter_output(params, file_path)
     with open(file_path) as f:
         ros2_params = yaml.load(f, Loader=yaml.Loader)
-    assert ros2_params == {"turtle": {"ros__parameters": {"speed": 5}}}
+    assert ros2_params == {
+        "turtle": {
+            "ros__parameters": {
+                "speed": 5,
+                "color": {"rgb": {"r": 255}},
+            }
+        },
+        "controller_server": {
+            "ros__parameters": {
+                "FollowPath": {"critics": ["RotateToGoal", "Oscillation"]}
+            }
+        },
+    }
 
 
 @patch("os.path.exists", return_value=False)
@@ -82,3 +98,53 @@ def test_run_and_save_logs_bad_ros2_launchtest():
             env=os.environ,
             output_path="/tmp/test_log.txt",
         )
+
+
+@patch("artefacts.cli.ros2.glob")
+@patch("os.path.isdir", return_value=True)
+@patch("artefacts.cli.bagparser.BagFileParser")
+@patch("artefacts.cli.ros2.parse_tests_results", return_value=([], True))
+@patch("artefacts.cli.ros2.run_and_save_logs", return_value=(0, "", ""))
+@pytest.mark.ros2
+def test_rosbag_discovered_and_metric_logged(
+    mock_run_logs, mock_parse, mock_bag_parser, mock_isdir, mock_glob
+):
+    # Setup test environment
+    os.environ["ARTEFACTS_JOB_ID"] = "test_job_id"
+    os.environ["ARTEFACTS_KEY"] = "test_key"
+
+    job = WarpJob(
+        "test_project_id", APIConf("test_url"), "test_jobname", {}, dryrun=True
+    )
+    scenario = {"ros_testfile": "test_launch.py", "metrics": ["topic1"]}
+    run = WarpRun(job, scenario, 0)
+
+    # Patch the methods to verify
+    run.log_artifacts = MagicMock()
+    run.log_metric = MagicMock()
+
+    # mock returns
+    preexisting_rosbags = [
+        "src/my_test_folder/rosbag2_existing",
+        "src/venv/some_rosbag_package/rosbag2_existing",
+    ]
+    all_rosbags = [
+        "src/my_test_folder/rosbag2_existing",
+        "src/venv/some_rosbag_package/rosbag2_existing",
+        "src/my_test_folder/rosbag2_new",
+    ]
+    bag_files = ["src/my_test_folder/rosbag2_new/test.mcap"]
+    mock_glob.side_effect = [preexisting_rosbags, all_rosbags, bag_files]
+
+    # BagFileParser mock
+    mock_bag = MagicMock()
+    mock_bag.get_last_message.return_value = (None, MagicMock(data=42.0))
+    mock_bag_parser.return_value = mock_bag
+
+    run_ros2_tests(run)
+
+    # Assert the right new rosbag directory was found
+    run.log_artifacts.assert_any_call("src/my_test_folder/rosbag2_new", "rosbag")
+
+    # Assert the right metric was logged
+    run.log_metric.assert_called_with("topic1", 42.0)

artefacts_cli-0.8.0/tests/cli/test_utils_ros.py

@@ -0,0 +1,9 @@
+from artefacts.cli.utils_ros import parse_tests_results
+
+
+def test_parse_tests_results():
+    # Create a XML file for testing
+    test_file = "test.xml"
+    results, _ = parse_tests_results(test_file)
+    assert type(results) is list
+    assert len(results) == 1

artefacts_cli-0.7.2/artefacts/cli/logger.py

@@ -1,10 +0,0 @@
-import logging
-import sys
-
-logger = logging.getLogger()
-
-default_handler = logging.StreamHandler(stream=sys.stderr)
-default_handler.setLevel(logging.ERROR)
-default_handler.setFormatter(logging.Formatter())
-
-logger.addHandler(default_handler)