Merge lp:~adeuring/lazr.jobrunner/use_job_repr_in_logging into lp:lazr.jobrunner

[Abel Deuring]

Some classes that are dervied from BaseRunnableJob in the Launchpad source code define __repr__(), and repr(job) was used by the old job implementation in log messages.

This change fixes failures in these Launchpad tests:

lp.registry.tests.test_process_job_sources_cronjob.ProcessJobSourceGroupsTest.test_processed
lp.registry.tests.test_process_job_sources_cronjob.ProcessJobSourceTest.test_processed
lp.registry.tests.test_membership_notification_job.MembershipNotificationJobTest

(the first two tests need also an s/DEBUG/INFO / in an assertWhatever() call, but i think it is reasonable to change the log level from DEBUG to INFO.)

[Abel Deuring (adeuring)]

see also https://code.launchpad.net/~adeuring/launchpad/lp-lazr.jobrunner/+merge/97458 for related changes in the main LP code.

[Richard Harding (rharding)]

review: Approve (code*)

[j.c.sackett (jcsackett)]

review: Approve

[Aaron Bentley (abentley)]

Please use a more standard __repr__ such as "<Job>" or "Job(id=5)". Other than that, this is fine.

review: Approve

[Abel Deuring (adeuring)]

On 22.03.2012 16:29, Aaron Bentley wrote:
> Review: Approve
>
> Please use a more standard __repr__ such as "<Job>" or "Job(id=5)". Other than that, this is fine.

I used '<%s>' % self.__class__.__name__. Something like

  <%s(%s)> % (self.__class__.__name__, self.job_id)

would let the job ID disappear from log messages when a derived class
has its own __repr__() method.

=== modified file 'src/lazr/jobrunner/jobrunner.py'
--- src/lazr/jobrunner/jobrunner.py	2012-03-16 18:27:52 +0000
+++ src/lazr/jobrunner/jobrunner.py	2012-03-22 11:51:17 +0000
@@ -144,6 +144,9 @@
     def getOopsVars(self):
         return ()
 
+    def __repr__(self):
+        return self.__class__.__name__
+
 
 class JobRunner:
 
@@ -160,9 +163,7 @@
 
     @staticmethod
     def job_str(job):
-        class_name = job.__class__.__name__
-        ijob_id = job.job_id
-        return '%s (ID %d)' % (class_name, ijob_id)
+        return '%r (ID %d)' % (job, job.job_id)
 
     def runJob(self, job):
         """Attempt to run a job, updating its status as appropriate."""

=== modified file 'src/lazr/jobrunner/tests/test_jobrunner.py'