Changeset 13802

Timestamp:

5 Apr 2016, 21:04:39 (9 years ago)

Author:

Henrik Bettermann

Message:

Do only allow one running export job.
Add switch to disable all exports.

See r13198 - r13201 and r13211.

Location:

main/waeup.ikoba/trunk

Files:

• CHANGES.txt (modified) (1 diff)
• src/waeup/ikoba/browser/pages.py (modified) (2 diffs)
• src/waeup/ikoba/browser/tests/test_browser.py (modified) (2 diffs)
• src/waeup/ikoba/interfaces.py (modified) (1 diff)
• src/waeup/ikoba/utils/utils.py (modified) (1 diff)
• versions.cfg (modified) (1 diff)

main/waeup.ikoba/trunk/CHANGES.txt

@@ -4 +4 @@
 0.2.dev0 (unreleased)
 =====================
+
+* Do only allow one running export job.
+
+* Add switch to disable all exports.
 
 * Rename customer views which are not layout-aware and thus not pages.

main/waeup.ikoba/trunk/src/waeup/ikoba/browser/pages.py

@@ -232 +232 @@
     return entries
 
+def running_jobs(view):
+    """True if any job is running.
+    """
+    job_entries = view.context.get_running_export_jobs()
+    job_manager = getUtility(IJobManager)
+    entries = []
+    for entry in job_entries:
+        job = job_manager.get(entry[0])
+        status = job.finished and 'ready' or 'running'
+        status = job.failed and 'FAILED' or status
+        if status == 'running':
+            return True
+    return False
+
 class LocalRoleAssignmentUtilityView(object):
     """A view mixin with useful methods for local role assignment.
@@ -1467 +1481 @@
             return
         if CREATE:
+            utils = queryUtility(IIkobaUtils)
+            if utils.export_disabled_message():
+                self.flash(utils.export_disabled_message(), type='danger')
+                self.entries = doll_up(self, user=None)
+                return
+            if running_jobs(self):
+                self.flash(_(
+                    "Sorry, another export job is running. "
+                    "Please try again later."), type='danger')
+                self.entries = doll_up(self, user=None)
+                return
             job_id = self.context.start_export_job(
                 exporter, self.request.principal.id)

main/waeup.ikoba/trunk/src/waeup/ikoba/browser/tests/test_browser.py

@@ -69 +69 @@
 
 
-class DataCenterUITests(CompanySetup):
+class DataCenterUITests(CompanySetup, FunctionalAsyncTestCase):
     # Tests for DataCenter class views and pages
 
     layer = FunctionalLayer
+
+    def wait_for_export_job_completed(self):
+        # helper function waiting until the current export job is completed
+        manager = getUtility(IJobManager)
+        job_id = self.app['datacenter'].running_exports[0][0]
+        job = manager.get(job_id)
+        wait_for_result(job)
+        return job_id
+
+    def cleanup_run_job(self):
+        # helper to remove any result file of an export
+        job_id = self.wait_for_export_job_completed()
+        manager = getUtility(IJobManager)
+        job = manager.get(job_id)
+        if os.path.exists(job.result):
+            shutil.rmtree(os.path.dirname(job.result))
 
     def test_user_data_import_permission(self):
@@ -96 +112 @@
         self.assertTrue('User Processor' in self.browser.contents)
         return
+
+    def test_export_disabled(self):
+        self.app['configuration'].export_disabled_message = u'Export forbidden'
+        self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
+        self.browser.open(self.datacenter_path)
+        self.assertEqual(self.browser.headers['Status'], '200 Ok')
+        self.assertEqual(self.browser.url, self.datacenter_path)
+        self.browser.getLink("Export data").click()
+        self.browser.getControl(name="exporter").value = ['products']
+        self.browser.getControl("Create CSV file").click()
+        self.assertEqual(self.browser.headers['Status'], '200 Ok')
+        self.assertTrue('div class="alert alert-danger">Export forbidden</div>'
+                         in self.browser.contents)
+        return
+
+    def test_export_start(self):
+        # we can trigger export file creation
+        self.browser.addHeader('Authorization', 'Basic mgr:mgrpw')
+        self.browser.open(self.datacenter_path)
+        self.assertEqual(self.browser.headers['Status'], '200 Ok')
+        self.assertEqual(self.browser.url, self.datacenter_path)
+        self.browser.getLink("Export data").click()
+        self.browser.getControl(name="exporter").value = ['products']
+        self.browser.getControl("Create CSV file").click()
+        # we can trigger export file creation only once
+        self.browser.getControl(name="exporter").value = ['pdfdocuments']
+        self.browser.getControl("Create CSV file").click()
+        self.assertTrue('Sorry, another export job is running.'
+                         in self.browser.contents)
+        self.wait_for_export_job_completed()
+        self.assertEqual(len(self.app['datacenter'].running_exports), 1)
+        self.browser.getControl(name="exporter").value = ['pdfdocuments']
+        self.browser.getControl("Create CSV file").click()
+        self.assertEqual(self.browser.headers['Status'], '200 Ok')
+        self.assertEqual(len(self.app['datacenter'].running_exports), 2)
+        # The second job is running
+        self.assertTrue('<img src="/static/img/actionicon_reload.png" />'
+                         in self.browser.contents)
+        self.cleanup_run_job() # make sure to remove temp dirs
+        # Also the second job must be cleaned up
+        manager = getUtility(IJobManager)
+        job_id = self.app['datacenter'].running_exports[1][0]
+        job = manager.get(job_id)
+        wait_for_result(job)
+        if os.path.exists(job.result):
+            shutil.rmtree(os.path.dirname(job.result))
+        return
+

main/waeup.ikoba/trunk/src/waeup/ikoba/interfaces.py

@@ -625 +625 @@
         )
 
+    export_disabled_message = schema.Text(
+        title = _(u'Export disabled message'),
+        description = _(u'This message will show up if an officer tries '
+                         'to export data. Setting this field automatically '
+                         'disables all exporters.'),
+        required = False,
+        )
+
 
 class IDataCenter(IIkobaObject):

main/waeup.ikoba/trunk/src/waeup/ikoba/utils/utils.py

@@ -338 +338 @@
                     return False
         return True
+
+    def export_disabled_message(self):
+        export_disabled_message = grok.getSite()[
+            'configuration'].export_disabled_message
+        if export_disabled_message:
+            return export_disabled_message
+        return None

main/waeup.ikoba/trunk/versions.cfg

@@ -20 +20 @@
 pycparser = 2.14
 requests = 2.9.1
+
+# Added by buildout at 2016-04-05 22:50:56.980778
+idna = 2.1