[MIG] base_rest: Migration to 19.0

Author: NachoAlesLopez

base_rest/__manifest__.py

@@ -12,16 +12,17 @@
     "author": "ACSONE SA/NV, Odoo Community Association (OCA)",
     "maintainers": [],
     "website": "https://github.com/OCA/rest-framework",
-    "depends": ["component", "web"],
+    "depends": ["bus", "component", "web", "web_tour"],
     "data": [
         "views/openapi_template.xml",
         "views/base_rest_view.xml",
     ],
     "assets": {
         "web.assets_frontend": [
             "base_rest/static/src/scss/base_rest.scss",
-            "base_rest/static/src/js/swagger_ui.js",
-            "base_rest/static/src/js/swagger.js",
+        ],
+        "web.assets_tests": [
+            "base_rest/static/tests/tours/**/*.js",
         ],
     },
     "external_dependencies": {
@@ -33,5 +34,4 @@
             "apispec",
         ]
     },
-    "installable": True,
 }

base_rest/controllers/api_docs.py

@@ -30,7 +30,7 @@ def index(self, **params):
         self._get_api_urls()
         primary_name = params.get("urls.primaryName")
         swagger_settings = {
-            "urls": self._get_api_urls(),
+            "urls": self._get_api_urls() or None,
             "urls.primaryName": primary_name,
         }
         values = {"swagger_settings": swagger_settings}

base_rest/http.py

@@ -29,8 +29,8 @@
     ValidationError,
 )
 from odoo.http import (
-    CSRF_FREE_METHODS,
     MISSING_CSRF_WARNING,
+    SAFE_HTTP_METHODS,
     Dispatcher,
     SessionExpiredException,
     request,
@@ -162,7 +162,7 @@ def dispatch(self, endpoint, args):
 
         # Check for CSRF token for relevant requests
         if (
-            self.request.httprequest.method not in CSRF_FREE_METHODS
+            self.request.httprequest.method not in SAFE_HTTP_METHODS
             and endpoint.routing.get("csrf", True)
         ):
             token = params.pop("csrf_token", None)

base_rest/models/rest_service_registration.py

@@ -189,8 +189,8 @@ def build_registry(self, services_registry, states=None, exclude_addons=None):
         # dependencies to ensure that controllers defined in a more
         # specialized addon and overriding more generic one takes precedences
         # on the generic one into the registry
-        graph = odoo.modules.graph.Graph()
-        graph.add_module(self.env.cr, "base")
+        graph = odoo.modules.module_graph.ModuleGraph(self.env.cr)
+        graph.extend(["base"])
 
         query = "SELECT name FROM ir_module_module WHERE state IN %s "
         params = [tuple(states)]
@@ -200,7 +200,7 @@ def build_registry(self, services_registry, states=None, exclude_addons=None):
         self.env.cr.execute(query, params)
 
         module_list = [name for (name,) in self.env.cr.fetchall() if name not in graph]
-        graph.add_modules(self.env.cr, module_list)
+        graph.extend(module_list)
 
         for module in graph:
             self.load_services(module.name, services_registry)

base_rest/static/tests/tours/tours_base_rest.esm.js

@@ -0,0 +1,35 @@
+import {registry} from "@web/core/registry";
+
+registry
+    .category("web_tour.tours")
+    .add("base_rest.tour_api_docs_no_content_validation", {
+        steps: () => [
+            {
+                trigger: "h4:contains('No API definition provided.')",
+            },
+        ],
+    });
+
+registry.category("web_tour.tours").add("base_rest.tour_api_docs_simple_api_endpoint", {
+    steps: () => [
+        {
+            trigger: "span:contains('pod_bay_doors')",
+        },
+        {
+            trigger:
+                "span.opblock-summary-path[data-path='/control-panel/pod_bay_doors/open']",
+            run: "click",
+        },
+        {
+            trigger: "button.try-out__btn",
+            run: "click",
+        },
+        {
+            trigger: "button.execute",
+            run: "click",
+        },
+        {
+            trigger: "pre.microlight:contains('I'm sorry, Dave.')",
+        },
+    ],
+});

base_rest/tests/__init__.py

@@ -1,4 +1,5 @@
 from . import common
+from . import test_api_docs
 from . import test_cerberus_list_validator
 from . import test_cerberus_validator
 from . import test_controller_builder

base_rest/tests/common.py

@@ -95,6 +95,7 @@ def _setup_registry(class_or_instance):
             )
 
         # register our components
+        class_or_instance.comp_registry.load_components("component")
         class_or_instance.comp_registry.load_components("base_rest")
 
         # Define a base test controller here to avoid to have this controller
@@ -239,15 +240,15 @@ def setUpClass(cls):
 
 
 class BaseRestCase(TransactionComponentCase, RegistryMixin):
-    @classmethod
-    def setUpClass(cls):
-        super().setUpClass()
-        cls.setUpRegistry()
-        cls.base_url = cls.env["ir.config_parameter"].get_param("web.base.url")
-        cls.registry.enter_test_mode(cls.env.cr)
+    # pylint: disable=W8106
+    def setUp(self):
+        super().setUp()
+        self.setUpRegistry()
+        self.base_url = self.env["ir.config_parameter"].get_param("web.base.url")
+        self.registry_enter_test_mode(register_cleanup=False)
 
     # pylint: disable=W8110
     @classmethod
     def tearDownClass(cls):
-        cls.registry.leave_test_mode()
+        cls.registry_leave_test_mode()
         super().tearDownClass()

base_rest/tests/test_api_docs.py

@@ -0,0 +1,79 @@
+from odoo.tests import HttpCase, tagged
+
+from odoo.addons.component.core import Component
+
+from .. import restapi
+from .common import TransactionRestServiceRegistryCase
+
+
+@tagged("post_install", "-at_install")
+class TestAPIDocs(TransactionRestServiceRegistryCase, HttpCase):
+    @classmethod
+    def setUpClass(cls):
+        """
+        Avoids shadowing of "base_url" from RegistyCase class.
+        """
+        super().setUpClass()
+        cls.base_url = lambda _self: cls.env["ir.config_parameter"].get_param(
+            "web.base.url"
+        )
+
+    def setUp(self):
+        super().setUp()
+
+        self._setup_registry(self)
+
+    def tearDown(self):
+        self._teardown_registry(self)
+
+        super().tearDown()
+
+    def test_00_api_docs_no_data(self):
+        """
+        Makes sure the API Swagger page doesn't crash when we have no active endpoints.
+        """
+        self.authenticate("admin", "admin")
+        response = self.url_open("/api-docs")
+
+        self.assertEqual(response.status_code, 200)
+
+        # Verify the content through a tour.
+        self.start_tour(
+            "/api-docs",
+            "base_rest.tour_api_docs_no_content_validation",
+            login="admin",
+        )
+
+    def test_01_api_docs_simple_request(self):
+        """
+        Adding a few controllers to the API, the Swagger interface should be fully
+         functional. We won't test it itself, only that Odoo is sending the
+         correct information.
+        """
+
+        class SimpleAPIEndpoint(Component):
+            _inherit = "base.rest.service"
+            _name = "simple.api.endpoint"
+            _usage = "api"
+            _collection = self._collection_name
+            _description = "Simple API Endpoint"
+
+            @restapi.method(
+                [("/control-panel/pod_bay_doors/open", "POST")],
+                auth="public",
+                output_param=restapi.CerberusValidator(
+                    {"result": {"type": "string", "required": True}}
+                ),
+            )
+            def open_pod_bay_doors(self):
+                return {"result": "I'm sorry, Dave. I'm afraid I can't do that."}
+
+        self._build_services(self, SimpleAPIEndpoint)
+
+        self.authenticate("admin", "admin")
+
+        self.start_tour(
+            "/api-docs",
+            "base_rest.tour_api_docs_simple_api_endpoint",
+            login="admin",
+        )

base_rest/tests/test_openapi_generator.py

@@ -2,7 +2,7 @@
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 
 from odoo.addons.component.core import Component
-from odoo.addons.website.tools import MockRequest
+from odoo.addons.http_routing.tests.common import MockRequest
 
 from .. import restapi
 from .common import TransactionRestServiceRegistryCase

base_rest/tests/test_service_context_provider.py

@@ -1,7 +1,7 @@
 # Copyright 2021 ACSONE SA/NV
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 from odoo.addons.component.core import Component
-from odoo.addons.website.tools import MockRequest
+from odoo.addons.http_routing.tests.common import MockRequest
 
 from .. import restapi
 from .common import BaseRestCase, TransactionRestServiceRegistryCase
@@ -79,25 +79,37 @@ class TestServiceNewApi(Component):
             _collection = self._collection_name
             _description = "test"
 
+            def _get_partner_schema(self):
+                return {"name": {"type": "string", "required": True}}
+
             @restapi.method(
                 [(["/<int:id>/get", "/<int:id>"], "GET")],
                 output_param=restapi.CerberusValidator("_get_partner_schema"),
                 auth="public",
             )
             def get(self, _id):
-                return {"name": self.env["res.partner"].browse(_id).name}
+                return {"name": self.env["res.partner"].browse(_id).exists().name}
 
         self._build_components(TestComponentContextprovider)
         self._build_services(self, TestServiceNewApi)
         controller = self._get_controller_for(TestServiceNewApi)
-        service_component = controller().service_component
+        controller_instance = controller()
+        service_component = controller_instance.service_component
         with (
-            MockRequest(self.env),
+            self.with_user("admin"),
+            MockRequest(self.env) as request,
             service_component(service_name="partner") as service,
         ):
+            # Required for logging REST methods.
+            request.httprequest.headers = {}
             self.assertEqual(
                 service.work.authenticated_partner_id, self.env.user.partner_id.id
             )
+            # Actually testing if the rules are computed correctly by calling
+            #  the controller method itself.
+            controller_instance._process_method(
+                "partner", "get", self.env.user.company_id.partner_id.id
+            )
 
     def test_03(self):
         """Test authenticated_partner_id
@@ -147,4 +159,4 @@ def get(self, _id):
 class CommonCase(BaseRestCase):
     # dummy test method to pass codecov
     def test_04(self):
-        self.assertEqual(self.registry.test_cr, self.cr)
+        self.assertEqual(self.registry.db_name, self.cr.dbname)