artefacts-cli 0.7.1__py3-none-any.whl → 0.7.2__py3-none-any.whl

artefacts/cli/app.py

@@ -309,8 +309,8 @@ def run(
     api_conf = APIConf(project_id, jobname)
     click.echo(f"[{jobname}] Starting tests")
     if jobname not in warpconfig["jobs"]:
-        click.echo(f"[{jobname}] Error: Job name not defined")
-        raise click.ClickException()
+        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"]:
@@ -358,10 +358,12 @@ def run(
             first,
         )
     except AuthenticationError:
-        click.echo(
-            f"[{jobname}] 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.ClickException()
+        raise click.Abort()
 
     job_success = True
     for scenario_n, scenario in enumerate(scenarios):
@@ -371,18 +373,29 @@ def run(
         try:
             run = warpjob.new_run(scenario)
         except AuthenticationError:
-            click.echo(
-                f"[{jobname}] 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.ClickException()
+            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:
-                click.echo(
-                    f"[{jobname}] 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.",
                 )
-                raise click.ClickException()
+                run.log_tests_results([result], False)
+                run.stop()
             if dryrun:
                 click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
@@ -393,26 +406,34 @@ def run(
                     warpjob.stop()
                     warpjob.log_tests_result(False)
                     click.secho(e, bold=True, err=True)
-                    click.echo(f"[{jobname}] artefacts failed to execute the tests")
-                    raise click.ClickException()
+                    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)
-                click.echo(
-                    f"[{jobname}] 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.ClickException()
+                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:
-                click.echo(
-                    f"[{jobname}] 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.ClickException()
+                raise click.Abort()
             if dryrun:
                 click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
@@ -424,8 +445,12 @@ def run(
             from artefacts.cli.other import run_other_tests
 
             if "run" not in run.params:
-                click.echo(f"[{jobname}] run command not specified for scenario")
-                raise click.ClickException()
+                click.secho(
+                    f"[{jobname}] run command not specified for scenario",
+                    err=True,
+                    bold=True,
+                )
+                raise click.Abort()
             if dryrun:
                 click.echo(f"[{jobname}] Performing dry run")
                 results, success = {}, True
@@ -562,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: {upload_urls_response.status_code} {upload_urls_response.reason}. Response text: {upload_urls_response.text}."
-            )
+            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/ros2.py

@@ -4,10 +4,58 @@ import os
 import shutil
 
 from .utils import run_and_save_logs
-from .utils_ros import parse_tests_results
+from .utils_ros import parse_tests_results, get_TestSuite_error_result
 from .parameters import TMP_SCENARIO_PARAMS_YAML
 
 
+# custom exceptions raised when trying to run ros2 tests
+class Launch_test_CmdNotFoundError(FileNotFoundError):
+    pass
+
+
+class LaunchTestFileNotFoundError(FileNotFoundError):
+    pass
+
+
+class BadLaunchTestFileError(Exception):
+    pass
+
+
+def ros2_run_and_save_logs(
+    args, output_path, shell=False, executable=None, env=None, cwd=None
+):
+    try:
+        return_code, stdout, stderr = run_and_save_logs(
+            args,
+            output_path,
+            shell=shell,
+            executable=executable,
+            env=env,
+            cwd=cwd,
+            with_output=True,
+        )
+    except FileNotFoundError:
+        raise Launch_test_CmdNotFoundError(
+            f"Running {args} failed. Please check that `launch_test` is installed and in the path."
+        )
+    if return_code == 2:
+        # check the proc stderr for `launch_test: error: Test file '[filename]' does not exist`
+
+        if "does not exist" in stderr:
+            raise LaunchTestFileNotFoundError(
+                f"Running {args} failed. Please check that the launch file exists."
+            )
+        if "launch_test: error: " in stderr:
+            # example errors:
+            # "has no attribute 'generate_test_description'"
+            # "error: name 'xxx' is not defined"
+            raise BadLaunchTestFileError(
+                f"Running {args} failed. Check that the launch_test file syntax is correct."
+            )
+
+    return return_code
+
+
 def generate_scenario_parameter_output(params: dict, param_file: str):
     """
     Store `params` in `param_file` and convert to ros2 param file nested format,
@@ -57,19 +105,54 @@ def run_ros2_tests(run):
     # Main: test execution
     # shell=True required to support command list items that are strings with spaces
     # (this way, scenario["ros_testfile"] can be either a path to the launch file or '<package_name> <launch_name>')
-    return_code = run_and_save_logs(
-        " ".join(command),
-        shell=True,
-        executable="/bin/bash",
-        env={
-            **os.environ,
-            **{
-                "ROS_LOG_DIR": ros_log_dir,
-                "ARTEFACTS_SCENARIO_PARAMS_FILE": TMP_SCENARIO_PARAMS_YAML,
+    try:
+        return_code = ros2_run_and_save_logs(
+            " ".join(command),
+            shell=True,
+            executable="/bin/bash",
+            env={
+                **os.environ,
+                **{
+                    "ROS_LOG_DIR": ros_log_dir,
+                    "ARTEFACTS_SCENARIO_PARAMS_FILE": TMP_SCENARIO_PARAMS_YAML,
+                },
             },
-        },
-        output_path=os.path.join(run.output_path, "test_process_log.txt"),
-    )
+            output_path=os.path.join(run.output_path, "test_process_log.txt"),
+        )
+    except Launch_test_CmdNotFoundError as e:
+        # raise Exception(
+        #    f"Running {scenario['ros_testfile']} failed. Please check that the launch file exists."
+        # )
+        # closes the run properly and mark as errored
+        # dict matching junit xml format for test execution error
+        result = get_TestSuite_error_result(
+            scenario["ros_testfile"],
+            "launch_test command not found",
+            "Please check that launch_test is installed and in the path. Exception: {e}",
+        )
+        results = [result]
+        run.log_tests_results(results, False)
+        return results, False
+    except LaunchTestFileNotFoundError as e:
+        result = get_TestSuite_error_result(
+            scenario["ros_testfile"],
+            "launch_test file not found",
+            f"Please check that the `ros_testfile` config is correct. Exception: {e}",
+        )
+        results = [result]
+        run.log_tests_results(results, False)
+        return results, False
+    except BadLaunchTestFileError as e:
+        launch_test_file = scenario["ros_testfile"]
+        result = get_TestSuite_error_result(
+            scenario["ros_testfile"],
+            "launch_test file syntax error",
+            f"Please check that the file specified in  `ros_testfile` config is a valid ros_test file. You may be able to identify issues by doing `launch_test {launch_test_file}`. Exception: {e}",
+        )
+        results = [result]
+        run.log_tests_results(results, False)
+        return results, False
+
     if return_code == 2:
         raise Exception(
             f"Running {scenario['ros_testfile']} failed. Please check that the launch file exists."
@@ -82,10 +165,11 @@ def run_ros2_tests(run):
 
     # parse xml generated by launch_test
     results, success = parse_tests_results(test_result_file_path)
+    # upload logs anyway to help user debug
+    run.log_artifacts(run.output_path)
     if success is None:
         run.log_tests_results(results, False)
         return results, success
-    run.log_artifacts(run.output_path)
 
     # upload any additional files in the folders specified by the user in artefacts.yaml
     for output in scenario.get("output_dirs", []):

artefacts/cli/utils.py

@@ -12,7 +12,13 @@ from artefacts.cli import WarpRun
 
 
 def run_and_save_logs(
-    args, output_path, shell=False, executable=None, env=None, cwd=None
+    args,
+    output_path,
+    shell=False,
+    executable=None,
+    env=None,
+    cwd=None,
+    with_output=False,
 ):
     """
     Run a command and save stdout and stderr to a file in output_path
@@ -20,6 +26,7 @@ def run_and_save_logs(
     Note: explicitly list used named params instead of using **kwargs to avoid typing issue: https://github.com/microsoft/pyright/issues/455#issuecomment-780076232
     """
     output_file = open(output_path, "wb")
+
     proc = subprocess.Popen(
         args,
         stdout=subprocess.PIPE,  # Capture stdout
@@ -30,17 +37,24 @@ def run_and_save_logs(
         cwd=cwd,
     )
     # write test-process stdout and stderr into file and stdout
+    stderr_content = ""
+    stdout_content = ""
     if proc.stdout:
         for line in proc.stdout:
             decoded_line = line.decode()
             sys.stdout.write(decoded_line)
             output_file.write(line)
+            stdout_content += decoded_line
     if proc.stderr:
+        output_file.write("[STDERR]\n".encode())
         for line in proc.stderr:
             decoded_line = line.decode()
             sys.stderr.write(decoded_line)
             output_file.write(line)
+            stderr_content += decoded_line
     proc.wait()
+    if with_output:
+        return proc.returncode, stdout_content, stderr_content
     return proc.returncode
 
 

artefacts/cli/utils_ros.py

@@ -6,6 +6,22 @@ class FailureElement(Element):
     message = Attr()
 
 
+def get_TestSuite_error_result(test_suite_name, name, error_msg):
+    return {
+        "suite": test_suite_name,
+        "errors": 1,
+        "failures": 0,
+        "tests": 1,
+        "details": [
+            {
+                "name": name,
+                "failure_message": error_msg,
+                "result": "failure",
+            }
+        ],
+    }
+
+
 def parse_tests_results(file):
     def parse_suite(suite):
         nonlocal success, results
@@ -50,19 +66,9 @@ def parse_tests_results(file):
     except Exception as e:
         print(f"[Exception in parse_tests_results] {e}")
         print("Test result xml could not be loaded, marking success as False")
-        results = [
-            {
-                "suite": "unittest.suite.TestSuite",
-                "errors": 1,
-                "failures": 0,
-                "tests": 1,
-                "details": [
-                    {
-                        "name": "Error parsing XML test results",
-                        "failure_message": f"The test may have timed out. Exception: {e}",
-                        "result": "failure",
-                    }
-                ],
-            }
-        ]
+        results = get_TestSuite_error_result(
+            "unittest.suite.TestSuite",
+            "Error parsing XML test results",
+            f"The test may have timed out. Exception: {e}",
+        )
         return results, None

artefacts/cli/version.py

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

{artefacts_cli-0.7.1.dist-info → artefacts_cli-0.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: artefacts_cli
-Version: 0.7.1
+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

{artefacts_cli-0.7.1.dist-info → artefacts_cli-0.7.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 artefacts/__init__.py,sha256=VLmogtpRQeJjQjAORV8ClSJ5qF-57Hxx3apvgy9H1zk,76
 artefacts/cli/__init__.py,sha256=pt8OK66hMeQUxT9iLcvzYIIjFGrPS63ecWo8hS0T2qQ,11980
-artefacts/cli/app.py,sha256=eJ70xlvPvSrz6CGCaXCxzBI26qBx_-2IA_6V5TPhVow,23131
+artefacts/cli/app.py,sha256=lTdfJsNCdUh8A0V-MvvYUNoB1rgHAMpXxInqPgPeC4g,24241
 artefacts/cli/app_containers.py,sha256=AOTiXjyJzYZn6JqfW26N3ehGQWcEVQ5mEmKDdp9a6tQ,5636
 artefacts/cli/bagparser.py,sha256=FE_QaztC9pg4hQzTjGSdyve6mzZbHJbyqa3wqvZSbxE,3702
 artefacts/cli/constants.py,sha256=bvsVDwqkAc49IZN7j6k6IL6EG87bECHd_VINtKJqbv8,320
@@ -9,16 +9,16 @@ 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=UENolcbPfd6sim2GUd3djX88atGsPXEKCbPHv1Wucs4,511
+artefacts/cli/ros2.py,sha256=RGAK228jjbWzcJW-ONGmkAl5QGvHC39SMij9GUthUTY,7587
+artefacts/cli/utils.py,sha256=oy56o3N361srwhIvbMxwSPg8I_-tC7xcWtTSINTF2rE,4125
+artefacts/cli/utils_ros.py,sha256=ucJrIMLcTh26ioduj3xiozgxqXZghkyTMHWI9BsHNjI,2156
+artefacts/cli/version.py,sha256=d8Q6A3AJbbiXbr7TTxrk_DMbAQYVhMa2jrNwZsIl2LM,511
 artefacts/cli/containers/__init__.py,sha256=K0efkJXNCqXH-qYBqhCE_8zVUCHbVmeuKH-y_fE8s4M,2254
 artefacts/cli/containers/docker.py,sha256=R0yA-aIZCyYWN7gzim_Dhn1owpKI9ekMu6qbz5URYbQ,4311
 artefacts/cli/containers/utils.py,sha256=bILX0uvazUJq7hoqKk4ztRzI_ZerYs04XQdKdx1ltjk,2002
 artefacts/wrappers/artefacts_ros1_meta.launch,sha256=9tN7_0xLH8jW27KYFerhF3NuWDx2dED3ks_qoGVZAPw,1412
-artefacts_cli-0.7.1.dist-info/METADATA,sha256=KuGOTvcRm3RPOqsEEp01SWAayNpBq6Z29kW-btfevOA,3183
-artefacts_cli-0.7.1.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-artefacts_cli-0.7.1.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
-artefacts_cli-0.7.1.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
-artefacts_cli-0.7.1.dist-info/RECORD,,
+artefacts_cli-0.7.2.dist-info/METADATA,sha256=BLLhtZXxpR49NRGgSHH9qVu4bImVgt5KJLFbHZsKxFk,3183
+artefacts_cli-0.7.2.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+artefacts_cli-0.7.2.dist-info/entry_points.txt,sha256=nlTXRzilNjccbi53FgaRWCQPkG-pv61HRkaCkrKjlec,58
+artefacts_cli-0.7.2.dist-info/top_level.txt,sha256=FdaMV1C9m36MWa-2Stm5xVODv7hss_nRYNwR83j_7ow,10
+artefacts_cli-0.7.2.dist-info/RECORD,,

{artefacts_cli-0.7.1.dist-info → artefacts_cli-0.7.2.dist-info}/WHEEL

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