Merge lp:~thumper/launchpad/send-mail-job-logging into lp:launchpad

[Tim Penhey]

Provide a repr method for derived branch job.

Add a repr method for the derived branch jobs. This will be emitted in the log files by the job runner class at the DEBUG level. This will help a lot with the debugging of branch job related issues (like bug 585126).

tests:
  TestRevisionMailJob

[Tim Penhey (thumper)]

Argh, fixed the docstrings.

=== modified file 'lib/lp/code/model/tests/test_branchjob.py'
--- lib/lp/code/model/tests/test_branchjob.py 2010-05-25 05:10:57 +0000
+++ lib/lp/code/model/tests/test_branchjob.py 2010-05-25 05:19:13 +0000
@@ -303,14 +303,14 @@
     layer = LaunchpadZopelessLayer

     def test_providesInterface(self):
- """Ensure that BranchDiffJob implements IBranchDiffJob."""
+ """Ensure that RevisionMailJob implements IRevisionMailJob."""
         branch = self.factory.makeAnyBranch()
         job = RevisionMailJob.create(
             branch, 0, '<email address hidden>', 'hello', False, 'subject')
         verifyObject(IRevisionMailJob, job)

     def test_repr(self):
- """Ensure that BranchDiffJob implements IBranchDiffJob."""
+ """Ensure that the revision mail job as a reasonable repr."""
         branch = self.factory.makeAnyBranch()
         job = RevisionMailJob.create(
             branch, 0, '<email address hidden>', 'hello', False, 'subject')

[Michael Hudson-Doyle (mwhudson)]

Looks fine.

review: Approve

=== modified file 'lib/lp/code/model/branchjob.py'
--- lib/lp/code/model/branchjob.py	2010-04-23 05:29:30 +0000
+++ lib/lp/code/model/branchjob.py	2010-05-26 23:18:37 +0000
@@ -183,6 +183,14 @@
     def __init__(self, branch_job):
         self.context = branch_job
 
+    def __repr__(self):
+        branch = self.branch
+        return '<%(job_type)s branch job (%(id)s) for %(branch)s>' % {
+            'job_type': self.context.job_type.name,
+            'id': self.context.id,
+            'branch': branch.unique_name,
+            }
+
     # XXX: henninge 2009-02-20 bug=331919: These two standard operators
     # should be implemented by delegates().
     def __eq__(self, other):
@@ -929,6 +937,12 @@
 
     class_job_type = BranchJobType.RECLAIM_BRANCH_SPACE
 
+    def __repr__(self):
+        return '<RECLAIM_BRANCH_SPACE branch job (%(id)s) for %(branch)s>' % {
+            'id': self.context.id,
+            'branch': self.branch_id,
+            }
+
     @classmethod
     def create(cls, branch_id):
         """See `IBranchDiffJobSource`."""

=== modified file 'lib/lp/code/model/tests/test_branchjob.py'
--- lib/lp/code/model/tests/test_branchjob.py	2010-04-27 09:05:44 +0000
+++ lib/lp/code/model/tests/test_branchjob.py	2010-05-26 23:18:37 +0000
@@ -303,12 +303,22 @@
     layer = LaunchpadZopelessLayer
 
     def test_providesInterface(self):
-        """Ensure that BranchDiffJob implements IBranchDiffJob."""
+        """Ensure that RevisionMailJob implements IRevisionMailJob."""
         branch = self.factory.makeAnyBranch()
         job = RevisionMailJob.create(
             branch, 0, '[e-mail]', 'hello', False, 'subject')
         verifyObject(IRevisionMailJob, job)
 
+    def test_repr(self):
+        """Ensure that the revision mail job as a reasonable repr."""
+        branch = self.factory.makeAnyBranch()
+        job = RevisionMailJob.create(
+            branch, 0, '[e-mail]', 'hello', False, 'subject')
+        self.assertEqual(
+            '<REVISION_MAIL branch job (%s) for %s>'
+            % (job.context.id, branch.unique_name),
+            repr(job))
+
     def test_run_sends_mail(self):
         """Ensure RevisionMailJob.run sends mail with correct values."""
         branch = self.factory.makeAnyBranch()