ragger 1.41.0__py3-none-any.whl → 1.41.2__py3-none-any.whl

ragger/__version__.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '1.41.0'
-__version_tuple__ = version_tuple = (1, 41, 0)
+__version__ = version = '1.41.2'
+__version_tuple__ = version_tuple = (1, 41, 2)
 
 __commit_id__ = commit_id = None

ragger/conftest/base_conftest.py

@@ -1,6 +1,7 @@
 import os
 import pytest
 import logging
+import warnings
 from dataclasses import fields
 from ledgered.devices import Device, Devices
 from ledgered.manifest import Manifest
@@ -14,6 +15,7 @@ from ragger.logger import init_loggers, standalone_conf_logger
 from ragger.navigator import Navigator, NanoNavigator, TouchNavigator, NavigateWithScenario
 from ragger.utils import find_project_root_dir, find_library_application, find_application
 from ragger.utils.misc import get_current_app_name_and_version, exit_current_app, open_app_from_dashboard
+from ragger.error import MissingElfError
 
 from . import configuration as conf
 
@@ -47,6 +49,10 @@ def pytest_addoption(parser):
                      const="apdu.log",
                      help="Log the APDU in a file. If no pattern provided, uses 'apdu_xxx.log'.")
     parser.addoption("--seed", action="store", default=None, help="Set a custom seed")
+    parser.addoption("--ignore-missing-binaries",
+                     action="store_true",
+                     default=False,
+                     help="Skip tests instead of failing when application binaries are missing")
     # Always allow "default" even if application conftest does not define it
     allowed_setups = conf.OPTIONAL.ALLOWED_SETUPS
     if "default" not in allowed_setups:
@@ -102,6 +108,11 @@ def cli_user_seed(pytestconfig):
     return pytestconfig.getoption("seed")
 
 
+@pytest.fixture(scope="session")
+def ignore_missing_binaries(pytestconfig):
+    return pytestconfig.getoption("ignore_missing_binaries")
+
+
 @pytest.fixture(scope="session")
 def pki_prod(pytestconfig):
     return pytestconfig.getoption("pki_prod")
@@ -238,7 +249,8 @@ def prepare_speculos_args(root_pytest_dir: Path,
                           pki_prod: bool,
                           cli_user_seed: str,
                           additional_args: List[str],
-                          verbose_speculos: bool = False):
+                          verbose_speculos: bool = False,
+                          ignore_missing_binaries: bool = False):
     speculos_args = additional_args.copy()
 
     if display:
@@ -270,16 +282,14 @@ def prepare_speculos_args(root_pytest_dir: Path,
                 f"Expected a single folder in {manifest.app.build_directory}, found {len(app_dir_subdirectories)}"
             )
         main_app_path = find_application(app_dir_subdirectories[0], device_name, "c")
-    # If the app is standalone, the main app should be located in project_root_dir / manifest.app.build_directory
-    else:
-        main_app_path = find_application(project_root_dir / manifest.app.build_directory,
-                                         device_name, manifest.app.sdk)
 
-    # If this repository does not hold the main app, then we need to load this repository's application as a library
-    if conf.OPTIONAL.MAIN_APP_DIR is not None:
         # This repo holds the library, not the standalone app: search in root_dir/build
         lib_path = find_application(project_root_dir, device_name, manifest.app.sdk)
         speculos_args.append(f"-l{lib_path}")
+    # If the app is standalone, the main app should be located in project_root_dir / manifest.app.build_directory
+    else:
+        main_app_path = find_application(project_root_dir / manifest.app.build_directory,
+                                         device_name, manifest.app.sdk)
 
     # Legacy lib method, remove once exchange is ported
     if len(conf.OPTIONAL.SIDELOADED_APPS) != 0:
@@ -290,8 +300,15 @@ def prepare_speculos_args(root_pytest_dir: Path,
         libs_dir = Path(project_root_dir / conf.OPTIONAL.SIDELOADED_APPS_DIR)
         # Add "-l Appname:filepath" to Speculos command line for every required lib app
         for coin_name, lib_name in conf.OPTIONAL.SIDELOADED_APPS.items():
-            lib_path = find_library_application(libs_dir, coin_name, device_name)
-            speculos_args.append(f"-l{lib_name}:{lib_path}")
+            try:
+                lib_path = find_library_application(libs_dir, coin_name, device_name)
+                speculos_args.append(f"-l{lib_name}:{lib_path}")
+            except MissingElfError as e:
+                if ignore_missing_binaries:
+                    warnings.warn(f"Could not find sideloaded app library for '{lib_name}': {e}",
+                                  UserWarning)
+                else:
+                    raise
     else:
         # Keep this method instead
         # Find all external libraries that have to be sideloaded
@@ -300,8 +317,17 @@ def prepare_speculos_args(root_pytest_dir: Path,
             subdirs = sorted(
                 filter(lambda d: (sideloaded_dir / d).is_dir(), os.listdir(sideloaded_dir)))
             for subdir in subdirs:
-                lib_path = find_application(sideloaded_dir / subdir, device_name, manifest.app.sdk)
-                speculos_args.append(f"-l{lib_path}")
+                try:
+                    # Currently only C apps are used as additional binaries by ragger (Ethereum and Exchange)
+                    # TODO: add support for Rust SDK libraries if needed
+                    lib_path = find_application(sideloaded_dir / subdir, device_name, "c")
+                    speculos_args.append(f"-l{lib_path}")
+                except MissingElfError as e:
+                    if ignore_missing_binaries:
+                        warnings.warn(f"Could not find sideloaded app binary for '{subdir}': {e}",
+                                      UserWarning)
+                    else:
+                        raise
 
     # Check if custom user seed has been provided through CLI or optional configuration.
     # CLI user seed has priority over the optional configuration seed.
@@ -324,7 +350,8 @@ def create_backend(root_pytest_dir: Path,
                    log_apdu_file: Optional[Path],
                    cli_user_seed: str,
                    additional_speculos_arguments: List[str],
-                   verbose_speculos: bool = False) -> BackendInterface:
+                   verbose_speculos: bool = False,
+                   ignore_missing_binaries: bool = False) -> BackendInterface:
     if backend_name.lower() == "ledgercomm":
         return LedgerCommBackend(device=device,
                                  interface="hid",
@@ -336,7 +363,8 @@ def create_backend(root_pytest_dir: Path,
         main_app_path, speculos_args = prepare_speculos_args(root_pytest_dir, device, display,
                                                              pki_prod, cli_user_seed,
                                                              additional_speculos_arguments,
-                                                             verbose_speculos)
+                                                             verbose_speculos,
+                                                             ignore_missing_binaries)
         return SpeculosBackend(main_app_path,
                                device=device,
                                log_apdu_file=log_apdu_file,
@@ -351,12 +379,21 @@ def create_backend(root_pytest_dir: Path,
 @pytest.fixture(scope=conf.OPTIONAL.BACKEND_SCOPE)
 def backend(skip_tests_for_unsupported_devices, root_pytest_dir: Path, backend_name: str,
             device: Device, display: bool, pki_prod: bool, log_apdu_file: Optional[Path],
-            cli_user_seed: str, additional_speculos_arguments: List[str],
-            verbose_speculos: bool) -> Generator[BackendInterface, None, None]:
+            cli_user_seed: str, additional_speculos_arguments: List[str], verbose_speculos: bool,
+            ignore_missing_binaries: bool) -> Generator[BackendInterface, None, None]:
     # to separate the test name and its following logs
     print("")
-    with create_backend(root_pytest_dir, backend_name, device, display, pki_prod, log_apdu_file,
-                        cli_user_seed, additional_speculos_arguments, verbose_speculos) as b:
+    backend_instance = None
+    try:
+        backend_instance = create_backend(root_pytest_dir, backend_name, device, display, pki_prod,
+                                          log_apdu_file, cli_user_seed,
+                                          additional_speculos_arguments, verbose_speculos,
+                                          ignore_missing_binaries)
+    except MissingElfError as e:
+        pytest.fail(f"Missing ELF: {e}")
+
+    assert backend_instance is not None, "Backend instance should be initialized"
+    with backend_instance as b:
         if backend_name.lower() != "speculos" and conf.OPTIONAL.APP_NAME:
             # Make sure the app is restarted as this is what is requested by the fixture scope
             app_name, version = get_current_app_name_and_version(b)

ragger/error.py

@@ -173,3 +173,11 @@ class ExceptionRAPDU(Exception):
 
     def __str__(self):
         return f"Error [0x{self.status:x}] {str(self.data)}"
+
+
+class MissingElfError(Exception):
+    """Exception raised when an expected ELF binary is missing."""
+
+    def __init__(self, path: str):
+        super().__init__(f"File '{path}' missing. Did you compile for this target?")
+        self.path = path

ragger/utils/misc.py

@@ -16,7 +16,7 @@
 import toml
 from typing import Optional, Tuple, List
 from pathlib import Path
-from ragger.error import ExceptionRAPDU
+from ragger.error import ExceptionRAPDU, MissingElfError
 import subprocess
 import json
 
@@ -48,7 +48,7 @@ def find_library_application(base_dir: Path, name: str, device: str) -> Path:
         raise AssertionError(f"{base_dir} is not a directory")
     lib = Path(base_dir / (name + "_" + device + ".elf")).resolve()
     if not lib.is_file():
-        raise AssertionError(f"File '{lib}' missing. Did you compile for this target?")
+        raise MissingElfError(str(lib))
     return lib
 
 
@@ -91,7 +91,7 @@ def find_application(base_dir: Path, device: str, sdk: str) -> Path:
     else:
         app = app / "build" / device / "bin" / "app.elf"
     if not app.is_file():
-        raise AssertionError(f"File '{app}' missing. Did you compile for this target?")
+        raise MissingElfError(str(app))
     return app
 
 

{ragger-1.41.0.dist-info → ragger-1.41.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ragger
-Version: 1.41.0
+Version: 1.41.2
 Summary: Testing framework using Speculos and LedgerComm as backends
 Author-email: Ledger <hello@ledger.fr>
 Project-URL: Homepage, https://github.com/LedgerHQ/ragger

{ragger-1.41.0.dist-info → ragger-1.41.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 ragger/__init__.py,sha256=Vbk78M7VtDVMTu02zYQquYSTxtgbieknkvr3uXONrig,713
-ragger/__version__.py,sha256=E1ZnJIkHAjOyZueq2FTrD7-A-X_nF3GK9RHXFfxJOQQ,706
-ragger/error.py,sha256=G81LOe38jUDV6EzdFc_foKVsMxk09q6N5--0M63qya0,6279
+ragger/__version__.py,sha256=YovYgyS1Rxt5rHmXoIuT5lFDUCxkYEVR2lrSZcSCwYg,706
+ragger/error.py,sha256=mmeipucrlUz1g1kkNy15rXpCccpzucnRTGIsKbcOzBo,6528
 ragger/logger.py,sha256=XF3DsHDLGOHAG7cqVj_7BQlHKj9J8zw8A9soFHIydc8,2457
 ragger/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ragger/backend/__init__.py,sha256=IQlMre2Pi5QWyYBTROMTbKuonNRUODKrrhj5UxcqQx4,1930
@@ -14,7 +14,7 @@ ragger/bip/__init__.py,sha256=7gY5V8gkJfct1g4OgaLg8bNpgoITGaqU9gTKC4tHbAM,920
 ragger/bip/path.py,sha256=uX69L3U8vteIHJy_PE5yPloGaiiYYMq_jLbBSENiRqs,1709
 ragger/bip/seed.py,sha256=yKGM_fkFCh6hNAl7vOMrEv5kEoQoDmVPhBCIMtO8dNk,1758
 ragger/conftest/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ragger/conftest/base_conftest.py,sha256=I2J0rvBY4W9G9OI3mE-qVeAM5vV3b9m_oSWqrceL-iM,19100
+ragger/conftest/base_conftest.py,sha256=CZxd88vtU1axohRpEK_Uf5IbDa8S0YBX5mOxGjoc_20,20763
 ragger/conftest/configuration.py,sha256=jE_zbvDWSc7jQQ4VEJBo8m_3kME09i2YXK6PLigPAes,3297
 ragger/firmware/__init__.py,sha256=3g_-n2b0qEgVlP42lOQiZzBPux6PCUtZnydkQeEn_Vk,687
 ragger/firmware/structs.py,sha256=pkUzEkq-kiUntWK2mt1Vkalgoe-3tbvBcLfe12L-CNo,1804
@@ -47,11 +47,11 @@ ragger/navigator/navigation_scenario.py,sha256=EY31uNp3hkMm8kVmvQEZvnjcw9ymDxHDZ
 ragger/navigator/navigator.py,sha256=ZT2smrw0Xz5XXhz2cZ3DJjbG4NwwQnCrQwvarbjZPTc,29146
 ragger/navigator/touch_navigator.py,sha256=k3PNaQ9sjfz4qFm-QuNPbnIJLXiICb_LeLbqnfjgdGM,5018
 ragger/utils/__init__.py,sha256=PUabSv1qx0XyKWovIxvGBI71sd3O3bKp3gCsUxlWm1E,997
-ragger/utils/misc.py,sha256=_ft_CrwEcZ-VVZCBG-_QjYQuTZn-Fht36k3C6BXhHOs,6930
+ragger/utils/misc.py,sha256=Gx1LbtaOh3ns8C_4sRJAFyym2RcbTEmjNtjRfHT_BYw,6851
 ragger/utils/packing.py,sha256=2xaRR-FhwVfknP74ZGo-O4JTE6R0HpNqhxKJ9aMrns4,766
 ragger/utils/structs.py,sha256=JMfuX5u-4gSZfqH0SER05B15-mj0YyHjnxLAgxAYtAM,1413
-ragger-1.41.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-ragger-1.41.0.dist-info/METADATA,sha256=aW_QcwGG5g4ig6mypqRa7AzL-4-kW1yXoQYEWqRRmQ4,10660
-ragger-1.41.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ragger-1.41.0.dist-info/top_level.txt,sha256=kqJEoAZ6qn0T3iuVa-710gBK7Ik1euCwNwBbyFraRQg,7
-ragger-1.41.0.dist-info/RECORD,,
+ragger-1.41.2.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+ragger-1.41.2.dist-info/METADATA,sha256=F3RzajCILlcstsq8xs3SCFIKIxB8BjHDgtrchfkKn8U,10660
+ragger-1.41.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ragger-1.41.2.dist-info/top_level.txt,sha256=kqJEoAZ6qn0T3iuVa-710gBK7Ik1euCwNwBbyFraRQg,7
+ragger-1.41.2.dist-info/RECORD,,