diff --git a/webservice/__manifest__.py b/webservice/__manifest__.py index 9818e558..ddb65a79 100644 --- a/webservice/__manifest__.py +++ b/webservice/__manifest__.py @@ -6,7 +6,7 @@ { "name": "WebService", "summary": """Defines webservice abstract definition to be used generally""", - "version": "19.0.1.1.2", + "version": "19.0.1.1.3", "license": "AGPL-3", "development_status": "Production/Stable", "maintainers": ["etobella"], diff --git a/webservice/tests/test_oauth2.py b/webservice/tests/test_oauth2.py index 49be4f1c..1d172cd9 100644 --- a/webservice/tests/test_oauth2.py +++ b/webservice/tests/test_oauth2.py @@ -8,6 +8,8 @@ import responses from oauthlib.oauth2.rfc6749.errors import InvalidGrantError +from odoo.tests import Form + from .common import CommonWebService, mock_cursor @@ -242,3 +244,57 @@ def test_fetch_token_from_auth(self): json.loads(responses.calls[0].response.content.decode())["access_token"], ) self.assertEqual("cool_token", token["access_token"]) + + def test_oauth2_flow_compute_with_ui(self): + """Check the ``compute`` method when updating WS from UI""" + ws = self.webservice + url = self.url + form_xmlid = "webservice.webservice_backend_form_view" + for auth_type, oauth2_flow in [ + (tp, fl) + for tp in ws._fields["auth_type"].get_values(ws.env) + for fl in ws._fields["oauth2_flow"].get_values(ws.env) + ]: + next_ws_id = ws.sudo().search([], order="id desc", limit=1).id + 1 + # Create a new WS with each ``auth_type/oauth2_flow`` couple through UI + with Form(ws.browse(), form_xmlid) as ws_form: + # Common fields + ws_form.name = "WebService Test UI" + ws_form.tech_name = f"webservice_test_ui_{next_ws_id}" + ws_form.protocol = "http" + ws_form.url = url + ws_form.content_type = "application/xml" + ws_form.auth_type = auth_type + # Auth type specific fields + if auth_type == "api_key": + ws_form.api_key = "Test Api Key" + ws_form.api_key_header = "Test Api Key Header" + if auth_type == "oauth2": + ws_form.oauth2_flow = oauth2_flow + ws_form.oauth2_clientid = "Test Client ID" + ws_form.oauth2_client_secret = "Test Client Secret" + ws_form.oauth2_token_url = f"{url}oauth2/token" + if auth_type == "user_pwd": + ws_form.username = "Test Username" + ws_form.password = "Test Password" + ws = ws_form.save() + # Check that ``oauth2_flow`` is the expected one after creation only if the + # ``auth_type`` is "oauth2", else it should be False + self.assertEqual( + ws.oauth2_flow, oauth2_flow if ws.auth_type == "oauth2" else False + ) + # Change WS's ``auth_type`` through UI + with Form(ws, form_xmlid) as ws_form: + new_auth_type = "none" if ws.auth_type == "oauth2" else "oauth2" + ws_form.auth_type = new_auth_type + if new_auth_type == "oauth2": + ws_form.oauth2_flow = oauth2_flow + ws_form.oauth2_clientid = "Test Client ID" + ws_form.oauth2_client_secret = "Test Client Secret" + ws_form.oauth2_token_url = f"{url}oauth2/token" + ws = ws_form.save() + # Check that ``oauth2_flow`` is the expected one after update only if the + # ``auth_type`` is "oauth2", else it should be False + self.assertEqual( + ws.oauth2_flow, oauth2_flow if ws.auth_type == "oauth2" else False + ) diff --git a/webservice/upgrades/19.0.1.1.3/post-update.py b/webservice/upgrades/19.0.1.1.3/post-update.py new file mode 100644 index 00000000..93d00f51 --- /dev/null +++ b/webservice/upgrades/19.0.1.1.3/post-update.py @@ -0,0 +1,13 @@ +# Copyright 2026 Camptocamp SA +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from openupgradelib import openupgrade + + +@openupgrade.migrate() +def migrate(env, version): + module = env["ir.module.module"].search( + [("name", "=", "webservice_environment"), ("state", "=", "uninstalled")] + ) + if module: + module.button_install() diff --git a/webservice_environment/README.rst b/webservice_environment/README.rst new file mode 100644 index 00000000..5174fce4 --- /dev/null +++ b/webservice_environment/README.rst @@ -0,0 +1,87 @@ +============================= +WebService Server Environment +============================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:3259abecb5f2052be5402be6eaa2e4a70ee6d401a3b9e1d6fd58499b13c36099 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png + :target: https://odoo-community.org/page/development-status + :alt: Production/Stable +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb--api-lightgray.png?logo=github + :target: https://github.com/OCA/web-api/tree/18.0/webservice_environment + :alt: OCA/web-api +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-api-18-0/web-api-18-0-webservice_environment + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/web-api&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Glue module to make Server Environment features available for the +Webservice addon. + +**Table of contents** + +.. contents:: + :local: + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Creu Blanca +* Camptocamp + +Contributors +------------ + +- Enric Tobella +- Daniel Reis + +Maintainers +----------- + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px + :target: https://github.com/etobella + :alt: etobella + +Current `maintainer `__: + +|maintainer-etobella| + +This module is part of the `OCA/web-api `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/webservice_environment/__init__.py b/webservice_environment/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/webservice_environment/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/webservice_environment/__manifest__.py b/webservice_environment/__manifest__.py new file mode 100644 index 00000000..758e342a --- /dev/null +++ b/webservice_environment/__manifest__.py @@ -0,0 +1,18 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +{ + "name": "WebService Server Environment", + "summary": "Use Server Environment feature to manage Webservice configs", + "version": "19.0.1.0.0", + "license": "AGPL-3", + "development_status": "Production/Stable", + "maintainers": ["etobella"], + "author": "Creu Blanca, Camptocamp, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/web-api", + "depends": ["webservice", "server_environment"], + "auto_install": True, +} diff --git a/webservice_environment/models/__init__.py b/webservice_environment/models/__init__.py new file mode 100644 index 00000000..c08fb9a9 --- /dev/null +++ b/webservice_environment/models/__init__.py @@ -0,0 +1 @@ +from . import webservice_backend diff --git a/webservice_environment/models/webservice_backend.py b/webservice_environment/models/webservice_backend.py new file mode 100644 index 00000000..a4b364fb --- /dev/null +++ b/webservice_environment/models/webservice_backend.py @@ -0,0 +1,41 @@ +# Copyright 2020 Creu Blanca +# Copyright 2022 Camptocamp SA +# @author Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + + +class WebserviceBackend(models.Model): + _name = "webservice.backend" + _inherit = ["webservice.backend", "server.env.techname.mixin", "server.env.mixin"] + + @property + def _server_env_fields(self): + base_fields = super()._server_env_fields + webservice_fields = { + "protocol": {}, + "url": {}, + "auth_type": {}, + "username": {}, + "password": {}, + "api_key": {}, + "api_key_header": {}, + "content_type": {}, + "oauth2_flow": {}, + "oauth2_scope": {}, + "oauth2_clientid": {}, + "oauth2_client_secret": {}, + "oauth2_authorization_url": {}, + "oauth2_token_url": {}, + "oauth2_audience": {}, + } + webservice_fields.update(base_fields) + return webservice_fields + + def _compute_server_env(self): + # OVERRIDE: reset ``oauth2_flow`` when ``auth_type`` is not "oauth2", even if + # defined otherwise in server env vars + res = super()._compute_server_env() + self.filtered(lambda r: r.auth_type != "oauth2").oauth2_flow = None + return res diff --git a/webservice_environment/pyproject.toml b/webservice_environment/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/webservice_environment/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/webservice_environment/readme/CONTRIBUTORS.md b/webservice_environment/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..8fb74687 --- /dev/null +++ b/webservice_environment/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- Enric Tobella \<\> +- Daniel Reis \<\> diff --git a/webservice_environment/readme/DESCRIPTION.md b/webservice_environment/readme/DESCRIPTION.md new file mode 100644 index 00000000..1c6edaa6 --- /dev/null +++ b/webservice_environment/readme/DESCRIPTION.md @@ -0,0 +1,2 @@ +Glue module to make Server Environment features available for the +Webservice addon. diff --git a/webservice_environment/static/description/icon.png b/webservice_environment/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/webservice_environment/static/description/icon.png differ diff --git a/webservice_environment/static/description/index.html b/webservice_environment/static/description/index.html new file mode 100644 index 00000000..c4209a2e --- /dev/null +++ b/webservice_environment/static/description/index.html @@ -0,0 +1,428 @@ + + + + + +WebService Server Environment + + + +
+

WebService Server Environment

+ + +

Production/Stable License: AGPL-3 OCA/web-api Translate me on Weblate Try me on Runboat

+

Glue module to make Server Environment features available for the +Webservice addon.

+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Creu Blanca
    • +
  • Camptocamp
    • +
+
+ +
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

etobella

+

This module is part of the OCA/web-api project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/webservice_environment/tests/__init__.py b/webservice_environment/tests/__init__.py new file mode 100644 index 00000000..38fb5cf0 --- /dev/null +++ b/webservice_environment/tests/__init__.py @@ -0,0 +1 @@ +from . import test_oauth2 diff --git a/webservice_environment/tests/test_oauth2.py b/webservice_environment/tests/test_oauth2.py new file mode 100644 index 00000000..b22e945a --- /dev/null +++ b/webservice_environment/tests/test_oauth2.py @@ -0,0 +1,77 @@ +# Copyright 2023 Camptocamp SA +# @author Alexandre Fayolle +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +import os +from unittest import mock + +from odoo.addons.server_environment import server_env +from odoo.addons.server_environment.models import server_env_mixin +from odoo.addons.webservice.tests.common import CommonWebService + + +class TestWebServiceOauth2WebApplication(CommonWebService): + @classmethod + def _setup_records(cls): + res = super()._setup_records() + cls.url = "https://localhost.demo.odoo/" + os.environ["SERVER_ENV_CONFIG"] = "\n".join( + [ + "[webservice_backend.test_oauth2_web]", + "auth_type = oauth2", + "oauth2_flow = web_application", + "oauth2_clientid = some_client_id", + "oauth2_client_secret = shh_secret", + f"oauth2_token_url = {cls.url}oauth2/token", + f"oauth2_audience = {cls.url}", + f"oauth2_authorization_url = {cls.url}/authorize", + ] + ) + cls.webservice = cls.env["webservice.backend"].create( + { + "name": "WebService OAuth2", + "tech_name": "test_oauth2_web", + "auth_type": "oauth2", + "protocol": "http", + "url": cls.url, + "oauth2_flow": "web_application", + "content_type": "application/xml", + "oauth2_clientid": "some_client_id", + "oauth2_client_secret": "shh_secret", + "oauth2_token_url": f"{cls.url}oauth2/token", + "oauth2_audience": cls.url, + "oauth2_authorization_url": f"{cls.url}/authorize", + } + ) + return res + + def test_oauth2_flow_compute_with_server_env(self): + """Check the ``compute`` method when updating server envs""" + ws = self.webservice + url = self.url + for auth_type, oauth2_flow in [ + (tp, fl) + for tp in ws._fields["auth_type"].get_values(ws.env) + for fl in ws._fields["oauth2_flow"].get_values(ws.env) + ]: + # Update env with current ``auth_type`` and ``oauth2_flow`` + with mock.patch.dict( + os.environ, + { + "SERVER_ENV_CONFIG": f""" +[webservice_backend.test_oauth2_web] +auth_type = {auth_type} +oauth2_flow = {oauth2_flow} +oauth2_clientid = some_client_id +oauth2_client_secret = shh_secret +oauth2_token_url = {url}oauth2/token +oauth2_audience = {url} +oauth2_authorization_url = {url}/authorize +""", + }, + ): + server_env_mixin.serv_config = server_env._load_config() # Reload vars + ws.invalidate_recordset() # Avoid reading from cache + if auth_type == "oauth2": + self.assertEqual(ws.oauth2_flow, oauth2_flow) + else: + self.assertFalse(ws.oauth2_flow)