artefacts-cli 0.6.19__tar.gz → 0.7.1__tar.gz

artefacts_cli-0.7.1/CHANGELOG.md

@@ -0,0 +1,57 @@
+# 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.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.6.19 → artefacts_cli-0.7.1}/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.2
 Name: artefacts_cli
-Version: 0.6.19
+Version: 0.7.1
 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.6.19 → artefacts_cli-0.7.1}/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.1/artefacts/__init__.py

@@ -0,0 +1,4 @@
+from pathlib import Path
+
+
+ARTEFACTS_DEFAULT_OUTPUT_DIR = Path("artefacts")

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/artefacts/cli/app.py

@@ -20,7 +20,7 @@ from gitignore_parser import parse_gitignore
 from artefacts.cli import init_job, generate_scenarios, AuthenticationError, __version__
 from artefacts.cli import app_containers as containers
 from artefacts.cli.constants import DEPRECATED_FRAMEWORKS, SUPPORTED_FRAMEWORKS
-from artefacts.cli.utils import read_config, config_validation
+from artefacts.cli.utils import add_output_from_default, config_validation, read_config
 
 HOME = os.path.expanduser("~")
 CONFIG_DIR = f"{HOME}/.artefacts"
@@ -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,14 +246,14 @@ 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(
-    "--rebuild-container",
+    "--no-rebuild",
     is_flag=True,
     default=False,
-    help="[Experimental] Rebuild the container image before running. This flag guarantees that the run uses the latest code available when building the image, and usually takes more time before the run can start (time to compile and generate the image).",
+    help="[Experimental] Override the default behaviour to always rebuild the container image (as we assume incremental testing).",
 )
 @click.option(
     "--with-gui",
@@ -272,7 +275,7 @@ def run(
     skip_validation=False,
     in_container: bool = False,
     with_image: str = "artefacts",
-    rebuild_container: bool = False,
+    no_rebuild: bool = False,
     with_gui: bool = False,
 ):
     """
@@ -281,30 +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:
-        if rebuild_container or not ctx.invoke(containers.check, name=with_image):
+        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(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.echo(f"[{jobname}] Error: Job name not defined")
+        raise click.ClickException()
     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)
@@ -313,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()
@@ -348,30 +358,33 @@ def run(
             first,
         )
     except AuthenticationError:
-        raise click.ClickException(
-            "Unable to authenticate (Stage: Job initialisation), please check your project name and API key"
+        click.echo(
+            f"[{jobname}] Unable to authenticate (Stage: Job initialisation), please check your project name and API key"
         )
+        raise click.ClickException()
 
     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.echo(
+                f"[{jobname}] Unable to authenticate (Stage: Job run), please check your project name and API key"
             )
+            raise click.ClickException()
         if framework is not None and framework.startswith("ros2:"):
             from artefacts.cli.ros2 import run_ros2_tests
 
             if "ros_testfile" not in run.params:
-                raise click.ClickException(
-                    "Test launch file not specified for ros2 project"
+                click.echo(
+                    f"[{jobname}] Test launch file not specified for ros2 project"
                 )
+                raise click.ClickException()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 try:
@@ -380,25 +393,28 @@ 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.echo(f"[{jobname}] artefacts failed to execute the tests")
+                    raise click.ClickException()
             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.echo(
+                    f"[{jobname}] Not able to execute tests. Make sure that ROS2 is sourced and that your launch file syntax is correct."
                 )
+                raise click.ClickException()
             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.echo(
+                    f"[{jobname}] Test launch file not specified for ros1 project"
                 )
+                raise click.ClickException()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 results, success = run_ros1_tests(run)
@@ -408,9 +424,10 @@ 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.echo(f"[{jobname}] run command not specified for scenario")
+                raise click.ClickException()
             if dryrun:
-                click.echo("performing dry run")
+                click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
             else:
                 results, success = run_other_tests(run)
@@ -419,9 +436,12 @@ def run(
             if type(run.params.get("metrics", [])) is str:
                 run.log_metrics()
 
+        # Add for upload any default output generated by the run
+        add_output_from_default(run)
+
         run.stop()
     warpjob.log_tests_result(job_success)
-    click.echo("Done")
+    click.echo(f"[{jobname}] Done")
     time.sleep(random.random() * 1)
 
     warpjob.stop()
@@ -551,7 +571,7 @@ def run_remote(config, description, jobname, skip_validation=False):
                 )
 
             raise click.ClickException(
-                f"Error getting project info: {result['message']}"
+                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"]

artefacts_cli-0.7.1/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.6.19 → artefacts_cli-0.7.1}/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"]

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/artefacts/cli/utils.py

@@ -1,4 +1,5 @@
 import os
+from pathlib import Path
 import subprocess
 import sys
 from typing import Union
@@ -6,6 +7,8 @@ from typing import Union
 import click
 
 import artefacts_copava as copava
+from artefacts import ARTEFACTS_DEFAULT_OUTPUT_DIR
+from artefacts.cli import WarpRun
 
 
 def run_and_save_logs(
@@ -97,3 +100,17 @@ def pretty_print_config_error(
         # Must not happen, so broad definition, but we want to know fast.
         raise Exception(f"Unacceptable data type for config error formatting: {errors}")
     return output
+
+
+def add_output_from_default(run: WarpRun) -> None:
+    """
+    Add every file found under ARTEFACTS_DEFAULT_OUTPUT_DIR to the set of files
+    uploaded to Artefacts for the run argument.
+
+    The default folder is created either directly, or more generally by Artefacts
+    toolkit libraries.
+    """
+    if ARTEFACTS_DEFAULT_OUTPUT_DIR.exists() and ARTEFACTS_DEFAULT_OUTPUT_DIR.is_dir():
+        for root, dirs, files in os.walk(ARTEFACTS_DEFAULT_OUTPUT_DIR):
+            for file in files:
+                run.log_artifacts(Path(root) / Path(file))

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/artefacts/cli/version.py

@@ -1,8 +1,13 @@
-# file generated by setuptools_scm
+# file generated by setuptools-scm
 # don't change, don't track in version control
+
+__all__ = ["__version__", "__version_tuple__", "version", "version_tuple"]
+
 TYPE_CHECKING = False
 if TYPE_CHECKING:
-    from typing import Tuple, Union
+    from typing import Tuple
+    from typing import Union
+
     VERSION_TUPLE = Tuple[Union[int, str], ...]
 else:
     VERSION_TUPLE = object
@@ -12,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.6.19'
-__version_tuple__ = version_tuple = (0, 6, 19)
+__version__ = version = '0.7.1'
+__version_tuple__ = version_tuple = (0, 7, 1)

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/artefacts_cli.egg-info/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.2
 Name: artefacts_cli
-Version: 0.6.19
+Version: 0.7.1
 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.6.19 → artefacts_cli-0.7.1}/artefacts_cli.egg-info/SOURCES.txt

@@ -1,8 +1,10 @@
+CHANGELOG.md
 README.md
 README_INTERNAL.md
 artefacts.yaml
 pyproject.toml
 pytest.ini
+artefacts/__init__.py
 artefacts/cli/__init__.py
 artefacts/cli/app.py
 artefacts/cli/app_containers.py
@@ -54,6 +56,7 @@ tests/cli/test_other.py
 tests/cli/test_parameters.py
 tests/cli/test_ros1.py
 tests/cli/test_ros2.py
+tests/cli/test_utils.py
 tests/cli/test_warp.py
 tests/cli/containers/__init__.py
 tests/cli/containers/test_utils.py

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/artefacts_cli.egg-info/requires.txt

@@ -1,3 +1,4 @@
+artefacts-c2d>=1.7.1
 artefacts-copava>=0.1.11
 click>=8.0.4
 gitignore_parser>=0.1.11

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/pyproject.toml

@@ -19,6 +19,7 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
+  "artefacts-c2d>=1.7.1",
   "artefacts-copava>=0.1.11",
   "click>=8.0.4",
   "gitignore_parser>=0.1.11",
@@ -63,6 +64,7 @@ dev = [
 [project.urls]
 "Homepage" = "https://github.com/art-e-fact/artefacts-client"
 "Bug Tracker" = "https://github.com/art-e-fact/artefacts-client/issues"
+"Changelog" = "https://github.com/art-e-fact/artefacts-client/CHANGELOG.md"
 
 [project.scripts]
 artefacts = "artefacts.cli.app:artefacts"

artefacts_cli-0.7.1/tests/cli/test_app_containers.py

@@ -0,0 +1,36 @@
+import os
+from uuid import uuid4
+
+
+from artefacts.cli.app_containers import containers
+
+
+def test_container_package_exists(cli_runner):
+    result = cli_runner.invoke(containers, [])
+    assert result.exit_code == 0
+
+
+def test_container_package_build_specific_dockerfile(
+    cli_runner, dockerfile_available, docker_mocker
+):
+    dockerfile = "non_standard_dockerfile"
+    result = cli_runner.invoke(containers, ["build", "--dockerfile", dockerfile])
+    dockerfile_available.assert_any_call(dockerfile)
+    assert result.exit_code == 0
+
+
+def test_container_package_build(
+    cli_runner, dockerfile_available, docker_mocker, sample_artefacts_config
+):
+    before = len(docker_mocker.images())
+    result = cli_runner.invoke(containers, ["build"])
+    assert result.exit_code == 0
+    assert len(docker_mocker.images()) == before + len(sample_artefacts_config["jobs"])
+    for job_name in sample_artefacts_config["jobs"]:
+        # Check the images exist, with name following our naming convention project/job_name
+        assert (
+            docker_mocker.get_image(
+                f"{sample_artefacts_config['project'].lower()}/{job_name}"
+            )
+            is not None
+        )

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/tests/cli/test_cli.py

@@ -13,14 +13,6 @@ from artefacts.cli.app import (
 )
 
 
-@pytest.fixture(scope="class")
-def project_with_key(cli_runner):
-    project_name = "_pytest-project_"
-    add_key_to_conf(project_name, "MYAPIKEY")
-    yield project_name
-    cli_runner.invoke(delete, [project_name])
-
-
 def test_hello(cli_runner):
     project_name = "_pytest-project_"
     result = cli_runner.invoke(hello, [project_name])
@@ -60,9 +52,9 @@ def test_run_with_conf_invalid_jobname(cli_runner, project_with_key):
     )
     assert result.exit_code == 1
     assert result.output == (
-        "Connecting to https://app.artefacts.com/api using ApiKey\n"
-        f"Starting tests for {project_with_key}\n"
-        "Error: Job invalid_job_name not defined\n"
+        "[invalid_job_name] Connecting to https://app.artefacts.com/api using ApiKey\n"
+        f"[invalid_job_name] Starting tests\n"
+        "[invalid_job_name] Error: Job name not defined\n"
     )
 
 
@@ -72,13 +64,13 @@ def test_run_with_conf(cli_runner, project_with_key):
     )
     assert result.exit_code == 0
     assert result.output == (
-        "Connecting to https://app.artefacts.com/api using ApiKey\n"
-        f"Starting tests for {project_with_key}\n"
-        "Starting scenario 1/2: basic-tests\n"
-        "performing dry run\n"
-        "Starting scenario 2/2: other-tests\n"
-        "performing dry run\n"
-        "Done\n"
+        "[simple_job] Connecting to https://app.artefacts.com/api using ApiKey\n"
+        f"[simple_job] Starting tests\n"
+        "[simple_job] Starting scenario 1/2: basic-tests\n"
+        "[simple_job] Performing dry run\n"
+        "[simple_job] Starting scenario 2/2: other-tests\n"
+        "[simple_job] Performing dry run\n"
+        "[simple_job] Done\n"
     )
 
 
@@ -89,13 +81,13 @@ def test_run_with_mode_ros1(cli_runner, project_with_key):
     )
     assert result.exit_code == 0
     assert result.output == (
-        "Connecting to https://app.artefacts.com/api using ApiKey\n"
-        "Starting tests for _pytest-project_\n"
-        "Starting scenario 1/2: basic-tests\n"
-        "performing dry run\n"
-        "Starting scenario 2/2: other-tests\n"
-        "performing dry run\n"
-        "Done\n"
+        "[simple_job] Connecting to https://app.artefacts.com/api using ApiKey\n"
+        "[simple_job] Starting tests\n"
+        "[simple_job] Starting scenario 1/2: basic-tests\n"
+        "[simple_job] Performing dry run\n"
+        "[simple_job] Starting scenario 2/2: other-tests\n"
+        "[simple_job] Performing dry run\n"
+        "[simple_job] Done\n"
     )
 
 
@@ -139,3 +131,15 @@ def test_run_remote_with_conf_invalid_jobname(cli_runner, project_with_key):
 def test_APIConf(project_with_key):
     conf = APIConf(project_with_key)
     assert conf.headers["Authorization"] == "ApiKey MYAPIKEY"
+
+
+def test_upload_default_dir(cli_runner, project_with_key, mocker):
+    # Note the patch applies to the object loaded in app, rather than the original in utils.
+    # https://docs.python.org/3/library/unittest.mock.html#where-to-patch
+    sut = mocker.patch("artefacts.cli.app.add_output_from_default")
+    result = cli_runner.invoke(
+        run, ["simple_job", "--config", "tests/fixtures/warp.yaml", "--dryrun"]
+    )
+    assert result.exit_code == 0
+    # Called twice in this config.
+    assert sut.call_count == 2

artefacts_cli-0.7.1/tests/cli/test_utils.py

@@ -0,0 +1,24 @@
+import pytest
+
+from artefacts.cli import WarpJob, WarpRun
+from artefacts.cli.app import APIConf
+from artefacts.cli.utils import add_output_from_default
+
+
+@pytest.fixture
+def new_run(project_with_key):
+    job = WarpJob(
+        project_with_key, APIConf(project_with_key), "jobname", {}, dryrun=True
+    )
+    return WarpRun(job=job, scenario={}, run_n=0)
+
+
+def test_adds_nothing_on_missing_default_output(new_run, mocker, project_with_key):
+    path = mocker.patch("artefacts.cli.utils.ARTEFACTS_DEFAULT_OUTPUT_DIR")
+    mocked = {
+        "exists.return_value": False,
+        "is_dir.return_value": True,
+    }
+    path.configure_mock(**mocked)
+    add_output_from_default(new_run)
+    assert len(new_run.uploads) == 0

{artefacts_cli-0.6.19 → artefacts_cli-0.7.1}/tests/conftest.py

@@ -6,6 +6,9 @@ from click.testing import CliRunner
 
 from tests.utils import docker_mock
 
+from artefacts.cli.app import add_key_to_conf, delete
+from artefacts.cli.utils import read_config
+
 
 def dockerfile_presence(mocker, value: bool):
     original = os.path.exists
@@ -39,3 +42,16 @@ def docker_mocker(module_mocker):
 @pytest.fixture(scope="module")
 def cli_runner():
     return CliRunner()
+
+
+@pytest.fixture(scope="class")
+def project_with_key(cli_runner):
+    project_name = "_pytest-project_"
+    add_key_to_conf(project_name, "MYAPIKEY")
+    yield project_name
+    cli_runner.invoke(delete, [project_name])
+
+
+@pytest.fixture(scope="session")
+def sample_artefacts_config():
+    return read_config(os.path.join(os.path.dirname(__file__), "..", "artefacts.yaml"))

artefacts_cli-0.6.19/artefacts/cli/app_containers.py

@@ -1,99 +0,0 @@
-import os
-
-import click
-
-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="Path to the root of the project, where a Dockerfile is available.",
-)
-@click.option(
-    "--dockerfile",
-    default="Dockerfile",
-    help="File name of the container definition file. Defaults to the standard Dockerfile inside the project root (see --path)",
-)
-@click.option(
-    "--name",
-    required=False,
-    help="Name for the generated container",
-)
-@click.pass_context
-def build(ctx: click.Context, path: str, dockerfile: str, name: str):
-    if not os.path.exists(os.path.join(path, dockerfile)):
-        raise click.ClickException(
-            f"No {dockerfile} found here. I cannot build the container."
-        )
-    if name is None:
-        name = "artefacts"
-    handler = ContainerMgr()
-    image, _ = handler.build(path=path, name=name)
-    print(f"Package complete in image: {image}")
-
-
-@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("image")
-@click.argument("jobname")
-@click.option(
-    "--config",
-    callback=config_validation,
-    default="artefacts.yaml",
-    help="Artefacts config file.",
-)
-@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, image: str, 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=image,
-        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.6.19/tests/cli/test_app_containers.py

@@ -1,53 +0,0 @@
-import os
-from uuid import uuid4
-
-
-from artefacts.cli.app_containers import containers
-
-
-def test_container_package_exists(cli_runner):
-    result = cli_runner.invoke(containers, [])
-    assert result.exit_code == 0
-
-
-def test_container_package_build_specific_dockerfile(
-    cli_runner, dockerfile_available, docker_mocker
-):
-    dockerfile = "non_standard_dockerfile"
-    result = cli_runner.invoke(containers, ["build", "--dockerfile", dockerfile])
-    dockerfile_available.assert_any_call(os.path.join(".", dockerfile))
-    assert result.exit_code == 0
-
-
-def test_container_package_build_specific_dockerfile_missing(
-    cli_runner, dockerfile_not_available
-):
-    dockerfile = "non_standard_dockerfile"
-    result = cli_runner.invoke(containers, ["build", "--dockerfile", dockerfile])
-    dockerfile_not_available.assert_any_call(os.path.join(".", dockerfile))
-    assert result.exit_code == 1
-    assert (
-        result.output.strip()
-        == f"Error: No {dockerfile} found here. I cannot build the container."
-    )
-
-
-def test_container_package_build_specific_image_name(
-    cli_runner, dockerfile_available, docker_mocker
-):
-    name = str(uuid4())
-    before = len(docker_mocker.images())
-    result = cli_runner.invoke(containers, ["build", "--name", name])
-    assert result.exit_code == 0
-    assert len(docker_mocker.images()) == before + 1
-    assert docker_mocker.get_image(name).Repository == name
-
-
-def test_container_package_build_default_image_name(
-    cli_runner, dockerfile_available, docker_mocker
-):
-    before = len(docker_mocker.images())
-    result = cli_runner.invoke(containers, ["build"])
-    assert result.exit_code == 0
-    assert len(docker_mocker.images()) == before + 1
-    assert docker_mocker.get_image("artefacts") is not None