check if device can be claimed with error message

Signed-off-by: Maximilian Deubel <[email protected]>

Author: maxd-nordic

README.md

@@ -46,7 +46,7 @@ Run the following command to use this package as a dependency:
     # Enable modem-based JSON Web Token (JWT) generation required for nRF Cloud authentication
     CONFIG_MODEM_JWT=y
 
-    # Configure the nRF Cloud library to use the device's internal UUID 
+    # Configure the nRF Cloud library to use the device's internal UUID
     CONFIG_NRF_CLOUD_CLIENT_ID_SRC_INTERNAL_UUID=y
     # Or IMEI as the device ID
     CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI=y
@@ -120,4 +120,4 @@ Running the tests depends on a [development installation](#development-installat
 
 Check coverage
 
-    poetry run pytest --cov=. tests
+    poetry run pytest --cov=src tests

src/nrfcloud_utils/claim_and_provision_device.py

@@ -206,11 +206,19 @@ def main(in_args):
         if args.provisioning_tags == "nrf-cloud-onboarding":
             nrf_cloud_diap.ensure_nrfcloud_provisioning_rule(args.api_key, args.sectag)
         logger.info(f'with provisioning tags: {args.provisioning_tags}')
+
+    can_claim, can_claim_reason = nrf_cloud_diap.can_device_be_claimed(args.api_key, attest_tok)
+    if not can_claim:
+        error_exit(f'Cannot claim device: {can_claim_reason}')
+
     api_res = nrf_cloud_diap.claim_device(args.api_key, attest_tok, args.provisioning_tags)
     nrf_cloud_diap.print_api_result("Claim device response", api_res)
     if api_res.status_code != 201:
-        error_exit('ClaimDeviceOwnership API call failed')
+        error_exit('ClaimDeviceOwnership API call failed: ' + api_res.text)
     elif args.provisioning_tags is not None:
+        if cred_if.shell:
+            # issue reboot to speed up provisioning
+            cred_if.write_raw('kernel reboot warm')
         logger.info('Done. It is assumed the provisioning tags complete the process over the air.')
         return
 

src/nrfcloud_utils/nrf_cloud_diap.py

@@ -70,6 +70,20 @@ def unclaim_device(api_key, dev_uuid):
 
     return requests.delete(req, headers=get_auth_header(api_key))
 
+def can_device_be_claimed(api_key, claim_token):
+    global api_url
+    req = f'{api_url}{CLAIMED_DEV}?dryrun=true'
+
+    response = requests.post(req, json={CLAIM_TOK : claim_token}, headers=get_auth_header(api_key))
+
+    reason = None
+
+    if response.text:
+        response_json = response.json()
+        reason = response_json.get('message', None)
+
+    return (response.status_code == 202, reason)
+
 def get_create_prov_cmd_req(dev_uuid):
     global api_url
     return f'{api_url}{CLAIMED_DEV}/{dev_uuid}/{PROV}'

tests/test_claim_and_provision_device.py

@@ -45,6 +45,7 @@ class TestClaimAndProvisionDevice:
     @patch("nrfcredstore.comms.serial.Serial", return_value=FakeSerial())
     def test_provisioning_tags(self, ser, select_device, diap):
         diap.claim_device = Mock(return_value=TEST_RESPONSE)
+        diap.can_device_be_claimed = Mock(return_value=(True, ""))
         args = f"--port /not/a/real/device --cmd-type at --api-key NOTAKEY --provisioning-tags nrf-cloud-onboarding".split()
         # call DUT
         claim_and_provision_device.main(args)