Add class LandoWarnings to push warning messages to Lando (#187)

Author: abpostelnicu

libmozdata/lando.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import requests
+
+
+class LandoWarnings(object):
+    """
+    Encapsulates lando warning calls
+    """
+
+    def __init__(self, api_url, api_key):
+        self.api_url = f"{api_url}/diff_warnings"
+        self.api_key = api_key
+
+    def del_warnings(self, warnings):
+        """
+        Deletes warnings from Lando based on a json warnings list
+        """
+        for warning in warnings:
+            warning_id = warning["id"]
+
+            response = requests.delete(
+                f"{self.api_url}/{warning_id}",
+                headers={"X-Phabricator-API-Key": self.api_key},
+            )
+
+            if response.status_code != 200:
+                raise Exception(f"Failed to delete warning with ID {warning_id}!")
+
+    def add_warning(self, warning, revision_id, diff_id):
+        """
+        Adds a warning to Lando
+        """
+        response = requests.post(
+            self.api_url,
+            json={
+                "revision_id": revision_id,
+                "diff_id": diff_id,
+                "group": "LINT",
+                "data": {"message": warning},
+            },
+            headers={"X-Phabricator-API-Key": self.api_key},
+        )
+        if response.status_code != 201:
+            raise Exception(
+                f"Failed to add warnings for revision_id {revision_id} and diff_id {diff_id}!"
+            )
+
+    def get_warnings(self, revision_id, diff_id):
+        """
+        Gets a list of warnings
+        """
+        response = requests.get(
+            self.api_url,
+            params={
+                "revision_id": revision_id,
+                "diff_id": diff_id,
+                "group": "LINT",
+            },
+            headers={"X-Phabricator-API-Key": self.api_key},
+        )
+        if response.status_code != 200:
+            raise Exception(
+                f"Failed to get warnings for revision_id {revision_id} and diff_id {diff_id}!"
+            )
+
+        return response.json()
+
+    def del_all_warnings(self, revision_id, diff_id):
+        """
+        Deletes all warnings
+        """
+        current_warnings = self.get_warnings(revision_id, diff_id)
+
+        if len(current_warnings):
+            return self.del_warnings(current_warnings)

tests/test_lando.py

@@ -0,0 +1,123 @@
+import unittest
+
+import responses
+
+from libmozdata.lando import LandoWarnings
+
+MOCK_LANDO_API_URL = "http://api.lando.test"
+MOCK_LANDO_TOKEN = "Some Test Token"
+
+MOCK_DIFF_ID = 0
+MOCK_REV_ID = 0
+MOCK_GROUP = "LINT"
+
+MOCK_WARNINGS_ID = 100
+
+MOCK_WARNING_MESSAGE = "There are still warnings"
+
+MOCK_WARNINGS_DATA = [
+    {
+        "data": MOCK_WARNING_MESSAGE,
+        "diff_id": MOCK_DIFF_ID,
+        "revision_id": MOCK_REV_ID,
+        "group": MOCK_GROUP,
+        "id": MOCK_WARNINGS_ID,
+    }
+]
+
+MOCK_WARNINGS_DATA_PUT = {
+    "revision_id": MOCK_REV_ID,
+    "diff_id": MOCK_DIFF_ID,
+    "group": MOCK_GROUP,
+    "data": {"message": MOCK_WARNING_MESSAGE},
+}
+
+
+class Test_LandoWarnings(unittest.TestCase):
+    @responses.activate
+    def test_get_warnings(self):
+        responses.add(
+            responses.GET,
+            f"{MOCK_LANDO_API_URL}/diff_warnings?revision_id={MOCK_REV_ID}&diff_id={MOCK_DIFF_ID}&group={MOCK_GROUP}",
+            json=MOCK_WARNINGS_DATA,
+            headers={"X-Phabricator-API-Key": MOCK_LANDO_TOKEN},
+            status=200,
+        )
+
+        mock_lando = LandoWarnings(MOCK_LANDO_API_URL, MOCK_LANDO_TOKEN)
+
+        self.assertEqual(
+            mock_lando.get_warnings(MOCK_REV_ID, MOCK_DIFF_ID), MOCK_WARNINGS_DATA
+        )
+        self.assertEqual(
+            responses.calls[0].request.headers["X-Phabricator-API-Key"],
+            MOCK_LANDO_TOKEN,
+        )
+
+    @responses.activate
+    def test_get_warnings_fail(self):
+        # Error code with 404
+        responses.add(
+            responses.GET,
+            f"{MOCK_LANDO_API_URL}/diff_warnings?revision_id={MOCK_REV_ID}&diff_id={MOCK_DIFF_ID}&group={MOCK_GROUP}",
+            json=MOCK_WARNINGS_DATA,
+            headers={"X-Phabricator-API-Key": MOCK_LANDO_TOKEN},
+            status=400,
+        )
+        mock_lando = LandoWarnings(MOCK_LANDO_API_URL, MOCK_LANDO_TOKEN)
+
+        try:
+            mock_lando.get_warnings(MOCK_REV_ID, MOCK_DIFF_ID)
+        except Exception as ex:
+            self.assertEqual(
+                str(ex), "Failed to get warnings for revision_id 0 and diff_id 0!"
+            )
+
+    @responses.activate
+    def test_add_warnings(self):
+        responses.add(
+            responses.POST,
+            f"{MOCK_LANDO_API_URL}/diff_warnings",
+            match=[responses.json_params_matcher(MOCK_WARNINGS_DATA_PUT)],
+            headers={"X-Phabricator-API-Key": MOCK_LANDO_TOKEN},
+            status=201,
+        )
+
+        mock_lando = LandoWarnings(MOCK_LANDO_API_URL, MOCK_LANDO_TOKEN)
+
+        self.assertEqual(
+            mock_lando.add_warning(MOCK_WARNING_MESSAGE, MOCK_REV_ID, MOCK_DIFF_ID),
+            None,
+        )
+
+        self.assertEqual(
+            responses.calls[0].request.headers["X-Phabricator-API-Key"],
+            MOCK_LANDO_TOKEN,
+        )
+
+    @responses.activate
+    def test_del_all_warnings(self):
+        responses.add(
+            responses.GET,
+            f"{MOCK_LANDO_API_URL}/diff_warnings?revision_id={MOCK_REV_ID}&diff_id={MOCK_DIFF_ID}&group={MOCK_GROUP}",
+            json=MOCK_WARNINGS_DATA,
+            headers={"X-Phabricator-API-Key": MOCK_LANDO_TOKEN},
+            status=200,
+        )
+        responses.add(
+            responses.DELETE,
+            f"{MOCK_LANDO_API_URL}/diff_warnings/{MOCK_WARNINGS_ID}",
+            headers={"X-Phabricator-API-Key": MOCK_LANDO_TOKEN},
+            status=200,
+        )
+        mock_lando = LandoWarnings(MOCK_LANDO_API_URL, MOCK_LANDO_TOKEN)
+
+        self.assertEqual(mock_lando.del_all_warnings(MOCK_REV_ID, MOCK_DIFF_ID), None)
+        self.assertEqual(
+            responses.calls[0].request.headers["X-Phabricator-API-Key"],
+            MOCK_LANDO_TOKEN,
+        )
+
+
+if __name__ == "__main__":
+    unittest.main()