Merge lp:~allenap/launchpad/series-init-failure-explanations-bug-835024 into lp:launchpad

[Gavin Panella]

[r=bac][bug=835024] New error_description property on InitializeDistroSeriesJob.

This adds an error_description property to
InitializeDistroSeriesJob. This property backs onto the job's metadata
so is meant to be persistent. It is populated by the overridden
notifyUserError() method so that the error can be saved even after the
job's transaction is aborted; see BaseJobRunner.runJobHandleError()
for the mechanism.

I've also switched to using the new JSON property from Storm instead
of the _json_data/metadata hackette. This uncovered a bad test -
test__repr__ for InitializeDistroSeriesJob - which I have also fixed.

Pre-implementation discussion with bigjools. There is a follow-up
branch already in progress to make error_description appear in the UI.

[Brad Crittenden (bac)]

Looks good Gavin.

s/slso/also

review: Approve (code)

=== modified file 'database/schema/security.cfg'
--- database/schema/security.cfg	2011-09-06 19:40:50 +0000
+++ database/schema/security.cfg	2011-09-09 19:29:35 +0000
@@ -975,7 +975,7 @@
 public.component                                = SELECT
 public.componentselection                       = SELECT, INSERT
 public.distribution                             = SELECT
-public.distributionjob                          = SELECT, INSERT
+public.distributionjob                          = SELECT, INSERT, UPDATE
 public.distributionsourcepackage                = SELECT, INSERT
 public.distroarchseries                         = SELECT, INSERT
 public.distroseries                             = SELECT, UPDATE

=== modified file 'lib/lp/soyuz/model/initializedistroseriesjob.py'
--- lib/lp/soyuz/model/initializedistroseriesjob.py	2011-08-04 10:37:58 +0000
+++ lib/lp/soyuz/model/initializedistroseriesjob.py	2011-09-09 19:29:35 +0000
@@ -7,6 +7,7 @@
     "InitializeDistroSeriesJob",
 ]
 
+import simplejson
 from zope.interface import (
     classProvides,
     implements,
@@ -31,7 +32,10 @@
     DistributionJobDerived,
     )
 from lp.soyuz.model.packageset import Packageset
-from lp.soyuz.scripts.initialize_distroseries import InitializeDistroSeries
+from lp.soyuz.scripts.initialize_distroseries import (
+    InitializationError,
+    InitializeDistroSeries,
+    )
 
 
 class InitializeDistroSeriesJob(DistributionJobDerived):
@@ -41,6 +45,8 @@
     class_job_type = DistributionJobType.INITIALIZE_SERIES
     classProvides(IInitializeDistroSeriesJobSource)
 
+    user_error_types = (InitializationError,)
+
     @classmethod
     def create(cls, child, parents, arches=(), packagesets=(),
                rebuild=False, overlays=(), overlay_pockets=(),
@@ -179,6 +185,10 @@
     def rebuild(self):
         return self.metadata['rebuild']
 
+    @property
+    def error_description(self):
+        return self.metadata.get("error_description")
+
     def run(self):
         """See `IRunnableJob`."""
         ids = InitializeDistroSeries(
@@ -188,6 +198,17 @@
         ids.check()
         ids.initialize()
 
+    def notifyUserError(self, error):
+        """Calls up and slso saves the error text in this job's metadata.
+
+        See `BaseRunnableJob`.
+        """
+        # This method is called when error is an instance of
+        # self.user_error_types.
+        super(InitializeDistroSeriesJob, self).notifyUserError(error)
+        metadata = dict(self.metadata, error_description=unicode(error))
+        self.context._json_data = simplejson.dumps(metadata).decode("utf-8")
+
     def getOopsVars(self):
         """See `IRunnableJob`."""
         vars = super(InitializeDistroSeriesJob, self).getOopsVars()

=== modified file 'lib/lp/soyuz/tests/test_initializedistroseriesjob.py'
--- lib/lp/soyuz/tests/test_initializedistroseriesjob.py	2011-08-02 16:24:30 +0000
+++ lib/lp/soyuz/tests/test_initializedistroseriesjob.py	2011-09-09 19:29:35 +0000
@@ -70,8 +70,8 @@
         packageset2 = self.factory.makePackageset()
 
         overlays = (True, False)
-        overlay_pockets = (('Updates',), ('Release',))
-        overlay_components = (("main",), ("universe",))
+        overlay_pockets = (u'Updates', u'Release')
+        overlay_components = (u"main", u"universe")
         arches = (u'i386', u'amd64')
         packagesets = (packageset1.id, packageset2.id)
         rebuild = False
@@ -84,8 +84,8 @@
             "distribution: {distroseries.distribution.name}, "
             "distroseries: {distroseries.name}, "
             "parent[overlay?/pockets/components]: "
-            "{parent1.name}[True/[u'Updates']/[u'main']],"
-            "{parent2.name}[False/[u'Release']/[u'universe']], "
+            "{parent1.name}[True/Updates/main],"
+            "{parent2.name}[False/Release/universe], "
             "architectures: (u'i386', u'amd64'), "
             "packagesets: [u'{packageset1.name}', u'{packageset2.name}'], "
             "rebuild: False>".format(
@@ -99,7 +99,6 @@
             repr(job)
         )
 
-
     def test_create_with_existing_pending_job(self):
         parent = self.factory.makeDistroSeries()
         distroseries = self.factory.makeDistroSeries()
@@ -197,6 +196,23 @@
         self.assertIsInstance(job, InitializeDistroSeriesJob)
         self.assertEqual(job.distroseries, distroseries)
 
+    def test_error_description_when_no_error(self):
+        # The InitializeDistroSeriesJob.error_description property returns
+        # None when no error description is recorded.
+        parent = self.factory.makeDistroSeries()
+        distroseries = self.factory.makeDistroSeries()
+        job = self.job_source.create(distroseries, [parent.id])
+        self.assertIs(None, removeSecurityProxy(job).error_description)
+
+    def test_error_description_set_when_notifying_about_user_errors(self):
+        # error_description is set by notifyUserError().
+        parent = self.factory.makeDistroSeries()
+        distroseries = self.factory.makeDistroSeries()
+        job = self.job_source.create(distroseries, [parent.id])
+        message = "This is an example message."
+        job.notifyUserError(InitializationError(message))
+        self.assertEqual(message, removeSecurityProxy(job).error_description)
+
 
 class InitializeDistroSeriesJobTestsWithPackages(TestCaseWithFactory):
     """Test case for InitializeDistroSeriesJob."""