many updates to support kirk restore

Author: kjnether

FMEUtil/FMEUtil/FMEConstants.py

@@ -6,7 +6,6 @@
 used to keep track of property names used by fme rest api.
 '''
 from enum import Enum
-from lxml.html.builder import ACRONYM
 
 
 class Schedule(Enum):

FMEUtil/FMEUtil/PyFMEServerV2.py

@@ -71,7 +71,7 @@ def fixUrlPath(self, url):  # pylint: disable=no-self-use
         This is used when constructing urls to make sure the path can have
         another directory added to it using the urljoin method.
         '''
-        if url[len(url) - 1] <> '/':
+        if url[len(url) - 1] != '/':
             url = url + '/'
         return url
 
@@ -433,7 +433,22 @@ def addSchedule(self, scheduleDescription):
                                              detail='low')
         # print 'response', response
         self.logger.debug("response is: %s", response)
+    
+    def updateSchedule(self, category, scheduleName, scheduleDescription):
+        self.logger.debug("root schedule url: {0}".format(self.schedules.url))
+        url = self.schedules.baseObj.fixUrlPath(self.schedules.url)
 
+        # url = urlparse.urljoin(url, catEncode)
+        url = urlparse.urljoin(url, category)
+        url = self.schedules.baseObj.fixUrlPath(url)
+        # url = urlparse.urljoin(url, scheduleNameEncode)
+        url = urlparse.urljoin(url, scheduleName)
+        url = self.schedules.baseObj.fixUrlPath(url)
+        # print 'schedule url now:', url
+        self.logger.debug("schedule url: {0}".format(url))
+        header = {'Accept': 'application/json'}
+        self.baseObj.putResponse(url, header=header, data=scheduleDescription)
+    
     def delete(self, category, scheduleName):
         '''
         :param category: The name of the category that the job exists within
@@ -457,7 +472,7 @@ def delete(self, category, scheduleName):
         # print 'schedule url now:', url
         self.logger.debug("schedule url: {0}".format(url))
         header = {'Accept': 'application/json'}
-        response = self.baseObj.deleteResponse(url, header=header, acceptCodes=[204])
+        response = self.baseObj.putResponse(url, header=header, acceptCodes=[204])
         # print 'response', response
         return response
 

FMEUtil/FMEUtil/PyFMEServerV3.py

@@ -27,7 +27,6 @@
 
 import requests
 
-
 # pylint: disable=invalid-name
 
 
@@ -531,17 +530,77 @@ def delete(self, scheduleName, category):
         url = self.schedules.baseObj.fixUrlPath(url)
         self.logger.debug("schedule url now: %s", url)
         header = {'Accept': 'application/json'}
-        response = self.baseObj.deleteResponse(url, header=header, acceptCodes=[204])
+        response = self.baseObj.deleteResponse(url, header=header,
+                                               acceptCodes=[204])
         self.logger.debug("response is: %s", response)
         return response
 
-    def __setEnabledFlag(self, scheduleName, category, enabledFlag):
-        # first make sure the schedule exists, which at the same
-        # time will load the schedule list which can then be
-        # retrieved to determine if the schedule in question
-        # is enable or not, then if its status has changed
-        # we can resubmit that schedule as is but with the
-        # changed enable parameter
+    def updateParameters(self, scheduleName, category, newParams):
+        '''
+        used to update an existing parameter.  Quick fix to support
+        need to be able to automate update of kirk schedules.
+
+        :param scheduleName: Name of the schedule that is to be updated
+        :type scheduleName: str
+        :param category: Name of the category that is to be updated
+        :type category: str
+        :param newParams: a dictionary where the key is the parameter name
+                          and the value is the parameter value.
+        :type newParams: dict
+        '''
+        # makeing the keys all lower case.
+        paramsLowerCase = {}
+        for k, v in newParams.iteritems():
+            paramsLowerCase[k.lower()] = v
+
+        sched2Use = self.__verifyScheduleCategory(scheduleName, category)
+        url = self.__getScheduleCategoryUrl(scheduleName, category)
+        # update the params defined in sched2Use
+        pubParams = sched2Use['request']['publishedParameters']
+        paramCnt = 0
+        for param in pubParams:
+            paramValue = param['value']
+            paramName = param['name']
+            # now iterate through the list of new params
+            if paramName.lower() in paramsLowerCase:
+                pubParams[paramCnt]['value'] = \
+                    paramsLowerCase[paramName.lower()]
+                msg = 'updated {0} from {1} to {2}'.format(
+                    paramName, paramValue, paramsLowerCase[paramName.lower()])
+                self.logger.info(msg)
+            paramCnt += 1
+        sched2Use['request']['publishedParameters'] = pubParams
+        body = sched2Use
+        header = {'Content-Type': 'application/json',
+                  'Accept': 'application/json'}
+        bodyStr = json.dumps(body)
+        resp = self.baseObj.putResponse(url=url, data=bodyStr,
+                                        header=header)
+        return resp
+
+    def __getScheduleCategoryUrl(self, scheduleName, category):
+        catEncode = urllib.quote(category)
+        scheduleNameEncode = urllib.quote(scheduleName)
+        url = self.schedules.baseObj.fixUrlPath(self.schedules.url)
+        url = urlparse.urljoin(url, catEncode)
+        url = self.schedules.baseObj.fixUrlPath(url)
+        url = urlparse.urljoin(url, scheduleNameEncode)
+        return url
+
+    def __verifyScheduleCategory(self, scheduleName, category):
+        '''
+        checks to make sure that a given schedule and category actually
+        exist.  Will also return the data object that is currently associated
+        with a schedule / category.
+
+        :param scheduleName: name of the schedule to verify
+        :type scheduleName: str
+        :param category: name of the category to verify
+        :type category: str
+
+        :return: the data associated with the schedule and category provided
+                 as arguments
+        '''
         if not self.schedules.exists(scheduleName, category):
             msg = 'Cannot enable/disable the schedule: {0} in the category {1} ' + \
                   'as there is no schedule with this name and category'
@@ -555,17 +614,17 @@ def __setEnabledFlag(self, scheduleName, category, enabledFlag):
                     sched2Use = sched
                     break
         if not sched2Use:
-            msg = "Cannot enable/disable the schedule {0} in the category {1} as " + \
-                  "I am unable to find a schedule that matches this combination"
+            msg = "Cannot enable/disable the schedule {0} in the category" + \
+                  " {1} as I am unable to find a schedule that matches " + \
+                  "this combination"
             msg = msg.format(scheduleName, category)
-            raise ValueError, msg
+            raise ValueError(msg)
+        return sched2Use
+
+    def __setEnabledFlag(self, scheduleName, category, enabledFlag):
+        sched2Use = self.__verifyScheduleCategory(scheduleName, category)
+        url = self.__getScheduleCategoryUrl(scheduleName, category)
 
-        catEncode = urllib.quote(category)
-        scheduleNameEncode = urllib.quote(scheduleName)
-        url = self.schedules.baseObj.fixUrlPath(self.schedules.url)
-        url = urlparse.urljoin(url, catEncode)
-        url = self.schedules.baseObj.fixUrlPath(url)
-        url = urlparse.urljoin(url, scheduleNameEncode)
         validStrings = ['true', 'false']
         if isinstance(enabledFlag, bool):
             if enabledFlag:
@@ -578,7 +637,7 @@ def __setEnabledFlag(self, scheduleName, category, enabledFlag):
                       'this is not a valid value.  Supply either a boolean value ' + \
                       'or one of the following values: {1}'
                 msg = msg.format(enabledFlag, validStrings)
-                raise ValueError, msg
+                raise ValueError(msg)
             else:
                 enabledFlag = enabledFlag.lower()
         else:
@@ -587,7 +646,7 @@ def __setEnabledFlag(self, scheduleName, category, enabledFlag):
                   'Supply either a boolean value or a string with one of the ' + \
                   'following values: {2}'
             msg = msg.format(enabledFlag, type(enabledFlag), validStrings)
-            raise ValueError, msg
+            raise ValueError(msg)
 
         if enabledFlag == 'true':
             enabledFlagBool = True
@@ -596,15 +655,16 @@ def __setEnabledFlag(self, scheduleName, category, enabledFlag):
 
         # before proceed check to see if there is actually a change to the
         # enabled property of it is already set to whatever the target is.
-        if sched2Use[self.const.enabled] <> enabledFlagBool:
+        if sched2Use[self.const.enabled] != enabledFlagBool:
             sched2Use[self.const.enabled] = enabledFlag
             msg = "enabled flag: {0}".format(sched2Use[self.const.enabled])
             self.logger.debug(msg)
             body = sched2Use
             header = {'Content-Type': 'application/json',
-                      'Accept'      : 'application/json'}
+                      'Accept': 'application/json'}
             bodyStr = json.dumps(body)
-            resp = self.baseObj.putResponse(url=url, data=bodyStr, header=header)
+            resp = self.baseObj.putResponse(url=url, data=bodyStr,
+                                            header=header)
         return resp
 
     def disable(self, scheduleName, category):

KirkUtil/KirkUtil/PyKirk.py

@@ -437,6 +437,37 @@ def getTransformers(self, force=None):
             self.fldMaps = respJson
         return respJson
 
+    def postTransformer2(self, jobid, transformer_type, ts1_name, ts1_value,
+                         ts2_name, ts2_value, ts3_name, ts3_value,
+                         ts4_name, ts4_value, ts5_name, ts5_value,
+                         ts6_name, ts6_value):
+        p = constants.TransformerProperties
+        struct = {p.jobid.name: jobid,
+                  p.transformer_type.name: transformer_type,
+                  p.ts1_name.name: ts1_name,
+                  p.ts1_value.name: ts1_value,
+                  p.ts2_name.name: ts2_name,
+                  p.ts2_value.name: ts2_value,
+                  p.ts3_name.name: ts3_name,
+                  p.ts3_value.name: ts3_value,
+                  p.ts4_name.name: ts4_name,
+                  p.ts4_value.name: ts4_value,
+                  p.ts5_name.name: ts5_name,
+                  p.ts5_value.name: ts5_value,
+                  p.ts6_name.name: ts6_name,
+                  p.ts6_value.name: ts6_value}
+        resp = requests.post(self.transformerUrl,
+                             data=struct,
+                             headers=self.baseObj.authHeader)
+        self.logger.debug("response from transformer post: %s", resp.json())
+        if resp.status_code < 200 or resp.status_code >= 300:
+            msg = constants.POST_NON_200_ERROR_MSG.format(self.transformerUrl,
+                                                          resp.status_code,
+                                                          resp.text)
+            raise APIError(msg)
+        self.getTransformers(force=True)
+        return resp.json()
+
     def postTransformer(self, jobid, transformerType, parameters):
         '''
         :param jobid: the job id the transformer is related to