diff --git a/base_technical_user/README.rst b/base_technical_user/README.rst index 2b67e7605..64b058799 100644 --- a/base_technical_user/README.rst +++ b/base_technical_user/README.rst @@ -14,13 +14,13 @@ Base Technical User :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html :alt: License: AGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github - :target: https://github.com/OCA/server-tools/tree/12.0/base_technical_user + :target: https://github.com/OCA/server-tools/tree/13.0/base_technical_user :alt: OCA/server-tools .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-tools-12-0/server-tools-12-0-base_technical_user + :target: https://translation.odoo-community.org/projects/server-tools-13-0/server-tools-13-0-base_technical_user :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png - :target: https://runbot.odoo-community.org/runbot/149/12.0 + :target: https://runbot.odoo-community.org/runbot/149/13.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -44,13 +44,28 @@ Usage If you install the module, you will find a tab on the company form allowing to define the technical user. +In your code you can use the following helper that will return you + +- a self with the user tech if configured +- or a self with sudo user + +.. code-block:: python + + self_tech = self.sudo_tech() + +If you want to raise an error if the tech user in not configured just call it with + +.. code-block:: python + + self_tech = self.sudo_tech(raise_if_missing) + Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. +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 smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -80,6 +95,6 @@ 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. -This module is part of the `OCA/server-tools `_ project on GitHub. +This module is part of the `OCA/server-tools `_ project on GitHub. -You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. +You are welcome to contribute. diff --git a/base_technical_user/models/__init__.py b/base_technical_user/models/__init__.py index aff44f335..fe04d2730 100644 --- a/base_technical_user/models/__init__.py +++ b/base_technical_user/models/__init__.py @@ -1 +1,2 @@ from . import res_company +from . import models diff --git a/base_technical_user/models/models.py b/base_technical_user/models/models.py new file mode 100644 index 000000000..d55363d0e --- /dev/null +++ b/base_technical_user/models/models.py @@ -0,0 +1,24 @@ +# Copyright 2020 Akretion (http://www.akretion.com). +# @author Sébastien BEAU +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +from odoo import _, models +from odoo.exceptions import UserError + + +class Base(models.AbstractModel): + _inherit = "base" + + def sudo_tech(self, raise_if_missing=False): + self_sudoer = self + tech_user = self.env.user.company_id.user_tech_id + if tech_user: + self_sudoer = self.with_user(tech_user.id) + elif raise_if_missing: + raise UserError( + _("The technical user is missing in the company {}").format( + self.env.user.company_id.name + ) + ) + return self_sudoer diff --git a/base_technical_user/readme/USAGE.rst b/base_technical_user/readme/USAGE.rst index 2ed2ad738..9441e914b 100644 --- a/base_technical_user/readme/USAGE.rst +++ b/base_technical_user/readme/USAGE.rst @@ -1,2 +1,17 @@ If you install the module, you will find a tab on the company form allowing to define the technical user. + +In your code you can use the following helper that will return you + +- a self with the user tech if configured +- or a self with sudo user + +.. code-block:: python + + self_tech = self.sudo_tech() + +If you want to raise an error if the tech user in not configured just call it with + +.. code-block:: python + + self_tech = self.sudo_tech(raise_if_missing) diff --git a/base_technical_user/static/description/index.html b/base_technical_user/static/description/index.html index 07cf484f3..2fd453881 100644 --- a/base_technical_user/static/description/index.html +++ b/base_technical_user/static/description/index.html @@ -367,7 +367,7 @@ ul.auto-toc { !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

+

Beta License: AGPL-3 OCA/server-tools Translate me on Weblate Try me on Runbot

This module extends the functionality of company management. It allows you to bind a technical user on the company in order to use it in batch processes.

@@ -391,13 +391,25 @@ batch processes.

Usage

If you install the module, you will find a tab on the company form allowing to define the technical user.

+

In your code you can use the following helper that will return you

+
    +
  • a self with the user tech if configured
    • +
  • or a self with sudo user
    • +
+
+self_tech = self.sudo_tech()
+
+

If you want to raise an error if the tech user in not configured just call it with

+
+self_tech = self.sudo_tech(raise_if_missing)
+

Bug Tracker

-

Bugs are tracked on GitHub Issues. +

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 smashing it by providing a detailed and welcomed -feedback.

+feedback.

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

@@ -421,7 +433,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

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.

-

This module is part of the OCA/server-tools project on GitHub.

+

This module is part of the OCA/server-tools project on GitHub.

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

diff --git a/base_technical_user/tests/__init__.py b/base_technical_user/tests/__init__.py new file mode 100644 index 000000000..2775d6506 --- /dev/null +++ b/base_technical_user/tests/__init__.py @@ -0,0 +1 @@ +from . import test_sudo_tech diff --git a/base_technical_user/tests/test_sudo_tech.py b/base_technical_user/tests/test_sudo_tech.py new file mode 100644 index 000000000..316762fc4 --- /dev/null +++ b/base_technical_user/tests/test_sudo_tech.py @@ -0,0 +1,34 @@ +# Copyright 2020 Akretion (http://www.akretion.com). +# @author Sébastien BEAU +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + + +from odoo import SUPERUSER_ID +from odoo.exceptions import UserError +from odoo.tests import SavepointCase + + +class SudoTechCase(SavepointCase): + @classmethod + def setUpClass(cls): + super(SudoTechCase, cls).setUpClass() + cls.user_tech = ( + cls.env["res.users"] + .with_context(tracking_disable=True, no_reset_password=True) + .create({"login": "tech", "name": "tech"}) + ) + cls.company = cls.env.ref("base.main_company") + cls.env(user=cls.env.ref("base.user_demo").id) + + def test_sudo_tech(self): + self.company.user_tech_id = self.user_tech + self_tech = self.env["res.partner"].sudo_tech() + self.assertEqual(self_tech._uid, self.user_tech.id) + + def test_sudo_tech_missing_return_sudo(self): + self_tech = self.env["res.partner"].sudo_tech() + self.assertEqual(self_tech._uid, SUPERUSER_ID) + + def test_sudo_tech_missing_raise(self): + with self.assertRaises(UserError): + self.env["res.partner"].sudo_tech(raise_if_missing=True)