Changeset 9633 for main/waeup.kofa/trunk/src

Timestamp:

14 Nov 2012, 18:40:59 (12 years ago)

Author:

uli

Message:

Basic statistics for kofa. Still the functionality is hidden - but available :-)

Location:

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

Files:

• browser/reports.py (added)
• browser/templates/reportscontainercreate.pt (added)
• browser/templates/reportscontainerpage.pt (added)
• reports.py (modified) (6 diffs)
• students/browser_templates/studentreportgeneratorpage.pt (added)
• students/reports.py (added)
• students/tests/test_reports.py (added)
• tests/test_reports.py (modified) (5 diffs)

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

@@ -44 +44 @@
         """not when any output was created.""")
 
+    title = schema.TextLine(
+        title = u"A human readable short description for a report.",
+        default = u'Untitled',
+        )
+
+    description = schema.Text(
+        title = u"A human readable text describing a report.",
+        default = u'No description'
+        )
+
     def create_pdf():
         """Generate a PDF copy.
@@ -121 +131 @@
         """
 
+    def get_report_jobs_description(user_id=None):
+        """Get running/completed report jobs fur ?user_id` as list of tuples.
+
+        Each tuple holds ``<job_id>, <description>,
+        <status_translated>`` in that order, where ``<description>``
+        is a human readable description of the report run and
+        ``<status_translated>`` is the report jobs' status
+        (translated).
+        """
+
     def delete_report_entry(entry):
         """Delete the report job denoted by `entry`.
@@ -162 +182 @@
 class Report(object):
     creation_dt = None
+
+    @property
+    def title(self):
+        return _(u'A report')
+
+    @property
+    def description(self):
+        return _(u'A dummy report')
 
     def __init__(self, args=[], kwargs={}):
@@ -170 +198 @@
     def create_pdf(self):
         raise NotImplementedError()
+
+    def __repr__(self):
+        return 'Report(args=%r, kwargs=%r)' % (self.args, self.kwargs)
+
 
 @implementer(IReportGenerator)
@@ -266 +298 @@
         str_repr = '(' + str_repr + ')'
         try:
-            generator = queryUtility(
+            generator = getUtility(
                 IReportGenerator, name=self._generator_name)
-            name = generator.name
+            name = generator.title
         except:
-            name = _('Invalid Report Generator')
+            name = _('Unregistered Report Generator')
         return name + ' ' + str_repr
 
@@ -351 +383 @@
         return result
 
+    def get_report_jobs_description(self, user_id=None):
+        """Get running/completed report jobs fur ?user_id` as list of tuples.
+
+        Each tuple holds ``<job_id>, <description>,
+        <status_translated>`` in that order, where ``<description>``
+        is a human readable description of the report run and
+        ``<status_translated>`` is the report jobs' status
+        (translated).
+        """
+        entries = self.get_running_report_jobs(user_id)
+        result = []
+        for (job_id, gen_name, user_name) in entries:
+            manager = getUtility(IJobManager)
+            job = manager.get(job_id)
+            status = JOB_STATUS_MAP.get(job.status, job.status)[1]
+            if not hasattr(job, 'description'):
+                continue
+            result.append((job_id, job.description, status),)
+        return result
+
     def delete_report_entry(self, entry):
         """Delete the report job denoted by `entry`.

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

@@ -25 +25 @@
 
     def __init__(self, name=None, perm_create=None, perm_view=None):
-        self.name = 'Report 1'
+        self.title = 'Report 1'
         self.perm_create = perm_create
         self.perm_view = perm_view
@@ -31 +31 @@
 
     def __eq__(self, obj):
-        if getattr(obj, 'name', None) is None:
+        if getattr(obj, 'title', None) is None:
             return False
-        return self.name == obj.name
+        return self.title == obj.title
 
     def generate(self, site, args=[], kw={}):
@@ -142 +142 @@
         self.assertEqual(
             result,
-            [('report1', FakeReportGenerator('report1')),
-             ('report2', FakeReportGenerator('report2'))])
+            [(u'report1', FakeReportGenerator('report1')),
+             (u'report2', FakeReportGenerator('report2'))])
         return
 
@@ -238 +238 @@
         job = AsyncReportJob(self.root_folder, 'NOT EXISTENT')
         self.assertEqual(
-            job.description, u'Invalid Report Generator ()')
+            job.description, u'Unregistered Report Generator ()')
         # with args set (no kws)
         job = AsyncReportJob(
             self.root_folder, 'NOT EXISTENT', args=['a', 'b'])
         self.assertEqual(
-            job.description, u"Invalid Report Generator ('a', 'b')")
+            job.description, u"Unregistered Report Generator ('a', 'b')")
         # with kw set (no args)
         job = AsyncReportJob(
             self.root_folder, 'NOT_EXISTENT', kw=dict(a=1, b=2))
         self.assertEqual(
-            job.description, u'Invalid Report Generator (a=1, b=2)')
+            job.description, u'Unregistered Report Generator (a=1, b=2)')
         # with args and kws set
         job = AsyncReportJob(
             self.root_folder, 'NOT_EXISTENT', args=['a'], kw=dict(b=2))
         self.assertEqual(
-            job.description, u"Invalid Report Generator ('a', b=2)")
-        return
-
+            job.description, u"Unregistered Report Generator ('a', b=2)")
+        return
 
 class FakeJobWithResult(FakeJob):
 
     def __init__(self, args=[], kw={}):
-        #self.dir_path = tempfile.mkdtemp()
-        #self.result = os.path.join(self.dir_path, 'fake.csv')
-        #open(self.result, 'wb').write('a fake result')
         self.result = Report()
         self.result.args = args
@@ -358 +354 @@
         self.assertEqual(
             result,
-            [('new', u'new', u'Unnamed Report'),
-             ('completed', u'completed', u'Unnamed Report')]
+            [('new', u'new', u'Report 1'),
+             ('completed', u'completed', u'Report 1')]
+            )
+        return
+
+    def test_get_report_job_description(self):
+        # we can get the descriptions of jobs...
+        container = ReportJobContainer()
+        container.start_report_job('report1', 'alice')
+        container.start_report_job('report1', 'bob')
+        result = container.get_report_jobs_description(user_id='bob')
+        # we'll get the job id, a description and the status
+        self.assertEqual(
+            result,
+            [('2', 'Report 1 ()', u'new'),]
             )
         return