launchpad-reviewers team mailing list archive

[Colin Watson <cjwatson@xxxxxxxxxxxxx>]

Colin Watson has proposed merging ~cjwatson/launchpad:signing-client-payload-tests into launchpad:master.

Commit message:
Test request bodies in SigningServiceClient tests

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~cjwatson/launchpad/+git/launchpad/+merge/389000
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/launchpad:signing-client-payload-tests into launchpad:master.

diff --git a/lib/lp/services/signing/tests/test_proxy.py b/lib/lp/services/signing/tests/test_proxy.py
index 9163c05..2e1e0df 100644
--- a/lib/lp/services/signing/tests/test_proxy.py
+++ b/lib/lp/services/signing/tests/test_proxy.py
@@ -21,6 +21,7 @@ from testtools.matchers import (
     AfterPreprocessing,
     ContainsDict,
     Equals,
+    MatchesDict,
     MatchesListwise,
     MatchesStructure,
     )
@@ -87,6 +88,15 @@ class SigningServiceResponseFactory:
         return box.encrypt(
             json.dumps(data), nonce, encoder=Base64Encoder).ciphertext
 
+    def _decryptPayload(self, value):
+        """Decrypt a payload we encrypted.
+
+        This is intended for use with `AfterPreprocessing` matchers.
+        """
+        box = Box(self.service_private_key, self.client_public_key)
+        decrypted = box.decrypt(value, self.nonce, encoder=Base64Encoder)
+        return json.loads(decrypted.decode("UTF-8"))
+
     def getAPISignedContent(self, call_index=0):
         """Returns the signed message returned by the API.
 
@@ -285,7 +295,12 @@ class SigningServiceProxyTest(TestCaseWithFactory, TestWithFixtures):
             "X-Response-Nonce": Equals(
                 self.response_factory.b64_response_nonce),
             }))
-        self.assertIsNotNone(http_generate.request.body)
+        self.assertThat(http_generate.request.body, AfterPreprocessing(
+            self.response_factory._decryptPayload,
+            MatchesDict({
+                "key-type": Equals("UEFI"),
+                "description": Equals("my lp test key"),
+                })))
 
         self.assertTimeline([
             ("POST", "/nonce", {}),
@@ -360,7 +375,15 @@ class SigningServiceProxyTest(TestCaseWithFactory, TestWithFixtures):
             "X-Response-Nonce": Equals(
                 self.response_factory.b64_response_nonce),
             }))
-        self.assertIsNotNone(http_sign.request.body)
+        self.assertThat(http_sign.request.body, AfterPreprocessing(
+            self.response_factory._decryptPayload,
+            MatchesDict({
+                "key-type": Equals("KMOD"),
+                "fingerprint": Equals(fingerprint),
+                "message-name": Equals(message_name),
+                "message": Equals(base64.b64encode(message).decode("UTF-8")),
+                "mode": Equals("DETACHED"),
+                })))
 
         self.assertTimeline([
             ("POST", "/nonce", {}),
@@ -394,12 +417,13 @@ class SigningServiceProxyTest(TestCaseWithFactory, TestWithFixtures):
         self.response_factory.addResponses(self)
         private_key = PrivateKey.generate()
         public_key = private_key.public_key
+        now = datetime.now()
 
         # Generate the key, and checks if we got back the correct dict.
         signing = getUtility(ISigningServiceClient)
         response_data = signing.inject(
             SigningKeyType.UEFI, bytes(private_key), bytes(public_key),
-            "This is a test key injected.", datetime.now())
+            "This is a test key injected.", now)
 
         self.assertEqual(response_data, {
             'fingerprint': self.response_factory.generated_fingerprint})
@@ -429,7 +453,17 @@ class SigningServiceProxyTest(TestCaseWithFactory, TestWithFixtures):
             "X-Response-Nonce": Equals(
                 self.response_factory.b64_response_nonce),
             }))
-        self.assertIsNotNone(http_inject.request.body)
+        self.assertThat(http_inject.request.body, AfterPreprocessing(
+            self.response_factory._decryptPayload,
+            MatchesDict({
+                "key-type": Equals("UEFI"),
+                "private-key": Equals(
+                    base64.b64encode(bytes(private_key)).decode("UTF-8")),
+                "public-key": Equals(
+                    base64.b64encode(bytes(public_key)).decode("UTF-8")),
+                "created-at": Equals(now.isoformat()),
+                "description": Equals("This is a test key injected."),
+                })))
 
         self.assertTimeline([
             ("POST", "/nonce", {}),