autoconfig: refactoring and adding test cases

 Refactoring the code to use constants for repeatedly used
strings and add some test case.

Change-Id: I7c88231a51ceea3b1cc94223018ecc704b657512
Bug-Url: https://bugzilla.redhat.com/1099093
Bug-Url: https://bugzilla.redhat.com/1099328
Signed-off-by: Ramesh Nachimuthu <rnachimu@redhat.com>
Reviewed-on: http://review.gluster.org/7883
Reviewed-by: Sahina Bose <sabose@redhat.com>

2 files changed, 50 insertions, 43 deletions

diff --git a/plugins/config_generator.py b/plugins/config_generator.py
index 1d0ed37..a5e52f8 100644
--- a/plugins/config_generator.py
+++ b/plugins/config_generator.py
@@ -23,6 +23,7 @@ from pynag import Model
 import server_utils
 from glusternagios.glustercli import HostStatus
 
+
 """
 Change mode helps to identify the change in the defintion.
 "ADD" means the entity and all its sub entities are added.
@@ -30,14 +31,17 @@ Change mode helps to identify the change in the defintion.
 "UPDATE" means the entity is changes. It may also means sub entities
 are added or removed to the entity.
 """
+CHANGE_MODE = 'changeMode'
 CHANGE_MODE_ADD = "ADD"
 CHANGE_MODE_REMOVE = "REMOVE"
 CHANGE_MODE_UPDATE = "UPDATE"
+HOST_SERVICES = 'host_services'
 GENERATED_BY_AUTOCONFIG = "__GENERATED_BY_AUTOCONFIG"
 VOL_NAME = '_VOL_NAME'
 BRICK_DIR = '_BRICK_DIR'
 HOST_UUID = '_HOST_UUID'
 NOTES = 'notes'
+GLUSTER_AUTO_CONFIG = "Cluster Auto Config"
 SERVICE_FIELDS_TO_FORCE_SYNC = [VOL_NAME, NOTES]
 
 
@@ -61,7 +65,7 @@ class GlusterNagiosConfManager:
         #Host service is not a field in host configuration. It helps to
         #aggregate all the host services under the host
         if services:
-            host['host_services'] = services
+            host[HOST_SERVICES] = services
         if uuid:
             host[HOST_UUID] = uuid
         return host
@@ -149,7 +153,7 @@ class GlusterNagiosConfManager:
         service['host_name'] = clusterName
         service['use'] = 'gluster-service'
         service['check_interval'] = '1440'
-        service['service_description'] = 'Cluster Auto Config'
+        service['service_description'] = GLUSTER_AUTO_CONFIG
         service['check_command'] = "gluster_auto_discovery!%s" % (hostIp)
         return service
 
@@ -265,7 +269,7 @@ class GlusterNagiosConfManager:
     #Host group should contain the delta to be written to the configuration.
     #Delta will be processed using the change mode.
     def writeHostGroup(self, hostgroup):
-        changeMode = hostgroup['changeMode']
+        changeMode = hostgroup[CHANGE_MODE]
         if changeMode == CHANGE_MODE_ADD:
             hostgroupModel = Model.Hostgroup()
             hostgroupModel['hostgroup_name'] = hostgroup['hostgroup_name']
@@ -285,25 +289,25 @@ class GlusterNagiosConfManager:
     #used to represent the config model and changes.
     def fillModel(self, model, values):
         for key, value in values.iteritems():
-            if key not in ['changeMode', 'host_services']:
+            if key not in [CHANGE_MODE, HOST_SERVICES]:
                 model[key] = value
         return model
 
     #Write service to nagios config
     def writeService(self, service, hostname):
-        if service['changeMode'] == CHANGE_MODE_ADD:
+        if service[CHANGE_MODE] == CHANGE_MODE_ADD:
             serviceModel = Model.Service()
             serviceModel = self.fillModel(serviceModel, service)
             serviceModel.set_filename(self.getCfgFileName(hostname))
             serviceModel[GENERATED_BY_AUTOCONFIG] = 1
             serviceModel.save()
-        elif service['changeMode'] == CHANGE_MODE_REMOVE:
+        elif service[CHANGE_MODE] == CHANGE_MODE_REMOVE:
             serviceModel = Model.Service.objects.filter(
                 host_name=hostname,
                 service_description=service['service_description'])
             if serviceModel:
                 serviceModel[0].delete()
-        elif service['changeMode'] == CHANGE_MODE_UPDATE:
+        elif service[CHANGE_MODE] == CHANGE_MODE_UPDATE:
             serviceModel = server_utils.getServiceConfig(
                 service['service_description'], service['host_name'])
             self.fillModel(serviceModel, service)
@@ -313,32 +317,32 @@ class GlusterNagiosConfManager:
     #host_services filed contains the list of services to be written to
     #nagios configuration
     def writeHostServices(self, host):
-        for service in host['host_services']:
-            if service.get('changeMode') is None:
-                service['changeMode'] = host['changeMode']
+        for service in host[HOST_SERVICES]:
+            if service.get(CHANGE_MODE) is None:
+                service[CHANGE_MODE] = host[CHANGE_MODE]
             self.writeService(service, host['host_name'])
 
     #Write the host configuration with list of services to nagios configuration
     def writeHost(self, host):
-        if host['changeMode'] == CHANGE_MODE_REMOVE:
+        if host[CHANGE_MODE] == CHANGE_MODE_REMOVE:
             hostModel = Model.Host.objects.filter(
                 host_name=host['host_name'])
             if hostModel:
                 hostModel[0].delete(recursive=True)
             return
-        if host['changeMode'] == CHANGE_MODE_ADD:
+        if host[CHANGE_MODE] == CHANGE_MODE_ADD:
             hostModel = Model.Host()
             hostModel = self.fillModel(hostModel, host)
             hostModel.set_filename(self.getCfgFileName(host['host_name']))
             hostModel.save()
 
-        if host.get('host_services'):
+        if host.get(HOST_SERVICES):
             self.writeHostServices(host)
 
     def writeHosts(self, hosts, chageMode):
         for host in hosts:
-            if host.get('changeMode') is None:
-                host['changeMode'] = chageMode
+            if host.get(CHANGE_MODE) is None:
+                host[CHANGE_MODE] = chageMode
             self.writeHost(host)
 
     #Write the hostgroup delta to nagios configuration.
diff --git a/plugins/discovery.py b/plugins/discovery.py
index 514dc22..18dc714 100755
--- a/plugins/discovery.py
+++ b/plugins/discovery.py
@@ -30,11 +30,14 @@ import submit_external_command
 from constants import DEFAULT_AUTO_CONFIG_DIR
 
 
+from config_generator import CHANGE_MODE
 from config_generator import CHANGE_MODE_ADD
 from config_generator import CHANGE_MODE_REMOVE
 from config_generator import CHANGE_MODE_UPDATE
 from config_generator import GENERATED_BY_AUTOCONFIG
 from config_generator import SERVICE_FIELDS_TO_FORCE_SYNC
+from config_generator import HOST_SERVICES
+from config_generator import GLUSTER_AUTO_CONFIG
 
 
 #Discovers volumes info one by one.
@@ -167,12 +170,12 @@ def findDeletedServices(host):
         #Consider only the service generated by autoconfig
         if not serviceConfig[GENERATED_BY_AUTOCONFIG]:
             continue
-        service = findServiceInList(host.get('host_services', []),
+        service = findServiceInList(host.get(HOST_SERVICES, []),
                                     serviceConfig['service_description'])
         if service is None:
             deletedService.append(
                 {'service_description': serviceConfig['service_description'],
-                 'changeMode': CHANGE_MODE_REMOVE})
+                 CHANGE_MODE: CHANGE_MODE_REMOVE})
     return deletedService
 
 
@@ -187,7 +190,7 @@ def findChangeInService(newService, oldService):
                 changes['service_description'] = \
                     newService['service_description']
                 changes['host_name'] = newService['host_name']
-                changes['changeMode'] = CHANGE_MODE_UPDATE
+                changes[CHANGE_MODE] = CHANGE_MODE_UPDATE
             changes[field] = newService.get(field)
     return changes
 
@@ -204,7 +207,7 @@ def findChangeInAutoConfig(newService, oldService):
         changes['check_command'] = "!".join(checkCommand)
         changes['service_description'] = newService['service_description']
         changes['host_name'] = newService['host_name']
-        changes['changeMode'] = CHANGE_MODE_UPDATE
+        changes[CHANGE_MODE] = CHANGE_MODE_UPDATE
         return changes
     return None
 
@@ -215,13 +218,13 @@ def findChangeInAutoConfig(newService, oldService):
 #have to update the host ip in existing auto-config service.
 def findServiceDelta(host):
     serviceDelta = []
-    for service in host.get('host_services', []):
+    for service in host.get(HOST_SERVICES, []):
         serviceConfig = server_utils.getServiceConfig(
             service['service_description'], service['host_name'])
         if serviceConfig is None:
-            service['changeMode'] = CHANGE_MODE_ADD
+            service[CHANGE_MODE] = CHANGE_MODE_ADD
             serviceDelta.append(service)
-        elif serviceConfig['service_description'] == "Cluster Auto Config":
+        elif serviceConfig['service_description'] == GLUSTER_AUTO_CONFIG:
             changes = findChangeInAutoConfig(service, serviceConfig)
             if changes:
                 serviceDelta.append(changes)
@@ -239,13 +242,13 @@ def findAddUpdateHosts(hosts):
     for host in hosts:
         hostConfing = server_utils.getHostConfigByName(host['host_name'])
         if hostConfing is None:
-            host['changeMode'] = CHANGE_MODE_ADD
+            host[CHANGE_MODE] = CHANGE_MODE_ADD
             delta.append(host)
         else:
             serviceDelta = findServiceDelta(host)
             if serviceDelta:
-                host['changeMode'] = CHANGE_MODE_UPDATE
-                host['host_services'] = serviceDelta
+                host[CHANGE_MODE] = CHANGE_MODE_UPDATE
+                host[HOST_SERVICES] = serviceDelta
                 delta.append(host)
     return delta
 
@@ -259,7 +262,7 @@ def findDeletedHosts(hostgroup, hosts, ignoredHosts):
             host = findHostInList(hosts, hostConfig['host_name'])
             if host is None:
                 deletedHosts.append({'host_name': hostConfig['host_name'],
-                                     'changeMode': CHANGE_MODE_REMOVE})
+                                     CHANGE_MODE: CHANGE_MODE_REMOVE})
     return deletedHosts
 
 
@@ -281,14 +284,14 @@ def findDelta(clusterConfig, ignoredHosts):
 
     hostgroup = server_utils.getHostGroup(clusterConfig['hostgroup_name'])
     if hostgroup is None:
-        delta['changeMode'] = CHANGE_MODE_ADD
+        delta[CHANGE_MODE] = CHANGE_MODE_ADD
         delta['_hosts'] = clusterConfig['_hosts']
         return delta
 
     hostDelta = findHostDelta(clusterConfig, ignoredHosts)
     delta['_hosts'] = hostDelta
     if hostDelta:
-        delta['changeMode'] = CHANGE_MODE_UPDATE
+        delta[CHANGE_MODE] = CHANGE_MODE_UPDATE
     return delta
 
 
@@ -330,18 +333,18 @@ def cleanConfigDir(dir):
 #string to get the proper format in mail.
 def getSummary(clusterDelta):
     summary = "\nChanges :"
-    clusterChangeMode = clusterDelta['changeMode']
+    clusterChangeMode = clusterDelta[CHANGE_MODE]
     summary += "\nHostgroup %s - %s" % (clusterDelta['hostgroup_name'],
                                         clusterChangeMode)
     for host in clusterDelta['_hosts']:
-        if host.get('changeMode'):
-            changeMode = host.get('changeMode')
+        if host.get(CHANGE_MODE):
+            changeMode = host.get(CHANGE_MODE)
         else:
             changeMode = clusterChangeMode
         summary += "\nHost %s - %s" % (host['host_name'], changeMode)
-        for service in host.get('host_services', []):
-            if service.get('changeMode'):
-                changeMode = service.get('changeMode')
+        for service in host.get(HOST_SERVICES, []):
+            if service.get(CHANGE_MODE):
+                changeMode = service.get(CHANGE_MODE)
             summary += "\n\t Service - %s -%s " % \
                        (service['service_description'], changeMode)
     return summary
@@ -358,8 +361,8 @@ def formatTextForMail(text):
 def configureNodes(clusterDelta, nagiosServerAddress, mode, timeout):
     for host in clusterDelta['_hosts']:
         #Only when a new node is added or whole cluster is added freshly.
-        if (clusterDelta.get('changeMode') == CHANGE_MODE_ADD or
-                host.get('changeMode') == CHANGE_MODE_ADD) \
+        if (clusterDelta.get(CHANGE_MODE) == CHANGE_MODE_ADD or
+                host.get(CHANGE_MODE) == CHANGE_MODE_ADD) \
                 and (host['use'] == 'gluster-host'):
             if not nagiosServerAddress:
                 #Nagios server address should be specified as arg in auto mode
@@ -388,8 +391,8 @@ def configureNodes(clusterDelta, nagiosServerAddress, mode, timeout):
 #server address. This is needed for the auto config to configure nodes in
 #'auto' mode.
 def updateNagiosAddressInAutoConfig(clusterHostConfig, nagiosServerAddress):
-    autoConfigService = findServiceInList(clusterHostConfig['host_services'],
-                                          "Cluster Auto Config")
+    autoConfigService = findServiceInList(clusterHostConfig[HOST_SERVICES],
+                                          GLUSTER_AUTO_CONFIG)
     if autoConfigService and nagiosServerAddress:
         checkCommandParams = autoConfigService['check_command'].split("!")
         if len(checkCommandParams) == 2:
@@ -423,7 +426,7 @@ def writeDelta(clusterDelta,
 def getNagiosAddress(clusterName):
     #If there is an auto config service exist for the cluster, then we have
     #to use the previously entered nagios server address
-    autoConfigService = server_utils.getServiceConfig("Cluster Auto Config",
+    autoConfigService = server_utils.getServiceConfig(GLUSTER_AUTO_CONFIG,
                                                       clusterName)
     if autoConfigService:
         nagiosAddress = autoConfigService['check_command'].split("!")[2]
@@ -465,8 +468,8 @@ def getConfirmation(message, default):
 #Send a custom notification about the config changes to admin
 def sendCustomNotification(cluster, summary):
     now = datetime.datetime.now()
-    cmdStr = "[%s] SEND_CUSTOM_SVC_NOTIFICATION;%s;Cluster Auto Config;0;" \
-             "Nagios Admin;%s\n" % (now, cluster, summary)
+    cmdStr = "[%s] SEND_CUSTOM_SVC_NOTIFICATION;%s;%s;0;" \
+             "Nagios Admin;%s\n" % (now, cluster, GLUSTER_AUTO_CONFIG, summary)
     submit_external_command.submitExternalCommand(cmdStr)
 
 
@@ -504,12 +507,12 @@ if __name__ == '__main__':
     configManager = getConfigManager(args)
     clusterDelta = configManager.generateNagiosConfig(clusterdata)
     if args.force:
-        clusterDelta['changeMode'] = CHANGE_MODE_ADD
+        clusterDelta[CHANGE_MODE] = CHANGE_MODE_ADD
     else:
         nonConnectedHosts = getAllNonConnectedHosts(clusterdata['hosts'])
         clusterDelta = findDelta(clusterDelta, nonConnectedHosts)
 
-    if clusterDelta.get('changeMode') is None:
+    if clusterDelta.get(CHANGE_MODE) is None:
         print "Cluster configurations are in sync"
         sys.exit(utils.PluginStatusCode.OK)
     #When auto config is run in manual mode, we will ask confirmation