[IMP] queue_job: remove DB commits within test of requeue

Author: AnizR

queue_job/__manifest__.py

@@ -9,6 +9,9 @@
     "category": "Generic Modules",
     "depends": ["mail", "base_sparse_field", "web"],
     "external_dependencies": {"python": ["requests"]},
+    "demo": [
+        "demo/queue_job_test_lock.xml",
+    ],
     "data": [
         "security/security.xml",
         "security/ir.model.access.csv",

queue_job/demo/queue_job_test_lock.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo noupdate="1">
+    <!--
+            To be used in tests cfr. test/test_requeue_dead_job.py
+            These 'test' data are loaded as 'demo' data to have records within db
+            and avoid doing commit within tests
+        -->
+    <function
+        name="_create_test_started_job"
+        model="queue.job"
+        eval="('test_started_job',)"
+    />
+    <function
+        name="_create_test_enqueued_job"
+        model="queue.job"
+        eval="('test_enqueued_job',)"
+    />
+</odoo>

queue_job/models/queue_job.py

@@ -445,3 +445,32 @@ def _test_job(self, failure_rate=0):
         _logger.info("Running test job.")
         if random.random() <= failure_rate:
             raise JobError("Job failed")
+
+    @api.model
+    def _create_test_started_job(self, uuid):
+        """Create started jobs to be used within tests"""
+        self.env["queue.job"].with_context(
+            _job_edit_sentinel=self.env["queue.job"].EDIT_SENTINEL,
+        ).create(
+            {
+                "uuid": uuid,
+                "state": "started",
+                "model_name": "queue.job",
+                "method_name": "write",
+            }
+        )
+
+    @api.model
+    def _create_test_enqueued_job(self, uuid):
+        """Create enqueued jobs to be used within tests"""
+        self.env["queue.job"].with_context(
+            _job_edit_sentinel=self.env["queue.job"].EDIT_SENTINEL,
+        ).create(
+            {
+                "uuid": uuid,
+                "state": "enqueued",
+                "model_name": "queue.job",
+                "method_name": "write",
+                "date_enqueued": datetime.now() - timedelta(minutes=1),
+            }
+        )

queue_job/tests/test_requeue_dead_job.py

@@ -1,7 +1,6 @@
 # Copyright 2025 ACSONE SA/NV
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 from contextlib import closing
-from datetime import datetime, timedelta
 
 from odoo.tests.common import TransactionCase
 
@@ -10,26 +9,22 @@
 
 
 class TestRequeueDeadJob(TransactionCase):
-    def create_dummy_job(self, uuid):
-        """
-        Create dummy job for tests
-        """
-        return (
-            self.env["queue.job"]
-            .with_context(
-                _job_edit_sentinel=self.env["queue.job"].EDIT_SENTINEL,
-            )
-            .create(
-                {
-                    "uuid": uuid,
-                    "user_id": self.env.user.id,
-                    "state": "pending",
-                    "model_name": "queue.job",
-                    "method_name": "write",
-                }
-            )
+    def _get_demo_job(self, uuid):
+        # job created during load of demo data
+        job = self.env["queue.job"].search(
+            [
+                ("uuid", "=", uuid),
+            ]
+        )
+
+        self.assertTrue(
+            job,
+            f"Demo data queue job {uuid} should be loaded in order"
+            " to make this tests work",
         )
 
+        return job
+
     def get_locks(self, uuid, cr=None):
         """
         Retrieve lock rows
@@ -60,7 +55,8 @@ def get_locks(self, uuid, cr=None):
         return cr.fetchall()
 
     def test_add_lock_record(self):
-        queue_job = self.create_dummy_job("test_add_lock")
+        queue_job = self._get_demo_job("test_started_job")
+
         job_obj = Job.load(self.env, queue_job.uuid)
 
         job_obj.set_started()
@@ -71,7 +67,7 @@ def test_add_lock_record(self):
         self.assertEqual(1, len(locks))
 
     def test_lock(self):
-        queue_job = self.create_dummy_job("test_lock")
+        queue_job = self._get_demo_job("test_started_job")
         job_obj = Job.load(self.env, queue_job.uuid)
 
         job_obj.set_started()
@@ -81,9 +77,6 @@ def test_lock(self):
 
         self.assertEqual(1, len(locks))
 
-        # commit to update queue_job records in DB
-        self.env.cr.commit()  # pylint: disable=E8102
-
         job_obj.lock()
 
         with closing(self.env.registry.cursor()) as new_cr:
@@ -92,28 +85,13 @@ def test_lock(self):
             # Row should be locked
             self.assertEqual(0, len(locks))
 
-        # clean up
-        queue_job.unlink()
-
-        self.env.cr.commit()  # pylint: disable=E8102
-
-        # because we committed the cursor, the savepoint of the test method is
-        # gone, and this would break TransactionCase cleanups
-        self.cr.execute("SAVEPOINT test_%d" % self._savepoint_id)
-
     def test_requeue_dead_jobs(self):
-        uuid = "test_requeue_dead_jobs"
-
-        queue_job = self.create_dummy_job(uuid)
+        queue_job = self._get_demo_job("test_enqueued_job")
         job_obj = Job.load(self.env, queue_job.uuid)
 
         job_obj.set_enqueued()
-        # simulate enqueuing was in the past
-        job_obj.date_enqueued = datetime.now() - timedelta(minutes=1)
         job_obj.set_started()
-
         job_obj.store()
-        self.env.cr.commit()  # pylint: disable=E8102
 
         # requeue dead jobs using current cursor
         query = Database(self.env.cr.dbname)._query_requeue_dead_jobs()
@@ -122,12 +100,4 @@ def test_requeue_dead_jobs(self):
         uuids_requeued = self.env.cr.fetchall()
 
         self.assertEqual(len(uuids_requeued), 1)
-        self.assertEqual(uuids_requeued[0][0], uuid)
-
-        # clean up
-        queue_job.unlink()
-        self.env.cr.commit()  # pylint: disable=E8102
-
-        # because we committed the cursor, the savepoint of the test method is
-        # gone, and this would break TransactionCase cleanups
-        self.cr.execute("SAVEPOINT test_%d" % self._savepoint_id)
+        self.assertEqual(uuids_requeued[0][0], queue_job.uuid)

test_queue_job/tests/test_autovacuum.py

@@ -28,12 +28,23 @@ def test_autovacuum(self):
         date_done = datetime.now() - timedelta(days=29)
         stored.write({"date_done": date_done})
         self.env["queue.job"].autovacuum()
-        self.assertEqual(len(self.env["queue.job"].search([])), 1)
+        self.assertEqual(
+            len(
+                self.env["queue.job"].search(
+                    [
+                        ("channel", "!=", False),
+                    ]
+                )
+            ),
+            1,
+        )
 
         date_done = datetime.now() - timedelta(days=31)
         stored.write({"date_done": date_done})
         self.env["queue.job"].autovacuum()
-        self.assertEqual(len(self.env["queue.job"].search([])), 0)
+        self.assertEqual(
+            len(self.env["queue.job"].search([("channel", "!=", False)])), 0
+        )
 
     def test_autovacuum_multi_channel(self):
         root_channel = self.env.ref("queue_job.channel_root")
@@ -48,11 +59,14 @@ def test_autovacuum_multi_channel(self):
             {"channel": channel_60days.complete_name, "date_done": date_done}
         )
 
-        self.assertEqual(len(self.env["queue.job"].search([])), 2)
         self.env["queue.job"].autovacuum()
-        self.assertEqual(len(self.env["queue.job"].search([])), 1)
+        self.assertEqual(
+            len(self.env["queue.job"].search([("channel", "!=", False)])), 1
+        )
 
         date_done = datetime.now() - timedelta(days=61)
         job_60days.write({"date_done": date_done})
         self.env["queue.job"].autovacuum()
-        self.assertEqual(len(self.env["queue.job"].search([])), 0)
+        self.assertEqual(
+            len(self.env["queue.job"].search([("channel", "!=", False)])), 0
+        )