Refactor functest environment

Depends on: https://gerrit.opnfv.org/gerrit/#/c/642/

JIRA: FUNCTEST-10

Change-Id: I08404df8b38372a40f715d9bde2347fd67ce52a9
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

4 files changed, 63 insertions, 156 deletions

diff --git a/testcases/VIM/OpenStack/CI/libraries/run_rally.py b/testcases/VIM/OpenStack/CI/libraries/run_rally.py
index 57b7b35c7..a1f46e5ba 100644
--- a/testcases/VIM/OpenStack/CI/libraries/run_rally.py
+++ b/testcases/VIM/OpenStack/CI/libraries/run_rally.py
@@ -11,7 +11,7 @@
 import re, json, os, urllib2, argparse, logging, yaml
 
 HOME = os.environ['HOME']+"/"
-with open(HOME+'.functest/functest.yaml') as f:
+with open(args.repo_path+"testcases/config_functest.yaml") as f:
     functest_yaml = yaml.safe_load(f)
 f.close()
 
diff --git a/testcases/config_functest.py b/testcases/config_functest.py
index 7f3da43f4..7aa313c52 100644
--- a/testcases/config_functest.py
+++ b/testcases/config_functest.py
@@ -15,6 +15,7 @@ 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")
@@ -31,46 +32,30 @@ if args.debug:
 else:
     ch.setLevel(logging.INFO)
 
-
 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 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)
 
-
-yaml_url = 'https://git.opnfv.org/cgit/functest/plain/testcases/functest.yaml'
-name = yaml_url.rsplit('/')[-1]
-dest = "./" + name
-if not os.path.exists(dest):
-    logger.info("Downloading functest.yaml...")
-    try:
-        response = urllib2.urlopen(yaml_url)
-    except (urllib2.HTTPError, urllib2.URLError):
-        logger.error("Error in fetching %s" %yaml_url)
-        exit(-1)
-    with open(dest, 'wb') as f:
-        f.write(response.read())
-    logger.info("functest.yaml stored in %s" % dest)
-else:
-    logger.info("functest.yaml found in %s" % dest)
-
-
-with open('./functest.yaml') as f:
+with open(args.repo_path+"testcases/config_functest.yaml") as f:
     functest_yaml = yaml.safe_load(f)
 f.close()
 
 
+
+
 """ global variables """
 # Directories
 HOME = os.environ['HOME']+"/"
-FUNCTEST_BASE_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_functest")
+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_TEST_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally")
 RALLY_INSTALLATION_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_inst")
-BENCH_TESTS_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_scn")
-VPING_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_vping")
-ODL_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_odl")
-
+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")
@@ -83,12 +68,14 @@ 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_DOWNLOAD_PATH = FUNCTEST_BASE_DIR + IMAGE_FILE_NAME
+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 config_functest_start():
+def action_start():
     """
     Start the functest environment installation
     """
@@ -96,37 +83,26 @@ def config_functest_start():
         logger.error("There is no Internet connectivity. Please check the network configuration.")
         exit(-1)
 
-    if config_functest_check():
-        logger.info("Functest environment already installed in %s. Nothing to do." %FUNCTEST_BASE_DIR)
+    if action_check():
+        logger.info("Functest environment already installed. Nothing to do.")
         exit(0)
 
     else:
         # Clean in case there are left overs
-        logger.debug("Functest environment not found or faulty. Cleaning in case of leftovers.")
-        config_functest_clean()
-
-        logger.info("Starting installation of functest environment in %s" % FUNCTEST_BASE_DIR)
-        os.makedirs(FUNCTEST_BASE_DIR)
-        if not os.path.exists(FUNCTEST_BASE_DIR):
-            logger.error("There has been a problem while creating the environment directory.")
-            exit(-1)
-
-        logger.info("Downloading 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)
+        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()
@@ -141,27 +117,26 @@ def config_functest_start():
             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.")
-                #config_functest_clean()
+                #action_clean()
                 exit(-1)
 
 
         logger.info("Donwloading image...")
-        if not download_url_with_progress(IMAGE_URL, FUNCTEST_BASE_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_DOWNLOAD_PATH,IMAGE_NAME,IMAGE_DISK_FORMAT):
+        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
     """
@@ -173,7 +148,7 @@ def config_functest_check():
 
     logger.debug("Checking directories...")
     errors = False
-    dirs = [FUNCTEST_BASE_DIR, RALLY_INSTALLATION_DIR, RALLY_REPO_DIR, RALLY_TEST_DIR, BENCH_TESTS_DIR, VPING_DIR, ODL_DIR]
+    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)
@@ -208,12 +183,12 @@ def config_functest_check():
 
     logger.debug("Checking Image...")
     errors = False
-    if not os.path.isfile(IMAGE_DOWNLOAD_PATH):
-        logger.debug("   Image file '%s' NOT found." % IMAGE_DOWNLOAD_PATH)
+    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_DOWNLOAD_PATH)
+        logger.debug("   Image file found in %s" % IMAGE_PATH)
 
     cmd="glance image-list | grep " + IMAGE_NAME
     FNULL = open(os.devnull, 'w');
@@ -242,25 +217,27 @@ def config_functest_check():
 
 
 
-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)
+        logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
         shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
 
-    if os.path.exists(FUNCTEST_BASE_DIR):
-        logger.debug("Removing functest directory %s" % FUNCTEST_BASE_DIR)
-        cmd = "sudo rm -rf " + FUNCTEST_BASE_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")
+    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")
 
@@ -334,6 +311,8 @@ def check_rally():
 
 
 def install_odl():
+    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"
@@ -386,49 +365,6 @@ def get_nova_credentials():
     return d
 
 
-def download_tests():
-    os.makedirs(VPING_DIR)
-    os.makedirs(ODL_DIR)
-    os.makedirs(BENCH_TESTS_DIR)
-
-    logger.info("Copying functest.yaml to functest environment...")
-    try:
-        shutil.copy("./functest.yaml", FUNCTEST_BASE_DIR+"functest.yaml")
-    except:
-        print "Error copying the file:", sys.exc_info()[0]
-        return False
-
-    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):
-        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("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
-
-
 
 def create_private_neutron_net(neutron):
     try:
@@ -532,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/'):
     """
@@ -589,7 +491,9 @@ def execute_command(cmd):
     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
@@ -605,29 +509,30 @@ 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":
         if args.force :
-            config_functest_clean()
+            action_clean()
         else :
             while True:
                 print("Are you sure? [y|n]")
                 answer = raw_input("")
                 if answer == "y":
-                    config_functest_clean()
+                    action_clean()
                     break
                 elif answer == "n":
                     break
diff --git a/testcases/functest.yaml b/testcases/config_functest.yaml
index 6175e6fcb..5fe7fbffc 100644
--- a/testcases/functest.yaml
+++ b/testcases/config_functest.yaml
@@ -1,18 +1,20 @@
 ---
 general:
+    # Relative paths to the path where the repo is cloned
     directories:
-        dir_functest:   .functest/ #DONT CHANGE
-        dir_rally_repo: .functest/Rally_repo/
-        dir_rally:      .functest/Rally_test/
-        dir_rally_scn:  .functest/Rally_test/scenarios/
-        dir_rally_res:  .functest/Rally_test/results/
-        dir_vping:      .functest/vPing/
-        dir_odl:        .functest/ODL/
-        dir_rally_inst: .rally/
+        dir_vping:      testcases/vPing/CI/libraries/
+        dir_odl:        testcases/Controllers/ODL/CI/
+        dir_rally:      testcases/VIM/OpenStack/CI/libraries/
+        dir_rally_scn:  testcases/VIM/OpenStack/CI/suites/
+        dir_rally_res:  functest/results/ # $HOME/functest/results
+        dir_rally_repo: functest/Rally_repo/
+        dir_rally_inst: .rally/  # $HOME/.rally/ usually
+
     openstack:
         image_name: functest-img
         image_url:  http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img
         image_disk_format:  qcow2
+        image_download_path:    functest/ # $HOME/functest/
         #Public network. Optional
         neutron_public_net_name: net04_ext
         neutron_public_subnet_name: net04_ext__subnet
diff --git a/testcases/vPing/CI/libraries/vPing.py b/testcases/vPing/CI/libraries/vPing.py
index 2baf448d2..8c365ffa9 100644
--- a/testcases/vPing/CI/libraries/vPing.py
+++ b/testcases/vPing/CI/libraries/vPing.py
@@ -19,7 +19,7 @@ import novaclient.v2.client as novaclient
 pp = pprint.PrettyPrinter(indent=4)
 
 HOME = os.environ['HOME']+"/"
-with open(HOME+'.functest/functest.yaml') as f:
+with open(args.repo_path+"testcases/config_functest.yaml") as f:
     functest_yaml = yaml.safe_load(f)
 f.close()