# http://www.apache.org/licenses/LICENSE-2.0
#
-import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml
+import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml, sys, getpass
+import functest_utils
from git import Repo
-
-from neutronclient.v2_0 import client
+from os import stat
+from pwd import getpwuid
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()
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")
+RALLY_RESULT_DIR = HOME + functest_yaml.get("general").get("directories").get("dir_rally_res")
+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_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
"""
- if not check_internet_connectivity():
+ if not check_permissions():
+ logger.error("Bad Python cache directory ownership.")
+ exit(-1)
+
+ if not functest_utils.check_internet_connectivity():
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.debug("Cleaning possible functest environment leftovers.")
+ action_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()
+ logger.info("Installing ODL environment...")
+ if not install_odl():
+ logger.error("There has been a problem while installing Robot.")
+ action_clean()
exit(-1)
+ 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()
- 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)
+ # Create result folder under functest if necessary
+ if not os.path.exists(RALLY_RESULT_DIR):
+ os.makedirs(RALLY_RESULT_DIR)
- 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.")
- #config_functest_clean()
- exit(-1)
-
-
- logger.info("Donwloading image...")
- if not download_url_with_progress(IMAGE_URL, FUNCTEST_BASE_DIR):
- logger.error("There has been a problem while downloading the image.")
- config_functest_clean()
+ logger.info("Downloading image...")
+ if not functest_utils.download_url(IMAGE_URL, IMAGE_DIR):
+ logger.error("There has been a problem downloading the image '%s'." %IMAGE_URL)
+ 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
"""
errors_all = False
logger.info("Checking current functest configuration...")
- credentials = get_credentials()
- neutron_client = client.Client(**credentials)
- logger.debug("Checking directories...")
+ logger.debug("Checking script 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)
logger.debug("Checking Rally deployment...")
if not check_rally():
- logger.debug(" Rally deployment NOT found.")
+ logger.debug(" Rally deployment NOT installed.")
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...")
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');
-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
- execute_command(cmd)
+ 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
+ functest_utils.execute_command(cmd,logger)
- #logger.debug("Deleting Neutron network %s" % NEUTRON_PRIVATE_NET_NAME)
- #if not delete_neutron_net() :
- # logger.error("Error deleting the network. Remove it manually.")
+ if os.path.exists(IMAGE_PATH):
+ logger.debug("Deleting image")
+ os.remove(IMAGE_PATH)
- logger.debug("Deleting glance images")
cmd = "glance image-list | grep "+IMAGE_NAME+" | cut -c3-38"
p = os.popen(cmd,"r")
#while image_id = p.readline()
for image_id in p.readlines():
cmd = "glance image-delete " + image_id
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
+
+ if os.path.exists(RALLY_RESULT_DIR):
+ logger.debug("Removing Result directory")
+ shutil.rmtree(RALLY_RESULT_DIR,ignore_errors=True)
- return True
+ logger.info("Functest environment clean!")
+def check_permissions():
+ current_user = getpass.getuser()
+ cache_dir = HOME+".cache/pip"
+ logger.info("Checking permissions of '%s'..." %cache_dir)
+ logger.debug("Current user is '%s'" %current_user)
+ cache_user = getpwuid(stat(cache_dir).st_uid).pw_name
+ logger.debug("Cache directory owner is '%s'" %cache_user)
+ if cache_user != current_user:
+ logger.info("The owner of '%s' is '%s'. Please run 'sudo chown -R %s %s'." %(cache_dir, cache_user, current_user, cache_dir))
+ return False
+
+ return True
+
def install_rally():
if check_rally():
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])
+ functest_utils.execute_command(cmd,logger)
logger.debug("Creating Rally environment...")
cmd = "rally deployment create --fromenv --name=opnfv-arno-rally"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
logger.debug("Installing tempest...")
cmd = "rally-manage tempest install"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
cmd = "rally deployment check"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
#TODO: check that everything is 'Available' and warn if not
cmd = "rally show images"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
cmd = "rally show flavors"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
return True
#if the command does not exist or there is no deployment
line = p.stdout.readline()
if line == "":
- logger.debug(" Rally deployment not found")
+ logger.debug(" Rally deployment NOT found")
return False
logger.debug(" Rally deployment found")
return True
else:
- logger.debug(" Rally installation directory not found")
return False
def install_odl():
+ cmd = "chmod +x " + ODL_DIR + "start_tests.sh"
+ functest_utils.execute_command(cmd,logger)
cmd = "chmod +x " + ODL_DIR + "create_venv.sh"
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
cmd = ODL_DIR + "create_venv.sh"
- execute_command(cmd)
- return True
-
-
-def check_credentials():
- """
- Check if the OpenStack credentials (openrc) are sourced
- """
- #TODO: there must be a short way to do this, doing if os.environ["something"] == "" throws an error
- try:
- os.environ['OS_AUTH_URL']
- except KeyError:
- return False
- try:
- os.environ['OS_USERNAME']
- except KeyError:
- return False
- try:
- os.environ['OS_PASSWORD']
- except KeyError:
- return False
- try:
- os.environ['OS_TENANT_NAME']
- except KeyError:
- return False
- try:
- os.environ['OS_REGION_NAME']
- except KeyError:
- return False
+ functest_utils.execute_command(cmd,logger)
return True
-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
-
-
-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:
- 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
-
- 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
-
-
-
-
def create_glance_image(path,name,disk_format):
"""
Create a glance image given the absolute path of the image, its name and the disk format
"""
cmd = "glance image-create --name "+name+" --is-public true --disk-format "+disk_format+" --container-format bare --file "+path
- execute_command(cmd)
+ functest_utils.execute_command(cmd,logger)
return True
-
-def download_url(url, dest_path):
- """
- Download a file to a destination path given a URL
- """
- 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
-
- with open(dest, 'wb') as f:
- f.write(response.read())
- 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/'):
- """
- Check if there is access to the internet
- """
- try:
- urllib2.urlopen(url, timeout=5)
- return True
- except urllib.request.URLError:
- return False
-
-def execute_command(cmd):
- """
- Execute Linux command
- """
- logger.debug('Executing command : {}'.format(cmd))
- #p = os.popen(cmd,"r")
- #logger.debug(p.read())
- 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())
- #p = subprocess.call(cmd,shell=True);
- if p == 0 :
- return True
- else:
- logger.error("Error when executing command %s" %cmd)
- exit(-1)
-
-
-
-
def main():
if not (args.action in actions):
logger.error('argument not valid')
exit(-1)
- if not check_credentials():
+
+ if not functest_utils.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")
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)