set up mechanism to tun only runnable tests in CI based on scenario
[functest.git] / testcases / config_functest.py
1 #!/usr/bin/env python
2 #
3 # Copyright (c) 2015 Ericsson
4 # jose.lausuch@ericsson.com
5 # All rights reserved. This program and the accompanying materials
6 # are made available under the terms of the Apache License, Version 2.0
7 # which accompanies this distribution, and is available at
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10
11 import re, json, os, urllib2, argparse, logging, shutil, subprocess, yaml, sys, getpass
12 import functest_utils
13 from git import Repo
14 from os import stat
15 from pwd import getpwuid
16 from neutronclient.v2_0 import client as neutronclient
17
18 actions = ['start', 'check', 'clean']
19 parser = argparse.ArgumentParser()
20 parser.add_argument("action", help="Possible actions are: '{d[0]}|{d[1]}|{d[2]}' ".format(d=actions))
21 parser.add_argument("-d", "--debug", help="Debug mode",  action="store_true")
22 parser.add_argument("-f", "--force", help="Force",  action="store_true")
23 args = parser.parse_args()
24
25
26 """ logging configuration """
27 logger = logging.getLogger('config_functest')
28 logger.setLevel(logging.DEBUG)
29
30 ch = logging.StreamHandler()
31 if args.debug:
32     ch.setLevel(logging.DEBUG)
33 else:
34     ch.setLevel(logging.INFO)
35
36 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
37 ch.setFormatter(formatter)
38 logger.addHandler(ch)
39
40 REPO_PATH=os.environ['repos_dir']+'/functest/'
41 if not os.path.exists(REPO_PATH):
42     logger.error("Functest repository directory not found '%s'" % REPO_PATH)
43     exit(-1)
44 sys.path.append(REPO_PATH + "testcases/")
45
46 with open("/home/opnfv/functest/conf/config_functest.yaml") as f:
47     functest_yaml = yaml.safe_load(f)
48 f.close()
49
50
51 """ global variables """
52 # Directories
53 RALLY_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_rally")
54 RALLY_REPO_DIR = functest_yaml.get("general").get("directories").get("dir_repo_rally")
55 RALLY_INSTALLATION_DIR = functest_yaml.get("general").get("directories").get("dir_rally_inst")
56 RALLY_RESULT_DIR = functest_yaml.get("general").get("directories").get("dir_rally_res")
57 VPING_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_vping")
58 VIMS_TEST_DIR = functest_yaml.get("general").get("directories").get("dir_repo_vims_test")
59 ODL_DIR = REPO_PATH + functest_yaml.get("general").get("directories").get("dir_odl")
60 DATA_DIR = functest_yaml.get("general").get("directories").get("dir_functest_data")
61
62 # Tempest/Rally configuration details
63 DEPLOYMENT_MAME = functest_yaml.get("rally").get("deployment_name")
64 RALLY_COMMIT = functest_yaml.get("general").get("repositories").get("rally_commit")
65
66 #Image (cirros)
67 IMAGE_FILE_NAME = functest_yaml.get("general").get("openstack").get("image_file_name")
68 IMAGE_PATH = DATA_DIR + "/" + IMAGE_FILE_NAME
69
70 # NEUTRON Private Network parameters
71 NEUTRON_PRIVATE_NET_NAME = functest_yaml.get("general"). \
72     get("openstack").get("neutron_private_net_name")
73 NEUTRON_PRIVATE_SUBNET_NAME = functest_yaml.get("general"). \
74     get("openstack").get("neutron_private_subnet_name")
75 NEUTRON_PRIVATE_SUBNET_CIDR = functest_yaml.get("general"). \
76     get("openstack").get("neutron_private_subnet_cidr")
77 NEUTRON_ROUTER_NAME = functest_yaml.get("general"). \
78     get("openstack").get("neutron_router_name")
79
80 creds_neutron = functest_utils.get_credentials("neutron")
81 neutron_client = neutronclient.Client(**creds_neutron)
82
83 def action_start():
84     """
85     Start the functest environment installation
86     """
87     if not functest_utils.check_internet_connectivity():
88         logger.error("There is no Internet connectivity. Please check the network configuration.")
89         exit(-1)
90
91     if action_check():
92         logger.info("Functest environment already installed. Nothing to do.")
93         exit(0)
94
95     else:
96         # Clean in case there are left overs
97         logger.debug("Cleaning possible functest environment leftovers.")
98         action_clean()
99         logger.info("Starting installation of functest environment")
100
101         private_net = functest_utils.get_private_net(neutron_client)
102         if private_net is None:
103             # If there is no private network in the deployment we create one
104             if not create_private_neutron_net(neutron_client):
105                 logger.error("There has been a problem while creating the functest network.")
106                 action_clean()
107                 exit(-1)
108         else:
109             logger.info("Private network '%s' already existing in the deployment."
110                  % private_net['name'])
111
112         logger.info("Installing Rally...")
113         if not install_rally():
114             logger.error("There has been a problem while installing Rally.")
115             action_clean()
116             exit(-1)
117
118         # Install ruby libraries for vims test-case
119         script = 'source /etc/profile.d/rvm.sh; '
120         script += 'cd ' + VIMS_TEST_DIR + '; '
121         script += 'rvm use system;'
122         script += 'bundle install'
123
124         cmd = "/bin/bash -c '" + script + "'"
125         functest_utils.execute_command(cmd,logger)
126
127         # Create result folder under functest if necessary
128         if not os.path.exists(RALLY_RESULT_DIR):
129             os.makedirs(RALLY_RESULT_DIR)
130
131         try:
132             functest_utils.generateTestcaseList(functest_yaml)
133         except:
134             logger.info("Not CI mode. Test cases list not generated.")
135
136         exit(0)
137
138
139 def action_check():
140     """
141     Check if the functest environment is properly installed
142     """
143     errors_all = False
144     errors = False
145     logger.info("Checking current functest configuration...")
146
147     logger.debug("Checking script directories...")
148
149     dirs = [RALLY_DIR, RALLY_INSTALLATION_DIR, VPING_DIR, ODL_DIR]
150     for dir in dirs:
151         if not os.path.exists(dir):
152             logger.debug("The directory '%s' does NOT exist." % dir)
153             errors = True
154             errors_all = True
155         else:
156             logger.debug("   %s found" % dir)
157     if not errors:
158         logger.debug("...OK")
159     else:
160         logger.debug("...FAIL")
161
162
163     logger.debug("Checking Rally deployment...")
164     if not check_rally():
165         logger.debug("   Rally deployment NOT installed.")
166         errors_all = True
167         logger.debug("...FAIL")
168     else:
169         logger.debug("...OK")
170
171     logger.debug("Checking Image...")
172     errors = False
173     if not os.path.isfile(IMAGE_PATH):
174         logger.debug("   Image file '%s' NOT found." % IMAGE_PATH)
175         errors = True
176         errors_all = True
177     else:
178         logger.debug("   Image file found in %s" % IMAGE_PATH)
179
180
181     if not errors:
182         logger.debug("...OK")
183     else:
184         logger.debug("...FAIL")
185
186     #TODO: check OLD environment setup
187     return not errors_all
188
189
190
191 def action_clean():
192     """
193     Clean the existing functest environment
194     """
195     logger.info("Removing current functest environment...")
196     if os.path.exists(RALLY_INSTALLATION_DIR):
197         logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
198         shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
199
200     if os.path.exists(RALLY_RESULT_DIR):
201         logger.debug("Removing Result directory")
202         shutil.rmtree(RALLY_RESULT_DIR,ignore_errors=True)
203
204     logger.debug("Cleaning up the OpenStack deployment...")
205     cmd='python ' + REPO_PATH + \
206         '/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py -d '
207     functest_utils.execute_command(cmd,logger)
208     logger.info("Functest environment clean!")
209
210
211
212 def install_rally():
213     if check_rally():
214         logger.info("Rally is already installed.")
215     else:
216         logger.debug("Executing %s/install_rally.sh..." %RALLY_REPO_DIR)
217         install_script = RALLY_REPO_DIR + "/install_rally.sh --yes"
218         cmd = 'sudo ' + install_script
219         functest_utils.execute_command(cmd,logger)
220
221         logger.debug("Creating Rally environment...")
222         cmd = "rally deployment create --fromenv --name="+DEPLOYMENT_MAME
223         functest_utils.execute_command(cmd,logger)
224
225         logger.debug("Installing tempest...")
226         cmd = "rally verify install"
227         functest_utils.execute_command(cmd,logger)
228
229         cmd = "rally deployment check"
230         functest_utils.execute_command(cmd,logger)
231         #TODO: check that everything is 'Available' and warn if not
232
233         cmd = "rally show images"
234         functest_utils.execute_command(cmd,logger)
235
236         cmd = "rally show flavors"
237         functest_utils.execute_command(cmd,logger)
238
239     return True
240
241
242 def check_rally():
243     """
244     Check if Rally is installed and properly configured
245     """
246     if os.path.exists(RALLY_INSTALLATION_DIR):
247         logger.debug("   Rally installation directory found in %s" % RALLY_INSTALLATION_DIR)
248         FNULL = open(os.devnull, 'w');
249         cmd="rally deployment list | grep "+DEPLOYMENT_MAME
250         logger.debug('   Executing command : {}'.format(cmd))
251         p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
252         #if the command does not exist or there is no deployment
253         line = p.stdout.readline()
254         if line == "":
255             logger.debug("   Rally deployment NOT found")
256             return False
257         logger.debug("   Rally deployment found")
258         return True
259     else:
260         return False
261
262
263 def create_private_neutron_net(neutron):
264     neutron.format = 'json'
265     logger.info('Creating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
266     network_id = functest_utils. \
267         create_neutron_net(neutron, NEUTRON_PRIVATE_NET_NAME)
268
269     if not network_id:
270         return False
271     logger.debug("Network '%s' created successfully" % network_id)
272
273     logger.info('Updating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
274     if functest_utils.update_neutron_net(neutron, network_id, shared=True):
275         logger.debug("Network '%s' updated successfully" % network_id)
276     else:
277         logger.info('Updating neutron network %s failed' % network_id)
278
279     logger.debug('Creating Subnet....')
280     subnet_id = functest_utils. \
281         create_neutron_subnet(neutron,
282                               NEUTRON_PRIVATE_SUBNET_NAME,
283                               NEUTRON_PRIVATE_SUBNET_CIDR,
284                               network_id)
285     if not subnet_id:
286         return False
287     logger.debug("Subnet '%s' created successfully" % subnet_id)
288     logger.debug('Creating Router...')
289     router_id = functest_utils. \
290         create_neutron_router(neutron, NEUTRON_ROUTER_NAME)
291
292     if not router_id:
293         return False
294
295     logger.debug("Router '%s' created successfully" % router_id)
296     logger.debug('Adding router to subnet...')
297
298     result = functest_utils.add_interface_router(neutron, router_id, subnet_id)
299
300     if not result:
301         return False
302
303     logger.debug("Interface added successfully.")
304     network_dic = {'net_id': network_id,
305                    'subnet_id': subnet_id,
306                    'router_id': router_id}
307     return True
308
309
310 def main():
311     if not (args.action in actions):
312         logger.error('argument not valid')
313         exit(-1)
314
315
316     if not functest_utils.check_credentials():
317         logger.error("Please source the openrc credentials and run the script again.")
318         #TODO: source the credentials in this script
319         exit(-1)
320
321
322     if args.action == "start":
323         action_start()
324
325     if args.action == "check":
326         if action_check():
327             logger.info("Functest environment correctly installed")
328         else:
329             logger.info("Functest environment not found or faulty")
330
331     if args.action == "clean":
332         if args.force :
333             action_clean()
334         else :
335             while True:
336                 print("Are you sure? [y|n]")
337                 answer = raw_input("")
338                 if answer == "y":
339                     action_clean()
340                     break
341                 elif answer == "n":
342                     break
343                 else:
344                     print("Invalid option.")
345     exit(0)
346
347
348 if __name__ == '__main__':
349     main()
350