Merge pull request #6450 from fstagni/81_addHTTPS

[8.1] Add few Framework Tornado handlers

Author: fstagni

src/DIRAC/Core/Utilities/DictCache.py

@@ -27,7 +27,6 @@ class MockLockRing:
 
     def doNothing(self, *args, **kwargs):
         """Really does nothing !"""
-        pass
 
     acquire = release = doNothing
 
@@ -105,9 +104,9 @@ def exists(self, cKey, validSeconds=0):
                 # If it's valid return True!
                 if expTime > datetime.datetime.now() + datetime.timedelta(seconds=validSeconds):
                     return True
-                else:
-                    # Delete expired
-                    self.delete(cKey)
+
+                # Delete expired
+                self.delete(cKey)
             return False
         finally:
             self.lock.release()
@@ -159,9 +158,9 @@ def get(self, cKey, validSeconds=0):
                 # If it's valid return True!
                 if expTime > datetime.datetime.now() + datetime.timedelta(seconds=validSeconds):
                     return self.__cache[cKey]["value"]
-                else:
-                    # Delete expired
-                    self.delete(cKey)
+
+                # Delete expired
+                self.delete(cKey)
             return None
         finally:
             self.lock.release()
@@ -174,11 +173,11 @@ def showContentsInString(self):
         self.lock.acquire()
         try:
             data = []
-            for cKey in self.__cache:
-                data.append("%s:" % str(cKey))
-                data.append("\tExp: %s" % self.__cache[cKey]["expirationTime"])
-                if self.__cache[cKey]["value"]:
-                    data.append("\tVal: %s" % self.__cache[cKey]["value"])
+            for cKey, cValue in self.__cache.items():
+                data.append(f"{cKey}:")
+                data.append(f"\tExp: {cValue['expirationTime']}")
+                if cValue["value"]:
+                    data.append(f"\tVal: {cValue['Value']}")
             return "\n".join(data)
         finally:
             self.lock.release()
@@ -194,8 +193,8 @@ def getKeys(self, validSeconds=0):
         try:
             keys = []
             limitTime = datetime.datetime.now() + datetime.timedelta(seconds=validSeconds)
-            for cKey in self.__cache:
-                if self.__cache[cKey]["expirationTime"] > limitTime:
+            for cKey, cValue in self.__cache.items():
+                if cValue["expirationTime"] > limitTime:
                     keys.append(cKey)
             return keys
         finally:
@@ -210,13 +209,13 @@ def purgeExpired(self, expiredInSeconds=0):
         try:
             keys = []
             limitTime = datetime.datetime.now() + datetime.timedelta(seconds=expiredInSeconds)
-            for cKey in self.__cache:
-                if self.__cache[cKey]["expirationTime"] < limitTime:
+            for cKey, cValue in self.__cache.items():
+                if cValue["expirationTime"] < limitTime:
                     keys.append(cKey)
-            for cKey in keys:
+            for key in keys:
                 if self.__deleteFunction:
-                    self.__deleteFunction(self.__cache[cKey]["value"])
-                del self.__cache[cKey]
+                    self.__deleteFunction(self.__cache[key]["value"])
+                del self.__cache[key]
         finally:
             self.lock.release()
 

src/DIRAC/FrameworkSystem/ConfigTemplate.cfg

@@ -116,6 +116,17 @@ Services
       Default = authenticated
     }
   }
+  ##BEGIN TornadoUserProfileManager:
+  # Section to describe UserProfileManager service
+  TornadoUserProfileManager
+  {
+    Protocol = https
+    Authorization
+    {
+      Default = authenticated
+    }
+  }
+  ##END
   BundleDelivery
   {
     Port = 9158
@@ -155,6 +166,24 @@ Services
       ping = authenticated
     }
   }
+  ##BEGIN TornadoNotification:
+  # Section to describe Notification service
+  TornadoNotification
+  {
+    Protocol = https
+    SMSSwitch = sms.switch.ch
+    Authorization
+    {
+      Default = AlarmsManagement
+      sendMail = authenticated
+      sendSMS = authenticated
+      removeNotificationsForUser = authenticated
+      markNotificationsAsRead = authenticated
+      getNotifications = authenticated
+      ping = authenticated
+    }
+  }
+  ##END
   ComponentMonitoring
   {
     Port = 9190
@@ -170,6 +199,24 @@ Services
       updateLog = Operator
     }
   }
+  ##BEGIN TornadoComponentMonitoring:
+  # Section to describe ComponentMonitoring service
+  TornadoComponentMonitoring
+  {
+    Protocol = https
+    Authorization
+    {
+      Default = ServiceAdministrator
+      componentExists = authenticated
+      getComponents = authenticated
+      hostExists = authenticated
+      getHosts = authenticated
+      installationExists = authenticated
+      getInstallations = authenticated
+      updateLog = Operator
+    }
+  }
+  ##END
   RabbitMQSync
   {
     Port = 9192

src/DIRAC/FrameworkSystem/Service/BundleDeliveryHandler.py

@@ -83,11 +83,15 @@ def updateBundles(self):
 class BundleDeliveryHandlerMixin:
     @classmethod
     def initializeHandler(cls, serviceInfoDict):
+
+        ## FIXME: move to an agent
         csPath = serviceInfoDict["serviceSectionPath"]
         cls.bundleManager = BundleManager(csPath)
         updateBundleTime = gConfig.getValue("%s/BundlesLifeTime" % csPath, 3600 * 6)
         gLogger.info("Bundles will be updated each %s secs" % updateBundleTime)
         gThreadScheduler.addPeriodicTask(updateBundleTime, cls.bundleManager.updateBundles)
+        ##
+
         return S_OK()
 
     types_getListOfBundles = []

src/DIRAC/FrameworkSystem/Service/ComponentMonitoringHandler.py

@@ -14,7 +14,7 @@
 from DIRAC.Core.DISET.RequestHandler import RequestHandler
 
 
-class ComponentMonitoringHandler(RequestHandler):
+class ComponentMonitoringHandlerMixin:
     @classmethod
     def initializeHandler(cls, serviceInfo):
         """
@@ -330,3 +330,7 @@ def export_removeLogs(self, fields):
             return S_ERROR("Host does not exist")
 
         return ComponentMonitoringHandler.db.removeLogs(fields)
+
+
+class ComponentMonitoringHandler(ComponentMonitoringHandlerMixin, RequestHandler):
+    pass

src/DIRAC/FrameworkSystem/Service/NotificationHandler.py

@@ -12,25 +12,23 @@
     It can also be used to set alarms to be promptly forwarded to those
     subscribing to them.
 """
-from DIRAC import gConfig, S_OK, S_ERROR
-
+from DIRAC import S_ERROR, S_OK, gConfig
+from DIRAC.ConfigurationSystem.Client import PathFinder
 from DIRAC.Core.DISET.RequestHandler import RequestHandler
-from DIRAC.Core.Utilities.Mail import Mail
-from DIRAC.Core.Utilities.ThreadScheduler import gThreadScheduler
 from DIRAC.Core.Security import Properties
-from DIRAC.ConfigurationSystem.Client import PathFinder
-from DIRAC.FrameworkSystem.DB.NotificationDB import NotificationDB
 from DIRAC.Core.Utilities.DictCache import DictCache
+from DIRAC.Core.Utilities.Mail import Mail
+from DIRAC.FrameworkSystem.DB.NotificationDB import NotificationDB
 
 
-class NotificationHandler(RequestHandler):
+class NotificationHandlerMixin:
     @classmethod
     def initializeHandler(cls, serviceInfo):
         """Handler initialization"""
-        cls.notDB = NotificationDB()
+
         cls.mailCache = DictCache()
-        gThreadScheduler.addPeriodicTask(3600, cls.notDB.purgeExpiredNotifications)
-        gThreadScheduler.addPeriodicTask(3600, cls.mailCache.purgeExpired())
+        cls.notDB = NotificationDB()
+
         return S_OK()
 
     def initialize(self):
@@ -40,6 +38,8 @@ def initialize(self):
         self.clientProperties = credDict["properties"]
         self.client = credDict["username"]
 
+        self.notDB.purgeExpiredNotifications()
+
     ###########################################################################
     types_sendMail = [str, str, str, str]
 
@@ -270,3 +270,7 @@ def export_getNotifications(self, selectDict, sortList, startItem, maxItems):
         if Properties.ALARMS_MANAGEMENT not in credDict["properties"]:
             selectDict["user"] = [credDict["username"]]
         return self.notDB.getNotifications(selectDict, sortList, startItem, maxItems)
+
+
+class NotificationHandler(NotificationHandlerMixin, RequestHandler):
+    pass

src/DIRAC/FrameworkSystem/Service/TornadoComponentMonitoringHandler.py

@@ -0,0 +1,14 @@
+""" TornadoComponentMonitoring is the implementation of the ComponentMonitoringent service in HTTPS
+
+    .. literalinclude:: ../ConfigTemplate.cfg
+      :start-after: ##BEGIN TornadoComponentMonitoring:
+      :end-before: ##END
+      :dedent: 2
+      :caption: TornadoComponentMonitoring options
+"""
+from DIRAC.Core.Tornado.Server.TornadoService import TornadoService
+from DIRAC.FrameworkSystem.Service.ComponentMonitoringHandler import ComponentMonitoringHandlerMixin
+
+
+class TornadoComponentMonitoringHandler(ComponentMonitoringHandlerMixin, TornadoService):
+    pass

src/DIRAC/FrameworkSystem/Service/TornadoNotificationHandler.py

@@ -0,0 +1,14 @@
+""" TornadoNotification is the implementation of the Notification service in HTTPS
+
+    .. literalinclude:: ../ConfigTemplate.cfg
+      :start-after: ##BEGIN TornadoNotification:
+      :end-before: ##END
+      :dedent: 2
+      :caption: TornadoNotification options
+"""
+from DIRAC.Core.Tornado.Server.TornadoService import TornadoService
+from DIRAC.FrameworkSystem.Service.NotificationHandler import NotificationHandlerMixin
+
+
+class TornadoNotificationHandler(NotificationHandlerMixin, TornadoService):
+    pass

src/DIRAC/FrameworkSystem/Service/TornadoUserProfileManagerHandler.py

@@ -0,0 +1,14 @@
+""" TornadoUserProfileManager is the implementation of the UserProfileManager service in HTTPS
+
+    .. literalinclude:: ../ConfigTemplate.cfg
+      :start-after: ##BEGIN TornadoUserProfileManager:
+      :end-before: ##END
+      :dedent: 2
+      :caption: TornadoUserProfileManager options
+"""
+from DIRAC.Core.Tornado.Server.TornadoService import TornadoService
+from DIRAC.FrameworkSystem.Service.UserProfileManagerHandler import UserProfileManagerHandlerMixin
+
+
+class TornadoUserProfileManagerHandler(UserProfileManagerHandlerMixin, TornadoService):
+    pass

src/DIRAC/FrameworkSystem/Service/UserProfileManagerHandler.py

@@ -7,7 +7,7 @@
 from DIRAC.Core.Security import Properties
 
 
-class UserProfileManagerHandler(RequestHandler):
+class UserProfileManagerHandlerMixin:
     @classmethod
     def initializeHandler(cls, serviceInfo):
         """Handler initialization"""
@@ -145,3 +145,7 @@ def export_getUserProfileNames(self, permission):
         it returns the available profile names by not taking account the permission: ReadAccess and PublishAccess
         """
         return self.upDB.getUserProfileNames(permission)
+
+
+class UserProfileManagerHandler(UserProfileManagerHandlerMixin, RequestHandler):
+    pass

tests/CI/install_server.sh

@@ -100,7 +100,7 @@ then
     dirac-restart-component Configuration Server "$DEBUG"
     sleep 5
     dirac-restart-component Tornado Tornado -ddd
-  done< <(python -m DIRAC.Core.Utilities.Extensions findServices | grep Tornado | grep -v Configuration | sed -e 's/Handler//g' -e 's/System//g')
+  done< <(python -m DIRAC.Core.Utilities.Extensions findServices | grep Tornado | grep -v Configuration | grep -v ComponentMonitoring | sed -e 's/Handler//g' -e 's/System//g')
 
   echo -e "*** $(date -u) **** DONE Installing Tornado services"
 fi