artefacts-cli 0.6.18__py3-none-any.whl → 0.7.0__py3-none-any.whl

artefacts/__init__.py

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

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"
@@ -247,10 +247,10 @@ def hello(project_name):
     help="[Experimental] 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 +272,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,
 ):
     """
@@ -282,10 +282,18 @@ def run(
     * Inside a packaged container when using the --in-container option.
     """
     if in_container:
-        if rebuild_container or not ctx.invoke(containers.check, name=with_image):
+        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)
             ctx.invoke(
                 containers.build, path=".", dockerfile="Dockerfile", name=with_image
             )
+            click.echo("Build complete.\n")
+        click.echo("Starting the container run...")
         return ctx.invoke(
             containers.run,
             image=with_image,
@@ -419,6 +427,9 @@ 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")

artefacts/cli/app_containers.py

@@ -85,9 +85,10 @@ def run(ctx: click.Context, image: str, jobname: str, config: str, with_gui: boo
         image=image,
         project=project,
         jobname=jobname,
-        # Hidden setting primarily useful to Artefacts developers
-        api_url=os.environ.get("ARTEFACTS_API_URL", DEFAULT_API_URL),
         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:

artefacts/cli/containers/__init__.py

@@ -2,7 +2,7 @@ from collections.abc import Generator
 import configparser
 import os
 from pathlib import Path
-from typing import Any, Tuple, Union
+from typing import Any, Optional, Tuple, Union
 
 from artefacts.cli.constants import DEFAULT_API_URL
 
@@ -36,17 +36,17 @@ class CMgr:
         """
         raise NotImplementedError()
 
-    def _valid_artefacts_api_key(
+    def _get_artefacts_api_key(
         self, project: str, path: Union[str, Path] = Path("~/.artefacts").expanduser()
-    ) -> bool:
+    ) -> Optional[str]:
         """
-        Check if a valid API key is available to embed in containers.
+        Get any valid API key to embed in containers.
 
-        1. Check overrides with the ARTEFACTS_KEY environment variable.
-        2. If `path` is not given, check the default .artefacts folder for the config file.
-        3. If `path` is given, check the file directly is a file, or check for a `config` file if a folder.
+        1. Checks first from the ARTEFACTS_KEY environment variable.
+        2. If `path` is not given, check from the default configuraiton file in the .artefacts folder.
+        3. If `path` is given, check the file directly if a file, or check for a `config` file if a folder.
 
-        When a config file is found, we check here if the API key for the `project` is available.
+        When a config file is found, we get the API key for the `project`.
 
         `path` set to None is an error, and aborts execution.
         """
@@ -55,7 +55,7 @@ class CMgr:
                 "`path` must be a string, a Path object, or excluded from the kwargs"
             )
         if os.environ.get("ARTEFACTS_KEY", None):
-            return True
+            return os.environ["ARTEFACTS_KEY"]
         path = Path(path)  # Ensure we have a Path object
         config = configparser.ConfigParser()
         if path.is_dir():
@@ -63,6 +63,6 @@ class CMgr:
         else:
             config.read(path)
         try:
-            return config[project].get("apikey") is not None
+            return config[project].get("apikey")
         except KeyError:
-            return False
+            return None

artefacts/cli/containers/docker.py

@@ -53,21 +53,35 @@ class DockerManager(CMgr):
         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]:
-        if not self._valid_artefacts_api_key(project, artefacts_dir):
+        """
+        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(
                 [
-                    "Missing API key for the project. Does `~/.artefacts/config` exist and contain your key?"
+                    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:
-            env = {
-                "JOB_ID": str(uuid4()),
-                "ARTEFACTS_JOB_NAME": jobname,
-                "ARTEFACTS_API_URL": api_url,
-            }
-
             if platform.system() in ["Darwin", "Windows"]:
                 # Assume we run in Docker Desktop
                 env["DISPLAY"] = "host.docker.internal:0"
@@ -77,24 +91,21 @@ class DockerManager(CMgr):
             if not with_gui:
                 env["QT_QPA_PLATFORM"] = "offscreen"
 
-            container = self.client.create_container(
-                image,
+            container_conf = dict(
+                image=image,
                 environment=env,
                 detach=False,
-                volumes=["/root/.artefacts"],
                 host_config=self.client.create_host_config(
-                    binds={
-                        artefacts_dir: {
-                            "bind": "/root/.artefacts",
-                            "mode": "ro",
-                        },
-                    },
                     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(

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/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.18'
-__version_tuple__ = version_tuple = (0, 6, 18)
+__version__ = version = '0.7.0'
+__version_tuple__ = version_tuple = (0, 7, 0)

{artefacts_cli-0.6.18.dist-info → artefacts_cli-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: artefacts_cli
-Version: 0.6.18
+Version: 0.7.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.0.dist-info/RECORD

@@ -0,0 +1,24 @@
+artefacts/__init__.py,sha256=VLmogtpRQeJjQjAORV8ClSJ5qF-57Hxx3apvgy9H1zk,76
+artefacts/cli/__init__.py,sha256=pt8OK66hMeQUxT9iLcvzYIIjFGrPS63ecWo8hS0T2qQ,11980
+artefacts/cli/app.py,sha256=tEknMMi7WhAPnq8NlGgLuLqqoCDWssZqs1lB3eNlVg4,22571
+artefacts/cli/app_containers.py,sha256=dsyzN8UzGNwxkhV8BsFK7Sz9EOL6Se3YpeiUgzC2qic,3099
+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=MP8WDImHA3BKVsn55BMWtGP5-aCmXl5ViVPtIo3jKk4,242
+artefacts/cli/other.py,sha256=7NvzlspvG0zF7sryR-QznwdLupXLln1BKWxHB9VuEcc,1160
+artefacts/cli/parameters.py,sha256=msf2aG-tmw0ahxwrPpB2W6KqdMj5A-nw9DPG9flkHTg,788
+artefacts/cli/ros1.py,sha256=rKepZckAuy5O_qraF2CW5GiTmTZHar7LRD4pvESy6T0,9622
+artefacts/cli/ros2.py,sha256=9Ax_WQIOV_cohKz3H1eo1LnWiahiaqxO8r99doMmhEc,4466
+artefacts/cli/utils.py,sha256=GJM2QdF_ewzPWr8NzO5BbrhyZdSSk9DNX12Nbwc4bnI,3814
+artefacts/cli/utils_ros.py,sha256=3EFoMrzBdlhLc-wAL3mmS5sSw_pACkurYhssKHqYJsI,2089
+artefacts/cli/version.py,sha256=itvIHlqPKoO_13qf_yPD2pmcp0U4z1s19vvBGZM927Q,511
+artefacts/cli/containers/__init__.py,sha256=K0efkJXNCqXH-qYBqhCE_8zVUCHbVmeuKH-y_fE8s4M,2254
+artefacts/cli/containers/docker.py,sha256=fsGTzpj7Sj7ykCBxzaYlIt_so1yfWJ2j6ktxsWjvdvY,4073
+artefacts/cli/containers/utils.py,sha256=bILX0uvazUJq7hoqKk4ztRzI_ZerYs04XQdKdx1ltjk,2002
+artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
+artefacts_cli-0.7.0.dist-info/METADATA,sha256=bYCIMBdVBOLHHW38dmsUqXj-hoFczntRhszgykDm_eM,3034
+artefacts_cli-0.7.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+artefacts_cli-0.7.0.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
+artefacts_cli-0.7.0.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
+artefacts_cli-0.7.0.dist-info/RECORD,,

artefacts_cli-0.6.18.dist-info/RECORD

@@ -1,23 +0,0 @@
-artefacts/cli/__init__.py,sha256=pt8OK66hMeQUxT9iLcvzYIIjFGrPS63ecWo8hS0T2qQ,11980
-artefacts/cli/app.py,sha256=fHqq4N_JdSO8jgN4uc0puLSSJk_NU5srbztveipbqLw,22221
-artefacts/cli/app_containers.py,sha256=dLQqcrRF-3NSpcmijGK6Q51CinumAXnJ1KLNSEKUIPQ,3043
-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=MP8WDImHA3BKVsn55BMWtGP5-aCmXl5ViVPtIo3jKk4,242
-artefacts/cli/other.py,sha256=7NvzlspvG0zF7sryR-QznwdLupXLln1BKWxHB9VuEcc,1160
-artefacts/cli/parameters.py,sha256=msf2aG-tmw0ahxwrPpB2W6KqdMj5A-nw9DPG9flkHTg,788
-artefacts/cli/ros1.py,sha256=rKepZckAuy5O_qraF2CW5GiTmTZHar7LRD4pvESy6T0,9622
-artefacts/cli/ros2.py,sha256=9Ax_WQIOV_cohKz3H1eo1LnWiahiaqxO8r99doMmhEc,4466
-artefacts/cli/utils.py,sha256=bqADil7Aqvg-ci0244e-yf8G9KvIkYeWGNc_jMn6qv0,3151
-artefacts/cli/utils_ros.py,sha256=3EFoMrzBdlhLc-wAL3mmS5sSw_pACkurYhssKHqYJsI,2089
-artefacts/cli/version.py,sha256=hdhRgZhTA3pieFZY1w6wT4BsoNOPCUB21i3j8v6cYbA,413
-artefacts/cli/containers/__init__.py,sha256=ga52A5dJUl3EzmrRAQ-ucsLVExPhL61cfcT4rnTgtzc,2258
-artefacts/cli/containers/docker.py,sha256=ndidmuMUc8LvgGGF7MwUTCaSUzp9dSS56DE847krmJ8,3535
-artefacts/cli/containers/utils.py,sha256=bILX0uvazUJq7hoqKk4ztRzI_ZerYs04XQdKdx1ltjk,2002
-artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
-artefacts_cli-0.6.18.dist-info/METADATA,sha256=r0BO8lNkG3yljvWpgU3R11x3WfpR3fGVdNIcK_Xu2-s,3035
-artefacts_cli-0.6.18.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-artefacts_cli-0.6.18.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
-artefacts_cli-0.6.18.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
-artefacts_cli-0.6.18.dist-info/RECORD,,