all lights green!

Author: maxd-nordic

src/nrfcredstore/command_interface.py

@@ -186,14 +186,12 @@ def get_attestation_token(self):
         attest_tok = output.split('"')[1]
         return attest_tok
 
-    def get_csr(self, sectag=0, cn=""):
-
-        # provide attributes parameter if a custom CN is specified
-        attr = f',"CN={cn}"' if len(cn) else ''
-
-        self.at_command(f'AT%KEYGEN={sectag},2,0{attr}')
+    def get_csr(self, sectag=0, attributes=""):
+        if attributes:
+            self.at_command(f'AT%KEYGEN={sectag},2,0,"{attributes}"')
+        else:
+            self.at_command(f'AT%KEYGEN={sectag},2,0')
 
-        # include the CR in OK because 'OK' could be found in the CSR string
         retval, output = self.comms.expect_response("OK", "ERROR", "%KEYGEN:")
 
         if not retval:

src/nrfcredstore/credstore.py

@@ -97,20 +97,14 @@ def delete(self, tag: int, type: CredType):
 
     def keygen(self, tag: int, file: io.BufferedIOBase, attributes: str = ''):
         """Generate a new private key and return a certificate signing request in DER format"""
-        cmd = f'AT%KEYGEN={tag},2,0'
 
-        if attributes != '':
-            cmd = f'{cmd},"{attributes}"'
+        keygen_output = self.command_interface.get_csr(sectag=tag, attributes=attributes)
 
-        self.command_interface.at_command(cmd, wait_for_result=False)
-        result, response = self.command_interface.comms.expect_response("OK", "ERROR", "%KEYGEN: ")
-
-        if not result:
+        if not keygen_output:
             raise RuntimeError("Failed to generate key")
 
-        keygen_output = response.replace('%KEYGEN: "', '')
         csr_der_b64 = keygen_output.split('.')[0]
         csr_der_bytes = base64.urlsafe_b64decode(csr_der_b64 + '===')
-        file.write(csr_der_bytes)
 
+        file.write(csr_der_bytes)
         file.close()

tests/test_comms.py

@@ -1,47 +1,3 @@
-"""
-What to test for comms module?
-
-get_connected_nordic_boards
-* both device and hwid need to be emulated
-* macos doesn't provide unique hwid per port
-* empty list
-* some non-nordic comports
-* some nordic comports on mac, linux and windows ()
-* test both Thingy91x and JLink based kits
-
-select_jlink
-* mock cases for no, one and multiple jlinks
-* figure out how to test with inquirer (can we emulate prompt answers?)
-
-select_device_by_serial
-similar to the above
-
-select_device
-* rtt enabled with and without snr
-* port given
-* serial number given
-* list all
-* no list-all, select from nordic devices: zero, one, two devices
-
-test with emulated serial device
-* _init_serial
-* close
-* expect_response
-* reset_device: expect error
-* write_line
-* _readline_serial: returns stripped string, not bytes
-* _write_serial: blank forward
-
-test with emulated rtt device
-* _init_rtt
-* close
-* expect_response
-* reset_device
-* _readline_rtt: internal line buffering
-* _write_rtt: chopping up of data
-
-"""
-
 from unittest.mock import patch, Mock
 from collections import namedtuple
 import pytest

tests/test_credstore.py

@@ -1,7 +1,7 @@
 import io
 import pytest
 
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 from nrfcredstore.credstore import *
 from nrfcredstore.exceptions import ATCommandError
 
@@ -44,10 +44,10 @@ def list_all_resp_blank_lines(self, cred_store):
     def ok_resp(self, cred_store):
         cred_store.command_interface.at_command.return_value = True
 
-    # @pytest.fixture
-    # def csr_resp(self, cred_store):
-    #     # KEYGEN value is base64-encoded 'foo' and base64-encoded 'bar' joined by '.'
-    #     cred_store.command_interface.at_command.return_value = ['', '%KEYGEN: "Zm9v.YmFy"']
+    @pytest.fixture
+    def csr_resp(self, cred_store):
+        # KEYGEN value is base64-encoded 'foo' and base64-encoded 'bar' joined by '.'
+        cred_store.command_interface.get_csr.return_value = "Zm9v.YmFy"
 
     @pytest.fixture
     def at_error(self, cred_store):
@@ -114,8 +114,7 @@ def test_list_fail(self, cred_store, at_error_in_expect_response):
             cred_store.list()
 
     def test_delete_success(self, cred_store, ok_resp):
-        response = cred_store.delete(567890, CredType(1))
-        assert response == True
+        cred_store.delete(567890, CredType(1))
         self.command_interface.at_command.assert_called_with('AT%CMNG=3,567890,1', wait_for_result=True)
 
     def test_delete_fail(self, cred_store, at_error):
@@ -142,21 +141,24 @@ def test_write_any_type_fail(self, cred_store):
         with pytest.raises(ValueError):
             cred_store.write(567890, CredType.ANY, io.StringIO())
 
-    # def test_generate_sends_keygen_cmd(self, cred_store, csr_resp):
-    #     fake_binary_file = Mock()
-    #     cred_store.keygen(12345678, fake_binary_file)
-    #     self.command_interface.at_command.assert_called_with(f'AT%KEYGEN=12345678,2,0', wait_for_result=True)
+    def test_generate_sends_keygen_cmd(self, cred_store, csr_resp):
+        fake_binary_file = Mock()
+        cred_store.keygen(12345678, fake_binary_file)
+        self.command_interface.get_csr.assert_called_with(sectag=12345678, attributes='')
 
-    # def test_generate_with_attributes(self, cred_store, csr_resp):
-    #     cred_store.keygen(12345678, Mock(), 'O=Nordic Semiconductor,L=Trondheim,C=no,CN=mydevice')
-    #     self.command_interface.at_command.assert_called_with(
-    #         f'AT%KEYGEN=12345678,2,0,"O=Nordic Semiconductor,L=Trondheim,C=no,CN=mydevice"')
+    def test_generate_with_attributes(self, cred_store, csr_resp):
+        cred_store.keygen(12345678, Mock(), 'O=Nordic Semiconductor,L=Trondheim,C=no,CN=mydevice')
+        self.command_interface.get_csr.assert_called_with(
+            sectag=12345678,
+            attributes="O=Nordic Semiconductor,L=Trondheim,C=no,CN=mydevice"
+        )
 
-    # def test_generate_writes_csr_to_stream(self, cred_store, csr_resp):
-    #     fake_binary_file = Mock()
-    #     cred_store.keygen(12345678, fake_binary_file)
-    #     fake_binary_file.write.assert_called_with(b'foo')
+    def test_generate_writes_csr_to_stream(self, cred_store, csr_resp):
+        fake_binary_file = Mock()
+        cred_store.keygen(12345678, fake_binary_file)
+        fake_binary_file.write.assert_called_with(b'foo')
 
-    def test_generate_fail(self, cred_store, at_error_in_expect_response):
-        with pytest.raises(RuntimeError):
-            cred_store.keygen(12345678, Mock())
+    def test_generate_fail(self, cred_store):
+        with patch.object(cred_store.command_interface, 'get_csr', return_value=None):
+            with pytest.raises(RuntimeError):
+                cred_store.keygen(12345678, Mock())