more unit tests

Author: EmmaLRussell

src/packit_client.py

@@ -20,18 +20,22 @@ def handle_response(response):
             raise PackitClientException(response)
         return response.json()
 
+    @staticmethod
+    def serialize(data):
+        return None if data is None else json.dumps(data)
+
     def __get(self, relative_url, headers = None):
         if headers is None:
             headers = self.__default_headers
         response = requests.get(self.__url(relative_url), headers=headers, verify = self.__verify)
         return PackitClient.handle_response(response)
 
     def __post(self, relative_url, data):
-        response = requests.post(self.__url(relative_url), data=json.dumps(data), headers=self.__default_headers, verify = self.__verify)
+        response = requests.post(self.__url(relative_url), data=PackitClient.serialize(data), headers=self.__default_headers, verify = self.__verify)
         return PackitClient.handle_response(response)
 
     def __put(self, relative_url, data):
-        response = requests.put(self.__url(relative_url), data=json.dumps(data), headers=self.__default_headers, verify = self.__verify)
+        response = requests.put(self.__url(relative_url), data=PackitClient.serialize(data), headers=self.__default_headers, verify = self.__verify)
         return PackitClient.handle_response(response)
 
     def __authenticate(self):

test/unit/test_packit_client.py

@@ -22,6 +22,13 @@ def mock_auth(mock_montagu_api_class, requests_mock):
     mock_montagu_api.token = "test-montagu-token"
     requests_mock.get(f"{PACKIT_URL}/api/auth/login/montagu", text = json.dumps({"token": "test-packit-token"} ))
 
+def assert_expected_packit_api_request(requests_mock, index, method, url, text = None):
+    req = requests_mock.request_history[index]
+    assert req.headers["Authorization"] == "Bearer test-packit-token"
+    assert req.method == method
+    assert req.url == url
+    assert req.text == text
+
 @patch("montagu.MontaguAPI")
 def test_authenticates_on_init(MockMontaguAPI, requests_mock):
     mock_auth(MockMontaguAPI, requests_mock)
@@ -37,15 +44,40 @@ def test_authenticates_on_init(MockMontaguAPI, requests_mock):
     assert sut.token == "test-packit-token"
 
 
-#@patch("montagu.MontaguAPI")
-#def test_run():
-#    mock_auth(MockMontaguAPI, requests_mock)
+@patch("montagu.MontaguAPI")
+def test_run(MockMontaguAPI, requests_mock):
+    mock_auth(MockMontaguAPI, requests_mock)
+    mock_branches_response = { "branches": [
+        { "name": "some_other_branch", "commitHash": "xyz987" },
+        { "name": "main", "commitHash": "abc123" }
+    ] }
+    requests_mock.get(f"{PACKIT_URL}/api/runner/git/branches", text = json.dumps(mock_branches_response))
+    requests_mock.post(f"{PACKIT_URL}/api/runner/run", text = json.dumps({ "taskId": "test-task-id" }))
 
-#def test_reauthenticates_on_401
+    sut = PackitClient(config)
+    task_id = sut.run("test-packet-group", {"a": 1, "b": 2})
 
-#def test_raises_exception_on_unexpected_status
+    assert task_id == "test-task-id"
+    assert_expected_packit_api_request(requests_mock, 1, "GET", f"{PACKIT_URL}/api/runner/git/branches")
+    expected_run_payload = json.dumps({
+        "name": "test-packet-group",
+        "parameters": {"a": 1, "b": 2},
+        "branch": "main",
+        "hash": "abc123"
+    })
+    assert_expected_packit_api_request(requests_mock, 2, "POST", f"{PACKIT_URL}/api/runner/run", expected_run_payload)
+
+
+@patch("montagu.MontaguAPI")
+def test_poll_status(MockMontaguAPI, requests_mock):
+    mock_auth(MockMontaguAPI, requests_mock)
+    mock_poll_response = { "status": "RUNNING" }
+    requests_mock.get(f"{PACKIT_URL}/api/runner/status/test-task-id", text = json.dumps(mock_poll_response))
+
+    sut = PackitClient(config)
+    resp = sut.poll("test-task-id")
 
-#def test_poll_status
+    assert resp == mock_poll_response
 
 @patch("montagu.MontaguAPI")
 def test_kill_task(MockMontaguAPI, requests_mock):
@@ -57,8 +89,37 @@ def test_kill_task(MockMontaguAPI, requests_mock):
     resp = sut.kill_task("test-task-id")
 
     assert resp == mock_kill_response
-    req = requests_mock.request_history[1]
-    assert req.headers["Authorization"] == "Bearer test-packit-token"
+    assert_expected_packit_api_request(requests_mock, 1, "POST", f"{PACKIT_URL}/api/runner/cancel/test-task-id")
+
+
+@patch("montagu.MontaguAPI")
+def test_publish(MockMontaguAPI, requests_mock):
+    mock_auth(MockMontaguAPI, requests_mock)
+    # publish polls for the packit - return 404 on first poll, 200 on second poll
+    requests_mock.get(f"{PACKIT_URL}/api/packets/test-packet-id", [
+        { "text": json.dumps({ "error": { "detail": "not found" } }),  "status_code": 404},
+        { "text": json.dumps({ "id": "test-packet-id", "name": "A packet" }), "status_code": 200 }
+    ])
+    expected_permissions_payload = json.dumps({
+        "addPermissions": [{ "permission": "packet.read", "packetId": "test-packet-id" }],
+        "removePermissions": []
+    })
+    requests_mock.put(f"{PACKIT_URL}/api/roles/test-role-1/permissions", json = "null")
+    requests_mock.put(f"{PACKIT_URL}/api/roles/test-role-2/permissions", text = "null")
+
+    sut = PackitClient(config)
+    result = sut.publish("A packet", "test-packet-id", ["test-role-1", "test-role-2"])
+    assert_expected_packit_api_request(requests_mock, 1, "GET", f"{PACKIT_URL}/api/packets/test-packet-id", None)
+    assert_expected_packit_api_request(requests_mock, 2, "GET", f"{PACKIT_URL}/api/packets/test-packet-id", None)
+
+    assert_expected_packit_api_request(requests_mock, 3, "PUT", f"{PACKIT_URL}/api/roles/test-role-1/permissions", expected_permissions_payload)
+    assert_expected_packit_api_request(requests_mock, 4, "PUT", f"{PACKIT_URL}/api/roles/test-role-2/permissions", expected_permissions_payload)
+    assert result
+
+#def test_raises_exception_when_auth_fails
+
+#def test_reauthenticates_on_401
+
+#def test_raises_exception_on_unexpected_status
 
-#def test_publish