artefacts-cli 0.6.15__py3-none-any.whl → 0.6.17__py3-none-any.whl

artefacts/cli/__init__.py

@@ -15,7 +15,7 @@ logging.basicConfig(level=logging.INFO)
 
 
 try:
-    __version__ = version("package-name")
+    __version__ = version("artefacts-cli")
 except PackageNotFoundError:
     try:
         # Package is not installed, most likely dev/test mode

artefacts/cli/app.py

@@ -231,11 +231,64 @@ def hello(project_name):
     is_eager=True,  # Necessary for callbacks to see it.
     help="Skip configuration validation, so that unsupported settings can be tried out, e.g. non-ROS settings or simulators like SAPIEN.",
 )
+@click.option(
+    "--in-container",
+    is_flag=True,
+    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(
+    "--with-image",
+    default="artefacts",
+    help="[Experimental] Run the job using the image name passed here. Only used when running with --in-container set.",
+)
+@click.option(
+    "--rebuild-container",
+    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).",
+)
+@click.option(
+    "--with-gui",
+    is_flag=True,
+    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 X11 (e.g. ROS), typically with Qt, so this may not work without a appropriate environment.",
+)
 @click.argument("jobname")
+@click.pass_context
 def run(
-    config, jobname, dryrun, nosim, noisolation, description="", skip_validation=False
+    ctx: click.Context,
+    config,
+    jobname,
+    dryrun,
+    nosim,
+    noisolation,
+    description="",
+    skip_validation=False,
+    in_container: bool = False,
+    with_image: str = "artefacts",
+    rebuild_container: bool = False,
+    with_gui: bool = False,
 ):
-    """Run JOBNAME locally"""
+    """
+    Run JOBNAME locally
+
+    * Directly in the shell by default.
+    * 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):
+            ctx.invoke(
+                containers.build, path=".", dockerfile="Dockerfile", name=with_image
+            )
+        return ctx.invoke(
+            containers.run,
+            image=with_image,
+            jobname=jobname,
+            config=config,
+            with_gui=with_gui,
+        )
+
     warpconfig = read_config(config)
 
     project_id = warpconfig["project"]
@@ -430,7 +483,7 @@ def run_remote(config, description, jobname, skip_validation=False):
     click.echo(f"Packaging source...")
 
     with tempfile.NamedTemporaryFile(
-        prefix=project_id, suffix=".tgz", delete=True
+        prefix=project_id.split("/")[-1], suffix=".tgz", delete=True
     ) as temp_file:
         # get list of patterns to be ignored in .artefactsignore
         ignore_file = Path(project_folder) / Path(".artefactsignore")
@@ -573,7 +626,7 @@ artefacts.add_command(config)
 artefacts.add_command(hello)
 artefacts.add_command(run)
 artefacts.add_command(run_remote)
-artefacts.add_command(containers.package)
+artefacts.add_command(containers.containers)
 
 
 if __name__ == "__main__":

artefacts/cli/app_containers.py

@@ -2,6 +2,7 @@ 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
 
@@ -9,12 +10,12 @@ from artefacts.cli.containers.utils import ContainerMgr
 @click.group()
 @click.option("--debug/--no-debug", default=False)
 @click.pass_context
-def package(ctx: click.Context, debug: bool):
+def containers(ctx: click.Context, debug: bool):
     ctx.ensure_object(dict)
     ctx.obj["debug"] = debug
 
 
-@package.command()
+@containers.command()
 @click.option(
     "--path",
     default=".",
@@ -28,13 +29,13 @@ def package(ctx: click.Context, debug: bool):
 @click.option(
     "--name",
     required=False,
-    help="Name for the generated package",
+    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 package."
+            f"No {dockerfile} found here. I cannot build the container."
         )
     if name is None:
         name = "artefacts"
@@ -43,7 +44,21 @@ def build(ctx: click.Context, path: str, dockerfile: str, name: str):
     print(f"Package complete in image: {image}")
 
 
-@package.command()
+@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(
@@ -52,15 +67,29 @@ def build(ctx: click.Context, path: str, dockerfile: str, name: str):
     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):
+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()
-    container, logs = handler.run(image, project, jobname)
+    params = dict(
+        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,
+    )
+    container, logs = handler.run(**params)
     if container:
         print(f"Package run complete: Container Id for inspection: {container['Id']}")
     else:

artefacts/cli/constants.py

@@ -1,3 +1,5 @@
+DEFAULT_API_URL = "https://app.artefacts.com/api"
+
 SUPPORTED_FRAMEWORKS = [
     "ros2:iron",
     "ros2:humble",

artefacts/cli/containers/__init__.py

@@ -4,6 +4,8 @@ import os
 from pathlib import Path
 from typing import Any, Tuple, Union
 
+from artefacts.cli.constants import DEFAULT_API_URL
+
 
 class CMgr:
     def build(self, **kwargs) -> Tuple[str, Generator]:
@@ -13,8 +15,20 @@ class CMgr:
         """
         raise NotImplemented()
 
+    def check(self, image: str) -> bool:
+        """
+        Checks whether a target image exists locally.
+        """
+        raise NotImplemented()
+
     def run(
-        self, image: str, project: str, jobname: str = None
+        self,
+        image: str,
+        project: str,
+        jobname: str = None,
+        artefacts_dir: str = Path("~/.artefacts").expanduser(),
+        api_url: str = DEFAULT_API_URL,
+        with_gui: bool = False,
     ) -> Tuple[Any, Generator]:
         """
         Returns a container (Any type as depends on the framework)
@@ -38,7 +52,7 @@ class CMgr:
         """
         if not path:
             raise Exception(
-                "`path` must be a string, a Path object, or exclusded from the kwargs"
+                "`path` must be a string, a Path object, or excluded from the kwargs"
             )
         if os.environ.get("ARTEFACTS_KEY", None):
             return True

artefacts/cli/containers/docker.py

@@ -1,9 +1,12 @@
 from collections.abc import Generator
 import json
 import os
+from pathlib import Path
+import platform
 from typing import Any, Tuple
 from uuid import uuid4
 
+from artefacts.cli.constants import DEFAULT_API_URL
 from artefacts.cli.containers import CMgr
 from artefacts.cli.utils import ensure_available
 
@@ -37,12 +40,20 @@ class DockerManager(CMgr):
             img_id = self.client.inspect_image(kwargs["tag"])["Id"]
         return img_id, iter(logs)
 
+    def check(
+        self,
+        image: str,
+    ) -> bool:
+        return len(self.client.images(name=image)) > 0
+
     def run(
         self,
         image: str,
         project: str,
         jobname: str = None,
-        artefacts_dir: str = os.path.join(os.path.expanduser("~/.artefacts")),
+        artefacts_dir: str = Path("~/.artefacts").expanduser(),
+        api_url: str = DEFAULT_API_URL,
+        with_gui: bool = False,
     ) -> Tuple[Any, Generator]:
         if not self._valid_artefacts_api_key(project, artefacts_dir):
             return None, iter(
@@ -51,12 +62,24 @@ class DockerManager(CMgr):
                 ]
             )
         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"
+            else:
+                env["DISPLAY"] = os.environ.get("DISPLAY", ":0")
+
+            if not with_gui:
+                env["QT_QPA_PLATFORM"] = "offscreen"
+
             container = self.client.create_container(
                 image,
-                environment={
-                    "JOB_ID": str(uuid4()),
-                    "ARTEFACTS_JOB_NAME": jobname,
-                },
+                environment=env,
                 detach=False,
                 volumes=["/root/.artefacts"],
                 host_config=self.client.create_host_config(
@@ -66,6 +89,7 @@ class DockerManager(CMgr):
                             "mode": "ro",
                         },
                     },
+                    network_mode="host",
                 ),
             )
             self.client.start(container=container.get("Id"))

artefacts/cli/containers/utils.py

@@ -50,7 +50,8 @@ class ContainerMgr:
     def build(self, **kwargs) -> Tuple[str, Generator]:
         return self.mgr.build(**kwargs)
 
-    def run(
-        self, image: str, project: str, jobname: str = None
-    ) -> Tuple[Any, Generator]:
-        return self.mgr.run(image, project, jobname)
+    def check(self, image: str) -> bool:
+        return self.mgr.check(image)
+
+    def run(self, **kwargs) -> Tuple[Any, Generator]:
+        return self.mgr.run(**kwargs)

artefacts/cli/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.6.15'
-__version_tuple__ = version_tuple = (0, 6, 15)
+__version__ = version = '0.6.17'
+__version_tuple__ = version_tuple = (0, 6, 17)

{artefacts_cli-0.6.15.dist-info → artefacts_cli-0.6.17.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: artefacts_cli
-Version: 0.6.15
+Version: 0.6.17
 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
@@ -9,33 +9,34 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: artefacts-copava >=0.1.11
-Requires-Dist: click >=8.0.4
-Requires-Dist: gitignore-parser >=0.1.11
-Requires-Dist: junitparser >=2.5
+Requires-Dist: artefacts-copava>=0.1.11
+Requires-Dist: click>=8.0.4
+Requires-Dist: gitignore_parser>=0.1.11
+Requires-Dist: junitparser>=2.5
 Requires-Dist: mcap
 Requires-Dist: mcap-ros2-support
-Requires-Dist: PyYAML >=6.0
-Requires-Dist: requests >=2.27.1
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: requests>=2.27.1
 Requires-Dist: setuptools-scm
+Requires-Dist: setuptools>=74
 Provides-Extra: dev
-Requires-Dist: awscli ; extra == 'dev'
-Requires-Dist: build ; extra == 'dev'
-Requires-Dist: docker ; extra == 'dev'
-Requires-Dist: lark ; extra == 'dev'
-Requires-Dist: pyre-check ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
-Requires-Dist: pytest-env ; extra == 'dev'
-Requires-Dist: pytest-mock ; extra == 'dev'
-Requires-Dist: ruff ; extra == 'dev'
-Requires-Dist: twine ; extra == 'dev'
-Requires-Dist: mkdocs-click ==0.8.0 ; extra == 'dev'
-Requires-Dist: mkdocs-material ==8.5.6 ; extra == 'dev'
-Requires-Dist: mkdocs-mermaid2-plugin ==0.6.0 ; extra == 'dev'
-Requires-Dist: mkdocs ==1.4.2 ; extra == 'dev'
-Requires-Dist: pre-commit ; extra == 'dev'
-Requires-Dist: python-markdown-math ; extra == 'dev'
+Requires-Dist: awscli; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: docker; extra == "dev"
+Requires-Dist: lark; extra == "dev"
+Requires-Dist: pyre-check; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-env; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: mkdocs-click==0.8.0; extra == "dev"
+Requires-Dist: mkdocs-material==8.5.6; extra == "dev"
+Requires-Dist: mkdocs-mermaid2-plugin==0.6.0; extra == "dev"
+Requires-Dist: mkdocs==1.4.2; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: python-markdown-math; extra == "dev"
 
 # Artefacts CLI
 

artefacts_cli-0.6.17.dist-info/RECORD

@@ -0,0 +1,21 @@
+artefacts/cli/__init__.py,sha256=--1soc8cqq1JWhz4DuRUvJWgSeDCPGqm8mEmdqtclsI,11644
+artefacts/cli/app.py,sha256=cxVVHD89_eVCHm5fqPq3ANuy6jTPfw3se-FST_7wILY,22093
+artefacts/cli/app_containers.py,sha256=tHdGkxtzjexLhgcx5YXy_OOJsPcBi1jmwKZN01OAcmU,3044
+artefacts/cli/bagparser.py,sha256=FE_QaztC9pg4hQzTjGSdyve6mzZbHJbyqa3wqvZSbxE,3702
+artefacts/cli/constants.py,sha256=bvsVDwqkAc49IZN7j6k6IL6EG87bECHd_VINtKJqbv8,320
+artefacts/cli/other.py,sha256=7NvzlspvG0zF7sryR-QznwdLupXLln1BKWxHB9VuEcc,1160
+artefacts/cli/parameters.py,sha256=MDhrM7ur95wKTLDteqz2f-sLdCPcepi5wk0XjeLo6TU,788
+artefacts/cli/ros1.py,sha256=RbtirCGarD9a0ikfuGK-pdpWYSXfqJhEt4rpA0uFsyU,9625
+artefacts/cli/ros2.py,sha256=YaCi3HRuCdvCTjM0Ftnm-SLgMOy1OneIr0aU7KVTiAM,4476
+artefacts/cli/utils.py,sha256=6yQJRzv-xaLbtcA73Tty9C9QZeV06n5pjXMYl3xsLPE,3156
+artefacts/cli/utils_ros.py,sha256=pYbhAU9fK2VbnWm3nSLBwUMVBzsZuCn10SFZmVW3-Zo,2090
+artefacts/cli/version.py,sha256=q7Xb4Wt4eH2VCIhiAa6149XDeUKQFfphqlwqiTFiurk,413
+artefacts/cli/containers/__init__.py,sha256=y6NVB0efBfRQBlHb71xhRu1hEh7t2bkKNs2vtsLJaO8,2239
+artefacts/cli/containers/docker.py,sha256=A9jqs0WU-g8umJzPpEACi0_DU5N8rglR-V3dmwxDuBA,3507
+artefacts/cli/containers/utils.py,sha256=6Bw6s1ceEnTbWSdE5_1CReNW6RB29VeHsq-BAwcJ_fY,1895
+artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
+artefacts_cli-0.6.17.dist-info/METADATA,sha256=aiDZPGqyOGAS_pS3XnjIk4IAStv_vS3fUOW3qPyEH-s,3051
+artefacts_cli-0.6.17.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+artefacts_cli-0.6.17.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
+artefacts_cli-0.6.17.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
+artefacts_cli-0.6.17.dist-info/RECORD,,

{artefacts_cli-0.6.15.dist-info → artefacts_cli-0.6.17.dist-info}/WHEEL

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

artefacts_cli-0.6.15.dist-info/RECORD

@@ -1,21 +0,0 @@
-artefacts/cli/__init__.py,sha256=9rTAfBoS9ALJxKSqaUo32ThbDshbvNN4-EmoyUsPhRI,11643
-artefacts/cli/app.py,sha256=J9lBtYDrBx9vPam1hJWDXKwkTEP4IXIfNEGCrGBzEE8,20125
-artefacts/cli/app_containers.py,sha256=hHJvqjxirbLUxgAT8fsOAMjkPmN0XGIX73krr5TEm7I,2011
-artefacts/cli/bagparser.py,sha256=FE_QaztC9pg4hQzTjGSdyve6mzZbHJbyqa3wqvZSbxE,3702
-artefacts/cli/constants.py,sha256=vZxtUprVqqZx1k4-LFFDU2tI0AnENV2cBt655uR17R8,269
-artefacts/cli/other.py,sha256=7NvzlspvG0zF7sryR-QznwdLupXLln1BKWxHB9VuEcc,1160
-artefacts/cli/parameters.py,sha256=MDhrM7ur95wKTLDteqz2f-sLdCPcepi5wk0XjeLo6TU,788
-artefacts/cli/ros1.py,sha256=RbtirCGarD9a0ikfuGK-pdpWYSXfqJhEt4rpA0uFsyU,9625
-artefacts/cli/ros2.py,sha256=YaCi3HRuCdvCTjM0Ftnm-SLgMOy1OneIr0aU7KVTiAM,4476
-artefacts/cli/utils.py,sha256=6yQJRzv-xaLbtcA73Tty9C9QZeV06n5pjXMYl3xsLPE,3156
-artefacts/cli/utils_ros.py,sha256=pYbhAU9fK2VbnWm3nSLBwUMVBzsZuCn10SFZmVW3-Zo,2090
-artefacts/cli/version.py,sha256=mm-8uYlR9TBoYFbfyOehz69r2OAONIb8KypEpPRKVqU,413
-artefacts/cli/containers/__init__.py,sha256=xOVmjLw3um8joQmjK_se-D1S9juufA-1s-RqXYJ5EoQ,1875
-artefacts/cli/containers/docker.py,sha256=nHVZ4ZSge7oUCbwvIT1vI-GAxuiSdJ-MVvLHJ2Un_OY,2805
-artefacts/cli/containers/utils.py,sha256=yahjJr9Oh7NuvJvy5X_nREMupQZ8A6hrhss3mscyqio,1882
-artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
-artefacts_cli-0.6.15.dist-info/METADATA,sha256=JXVv2Yc_Q859rR3F1qxSUl-uVaHa_1PV5sZEUAQZHPQ,3048
-artefacts_cli-0.6.15.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-artefacts_cli-0.6.15.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
-artefacts_cli-0.6.15.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
-artefacts_cli-0.6.15.dist-info/RECORD,,