feat: Add endpoint for remodel allowlist (#5576)

Author: steverydz

requirements.txt

@@ -6,7 +6,7 @@ canonicalwebteam.discourse==7.0.0
 canonicalwebteam.blog==6.6.0
 canonicalwebteam.search==2.1.2
 canonicalwebteam.image-template==1.9.0
-canonicalwebteam.store-api==7.3.8
+canonicalwebteam.store-api==7.3.10
 canonicalwebteam.launchpad==0.9.0
 django-openid-auth==0.17
 Flask-OpenID==1.3.0

tests/endpoints/tests_models.py

@@ -162,3 +162,103 @@ def test_model_not_found(self, mock_update_store_model):
         self.assertEqual(response.status_code, 500)
         self.assertFalse(data["success"])
         self.assertEqual(data["message"], "Model not found")
+
+
+class TestGetRemodelAllowlist(TestModelServiceEndpoints):
+    @patch(
+        "canonicalwebteam.store_api.publishergw.PublisherGW"
+        + ".get_remodel_allowlist"
+    )
+    def test_get_remodel_allowlist_success(self, mock_get_remodel_allowlist):
+        mock_allowlist = {
+            "allowlist": [
+                {
+                    "created-at": "2026-02-03T11:31:06Z",
+                    "created-by": "test-user-id",
+                    "description": "Test description",
+                    "from-model": "test-from-model",
+                    "from-serial": "test-from-serial",
+                    "modified-at": None,
+                    "modified-by": None,
+                    "to-model": "test-to-model",
+                }
+            ]
+        }
+        mock_get_remodel_allowlist.return_value = mock_allowlist
+
+        response = self.client.get("/api/store/1/models/remodel-allowlist")
+        data = response.json
+
+        self.assertEqual(response.status_code, 200)
+        self.assertTrue(data["success"])
+        self.assertEqual(data["data"], mock_allowlist)
+
+    @patch(
+        "canonicalwebteam.store_api.publishergw.PublisherGW"
+        + ".get_remodel_allowlist"
+    )
+    def test_get_remodel_allowlist_empty(self, mock_get_remodel_allowlist):
+        mock_get_remodel_allowlist.return_value = {"allowlist": []}
+
+        response = self.client.get("/api/store/1/models/remodel-allowlist")
+        data = response.json
+
+        self.assertEqual(response.status_code, 200)
+        self.assertTrue(data["success"])
+        self.assertEqual(data["data"]["allowlist"], [])
+
+    @patch(
+        "canonicalwebteam.store_api.publishergw.PublisherGW"
+        + ".get_remodel_allowlist"
+    )
+    def test_get_remodel_allowlist_unauthorized(
+        self, mock_get_remodel_allowlist
+    ):
+        mock_get_remodel_allowlist.side_effect = StoreApiResponseErrorList(
+            "unauthorized", 401, [{"message": "unauthorized"}]
+        )
+
+        response = self.client.get("/api/store/1/models/remodel-allowlist")
+        data = response.json
+
+        self.assertEqual(response.status_code, 500)
+        self.assertFalse(data["success"])
+        self.assertEqual(data["message"], "Store not found")
+
+    @patch(
+        "canonicalwebteam.store_api.publishergw.PublisherGW"
+        + ".get_remodel_allowlist"
+    )
+    def test_get_remodel_allowlist_store_not_found(
+        self, mock_get_remodel_allowlist
+    ):
+        mock_get_remodel_allowlist.side_effect = StoreApiResponseErrorList(
+            "Store not found", 404, [{"message": "Store not found"}]
+        )
+
+        response = self.client.get("/api/store/999/models/remodel-allowlist")
+        data = response.json
+
+        self.assertEqual(response.status_code, 500)
+        self.assertFalse(data["success"])
+        self.assertEqual(data["message"], "Store not found")
+
+    @patch(
+        "canonicalwebteam.store_api.publishergw.PublisherGW"
+        + ".get_remodel_allowlist"
+    )
+    def test_get_remodel_allowlist_general_error(
+        self, mock_get_remodel_allowlist
+    ):
+        mock_get_remodel_allowlist.side_effect = StoreApiResponseErrorList(
+            "Internal server error",
+            500,
+            [{"message": "Internal server error"}],
+        )
+
+        response = self.client.get("/api/store/1/models/remodel-allowlist")
+        data = response.json
+
+        self.assertEqual(response.status_code, 500)
+        self.assertFalse(data["success"])
+        self.assertEqual(data["message"], "Internal server error")

webapp/endpoints/models.py

@@ -262,3 +262,42 @@ def update_model(store_id: str, model_name: str):
     if res["success"]:
         return make_response(res, 200)
     return make_response(res, 500)
+
+
+@models.route("/api/store/<store_id>/models/remodel-allowlist")
+@login_required
+@exchange_required
+def get_remodel_allowlist(store_id: str):
+    """
+    Retrieves remodels associated with a given store ID.
+
+    Args:
+        store_id (int): The ID of the store for which to retrieve remodels.
+
+    Returns:
+        dict: A dictionary containing the response message, success status,
+        and data.
+    """
+
+    res = {}
+    try:
+        allowlist = publisher_gateway.get_remodel_allowlist(
+            flask.session, store_id
+        )
+        res["success"] = True
+        res["data"] = allowlist
+        response = make_response(res, 200)
+        response.cache_control.max_age = "3600"
+    except StoreApiResponseErrorList as error_list:
+        error_messages = [
+            f"{error.get('message', 'An error occurred')}"
+            for error in error_list.errors
+        ]
+        if "unauthorized" in error_messages:
+            res["message"] = "Store not found"
+        else:
+            res["message"] = " ".join(error_messages)
+        res["success"] = False
+        response = make_response(res, 500)
+
+    return response