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

artefacts_cli-0.7.2/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Run in containers with only an artefacts.yaml configuration file. No need to
+  write a Dockerfile in many standard situations.
+
+### Changed
+
+- New logging messages and format.
+
+
+## [0.7.2] - 2025-03-19
+
+### Fixed
+
+- Fixed error handling (bug from misuse of Click's `ClickException`).
+
+### Changed
+
+- Improved error handling and messages.
+
+
+## [0.7.1] - 2025-03-14
+
+### Added
+
+- Partial CHANGELOG with information on the day we start SemVer and the current
+  0.7.0. More detail to come inbetween, but we will focus on the future.
+
+### Changed
+
+- Replace Ruff shield for the original Black one.
+
+
+## [0.7.0] - 2025-02-25
+
+### Added
+
+- Default upload directory to automatically include output from the Artefacts
+  toolkit.
+
+### Changed
+
+- Always rebuild container images before run. These incremental rebuilds avoid
+  existing confusion when running an updated code base without rebuilding.
+- Separate CD workflow from PyPi publication testing: For reusability and
+  direct invocation.
+
+
+## [0.5.8] - 2024-08-19
+
+### Added
+
+- Beginning of semantic versioning.
+- Local metrics errors do not block publication of results.
+- Introduction of Black formatting. 
+
+[unreleased]: https://github.com/art-e-fact/artefacts-client/compare/0.7.0...HEAD
+[0.7.0]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.7.0
+[0.5.8]: https://github.com/art-e-fact/artefacts-client/releases/tag/0.5.8

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

@@ -1,14 +1,16 @@
 Metadata-Version: 2.2
 Name: artefacts_cli
-Version: 0.7.0
+Version: 0.7.2
 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
+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: gitignore_parser>=0.1.11
@@ -42,7 +44,7 @@ Requires-Dist: twine; extra == "dev"
 CLI to the Artefacts platform.
 
 [![Documentation](https://img.shields.io/badge/documentation-blue.svg?style=flat-square)](https://docs.artefacts.com/)
-[![Code style: Black-compatible with Ruff](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff Style](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ## Requirements
 

{artefacts_cli-0.7.0 → artefacts_cli-0.7.2}/README.md

@@ -3,7 +3,7 @@
 CLI to the Artefacts platform.
 
 [![Documentation](https://img.shields.io/badge/documentation-blue.svg?style=flat-square)](https://docs.artefacts.com/)
-[![Code style: Black-compatible with Ruff](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Ruff Style](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 ## Requirements
 

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

@@ -71,7 +71,7 @@ def get_artefacts_api_url(project_profile):
 
 
 class APIConf:
-    def __init__(self, project_name):
+    def __init__(self, project_name: str, job_name: str = None) -> None:
         config = get_conf_from_file()
         if project_name in config:
             profile = config[project_name]
@@ -96,7 +96,10 @@ class APIConf:
         self.headers["User-Agent"] = (
             f"ArtefactsClient/{__version__} ({platform.platform()}/{platform.python_version()})"
         )
-        click.echo(f"Connecting to {self.api_url} using {auth_type}")
+        if job_name:
+            click.echo(f"[{job_name}] Connecting to {self.api_url} using {auth_type}")
+        else:
+            click.echo(f"Connecting to {self.api_url} using {auth_type}")
 
 
 def validate_artefacts_config(config_file: str) -> dict:
@@ -243,8 +246,8 @@ def hello(project_name):
 )
 @click.option(
     "--with-image",
-    default="artefacts",
-    help="[Experimental] Run the job using the image name passed here. Only used when running with --in-container set.",
+    default=None,
+    help="[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.",
 )
 @click.option(
     "--no-rebuild",
@@ -281,38 +284,37 @@ def run(
     * Directly in the shell by default.
     * Inside a packaged container when using the --in-container option.
     """
+    warpconfig = read_config(config)
+    project_id = warpconfig["project"]
+
     if in_container:
-        image_exist = ctx.invoke(containers.check, name=with_image)
-        if not no_rebuild or not image_exist:
-            if image_exist:
-                announce = "Rebuilding container image to prepare the run..."
-            else:
-                announce = "Building container image to prepare the run..."
-            click.echo(announce)
+        click.echo("#" * 80)
+        click.echo(f"# Job {jobname}".ljust(79, " ") + "#")
+        click.echo("#" * 80)
+        click.echo(f"[{jobname}] Checking container image")
+        if not no_rebuild:
             ctx.invoke(
-                containers.build, path=".", dockerfile="Dockerfile", name=with_image
+                containers.build,
+                root=".",
             )
-            click.echo("Build complete.\n")
-        click.echo("Starting the container run...")
+            click.echo(f"[{jobname}] Container image ready")
+        click.echo(f"[{jobname}] Run in container")
         return ctx.invoke(
             containers.run,
-            image=with_image,
             jobname=jobname,
             config=config,
             with_gui=with_gui,
         )
 
-    warpconfig = read_config(config)
-
-    project_id = warpconfig["project"]
-    api_conf = APIConf(project_id)
-    click.echo(f"Starting tests for {project_id}")
+    api_conf = APIConf(project_id, jobname)
+    click.echo(f"[{jobname}] Starting tests")
     if jobname not in warpconfig["jobs"]:
-        raise click.ClickException(f"Job {jobname} not defined")
+        click.secho(f"[{jobname}] Error: Job name not defined", err=True, bold=True)
+        raise click.Abort()
     jobconf = warpconfig["jobs"][jobname]
     job_type = jobconf.get("type", "test")
     if job_type not in ["test"]:
-        click.echo(f"Job type not supported: f{job_type}")
+        click.echo(f"[{jobname}] Job type not supported: {job_type}")
         return
 
     framework = jobconf["runtime"].get("framework", None)
@@ -321,19 +323,19 @@ def run(
     if framework in DEPRECATED_FRAMEWORKS.keys():
         migrated_framework = DEPRECATED_FRAMEWORKS[framework]
         click.echo(
-            f"The selected framework '{framework}' is deprecated. Using '{migrated_framework}' instead."
+            f"[{jobname}] The selected framework '{framework}' is deprecated. Using '{migrated_framework}' instead."
         )
         framework = migrated_framework
 
     if framework not in SUPPORTED_FRAMEWORKS:
         click.echo(
-            f"WARNING: framework: '{framework}' is not officially supported. Attempting run."
+            f"[{jobname}] WARNING: framework: '{framework}' is not officially supported. Attempting run."
         )
 
     batch_index = os.environ.get("AWS_BATCH_JOB_ARRAY_INDEX", None)
     if batch_index is not None:
         batch_index = int(batch_index)
-        click.echo(f"AWS BATCH ARRAY DETECTED, batch_index={batch_index}")
+        click.echo(f"[{jobname}] AWS BATCH ARRAY DETECTED, batch_index={batch_index}")
     scenarios, first = generate_scenarios(jobconf, batch_index)
     context = None
     execution_context = getpass.getuser() + "@" + platform.node()
@@ -356,30 +358,46 @@ def run(
             first,
         )
     except AuthenticationError:
-        raise click.ClickException(
-            "Unable to authenticate (Stage: Job initialisation), please check your project name and API key"
+        click.secho(
+            f"[{jobname}] Unable to authenticate (Stage: Job initialisation), please check your project name and API key",
+            err=True,
+            bold=True,
         )
+        raise click.Abort()
 
     job_success = True
     for scenario_n, scenario in enumerate(scenarios):
         click.echo(
-            f"Starting scenario {scenario_n + 1}/{len(scenarios)}: {scenario['name']}"
+            f"[{jobname}] Starting scenario {scenario_n + 1}/{len(scenarios)}: {scenario['name']}"
         )
         try:
             run = warpjob.new_run(scenario)
         except AuthenticationError:
-            raise click.ClickException(
-                "Unable to authenticate (Stage: Job run), please check your project name and API key"
+            click.secho(
+                f"[{jobname}] Unable to authenticate (Stage: Job run), please check your project name and API key",
+                err=True,
+                bold=True,
             )
+            raise click.Abort()
         if framework is not None and framework.startswith("ros2:"):
             from artefacts.cli.ros2 import run_ros2_tests
+            from artefacts.cli.utils_ros import get_TestSuite_error_result
 
             if "ros_testfile" not in run.params:
-                raise click.ClickException(
-                    "Test launch file not specified for ros2 project"
+                click.secho(
+                    f"[{jobname}] Test launch file not specified for ros2 project",
+                    err=True,
+                    bold=True,
+                )
+                result = get_TestSuite_error_result(
+                    scenario["name"],
+                    "launch_test file not specified error",
+                    f"Please specify a `ros_testfile` in the artefacts.yaml scenario configuration.",
                 )
+                run.log_tests_results([result], False)
+                run.stop()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 try:
@@ -388,25 +406,36 @@ def run(
                     warpjob.stop()
                     warpjob.log_tests_result(False)
                     click.secho(e, bold=True, err=True)
-                    raise click.ClickException("artefacts failed to execute the tests")
+                    click.secho(
+                        f"[{jobname}] artefacts failed to execute the tests",
+                        err=True,
+                        bold=True,
+                    )
+                    raise click.Abort()
             if success is None:
                 run.stop()
                 warpjob.stop()
                 warpjob.log_tests_result(job_success)
-                raise click.ClickException(
-                    "Not able to execute tests. Make sure that ROS2 is sourced and that your launch file syntax is correct."
+                click.secho(
+                    f"[{jobname}] Not able to execute tests. Make sure that ROS2 is sourced and that your launch file syntax is correct.",
+                    err=True,
+                    bold=True,
                 )
+                raise click.Abort()
             if not success:
                 job_success = False
         elif framework is not None and framework.startswith("ros1:"):
             from artefacts.cli.ros1 import run_ros1_tests
 
             if "ros_testfile" not in run.params:
-                raise click.ClickException(
-                    "Test launch file not specified for ros1 project"
+                click.secho(
+                    f"[{jobname}] Test launch file not specified for ros1 project",
+                    err=True,
+                    bold=True,
                 )
+                raise click.Abort()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 results, success = run_ros1_tests(run)
@@ -416,9 +445,14 @@ def run(
             from artefacts.cli.other import run_other_tests
 
             if "run" not in run.params:
-                raise click.ClickException("run command not specified for scenario")
+                click.secho(
+                    f"[{jobname}] run command not specified for scenario",
+                    err=True,
+                    bold=True,
+                )
+                raise click.Abort()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 results, success = run_other_tests(run)
@@ -432,7 +466,7 @@ def run(
 
         run.stop()
     warpjob.log_tests_result(job_success)
-    click.echo("Done")
+    click.echo(f"[{jobname}] Done")
     time.sleep(random.random() * 1)
 
     warpjob.stop()
@@ -553,17 +587,23 @@ def run_remote(config, description, jobname, skip_validation=False):
                     f"Missing access! Please make sure your API key is added at {dashboard_url}/settings"
                 )
 
-            if (
-                upload_urls_response.status_code == 401
-                and result["message"] == "no linked repository"
-            ):
+            if upload_urls_response.status_code == 402:
                 raise click.ClickException(
-                    f"Missing linked GitHub repository. Please link a GitHub repository at {dashboard_url}/settings"
+                    f"Billing issue, please go to {dashboard_url}/settings to correct: {result['error']}"
                 )
 
-            raise click.ClickException(
-                f"Error getting project info: {result['message']}"
-            )
+            if "message" in result:
+                raise click.ClickException(
+                    f"Error getting project info: {result['message']}"
+                )
+            elif "error" in result:
+                raise click.ClickException(
+                    f"Error getting project info: {result['error']}"
+                )
+            else:
+                raise click.ClickException(
+                    f"Error getting project info: {upload_urls_response.status_code} {upload_urls_response.reason}. Response text: {upload_urls_response.text}."
+                )
 
         upload_urls = upload_urls_response.json()["upload_urls"]
         url = ""

artefacts_cli-0.7.2/artefacts/cli/app_containers.py

@@ -0,0 +1,165 @@
+import os
+from pathlib import Path
+
+import click
+
+from c2d.core import Converter
+
+from artefacts.cli.constants import DEFAULT_API_URL
+from artefacts.cli.utils import config_validation, read_config
+from artefacts.cli.containers.utils import ContainerMgr
+
+
+@click.group()
+@click.option("--debug/--no-debug", default=False)
+@click.pass_context
+def containers(ctx: click.Context, debug: bool):
+    ctx.ensure_object(dict)
+    ctx.obj["debug"] = debug
+
+
+@containers.command()
+@click.option(
+    "--path",
+    default=".",
+    help="[Deprecated since 0.8.0; please see --root] Path to the root of the project.",
+)
+@click.option(
+    "--root",
+    default=".",
+    help="Path to the root of the project.",
+)
+@click.option(
+    "--dockerfile",
+    default="Dockerfile",
+    help="Path to a custom Dockerfile. Defaults to Dockerfile under `path` (see option of the same name).",
+)
+@click.option(
+    "--name",
+    required=False,
+    help="[Deprecated since 0.8.0; not used and will disappear after 0.8.0] Name for the generated image",
+)
+@click.option(
+    "--config",
+    callback=config_validation,
+    default="artefacts.yaml",
+    help="Path to the Artefacts configuration file. It defaults to `./artefacts.yaml`",
+)
+@click.pass_context
+def build(
+    ctx: click.Context,
+    path: str,
+    root: str,
+    dockerfile: str,
+    name: str,
+    config: str,
+):
+    try:
+        artefacts_config = read_config(config)
+    except FileNotFoundError:
+        raise click.ClickException(
+            f"Project config file not found: {config}. Please provide an Artefacts configuration file to proceed (running `artefacts init` allows to generate one)."
+        )
+    prefix = artefacts_config["project"].strip().lower()
+    dockerfiles = []
+    if os.path.exists(dockerfile):
+        for job_name in artefacts_config["jobs"]:
+            dockerfiles.append(
+                dict(
+                    path=root,
+                    dockerfile=dockerfile,
+                    name=f"{prefix}/{job_name.strip().lower()}",
+                )
+            )
+    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 = (
+            Path.home()
+            / Path(".artefacts")
+            / Path("projects")
+            / Path(*(prefix.split("/")))
+            / Path("containers")
+        )
+        if not dest_root.exists():
+            click.echo(
+                f"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."
+            )
+        # No condition on generating the Dockerfiles as:
+        #   - Fast
+        #   - We consider entirely managed, so any manual change should be ignored.
+        scenarios = Converter().process(config, as_text=False)
+        for idx, df in enumerate(scenarios.values()):
+            job_name = df.job_name.strip().lower()
+            dest = dest_root / Path(job_name)
+            dest.mkdir(parents=True, exist_ok=True)
+            _dockerfile = os.path.join(dest, "Dockerfile")
+            df.dump(_dockerfile)
+            click.echo(f"[{job_name}] Using generated Dockerfile at: {_dockerfile}")
+            dockerfiles.append(
+                dict(
+                    path=root,
+                    dockerfile=_dockerfile,
+                    name=f"{prefix}/{job_name}",
+                )
+            )
+    handler = ContainerMgr()
+    if len(dockerfiles) > 0:
+        for specs in dockerfiles:
+            # No condition on building the images, as relatively fast when already exists, and straightforward logic.
+            image, _ = handler.build(**specs)
+    else:
+        click.echo("No Dockerfile, nothing to do.")
+
+
+@containers.command()
+@click.argument("name")
+@click.pass_context
+def check(ctx: click.Context, name: str):
+    if name is None:
+        name = "artefacts"
+    handler = ContainerMgr()
+    result = handler.check(name)
+    if ctx.parent is None:
+        # Print only if the command is called directly.
+        print(f"Package {name} exists and ready to use.")
+    return result
+
+
+@containers.command()
+@click.argument("jobname")
+@click.option(
+    "--config",
+    callback=config_validation,
+    default="artefacts.yaml",
+    help="Path to the Artefacts configuration file. It defaults to `./artefacts.yaml`",
+)
+@click.option(
+    "--with-gui",
+    "with_gui",
+    default=False,
+    help="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.",
+)
+@click.pass_context
+def run(ctx: click.Context, jobname: str, config: str, with_gui: bool):
+    try:
+        artefacts_config = read_config(config)
+    except FileNotFoundError:
+        raise click.ClickException(f"Project config file not found: {config}")
+    project = artefacts_config["project"]
+    handler = ContainerMgr()
+    params = dict(
+        image=f"{project.strip().lower()}/{jobname}",
+        project=project,
+        jobname=jobname,
+        with_gui=with_gui,
+        # Hidden settings primarily useful to Artefacts developers
+        api_url=os.environ.get("ARTEFACTS_API_URL", DEFAULT_API_URL),
+        api_key=os.environ.get("ARTEFACTS_KEY", None),
+    )
+    container, logs = handler.run(**params)
+    if container:
+        print(f"Package run complete: Container Id for inspection: {container['Id']}")
+    else:
+        print("Package run failed:")
+        for entry in logs:
+            print("\t- " + entry)

{artefacts_cli-0.7.0 → artefacts_cli-0.7.2}/artefacts/cli/containers/docker.py

@@ -22,6 +22,10 @@ class DockerManager(CMgr):
 
     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):
@@ -32,7 +36,7 @@ class DockerManager(CMgr):
                 if "stream" in data:
                     line = data["stream"].strip()
                     if not line.startswith("---") and len(line) > 0:
-                        print(line)
+                        print(f"[{kwargs['tag'].split('/')[-1]}] {line}")
                         logs.append(line)
                 elif "aux" in data and "ID" in data["aux"]:
                     img_id = data["aux"]["ID"]