enh: detect DCOR maintenance mode

Author: paulmueller

CHANGELOG

@@ -1,5 +1,6 @@
 0.17.0
  - BREAKING CHANGE: migrate codebase from PyQt5 to PyQt6
+ - enh: detect DCOR maintenance mode
  - tests: allow to use different DCOR instance for testing
  - tests: make tests independent of testing user
 0.16.11

dcoraid/api/ckan_api.py

@@ -16,7 +16,8 @@
 
 from .errors import (APIConflictError, APINotFoundError, NoAPIKeyError,
                      APIBadGatewayError, APIBadRequest, APIGatewayTimeoutError,
-                     APIAuthorizationError, APIOutdatedError)
+                     APIAuthorizationError, APIOutdatedError,
+                     ServerUnderMaintenanceError)
 
 #: Minimum required CKAN version on the server side
 MIN_CKAN_VERSION = "2.9.4"
@@ -267,6 +268,17 @@ def is_available(self, with_api_key=False, with_correct_version=False):
                 status = True
         return status
 
+    def is_under_maintenance(self):
+        """Check whether DCOR is under maintenance"""
+        maintenance = False
+        try:
+            self.get("status_show")
+        except ServerUnderMaintenanceError:
+            maintenance = True
+        except BaseException:
+            pass
+        return maintenance
+
     def get(self,
             api_call: str,
             timeout: float = 27.9,
@@ -302,6 +314,10 @@ def get(self,
                                headers=self.headers,
                                verify=self.verify,
                                timeout=timeout)
+
+        if req.status_code == 503:
+            raise ServerUnderMaintenanceError(
+                "DCOR under maintenance. Please try again later.")
         rdata = self.handle_response(req, api_call)
         return rdata["result"]
 

dcoraid/api/errors.py

@@ -49,5 +49,10 @@ class NoS3UploadAvailableError(BaseException):
 
 
 class S3UploadError(BaseException):
-    """raised when an upload to S3 failed"""
+    """Raised when an upload to S3 failed"""
+    pass
+
+
+class ServerUnderMaintenanceError(BaseException):
+    """Raised when the DCOR server is under maintenance"""
     pass

dcoraid/gui/status_widget.py

@@ -116,8 +116,12 @@ def run(self):
         api = get_ckan_api()
 
         if not api.is_available():
-            text = "No connection"
-            tip = f"Can you access {api.server} via a browser?"
+            if api.is_under_maintenance():
+                text = "Under Maintenance"
+                tip = "Please wait until maintenance is complete"
+            else:
+                text = "No connection"
+                tip = f"Can you access {api.server} via a browser?"
             icon = "hourglass"
         elif not api.is_available(with_correct_version=True):
             text = "Server out of date"

tests/test_api_base.py

@@ -7,6 +7,12 @@
 from . import common
 
 
+def test_api_no_maintenance():
+    """Normally, the DCOR instance should not be under maintenance"""
+    api = common.get_api()
+    assert not api.is_under_maintenance()
+
+
 def test_api_requests_cache_no_parameters():
     """Test the requests_cache for an API call *without* parameters"""
     api = common.get_api()