[16.0][ADD] hr_timesheet_sheet_warning: fixed problems and improved testing

LauraCForgeFlow · LauraCForgeFlow · commit ecd744344339 · 2024-02-29T09:59:35.000+01:00
diff --git a/hr_timesheet_sheet_warning/README.rst b/hr_timesheet_sheet_warning/README.rst
@@ -7,7 +7,7 @@ HR Timesheet Sheet Warning
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:43890a1c4867dee1335ee92a4afeb0de109e14ee98a3d4b2b822ce1d4daca1e3
+   !! source digest: sha256:5f86aee8d8ec3d3e4e473059d8e8094b0df0fd98ceda8ab78209c24ba5b92192
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -28,10 +28,12 @@ HR Timesheet Sheet Warning
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows the creation warning definitions, to be able to check
-certain aspects related to Timesheet Sheets.
-Once the warnings are defined, it can check their criteria against the
-actual Timesheet Sheets and raise individual warnings for each one if necessary.
+This module provides functionality for defining custom warning criteria related to
+Timesheet Sheets using Python expressions. Users can establish specific conditions
+for evaluating certain aspects of the Sheets.
+Once the warnings are defined, the module facilitates a systematic evaluation of
+Timesheet Sheets against these conditions. It generates individual warnings for each
+Sheet, if the warnings criteria are met.
 
 **Table of contents**
 
diff --git a/hr_timesheet_sheet_warning/models/hr_timesheet_sheet.py b/hr_timesheet_sheet_warning/models/hr_timesheet_sheet.py
@@ -14,7 +14,9 @@ class Sheet(models.Model):
     )
 
     def _generate_hr_timesheet_sheet_warnings(self):
-        definitions = self.env["hr_timesheet.sheet.warning.definition"].search([])
+        definitions = self.env["hr_timesheet.sheet.warning.definition"].search(
+            [("active", "in", [True, False])]
+        )
         item_model = self.env["hr_timesheet.sheet.warning.item"]
 
         for rec in self:
@@ -25,9 +27,12 @@ def _generate_hr_timesheet_sheet_warnings(self):
                         ("warning_definition_id", "=", definition.id),
                     ]
                 )
-                warning_applicable = definition._is_warning_applicable(rec)
+                warning_applicable = definition.is_warning_applicable(rec)
                 if warning_applicable:
                     warning_raised = definition.evaluate_definition(rec)
+                    if not definition.active:
+                        warning_raised = False
+
                     if warning_raised and not existing:
                         item_model.create(
                             {"sheet_id": rec.id, "warning_definition_id": definition.id}
diff --git a/hr_timesheet_sheet_warning/models/hr_timesheet_sheet_warning_definition.py b/hr_timesheet_sheet_warning/models/hr_timesheet_sheet_warning_definition.py
@@ -41,7 +41,7 @@ def _eval_warning_domain(self, sheet, domain):
             )
         )
 
-    def _is_warning_applicable(self, sheet):
+    def is_warning_applicable(self, sheet):
         domain = safe_eval(self.warning_domain) or []
         if domain:
             return self._eval_warning_domain(sheet, domain)
diff --git a/hr_timesheet_sheet_warning/models/hr_timesheet_sheet_warning_item.py b/hr_timesheet_sheet_warning/models/hr_timesheet_sheet_warning_item.py
@@ -7,7 +7,7 @@
 class SheetWarningItem(models.Model):
     _name = "hr_timesheet.sheet.warning.item"
     _description = "Timesheet Sheet Warning Item"
-    _order = "name desc"
+    _order = "id desc"
 
     warning_definition_id = fields.Many2one(
         comodel_name="hr_timesheet.sheet.warning.definition",
@@ -21,6 +21,14 @@ class SheetWarningItem(models.Model):
         store=True,
     )
 
+    _sql_constraints = [
+        (
+            "unique_warning",
+            "unique(sheet_id, warning_definition_id)",
+            "Timesheet warning has to be unique for timesheet sheet.",
+        )
+    ]
+
     def _compute_name(self):
         for rec in self:
             rec.name = "{} in {}".format(
diff --git a/hr_timesheet_sheet_warning/readme/DESCRIPTION.rst b/hr_timesheet_sheet_warning/readme/DESCRIPTION.rst
@@ -1,4 +1,6 @@
-This module allows the creation warning definitions, to be able to check
-certain aspects related to Timesheet Sheets.
-Once the warnings are defined, it can check their criteria against the
-actual Timesheet Sheets and raise individual warnings for each one if necessary.
+This module provides functionality for defining custom warning criteria related to
+Timesheet Sheets using Python expressions. Users can establish specific conditions
+for evaluating certain aspects of the Sheets.
+Once the warnings are defined, the module facilitates a systematic evaluation of
+Timesheet Sheets against these conditions. It generates individual warnings for each
+Sheet, if the warnings criteria are met.
diff --git a/hr_timesheet_sheet_warning/static/description/index.html b/hr_timesheet_sheet_warning/static/description/index.html
@@ -367,13 +367,15 @@ <h1 class="title">HR Timesheet Sheet Warning</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:43890a1c4867dee1335ee92a4afeb0de109e14ee98a3d4b2b822ce1d4daca1e3
+!! source digest: sha256:5f86aee8d8ec3d3e4e473059d8e8094b0df0fd98ceda8ab78209c24ba5b92192
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/timesheet/tree/16.0/hr_timesheet_sheet_warning"><img alt="OCA/timesheet" src="https://img.shields.io/badge/github-OCA%2Ftimesheet-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/timesheet-16-0/timesheet-16-0-hr_timesheet_sheet_warning"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/timesheet&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module allows the creation warning definitions, to be able to check
-certain aspects related to Timesheet Sheets.
-Once the warnings are defined, it can check their criteria against the
-actual Timesheet Sheets and raise individual warnings for each one if necessary.</p>
+<p>This module provides functionality for defining custom warning criteria related to
+Timesheet Sheets using Python expressions. Users can establish specific conditions
+for evaluating certain aspects of the Sheets.
+Once the warnings are defined, the module facilitates a systematic evaluation of
+Timesheet Sheets against these conditions. It generates individual warnings for each
+Sheet, if the warnings criteria are met.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
diff --git a/hr_timesheet_sheet_warning/tests/test_hr_timesheet_sheet_warning.py b/hr_timesheet_sheet_warning/tests/test_hr_timesheet_sheet_warning.py
@@ -2,6 +2,9 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
 
+from unittest.mock import patch
+
+from odoo.exceptions import UserError
 from odoo.tests.common import Form, TransactionCase
 
 
@@ -121,6 +124,13 @@ def test_02_timesheet_warnings(self):
         self.assertEqual(warning_item.warning_definition_id.id, warning_definition.id)
         self.assertEqual(warning_item.sheet_id.id, sheet.id)
 
+        warning_definition.write({"active": False})
+        sheet.action_generate_warnings()
+        self.assertEqual(len(sheet.hr_timesheet_sheet_warning_item_ids), 0)
+        warning_definition.write({"active": True})
+        sheet.action_generate_warnings()
+        self.assertEqual(len(sheet.hr_timesheet_sheet_warning_item_ids), 1)
+
     def test_03_timesheet_warnings_with_domain(self):
         sheet_form_1 = Form(self.sheet_model.with_user(self.user))
         sheet_form_1.date_start = "2024-02-05"
@@ -151,3 +161,47 @@ def test_03_timesheet_warnings_with_domain(self):
         sheet_2.action_generate_warnings()
         self.assertEqual(len(sheet_1.hr_timesheet_sheet_warning_item_ids), 1)
         self.assertEqual(len(sheet_2.hr_timesheet_sheet_warning_item_ids), 0)
+
+    def test_04_timesheet_warnings_on_confirm(self):
+        sheet_form = Form(self.sheet_model.with_user(self.user))
+        sheet = sheet_form.save()
+        with patch.object(type(sheet), "action_generate_warnings") as patched:
+            sheet.action_timesheet_confirm()
+            patched.assert_called_once_with()
+
+    def test_05_timesheet_warning_items(self):
+        sheet_form = Form(self.sheet_model.with_user(self.user))
+        sheet = sheet_form.save()
+        warning_definition = self.sheet_warning_definition_model.create(
+            {
+                "name": "Test Warning Definition",
+                "python_code": "sheet.total_time > 40",
+            }
+        )
+        sheet.write({"total_time": 45})
+        sheet.action_generate_warnings()
+        warning_item = sheet.hr_timesheet_sheet_warning_item_ids
+
+        default_display_name = (
+            warning_definition.display_name + " in " + sheet.complete_name
+        )
+        self.assertEqual(warning_item.name, default_display_name)
+        warning_item.write({"name": "Test Name"})
+        self.assertEqual(warning_item.name, "Test Name")
+        warning_item._compute_name()
+        self.assertEqual(warning_item.name, default_display_name)
+
+    def test_06_timesheet_warning_definitions(self):
+        sheet_form = Form(self.sheet_model.with_user(self.user))
+        sheet = sheet_form.save()
+        warning_definition = self.sheet_warning_definition_model.create(
+            {
+                "name": "Test Warning Definition",
+                "python_code": "123ABC",
+            }
+        )
+
+        with self.assertRaises(UserError):
+            warning_definition.evaluate_definition(sheet)
+        warning_definition.write({"python_code": "True"})
+        warning_definition.evaluate_definition(sheet)
diff --git a/hr_timesheet_sheet_warning/views/hr_timesheet_sheet.xml b/hr_timesheet_sheet_warning/views/hr_timesheet_sheet.xml
@@ -19,7 +19,7 @@
                     />
                     <field
                         name="hr_timesheet_sheet_warning_item_ids"
-                        widget="many2many"
+                        widget="one2many"
                     />
                 </page>
             </xpath>
diff --git a/hr_timesheet_sheet_warning/views/hr_timesheet_sheet_warning_definition.xml b/hr_timesheet_sheet_warning/views/hr_timesheet_sheet_warning_definition.xml
@@ -10,7 +10,7 @@
         <field name="arch" type="xml">
             <tree>
                 <field name="name" />
-                <field name="active" />
+                <field name="active" optional="hide" />
             </tree>
         </field>
     </record>
@@ -54,7 +54,7 @@
                 <field name="name" />
                 <separator />
                 <filter
-                    string="Archived"
+                    string="Inactive"
                     name="inactive"
                     domain="[('active', '=', False)]"
                 />
@@ -72,20 +72,20 @@
     </record>
 
     <menuitem
-        id="timesheet_menu_settings"
-        name="Settings"
+        id="timesheet_menu_warning_definitions"
+        name="Warnings"
         parent="hr_timesheet.hr_timesheet_menu_configuration"
-        action="hr_timesheet.hr_timesheet_config_settings_action"
-        groups="base.group_system"
+        action="hr_timesheet_sheet_warning_definition_action"
+        groups="hr_timesheet.group_hr_timesheet_approver"
         sequence="80"
     />
 
     <menuitem
-        id="timesheet_menu_warning_definitions"
-        name="Warnings"
+        id="timesheet_menu_settings"
+        name="Settings"
         parent="hr_timesheet.hr_timesheet_menu_configuration"
-        action="hr_timesheet_sheet_warning_definition_action"
-        groups="hr_timesheet.group_hr_timesheet_approver"
+        action="hr_timesheet.hr_timesheet_config_settings_action"
+        groups="base.group_system"
         sequence="85"
     />
 

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ def _eval_warning_domain(self, sheet, domain):`
`41`	`41`	`)`
`42`	`42`	`)`
`43`	`43`
`44`		`- def _is_warning_applicable(self, sheet):`
	`44`	`+ def is_warning_applicable(self, sheet):`
`45`	`45`	`domain = safe_eval(self.warning_domain) or []`
`46`	`46`	`if domain:`
`47`	`47`	`return self._eval_warning_domain(sheet, domain)`