Add explicit logs when creating list of runnable tests
[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         logger.info("Installing Ruby libraries for vIMS testcase...")
119         # Install ruby libraries for vims test-case
120         script = 'source /etc/profile.d/rvm.sh; '
121         script += 'cd ' + VIMS_TEST_DIR + '; '
122         script += 'rvm autolibs enable ;'
123         script += 'rvm install 1.9.3; '
124         script += 'rvm use 1.9.3;'
125         script += 'bundle install'
126
127         cmd = "/bin/bash -c '" + script + "'"
128         functest_utils.execute_command(cmd,logger)
129
130         # Create result folder under functest if necessary
131         if not os.path.exists(RALLY_RESULT_DIR):
132             os.makedirs(RALLY_RESULT_DIR)
133
134         try:
135             logger.info("CI: Generate the list of executable tests.")
136             runnable_test = functest_utils.generateTestcaseList(functest_yaml)
137             logger.info("List of runnable tests generated: %s" % runnable_test)
138         except:
139             logger.error("Impossible to generate the list of runnable tests")
140
141         exit(0)
142
143
144 def action_check():
145     """
146     Check if the functest environment is properly installed
147     """
148     errors_all = False
149     errors = False
150     logger.info("Checking current functest configuration...")
151
152     logger.debug("Checking script directories...")
153
154     dirs = [RALLY_DIR, RALLY_INSTALLATION_DIR, VPING_DIR, ODL_DIR]
155     for dir in dirs:
156         if not os.path.exists(dir):
157             logger.debug("The directory '%s' does NOT exist." % dir)
158             errors = True
159             errors_all = True
160         else:
161             logger.debug("   %s found" % dir)
162     if not errors:
163         logger.debug("...OK")
164     else:
165         logger.debug("...FAIL")
166
167
168     logger.debug("Checking Rally deployment...")
169     if not check_rally():
170         logger.debug("   Rally deployment NOT installed.")
171         errors_all = True
172         logger.debug("...FAIL")
173     else:
174         logger.debug("...OK")
175
176     logger.debug("Checking Image...")
177     errors = False
178     if not os.path.isfile(IMAGE_PATH):
179         logger.debug("   Image file '%s' NOT found." % IMAGE_PATH)
180         errors = True
181         errors_all = True
182     else:
183         logger.debug("   Image file found in %s" % IMAGE_PATH)
184
185
186     if not errors:
187         logger.debug("...OK")
188     else:
189         logger.debug("...FAIL")
190
191     #TODO: check OLD environment setup
192     return not errors_all
193
194
195
196 def action_clean():
197     """
198     Clean the existing functest environment
199     """
200     logger.info("Removing current functest environment...")
201     if os.path.exists(RALLY_INSTALLATION_DIR):
202         logger.debug("Removing Rally installation directory %s" % RALLY_INSTALLATION_DIR)
203         shutil.rmtree(RALLY_INSTALLATION_DIR,ignore_errors=True)
204
205     if os.path.exists(RALLY_RESULT_DIR):
206         logger.debug("Removing Result directory")
207         shutil.rmtree(RALLY_RESULT_DIR,ignore_errors=True)
208
209     logger.debug("Cleaning up the OpenStack deployment...")
210     cmd='python ' + REPO_PATH + \
211         '/testcases/VIM/OpenStack/CI/libraries/clean_openstack.py -d '
212     functest_utils.execute_command(cmd,logger)
213     logger.info("Functest environment clean!")
214
215
216
217 def install_rally():
218     if check_rally():
219         logger.info("Rally is already installed.")
220     else:
221         logger.debug("Executing %s/install_rally.sh..." %RALLY_REPO_DIR)
222         install_script = RALLY_REPO_DIR + "/install_rally.sh --yes"
223         cmd = 'sudo ' + install_script
224         functest_utils.execute_command(cmd,logger)
225
226         logger.debug("Creating Rally environment...")
227         cmd = "rally deployment create --fromenv --name="+DEPLOYMENT_MAME
228         functest_utils.execute_command(cmd,logger)
229
230         logger.debug("Installing tempest...")
231         cmd = "rally verify install"
232         functest_utils.execute_command(cmd,logger)
233
234         cmd = "rally deployment check"
235         functest_utils.execute_command(cmd,logger)
236         #TODO: check that everything is 'Available' and warn if not
237
238         cmd = "rally show images"
239         functest_utils.execute_command(cmd,logger)
240
241         cmd = "rally show flavors"
242         functest_utils.execute_command(cmd,logger)
243
244     return True
245
246
247 def check_rally():
248     """
249     Check if Rally is installed and properly configured
250     """
251     if os.path.exists(RALLY_INSTALLATION_DIR):
252         logger.debug("   Rally installation directory found in %s" % RALLY_INSTALLATION_DIR)
253         FNULL = open(os.devnull, 'w');
254         cmd="rally deployment list | grep "+DEPLOYMENT_MAME
255         logger.debug('   Executing command : {}'.format(cmd))
256         p=subprocess.Popen(cmd,shell=True,stdout=subprocess.PIPE,stderr=FNULL);
257         #if the command does not exist or there is no deployment
258         line = p.stdout.readline()
259         if line == "":
260             logger.debug("   Rally deployment NOT found")
261             return False
262         logger.debug("   Rally deployment found")
263         return True
264     else:
265         return False
266
267
268 def create_private_neutron_net(neutron):
269     neutron.format = 'json'
270     logger.info('Creating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
271     network_id = functest_utils. \
272         create_neutron_net(neutron, NEUTRON_PRIVATE_NET_NAME)
273
274     if not network_id:
275         return False
276     logger.debug("Network '%s' created successfully" % network_id)
277
278     logger.info('Updating neutron network %s...' % NEUTRON_PRIVATE_NET_NAME)
279     if functest_utils.update_neutron_net(neutron, network_id, shared=True):
280         logger.debug("Network '%s' updated successfully" % network_id)
281     else:
282         logger.info('Updating neutron network %s failed' % network_id)
283
284     logger.debug('Creating Subnet....')
285     subnet_id = functest_utils. \
286         create_neutron_subnet(neutron,
287                               NEUTRON_PRIVATE_SUBNET_NAME,
288                               NEUTRON_PRIVATE_SUBNET_CIDR,
289                               network_id)
290     if not subnet_id:
291         return False
292     logger.debug("Subnet '%s' created successfully" % subnet_id)
293     logger.debug('Creating Router...')
294     router_id = functest_utils. \
295         create_neutron_router(neutron, NEUTRON_ROUTER_NAME)
296
297     if not router_id:
298         return False
299
300     logger.debug("Router '%s' created successfully" % router_id)
301     logger.debug('Adding router to subnet...')
302
303     result = functest_utils.add_interface_router(neutron, router_id, subnet_id)
304
305     if not result:
306         return False
307
308     logger.debug("Interface added successfully.")
309     network_dic = {'net_id': network_id,
310                    'subnet_id': subnet_id,
311                    'router_id': router_id}
312     return True
313
314
315 def main():
316     if not (args.action in actions):
317         logger.error('argument not valid')
318         exit(-1)
319
320
321     if not functest_utils.check_credentials():
322         logger.error("Please source the openrc credentials and run the script again.")
323         #TODO: source the credentials in this script
324         exit(-1)
325
326
327     if args.action == "start":
328         action_start()
329
330     if args.action == "check":
331         if action_check():
332             logger.info("Functest environment correctly installed")
333         else:
334             logger.info("Functest environment not found or faulty")
335
336     if args.action == "clean":
337         if args.force :
338             action_clean()
339         else :
340             while True:
341                 print("Are you sure? [y|n]")
342                 answer = raw_input("")
343                 if answer == "y":
344                     action_clean()
345                     break
346                 elif answer == "n":
347                     break
348                 else:
349                     print("Invalid option.")
350     exit(0)
351
352
353 if __name__ == '__main__':
354     main()
355