Changeset 9639 for main/waeup.kofa

Timestamp:

15 Nov 2012, 15:38:25 (12 years ago)

Author:

uli

Message:

Provide a reduced set of stati in report jobs which are better suited for frontends.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• reports.py (modified) (5 diffs)
• tests/test_reports.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/reports.py

@@ -32 +32 @@
 from waeup.kofa.utils.helpers import now
 
+#: A status map that reflects the really interesting types of status
+#: for reports.
+#:
+#: For reports we want to know whether a job was finished
+#: and/or whether it failed. All the other possible states ('new',
+#: etc.) are not really interesting in that regard.
+STATUS_MAP = {
+    'unknown': _('unknown'),
+    'running': _('running'),
+    'finished': _('finished'),
+    'failed': _('FAILED'),
+    }
+
 class IReport(Interface):
     """A report.
@@ -84 +97 @@
         title = u"""Textual representation of arguments and keywords.""",
         default = u"",
+        )
+
+    report_status = schema.TextLine(
+        title = u"""Translated status string.""",
+        default = STATUS_MAP['unknown'],
         )
 
@@ -299 +317 @@
             return True
         return False
+
+    @property
+    def report_status(self):
+        """The status of a report as translated string.
+        """
+        if not self.finished:
+            return STATUS_MAP['running']
+        if self.failed:
+            return STATUS_MAP['failed']
+        return STATUS_MAP['finished']
 
     @property
@@ -327 +355 @@
         return name + ' ' + str_repr
 
-
 @implementer(IReportJobContainer)
 class ReportJobContainer(object):
@@ -441 +468 @@
             manager = getUtility(IJobManager)
             job = manager.get(job_id)
-            status = JOB_STATUS_MAP.get(job.status, job.status)[1]
+            status = job.report_status
             discardable = job.finished
             downloadable = job.finished and not job.failed

main/waeup.kofa/trunk/src/waeup/kofa/tests/test_reports.py

@@ -256 +256 @@
         return
 
+    def test_report_status(self):
+        # We can get a report status apart from the job status
+        job = AsyncReportJob(self.root_folder, 'report1')
+        self.assertEqual(job.report_status, u'running')
+        return
+
+    def test_report_status_failed(self):
+        # A failed job is reflected in report_status
+        job = AsyncReportJob(self.root_folder, None) # no report generator
+        setSite(self.root_folder)
+        self.assertTrue(job.failed is None)
+        manager = getUtility(IJobManager)
+        manager.put(job)
+        wait_for_result(job)
+        self.assertEqual(job.report_status, u'FAILED')
+        return
+
+    def test_report_status_finished(self):
+        # A finished report is reflected in report_status
+        job = AsyncReportJob(self.root_folder, 'report1')
+        setSite(self.root_folder)
+        manager = getUtility(IJobManager)
+        manager.put(job)
+        wait_for_result(job)
+        self.assertEqual(job.report_status, u'finished')
+        return
+
 class FakeJobWithResult(FakeJob):
 
@@ -368 +395 @@
         self.assertEqual(
             result,
-            [('2', 'Report 1 ()', u'new', False, False),]
+            [('2', 'Report 1 ()', u'running', False, False),]
             )
         return