Merge branch 'task/wifi-no-retry' into 'master'

provision: Provide a --no-retry option to fail gracefully and avoid user interfactive prompts

See merge request app-frameworks/esp-rainmaker-cli!77

Author: shahpiyushv

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All major changes to ESP RainMaker CLI will be documented in this file.
 
+## [1.8.1] - 19-Dec-2025
+### Added
+- An option --no-retry for provisioning, to avoid user-interactive prompts asking to retry in case of failures
+
 ## [1.8.0] - 18-Dec-2025
 ### Added
 - Retry support for WiFi provisioning - allows users to retry provisioning on failure,

rainmaker/rainmaker.py

@@ -401,6 +401,10 @@ def main():
                                        'Values from QR code will be used as defaults, but can be overridden\n'
                                        'by explicit --transport, --device_name, and --pop options')
 
+    provision_parser.add_argument('--no-retry',
+                                  action='store_true',
+                                  help='Exit immediately on provisioning failure without prompting for retry')
+    
     add_profile_argument(provision_parser)
     provision_parser.set_defaults(func=provision)
 

rainmaker/version.py

@@ -5,4 +5,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 # This file contains the version information for the ESP RainMaker CLI
-VERSION = "1.8.0"
+VERSION = "1.8.1"

rmaker_cmd/provision.py

@@ -40,6 +40,7 @@ def provision(vars=None):
                  - `ssid`: WiFi SSID
                  - `passphrase`: WiFi password
                  - `profile`: Profile to use for the operation
+                 - `no_retry`: If True, exit immediately if prov-ctrl succeeds without prompting for retry
     :type vars: dict | None
 
     :raises Exception: If there is an issue with provisioning or adding device
@@ -152,7 +153,8 @@ def provision(vars=None):
                 sec2_username=sec2_username,
                 sec2_password=sec2_password,
                 device_name=device_name,
-                session=curr_session
+                session=curr_session,
+                no_retry=vars.get('no_retry', False)
             )
         except RuntimeError as claim_err:
             # Handle claim requirement error specifically
@@ -161,14 +163,28 @@ def provision(vars=None):
             print(f'❌ Error: {error_msg}')
             sys.exit(1)
 
-        # Handle tuple return (node_id, challenge_response_performed)
+        # Handle tuple return
+        # Can be: (node_id, challenge_response_performed) on success
+        # Or: (None, False, prov_ctrl_succeeded) on failure after prov-ctrl attempt
+        # Or: None on early failure (before prov-ctrl attempt)
+        prov_ctrl_succeeded = False
         if isinstance(result, tuple):
-            node_id, challenge_response_performed = result
+            if len(result) == 3:
+                # Failure case with prov_ctrl_succeeded flag
+                node_id, challenge_response_performed, prov_ctrl_succeeded = result
+            else:
+                # Success case
+                node_id, challenge_response_performed = result
         else:
             node_id = result
             challenge_response_performed = False
 
         if node_id is None:
+            # If prov-ctrl succeeded, don't show factory defaults message
+            # (whether --no-retry was used or user declined retry)
+            if prov_ctrl_succeeded:
+                # Message already printed by provision_device
+                return
             # Error message already printed by provision_device when reset fails
             # Only log for debugging purposes
             log.error(PROVISION_FAILURE_MSG)

rmaker_tools/rmaker_prov/esp_rainmaker_prov.py

@@ -163,7 +163,7 @@ def get_wifi_creds_from_scanlist(transport_mode, obj_transport,
 
 def provision_device(transport_mode, pop, userid, secretkey,
                      ssid=None, passphrase=None, security_version=None,
-                     sec2_username='', sec2_password='', device_name=None, session=None):
+                     sec2_username='', sec2_password='', device_name=None, session=None, no_retry=False):
     """
     Wi-Fi Provision a device
 
@@ -209,6 +209,9 @@ def provision_device(transport_mode, pop, userid, secretkey,
     :param session: Authenticated session object for challenge-response
     :type session: object, optional
 
+    :param no_retry: If True, exit immediately if prov-ctrl succeeds without prompting for retry
+    :type no_retry: bool, optional
+
     :return: nodeid (Node Identifier) on Success, None on Failure
     :rtype: str | None
     """
@@ -337,6 +340,7 @@ def provision_device(transport_mode, pop, userid, secretkey,
         print("No session provided, proceeding with traditional flow")
 
     dynamic_credentials = not bool(ssid and passphrase)
+    prov_ctrl_succeeded = False  # Track if prov-ctrl reset succeeded
 
     def prompt_yes_no(prompt, default=False):
         while True:
@@ -350,35 +354,48 @@ def prompt_yes_no(prompt, default=False):
             print('Please respond with yes or no (y/n).')
 
     def request_device_reset():
+        nonlocal prov_ctrl_succeeded
         # Try reset silently - only show messages if it succeeds
         try:
             reset_ok = esp_prov.ctrl_reset(obj_transport, obj_security)
         except RuntimeError as err:
+            prov_ctrl_succeeded = False
             return False
 
         if not reset_ok:
+            prov_ctrl_succeeded = False
             return False
 
         # Only show message if reset succeeded
         print('Device reset via prov-ctrl successful.')
+        prov_ctrl_succeeded = True
         time.sleep(2)
         return True
 
     def handle_retry(reason_msg):
-        nonlocal ssid, passphrase, dynamic_credentials
+        nonlocal ssid, passphrase, dynamic_credentials, prov_ctrl_succeeded
         if reason_msg:
             print(reason_msg)
 
         # Try to reset device state before asking user if they want to retry
         if not request_device_reset():
             # If reset failed, print error message and exit without offering retry
             # Don't mention prov-ctrl since it failed silently
+            prov_ctrl_succeeded = False
             print('Provisioning Failed. Reset your board to factory defaults and retry.')
             return False
 
+        # If --no-retry is set and reset succeeded, exit with message
+        # Don't show factory defaults message since prov-ctrl succeeded
+        if no_retry:
+            print('Device is reset to provisioning. Please try again')
+            return False
+        
         # Only offer retry if reset succeeded
         if not prompt_yes_no('Would you like to retry provisioning? [y/N]: '):
-            print('Provisioning Failed. Reset your board to factory defaults and retry.')
+            # User declined retry, but prov-ctrl succeeded, so don't ask to reset to factory defaults
+            # Since prov-ctrl succeeded, device is already reset to provisioning state
+            print('Provisioning cancelled.')
             return False
 
         # If we have an SSID, offer to retry with the same SSID but new password
@@ -444,13 +461,15 @@ def wait_for_wifi_connection():
                                          passphrase):
             if handle_retry("Sending Wi-Fi credentials to node - Failed"):
                 continue
-            return None
+            # Return tuple with prov_ctrl_succeeded flag
+            return (None, False, prov_ctrl_succeeded)
         print("Sending Wi-Fi credentials to node - Successful")
 
         if not esp_prov.apply_wifi_config(obj_transport, obj_security):
             if handle_retry("Applying Wi-Fi config to node - Failed"):
                 continue
-            return None
+            # Return tuple with prov_ctrl_succeeded flag
+            return (None, False, prov_ctrl_succeeded)
         print("Applying Wi-Fi config to node - Successful")
 
         success, status = wait_for_wifi_connection()
@@ -464,7 +483,8 @@ def wait_for_wifi_connection():
             reason_msg = f"Wi-Fi Provisioning Failed. Unexpected status: {status}"
 
         if not handle_retry(reason_msg):
-            return None
+            # Return tuple with prov_ctrl_succeeded flag
+            return (None, False, prov_ctrl_succeeded)
 
 
 if __name__ == '__main__':