Finished CLI and Logging (Ready for PR)

Author: Sourabh Bollapragada

bmi_config.cfg

@@ -24,8 +24,6 @@ url = <base url for haas>
 # This section is for iscsi related config
 [iscsi]
 ip = <ip of iscsi server>
-# will be replaced with python script
-update_shell_url = <location of iscsci_update shell script>
 password = <sudo password for iscsi_update script>
 
 # this section is for rpc server config

ims/cli/cli.py

@@ -22,6 +22,15 @@
 _password = os.environ[constants.HAAS_PASSWORD_VARIABLE]
 
 
+def bmi_exception_wrapper(func):
+    def function_wrapper(*args,**kwargs):
+        try:
+            return func(*args,**kwargs)
+        except BMIException as e:
+            click.echo(str(e))
+
+    return function_wrapper
+
 @click.group()
 def cli():
     """
@@ -98,6 +107,7 @@ def deprovision(project, node, network, nic):
 @cli.command(name='showpro',
              short_help='Lists Provisioned Nodes')
 @click.argument(constants.PROJECT_PARAMETER)
+@bmi_exception_wrapper
 def list_provisioned_nodes(project):
     """
     Lists Provisioned Nodes under a Project.
@@ -243,14 +253,15 @@ def project_grp():
 
 
 @project_grp.command(name='ls', short_help='Lists Projects')
+@bmi_exception_wrapper
 def list_projects():
     """
     Lists Projects From DB
 
     \b
     WARNING = User Must be An Admin
     """
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.list_projects()
         if ret[constants.STATUS_CODE_KEY] == 200:
             table = PrettyTable(field_names=["Id", "Name", "Provision Network"])
@@ -266,6 +277,7 @@ def list_projects():
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.NETWORK_PARAMETER)
 @click.option('--id', default=None, help='Specify what id to use for project')
+@bmi_exception_wrapper
 def add_project(project, network, id):
     """
     Create Project in DB
@@ -278,7 +290,7 @@ def add_project(project, network, id):
     PROJECT = The Name of Project (A HIL Project must exist)
     NETWORK = The Name of the Provisioning Network
     """
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.add_project(project, network, id)
         if ret[constants.STATUS_CODE_KEY] == 200:
             click.echo("Success")
@@ -288,6 +300,7 @@ def add_project(project, network, id):
 
 @project_grp.command(name='rm', help='Deletes Project From DB')
 @click.argument(constants.PROJECT_PARAMETER)
+@bmi_exception_wrapper
 def delete_project(project):
     """
     Remove Project From DB
@@ -299,7 +312,7 @@ def delete_project(project):
     Arguments:
     PROJECT = The Name of Project (A HIL Project must exist)
     """
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.delete_project(project)
         if ret[constants.STATUS_CODE_KEY] == 200:
             click.echo("Success")
@@ -318,6 +331,7 @@ def db():
 @db.command(name='rm', help='Deletes Image From DB')
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.IMAGE_NAME_PARAMETER)
+@bmi_exception_wrapper
 def delete_image(project, img):
     """
     Delete Image in DB
@@ -330,7 +344,7 @@ def delete_image(project, img):
     PROJECT = The Name of Project
     IMG     = The Name of the Image to insert
     """
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.delete_image(project, img)
         if ret[constants.STATUS_CODE_KEY] == 200:
             click.echo("Success")
@@ -345,6 +359,7 @@ def delete_image(project, img):
 @click.option('--snap', is_flag=True, help='If image is snapshot')
 @click.option('--parent', default=None, help='Specify parent name')
 @click.option('--public', is_flag=True, help='If image is public')
+@bmi_exception_wrapper
 def add_image(project, img, id, snap, parent, public):
     """
     Create Image in DB
@@ -357,7 +372,7 @@ def add_image(project, img, id, snap, parent, public):
     PROJECT = The Name of Project (A HIL Project must exist)
     IMG = The Name of the Image to insert
     """
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.add_image(project, img, id, snap, parent, public)
         if ret[constants.STATUS_CODE_KEY] == 200:
             click.echo("Success")
@@ -372,6 +387,7 @@ def add_image(project, img, id, snap, parent, public):
 @click.option('--project', default=None, help='Filter By Project')
 @click.option('--name', default=None, help='Filter By Name')
 @click.option('--ceph', default=None, help="Filter By Ceph Name")
+@bmi_exception_wrapper
 def list_all_images(s, c, p, project, name, ceph):
     """
     List All Image Present in DB
@@ -400,7 +416,7 @@ def second_filter():
 
         return (f1 and f2 and f3) or f4
 
-    with BMI(_username, _password, "bmi_admin") as bmi:
+    with BMI(_username, _password, constants.BMI_ADMIN_PROJECT) as bmi:
         ret = bmi.list_all_images()
         if ret[constants.STATUS_CODE_KEY] == 200:
             table = PrettyTable(
@@ -430,6 +446,7 @@ def second_filter():
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.IMAGE_NAME_PARAMETER)
 @click.option('--snap', default=None, help='Specifies what snapshot to import')
+@bmi_exception_wrapper
 def import_ceph_image(project, img, snap):
     """
     Import an existing CEPH image into BMI
@@ -453,10 +470,11 @@ def import_ceph_image(project, img, snap):
 
 
 @cli.command(name='cp', help="Copy an existing image not clones")
-@click.argument('src_project')
-@click.argument('img1')
-@click.argument('dest_project')
-@click.argument('img2', default=None)
+@click.argument(constants.SRC_PROJECT_PARAMETER)
+@click.argument(constants.IMAGE1_NAME_PARAMETER)
+@click.argument(constants.DEST_PROJECT_PARAMETER)
+@click.argument(constants.IMAGE2_NAME_PARAMETER, default=None)
+@bmi_exception_wrapper
 def copy_image(src_project, img1, dest_project, img2):
     """
     Copy an image from one project to another
@@ -477,10 +495,11 @@ def copy_image(src_project, img1, dest_project, img2):
 
 
 @cli.command(name='mv', help='Move Image From Project to Another')
-@click.argument('src_project')
-@click.argument('img1')
-@click.argument('dest_project')
-@click.argument('img2', default=None)
+@click.argument(constants.SRC_PROJECT_PARAMETER)
+@click.argument(constants.IMAGE1_NAME_PARAMETER)
+@click.argument(constants.DEST_PROJECT_PARAMETER)
+@click.argument(constants.IMAGE2_NAME_PARAMETER, default=None)
+@bmi_exception_wrapper
 def move_image(src_project, img1, dest_project, img2):
     """
     Move an image from one project to another
@@ -508,6 +527,7 @@ def node():
 @node.command('ip', help='Get IP on Provisioning Network')
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.NODE_NAME_PARAMETER)
+@bmi_exception_wrapper
 def get_node_ip(project, node):
     """
     Get the IP of Provisioned Node on Provisioning Network
@@ -533,6 +553,7 @@ def iscsi():
 @iscsi.command(name='create', help='Create ISCSI Mapping')
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.IMAGE_NAME_PARAMETER)
+@bmi_exception_wrapper
 def create_mapping(project, img):
     """
     Mount image on iscsi server
@@ -556,6 +577,7 @@ def create_mapping(project, img):
 @iscsi.command(name='rm', help='Remove ISCSI Mapping')
 @click.argument(constants.PROJECT_PARAMETER)
 @click.argument(constants.IMAGE_NAME_PARAMETER)
+@bmi_exception_wrapper
 def delete_mapping(project, img):
     """
     Unmount image from iscsi server
@@ -578,6 +600,7 @@ def delete_mapping(project, img):
 
 @iscsi.command(name='ls', help='Show ISCSI Mappings')
 @click.argument(constants.PROJECT_PARAMETER)
+@bmi_exception_wrapper
 def show_mappings(project):
     """
     Show mounted images on iscsi

ims/common/config.py

@@ -36,7 +36,6 @@ def __init__(self, filename):
         self.fs = {}
         self.uid = None
         self.db_url = None
-        self.iscsi_update = None
         self.iscsi_update_password = None
         self.iscsi_ip = None
         self.haas_url = None
@@ -64,9 +63,6 @@ def parse_config(self):
             self.db_url = config.get(constants.DB_CONFIG_SECTION_NAME,
                                      constants.DB_URL_KEY)
 
-            self.iscsi_update = config.get(constants.ISCSI_CONFIG_SECTION_NAME,
-                                           constants.ISCSI_URL_KEY)
-
             self.iscsi_update_password = config.get(
                 constants.ISCSI_CONFIG_SECTION_NAME,
                 constants.ISCSI_PASSWORD_KEY)

ims/common/constants.py

@@ -25,7 +25,6 @@
 
 # Non FS Keys in Config File
 HAAS_URL_KEY = 'url'
-ISCSI_URL_KEY = 'update_shell_url'
 ISCSI_PASSWORD_KEY = 'password'
 ISCSI_IP_KEY = 'ip'
 
@@ -86,6 +85,10 @@
 IMAGE_NAME_PARAMETER = "img"
 SNAP_NAME_PARAMETER = "snap_name"
 PROJECT_PARAMETER = "project"
+SRC_PROJECT_PARAMETER = 'src_project'
+DEST_PROJECT_PARAMETER = "dest_project"
+IMAGE1_NAME_PARAMETER = "img1"
+IMAGE2_NAME_PARAMETER = "img2"
 NETWORK_PARAMETER = "network"
 NIC_PARAMETER = "nic"
 CHANNEL_PARAMETER = "channel"
@@ -105,5 +108,9 @@
 IET_TARGET_STARTING = 'Target'
 IET_LUN_STARTING = "Lun"
 
+DNSMASQ_LEASES_LOC = '/var/lib/misc/dnsmasq.leases'
+
 HAAS_CALL_TIMEOUT = 5
 DEFAULT_SNAPSHOT_NAME = "snapshot"
+
+BMI_ADMIN_PROJECT = "bmi_infra"

ims/common/log.py

@@ -31,7 +31,7 @@ def func_wrapper(*args, **kwargs):
         ret = func(*args, **kwargs)
         if func.__name__ == "__init__":
             logger.info(base_msg + "Successfully Initialised %s instance",
-                        type(list(args)[0]).__name__, extra={'special': True})
+                        list(args)[0].__class__.__name__, extra={'special': True})
         else:
             logger.info(base_msg + "Successfully Executed %s",
                         func.__name__, extra={'special': True})

ims/einstein/dnsmasq.py

@@ -1,9 +1,9 @@
 from ims.exception.dhcp_exceptions import *
-
+import ims.common.constants as constants
 
 class DNSMasq:
     def get_ip(self, mac_addr):
-        with open('/var/lib/misc/dnsmasq.leases', 'r') as file:
+        with open(constants.DNSMASQ_LEASES_LOC, 'r') as file:
             for line in file:
                 parts = line.strip().split(' ')
                 if parts[1] == mac_addr and parts[4] == '01:' + mac_addr:

ims/einstein/hil.py

@@ -10,7 +10,7 @@
 logger = create_logger(__name__)
 
 
-class HaaS:
+class HIL:
     class Request:
         def __init__(self, method, data, auth=None):
             self.method = method
@@ -71,14 +71,14 @@ def __init__(self, base_url, usr, passwd):
     @trace
     def __call_rest_api(self, api):
         link = urlparse.urljoin(self.base_url, api)
-        request = HaaS.Request('get', None, auth=(self.usr, self.passwd))
-        return HaaS.Communicator(link, request).send_request()
+        request = HIL.Request('get', None, auth=(self.usr, self.passwd))
+        return HIL.Communicator(link, request).send_request()
 
     @trace
     def __call_rest_api_with_body(self, api, body):
         link = urlparse.urljoin(self.base_url, api)
-        request = HaaS.Request('post', body, auth=(self.usr, self.passwd))
-        return HaaS.Communicator(link, request).send_request()
+        request = HIL.Request('post', body, auth=(self.usr, self.passwd))
+        return HIL.Communicator(link, request).send_request()
 
     @log
     def list_free_nodes(self):

ims/einstein/iscsi.py

@@ -1,6 +1,7 @@
 import subprocess
 
 import os
+import sh
 
 import ims.common.constants as constants
 from ims.exception import *
@@ -82,9 +83,7 @@ def __execute_unmap(self, rbd_name):
         output, err = p.communicate()
 
     def __execute_showmapped(self):
-        p = subprocess.Popen('rbd showmapped', shell=True,
-                             stdout=subprocess.PIPE)
-        output, err = p.communicate()
+        output = sh.rbd("showmapped")
         lines = output.split('\n')[1:-1]
         maps = {}
         for line in lines: