Merge lp:~camptocamp/openerp-connector/7.0-delay-return-uuid-lep into lp:~openerp-connector-core-editors/openerp-connector/7.0

[Leonardo Pistone]

[imp] when delaying function and creating a job, return the job uuid.
This should not break anything because before everything returned None.

The delay() function returns None.

This changes it so that it returns the new job UUID.

I changed an existing unit test to cover that.

Thanks!

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Nice! Thanks

review: Approve (code review)

[Leonardo Pistone (lepistone)]

Guewen,

FYI, I gave a quick look to what celery does in that case, and they return an AsynchResult instance you can use to ask things including the uuid.

just the uuid should do for now, still.

=== modified file 'connector/queue/job.py'
--- connector/queue/job.py	2013-11-18 14:28:23 +0000
+++ connector/queue/job.py	2014-01-13 16:10:56 +0000
@@ -103,13 +103,20 @@
 
     def enqueue(self, func, model_name=None, args=None, kwargs=None,
                 priority=None, eta=None, max_retries=None, description=None):
+        """Create a Job and enqueue it in the queue. Return the job uuid.
+
+        This expects the arguments specific to the job to be already extracted
+        from the ones to pass to the job function.
+
+        """
         job = Job(func=func, model_name=model_name, args=args, kwargs=kwargs,
                   priority=priority, eta=eta, max_retries=max_retries, description=description)
         job.user_id = self.session.uid
         self.store(job)
+        return job.uuid
 
     def enqueue_resolve_args(self, func, *args, **kwargs):
-        """Create a Job and enqueue it in the queue"""
+        """Create a Job and enqueue it in the queue. Return the job uuid."""
         priority = kwargs.pop('priority', None)
         eta = kwargs.pop('eta', None)
         model_name = kwargs.pop('model_name', None)
@@ -638,8 +645,11 @@
 
     """
     def delay(session, model_name, *args, **kwargs):
-        OpenERPJobStorage(session).enqueue_resolve_args(func,
-                                                        model_name=model_name,
-                                                        *args, **kwargs)
+        """Enqueue the function. Return the uuid of the created job."""
+        return OpenERPJobStorage(session).enqueue_resolve_args(
+            func,
+            model_name=model_name,
+            *args,
+            **kwargs)
     func.delay = delay
     return func

=== modified file 'connector/tests/test_job.py'
--- connector/tests/test_job.py	2013-11-16 14:04:11 +0000
+++ connector/tests/test_job.py	2014-01-13 16:10:56 +0000
@@ -164,9 +164,14 @@
     def test_job_delay(self):
         self.cr.execute('delete from queue_job')
         deco_task = job(task_a)
-        task_a.delay(self.session, 'res.users')
+        job_uuid = task_a.delay(self.session, 'res.users')
         stored = self.queue_job.search(self.cr, self.uid, [])
         self.assertEqual(len(stored), 1)
+        stored_brw = self.queue_job.browse(self.cr, self.uid, stored)
+        self.assertEqual(
+            stored_brw[0].uuid,
+            job_uuid,
+            'Incorrect returned Job UUID')
 
     def test_job_delay_args(self):
         self.cr.execute('delete from queue_job')