Refactor functest environment. Bugfixes: arguments missing
[functest.git] / testcases / config_functest.py
index ad804d1..5a3fcbb 100644 (file)
@@ -8,30 +8,17 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 #
 
-import re, json, os, urllib2, argparse, logging, shutil, subprocess
+import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml, sys
 from git import Repo
 
-actions = ['start', 'check', 'clean']
-
-""" global variables """
-functest_dir = os.environ['HOME'] + '/.functest/'
-#image_url = 'https://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img'
-image_url = 'http://download.cirros-cloud.net/0.3.0/cirros-0.3.0-i386-disk.img'
-
-image_disk_format = 'raw'
-image_name = image_url.rsplit('/')[-1]
-image_path = functest_dir + image_name
-rally_repo_dir = functest_dir + "Rally_repo/"
-rally_test_dir = functest_dir + "Rally_test/"
-bench_tests_dir = rally_test_dir + "scenarios/"
-rally_installation_dir = os.environ['HOME'] + "/.rally"
-vPing_dir = functest_dir + "vPing/"
-odl_dir = functest_dir + "ODL/"
-
+from neutronclient.v2_0 import client
 
+actions = ['start', 'check', 'clean']
 parser = argparse.ArgumentParser()
+parser.add_argument("repo_path", help="Path to the repository")
 parser.add_argument("action", help="Possible actions are: '{d[0]}|{d[1]}|{d[2]}' ".format(d=actions))
 parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
+parser.add_argument("-f", "--force", help="Force",  action="store_true")
 args = parser.parse_args()
 
 
@@ -49,126 +36,209 @@ formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(messag
 ch.setFormatter(formatter)
 logger.addHandler(ch)
 
+if not os.path.exists(args.repo_path):
+    logger.error("Repo directory not found '%s'" % args.repo_path)
+    exit(-1)
 
+with open(args.repo_path+"testcases/config_functest.yaml") as f:
+    functest_yaml = yaml.safe_load(f)
+f.close()
 
-def config_functest_start():
+
+
+
+""" global variables """
+# Directories
+HOME = os.environ['HOME']+"/"
+REPO_PATH = args.repo_path
+RALLY_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_rally")
+RALLY_REPO_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_repo")
+RALLY_INSTALLATION_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_inst")
+VPING_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_vping")
+ODL_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_odl")
+
+# NEUTRON Private Network parameters
+NEUTRON_PRIVATE_NET_NAME = functest_yaml.get("general").get("openstack").get("neutron_private_net_name")
+NEUTRON_PRIVATE_SUBNET_NAME = functest_yaml.get("general").get("openstack").get("neutron_private_subnet_name")
+NEUTRON_PRIVATE_SUBNET_CIDR = functest_yaml.get("general").get("openstack").get("neutron_private_subnet_cidr")
+ROUTER_NAME = functest_yaml.get("general").get("openstack").get("neutron_router_name")
+
+#GLANCE image parameters
+IMAGE_URL = functest_yaml.get("general").get("openstack").get("image_url")
+IMAGE_DISK_FORMAT = functest_yaml.get("general").get("openstack").get("image_disk_format")
+IMAGE_NAME = functest_yaml.get("general").get("openstack").get("image_name")
+IMAGE_FILE_NAME = IMAGE_URL.rsplit('/')[-1]
+IMAGE_DIR = HOME + functest_yaml.get("general").get("openstack").get("image_download_path")
+IMAGE_PATH = IMAGE_DIR + IMAGE_FILE_NAME
+
+
+credentials = None
+neutron_client = None
+
+def action_start():
     """
     Start the functest environment installation
     """
-    if config_functest_check():
-        logger.info("Functest environment already installed in %s. Nothing to do." %functest_dir)
-        exit(0)
-    elif not check_internet_connectivity():
+    if not check_internet_connectivity():
         logger.error("There is no Internet connectivity. Please check the network configuration.")
         exit(-1)
-    elif not check_credentials():
-        logger.error("Please source the openrc credentials and run the script again.")
-        #TODO: source the credentials in this script
-        exit(-1)
-    else:
-        config_functest_clean()
 
-        logger.info("Starting installationg of functest environment in %s" %functest_dir)
-        os.makedirs(functest_dir)
-        if not os.path.exists(functest_dir):
-            logger.error("There has been a problem while creating the environment directory.")
-            exit(-1)
+    if action_check():
+        logger.info("Functest environment already installed. Nothing to do.")
+        exit(0)
 
-        logger.info("Donwloading test scripts and scenarios...")
-        if not download_tests():
-            logger.error("There has been a problem while downloading the test scripts and scenarios.")
-            config_functest_clean()
-            exit(-1)
+    else:
+        # Clean in case there are left overs
+        logger.debug("Cleaning possible functest environment leftovers.")
+        action_clean()
 
+        logger.info("Starting installation of functest environment")
         logger.info("Installing Rally...")
         if not install_rally():
             logger.error("There has been a problem while installing Rally.")
-            config_functest_clean()
+            action_clean()
             exit(-1)
 
         logger.info("Installing ODL environment...")
         if not install_odl():
             logger.error("There has been a problem while installing Robot.")
-            config_functest_clean()
+            action_clean()
             exit(-1)
 
+        credentials = get_credentials()
+        neutron_client = client.Client(**credentials)
+
+        logger.info("Configuring Neutron...")
+        logger.info("Checking if private network '%s' exists..." % NEUTRON_PRIVATE_NET_NAME)
+        #Now: if exists we don't create it again (the clean command does not clean the neutron networks yet)
+        if check_neutron_net(neutron_client, NEUTRON_PRIVATE_NET_NAME):
+            logger.info("Private network '%s' found. No need to create another one." % NEUTRON_PRIVATE_NET_NAME)
+        else:
+            logger.info("Private network '%s' not found. Creating..." % NEUTRON_PRIVATE_NET_NAME)
+            if not create_private_neutron_net(neutron_client):
+                logger.error("There has been a problem while creating the Neutron network.")
+                #action_clean()
+                exit(-1)
+
+
         logger.info("Donwloading image...")
-        if not download_url_with_progress(image_url, functest_dir):
+        if not download_url(IMAGE_URL, IMAGE_DIR):
             logger.error("There has been a problem while downloading the image.")
-            config_functest_clean()
+            action_clean()
             exit(-1)
 
-        logger.info("Creating Glance image: %s ..." %image_name)
-        if not create_glance_image(image_path,image_name,image_disk_format):
+        logger.info("Creating Glance image: %s ..." %IMAGE_NAME)
+        if not create_glance_image(IMAGE_PATH,IMAGE_NAME,IMAGE_DISK_FORMAT):
             logger.error("There has been a problem while creating the Glance image.")
-            config_functest_clean()
+            action_clean()
             exit(-1)
 
         exit(0)
 
 
-
-def config_functest_check():
+def action_check():
     """
     Check if the functest environment is properly installed
     """
+    errors_all = False
+
     logger.info("Checking current functest configuration...")
+    credentials = get_credentials()
+    neutron_client = client.Client(**credentials)
 
     logger.debug("Checking directories...")
-    dirs = [functest_dir, rally_installation_dir, rally_repo_dir, rally_test_dir, bench_tests_dir, vPing_dir, odl_dir]
+    errors = False
+    dirs = [RALLY_DIR, RALLY_INSTALLATION_DIR, VPING_DIR, ODL_DIR]
     for dir in dirs:
         if not os.path.exists(dir):
-            logger.debug("The directory %s does not exist." %dir)
-            return False
-        logger.debug("   %s found" % dir)
+            logger.debug("The directory '%s' does NOT exist." % dir)
+            errors = True
+            errors_all = True
+        else:
+            logger.debug("   %s found" % dir)
+    if not errors:
+        logger.debug("...OK")
+    else:
+        logger.debug("...FAIL")
+
 
-    logger.debug("...OK")
     logger.debug("Checking Rally deployment...")
     if not check_rally():
-        logger.debug("Rally deployment not found.")
-        return False
-    logger.debug("...OK")
+        logger.debug("   Rally deployment NOT found.")
+        errors_all = True
+        logger.debug("...FAIL")
+    else:
+        logger.debug("...OK")
+
+
+    logger.debug("Checking Neutron...")
+    if not check_neutron_net(neutron_client, NEUTRON_PRIVATE_NET_NAME):
+        logger.debug("   Private network '%s' NOT found." % NEUTRON_PRIVATE_NET_NAME)
+        logger.debug("...FAIL")
+        errors_all = True
+    else:
+        logger.debug("   Private network '%s' found." % NEUTRON_PRIVATE_NET_NAME)
+        logger.debug("...OK")
+
 
     logger.debug("Checking Image...")
-    if not os.path.isfile(image_path):
-        return False
-    logger.debug("   Image file found in %s" %image_path)
+    errors = False
+    if not os.path.isfile(IMAGE_PATH):
+        logger.debug("   Image file '%s' NOT found." % IMAGE_PATH)
+        errors = True
+        errors_all = True
+    else:
+        logger.debug("   Image file found in %s" % IMAGE_PATH)
 
-    cmd="glance image-list | grep " + image_name
+    cmd="glance image-list | grep " + IMAGE_NAME
     FNULL = open(os.devnull, 'w');
     logger.debug('   Executing command : {}'.format(cmd))
     p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
     #if the command does not exist or there is no glance image
     line = p.stdout.readline()
     if line == "":
-        logger.debug("   Glance image not found")
-        return False
-    logger.debug("   Glance image found")
-    logger.debug("...OK")
+        logger.debug("   Glance image NOT found.")
+        errors = True
+        errors_all = True
+    else:
+        logger.debug("   Glance image found.")
 
-    #TODO: check OLD environment setup
+    if not errors:
+        logger.debug("...OK")
+    else:
+        logger.debug("...FAIL")
 
-    return True
+    #TODO: check OLD environment setup
+    if errors_all:
+        return False
+    else:
+        return True
 
 
 
 
-def config_functest_clean():
+def action_clean():
     """
     Clean the existing functest environment
     """
     logger.info("Removing current functest environment...")
-    if os.path.exists(rally_installation_dir):
-        logger.debug("Removing rally installation directory %s" % rally_installation_dir)
-        shutil.rmtree(rally_installation_dir,ignore_errors=True)
+    if os.path.exists(RALLY_INSTALLATION_DIR):
+        logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
+        shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
 
-    if os.path.exists(functest_dir):
-        logger.debug("Removing functest directory %s" % functest_dir)
-        cmd = "sudo rm -rf " + functest_dir #need to be sudo, not possible with rmtree
+    if os.path.exists(RALLY_REPO_DIR):
+        logger.debug("Removing Rally repository %s" % RALLY_REPO_DIR)
+        cmd = "sudo rm -rf " + RALLY_REPO_DIR #need to be sudo, not possible with rmtree
         execute_command(cmd)
+    #logger.debug("Deleting Neutron network %s" % NEUTRON_PRIVATE_NET_NAME)
+    #if not delete_neutron_net() :
+    #    logger.error("Error deleting the network. Remove it manually.")
 
     logger.debug("Deleting glance images")
-    cmd = "glance image-list | grep "+image_name+" | cut -c3-38"
+    if os.path.exists(IMAGE_PATH):
+        os.remove(IMAGE_PATH)
+
+    cmd = "glance image-list | grep "+IMAGE_NAME+" | cut -c3-38"
     p = os.popen(cmd,"r")
 
     #while image_id = p.readline()
@@ -179,16 +249,19 @@ def config_functest_clean():
     return True
 
 
+
+
+
 def install_rally():
     if check_rally():
         logger.info("Rally is already installed.")
     else:
         logger.debug("Cloning repository...")
         url = "https://git.openstack.org/openstack/rally"
-        Repo.clone_from(url, rally_repo_dir)
+        Repo.clone_from(url, RALLY_REPO_DIR)
 
-        logger.debug("Executing %s./install_rally.sh..." %rally_repo_dir)
-        install_script = rally_repo_dir + "install_rally.sh"
+        logger.debug("Executing %s./install_rally.sh..." %RALLY_REPO_DIR)
+        install_script = RALLY_REPO_DIR + "install_rally.sh"
         cmd = 'sudo ' + install_script
         execute_command(cmd)
         #subprocess.call(['sudo', install_script])
@@ -219,8 +292,8 @@ def check_rally():
     """
     Check if Rally is installed and properly configured
     """
-    if os.path.exists(rally_installation_dir):
-        logger.debug("   Rally installation directory found in %s" % rally_installation_dir)
+    if os.path.exists(RALLY_INSTALLATION_DIR):
+        logger.debug("   Rally installation directory found in %s" % RALLY_INSTALLATION_DIR)
         FNULL = open(os.devnull, 'w');
         cmd="rally deployment list | grep opnfv";
         logger.debug('   Executing command : {}'.format(cmd))
@@ -238,9 +311,11 @@ def check_rally():
 
 
 def install_odl():
-    cmd = "chmod +x " + odl_dir + "create_venv.sh"
+    cmd = "chmod +x " + ODL_DIR + "start_tests.sh"
+    execute_command(cmd)
+    cmd = "chmod +x " + ODL_DIR + "create_venv.sh"
     execute_command(cmd)
-    cmd = odl_dir + "create_venv.sh"
+    cmd = ODL_DIR + "create_venv.sh"
     execute_command(cmd)
     return True
 
@@ -273,40 +348,94 @@ def check_credentials():
     return True
 
 
-def download_tests():
-    os.makedirs(vPing_dir)
-    os.makedirs(odl_dir)
-    os.makedirs(bench_tests_dir)
+def get_credentials():
+    d = {}
+    d['username'] = os.environ['OS_USERNAME']
+    d['password'] = os.environ['OS_PASSWORD']
+    d['auth_url'] = os.environ['OS_AUTH_URL']
+    d['tenant_name'] = os.environ['OS_TENANT_NAME']
+    return d
+
+def get_nova_credentials():
+    d = {}
+    d['username'] = os.environ['OS_USERNAME']
+    d['api_key'] = os.environ['OS_PASSWORD']
+    d['auth_url'] = os.environ['OS_AUTH_URL']
+    d['project_id'] = os.environ['OS_TENANT_NAME']
+    return d
 
-    logger.info("Downloading vPing test...")
-    vPing_url = 'https://git.opnfv.org/cgit/functest/plain/testcases/vPing/CI/libraries/vPing.py'
-    if not download_url(vPing_url,vPing_dir):
-        return False
 
 
-    logger.info("Downloading Rally bench tests...")
-    run_rally_url = 'https://git.opnfv.org/cgit/functest/plain/testcases/VIM/OpenStack/CI/libraries/run_rally.py'
-    if not download_url(run_rally_url,rally_test_dir):
+def create_private_neutron_net(neutron):
+    try:
+        neutron.format = 'json'
+        logger.debug('Creating Neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
+        json_body = {'network': {'name': NEUTRON_PRIVATE_NET_NAME,
+                    'admin_state_up': True}}
+        netw = neutron.create_network(body=json_body)
+        net_dict = netw['network']
+        network_id = net_dict['id']
+        logger.debug("Network '%s' created successfully" % network_id)
+
+        logger.debug('Creating Subnet....')
+        json_body = {'subnets': [{'name': NEUTRON_PRIVATE_SUBNET_NAME, 'cidr': NEUTRON_PRIVATE_SUBNET_CIDR,
+                           'ip_version': 4, 'network_id': network_id}]}
+
+        subnet = neutron.create_subnet(body=json_body)
+        subnet_id = subnet['subnets'][0]['id']
+        logger.debug("Subnet '%s' created successfully" % subnet_id)
+
+
+        logger.debug('Creating Router...')
+        json_body = {'router': {'name': ROUTER_NAME, 'admin_state_up': True}}
+        router = neutron.create_router(json_body)
+        router_id = router['router']['id']
+        logger.debug("Router '%s' created successfully" % router_id)
+
+        logger.debug('Adding router to subnet...')
+        json_body = {"subnet_id": subnet_id}
+        neutron.add_interface_router(router=router_id, body=json_body)
+        logger.debug("Interface added successfully.")
+
+    except:
+        print "Error:", sys.exc_info()[0]
         return False
 
-    rally_bench_base_url = 'https://git.opnfv.org/cgit/functest/plain/testcases/VIM/OpenStack/CI/suites/'
-    bench_tests = ['authenticate', 'cinder', 'glance', 'heat', 'keystone', 'neutron', 'nova', 'quotas', 'requests', 'tempest', 'vm']
-    for i in bench_tests:
-        rally_bench_url = rally_bench_base_url + "opnfv-" + i + ".json"
-        logger.debug("Downloading %s" %rally_bench_url)
-        if not download_url(rally_bench_url,bench_tests_dir):
-            return False
+    logger.info("Private Neutron network created successfully.")
+    return True
+
+def get_network_id(neutron, network_name):
+    networks = neutron.list_networks()['networks']
+    id  = ''
+    for n in networks:
+        if n['name'] == network_name:
+            id = n['id']
+            break
+    return id
+
+def check_neutron_net(neutron, net_name):
+    for network in neutron.list_networks()['networks']:
+        if network['name'] == net_name :
+            for subnet in network['subnets']:
+                return True
+    return False
+
+def delete_neutron_net(neutron):
+    #TODO: remove router, ports
+    try:
+        #https://github.com/isginf/openstack_tools/blob/master/openstack_remove_tenant.py
+        for network in neutron.list_networks()['networks']:
+            if network['name'] == NEUTRON_PRIVATE_NET_NAME :
+                for subnet in network['subnets']:
+                    print "Deleting subnet " + subnet
+                    neutron.delete_subnet(subnet)
+                print "Deleting network " + network['name']
+                neutron.delete_neutron_net(network['id'])
+    finally:
+        return True
+    return False
 
-    logger.info("Downloading OLD tests...")
-    odl_base_url = 'https://git.opnfv.org/cgit/functest/plain/testcases/Controllers/ODL/CI/'
-    odl_tests = ['create_venv.sh', 'requirements.pip', 'start_tests.sh', 'test_list.txt']
-    for i in odl_tests:
-        odl_url = odl_base_url + i
-        logger.debug("Downloading %s" %odl_url)
-        if not download_url(odl_url,odl_dir):
-            return False
 
-    return True
 
 
 
@@ -319,6 +448,9 @@ def create_glance_image(path,name,disk_format):
     return True
 
 
+
+
+
 def download_url(url, dest_path):
     """
     Download a file to a destination path given a URL
@@ -336,40 +468,6 @@ def download_url(url, dest_path):
     return True
 
 
-def download_url_with_progress(url, dest_path):
-    """
-    Download a file to a destination path given a URL showing the progress
-    """
-    name = url.rsplit('/')[-1]
-    dest = dest_path + name
-    try:
-        response = urllib2.urlopen(url)
-    except (urllib2.HTTPError, urllib2.URLError):
-        logger.error("Error in fetching %s" %url)
-        return False
-
-    f = open(dest, 'wb')
-    meta = response.info()
-    file_size = int(meta.getheaders("Content-Length")[0])
-    logger.info("Downloading: %s Bytes: %s" %(dest, file_size))
-
-    file_size_dl = 0
-    block_sz = 8192
-    while True:
-        buffer = response.read(block_sz)
-        if not buffer:
-            break
-
-        file_size_dl += len(buffer)
-        f.write(buffer)
-        status = r"%10d  [%3.2f%%]" % (file_size_dl, file_size_dl * 100. / file_size)
-        status = status + chr(8)*(len(status)+1)
-        print status,
-
-    f.close()
-    print("\n")
-    return True
-
 
 def check_internet_connectivity(url='http://www.google.com/'):
     """
@@ -388,12 +486,14 @@ def execute_command(cmd):
     logger.debug('Executing command : {}'.format(cmd))
     #p = os.popen(cmd,"r")
     #logger.debug(p.read())
-    output_file = "/tmp/output.txt"
+    output_file = "output.txt"
     f = open(output_file, 'w+')
     p = subprocess.call(cmd,shell=True, stdout=f, stderr=subprocess.STDOUT)
     f.close()
     f = open(output_file, 'r')
-    logger.debug(f.read())
+    result = f.read()
+    if result != "":
+        logger.debug(result)
     #p = subprocess.call(cmd,shell=True);
     if p == 0 :
         return True
@@ -409,26 +509,35 @@ def main():
         logger.error('argument not valid')
         exit(-1)
 
+
+    if not check_credentials():
+        logger.error("Please source the openrc credentials and run the script again.")
+        #TODO: source the credentials in this script
+        exit(-1)
+
     if args.action == "start":
-        config_functest_start()
+        action_start()
 
     if args.action == "check":
-        if config_functest_check():
+        if action_check():
             logger.info("Functest environment correctly installed")
         else:
-            logger.info("Functest environment not found or faulty")
+            logger.info("Functest environment faulty")
 
     if args.action == "clean":
-        while True:
-            print("Are you sure? [y|n]")
-            answer = raw_input("")
-            if answer == "y":
-                config_functest_clean()
-                break
-            elif answer == "n":
-                break
-            else:
-                print("Invalid option.")
+        if args.force :
+            action_clean()
+        else :
+            while True:
+                print("Are you sure? [y|n]")
+                answer = raw_input("")
+                if answer == "y":
+                    action_clean()
+                    break
+                elif answer == "n":
+                    break
+                else:
+                    print("Invalid option.")
     exit(0)