Merge "Unit tests added for openstack/tempest"
[functest.git] / functest / opnfv_tests / openstack / tempest / conf_utils.py
1 #!/usr/bin/python
2 #
3 # Copyright (c) 2015 All rights reserved
4 # This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 #
10 import ConfigParser
11 import os
12 import re
13 import shutil
14 import subprocess
15
16 from functest.utils.constants import CONST
17 import functest.utils.functest_logger as ft_logger
18 import functest.utils.functest_utils as ft_utils
19 import functest.utils.openstack_utils as os_utils
20
21
22 IMAGE_ID_ALT = None
23 FLAVOR_ID_ALT = None
24 REPO_PATH = CONST.dir_repo_functest
25 GLANCE_IMAGE_PATH = os.path.join(CONST.dir_functest_data,
26                                  CONST.openstack_image_file_name)
27 TEMPEST_TEST_LIST_DIR = CONST.dir_tempest_cases
28 TEMPEST_RESULTS_DIR = os.path.join(CONST.dir_results,
29                                    'tempest')
30 TEMPEST_CUSTOM = os.path.join(REPO_PATH, TEMPEST_TEST_LIST_DIR,
31                               'test_list.txt')
32 TEMPEST_BLACKLIST = os.path.join(REPO_PATH, TEMPEST_TEST_LIST_DIR,
33                                  'blacklist.txt')
34 TEMPEST_DEFCORE = os.path.join(REPO_PATH, TEMPEST_TEST_LIST_DIR,
35                                'defcore_req.txt')
36 TEMPEST_RAW_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_raw_list.txt')
37 TEMPEST_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_list.txt')
38
39 CI_INSTALLER_TYPE = CONST.INSTALLER_TYPE
40 CI_INSTALLER_IP = CONST.INSTALLER_IP
41
42 """ logging configuration """
43 logger = ft_logger.Logger("Tempest").getLogger()
44
45
46 def get_verifier_id():
47     """
48     Returns verifer id for current Tempest
49     """
50     cmd = ("rally verify list-verifiers | awk '/" +
51            CONST.tempest_deployment_name +
52            "/ {print $2}'")
53     p = subprocess.Popen(cmd, shell=True,
54                          stdout=subprocess.PIPE,
55                          stderr=subprocess.STDOUT)
56     deployment_uuid = p.stdout.readline().rstrip()
57     if deployment_uuid == "":
58         logger.error("Tempest verifier not found.")
59         raise Exception('Error with command:%s' % cmd)
60     return deployment_uuid
61
62
63 def get_verifier_deployment_id():
64     """
65     Returns deployment id for active Rally deployment
66     """
67     cmd = ("rally deployment list | awk '/" +
68            CONST.rally_deployment_name +
69            "/ {print $2}'")
70     p = subprocess.Popen(cmd, shell=True,
71                          stdout=subprocess.PIPE,
72                          stderr=subprocess.STDOUT)
73     deployment_uuid = p.stdout.readline().rstrip()
74     if deployment_uuid == "":
75         logger.error("Rally deployment not found.")
76         raise Exception('Error with command:%s' % cmd)
77     return deployment_uuid
78
79
80 def get_verifier_repo_dir(verifier_id):
81     """
82     Returns installed verfier repo directory for Tempest
83     """
84     if not verifier_id:
85         verifier_id = get_verifier_id()
86
87     return os.path.join(CONST.dir_rally_inst,
88                         'verification',
89                         'verifier-{}'.format(verifier_id),
90                         'repo')
91
92
93 def get_verifier_deployment_dir(verifier_id, deployment_id):
94     """
95     Returns Rally deployment directory for current verifier
96     """
97     if not verifier_id:
98         verifier_id = get_verifier_id()
99
100     if not deployment_id:
101         deployment_id = get_verifier_deployment_id()
102
103     return os.path.join(CONST.dir_rally_inst,
104                         'verification',
105                         'verifier-{}'.format(verifier_id),
106                         'for-deployment-{}'.format(deployment_id))
107
108
109 def get_repo_tag(repo):
110     """
111     Returns last tag of current branch
112     """
113     cmd = ("git -C {0} describe --abbrev=0 HEAD".format(repo))
114     p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
115     tag = p.stdout.readline().rstrip()
116
117     return str(tag)
118
119
120 def backup_tempest_config(conf_file):
121     """
122     Copy config file to tempest results directory
123     """
124     if not os.path.exists(TEMPEST_RESULTS_DIR):
125         os.makedirs(TEMPEST_RESULTS_DIR)
126
127     shutil.copyfile(conf_file,
128                     os.path.join(TEMPEST_RESULTS_DIR, 'tempest.conf'))
129
130
131 def configure_tempest(deployment_dir, IMAGE_ID=None, FLAVOR_ID=None,
132                       MODE=None):
133     """
134     Calls rally verify and updates the generated tempest.conf with
135     given parameters
136     """
137     conf_file = configure_verifier(deployment_dir)
138     configure_tempest_update_params(conf_file,
139                                     IMAGE_ID, FLAVOR_ID)
140     if MODE == 'feature_multisite':
141         configure_tempest_multisite_params(conf_file)
142
143
144 def configure_tempest_update_params(tempest_conf_file,
145                                     IMAGE_ID=None, FLAVOR_ID=None):
146     """
147     Add/update needed parameters into tempest.conf file
148     """
149     logger.debug("Updating selected tempest.conf parameters...")
150     config = ConfigParser.RawConfigParser()
151     config.read(tempest_conf_file)
152     config.set(
153         'compute',
154         'fixed_network_name',
155         CONST.tempest_private_net_name)
156     if CONST.tempest_use_custom_images:
157         if IMAGE_ID is not None:
158             config.set('compute', 'image_ref', IMAGE_ID)
159         if IMAGE_ID_ALT is not None:
160             config.set('compute', 'image_ref_alt', IMAGE_ID_ALT)
161     if CONST.tempest_use_custom_flavors:
162         if FLAVOR_ID is not None:
163             config.set('compute', 'flavor_ref', FLAVOR_ID)
164         if FLAVOR_ID_ALT is not None:
165             config.set('compute', 'flavor_ref_alt', FLAVOR_ID_ALT)
166     config.set('identity', 'tenant_name', CONST.tempest_identity_tenant_name)
167     config.set('identity', 'username', CONST.tempest_identity_user_name)
168     config.set('identity', 'password', CONST.tempest_identity_user_password)
169     config.set(
170         'validation', 'ssh_timeout', CONST.tempest_validation_ssh_timeout)
171     config.set('object-storage', 'operator_role',
172                CONST.tempest_object_storage_operator_role)
173
174     if CONST.OS_ENDPOINT_TYPE is not None:
175         services_list = ['compute',
176                          'volume',
177                          'image',
178                          'network',
179                          'data-processing',
180                          'object-storage',
181                          'orchestration']
182         sections = config.sections()
183         for service in services_list:
184             if service not in sections:
185                 config.add_section(service)
186             config.set(service, 'endpoint_type',
187                        CONST.OS_ENDPOINT_TYPE)
188
189     with open(tempest_conf_file, 'wb') as config_file:
190         config.write(config_file)
191
192     backup_tempest_config(tempest_conf_file)
193
194
195 def configure_verifier(deployment_dir):
196     """
197     Execute rally verify configure-verifier, which generates tempest.conf
198     """
199     tempest_conf_file = os.path.join(deployment_dir, "tempest.conf")
200     if os.path.isfile(tempest_conf_file):
201         logger.debug("Verifier is already configured.")
202         logger.debug("Reconfiguring the current verifier...")
203         cmd = "rally verify configure-verifier --reconfigure"
204     else:
205         logger.info("Configuring the verifier...")
206         cmd = "rally verify configure-verifier"
207     ft_utils.execute_command(cmd)
208
209     logger.debug("Looking for tempest.conf file...")
210     if not os.path.isfile(tempest_conf_file):
211         logger.error("Tempest configuration file %s NOT found."
212                      % tempest_conf_file)
213         raise Exception("Tempest configuration file %s NOT found."
214                         % tempest_conf_file)
215     else:
216         return tempest_conf_file
217
218
219 def configure_tempest_multisite_params(tempest_conf_file):
220     """
221     Add/update multisite parameters into tempest.conf file generated by Rally
222     """
223     logger.debug("Updating multisite tempest.conf parameters...")
224     config = ConfigParser.RawConfigParser()
225     config.read(tempest_conf_file)
226
227     config.set('service_available', 'kingbird', 'true')
228     # cmd = ("openstack endpoint show kingbird | grep publicurl |"
229     #       "awk '{print $4}' | awk -F '/' '{print $4}'")
230     # kingbird_api_version = os.popen(cmd).read()
231     kingbird_api_version = os_utils.get_endpoint(service_type='multisite')
232
233     if CI_INSTALLER_TYPE == 'fuel':
234         # For MOS based setup, the service is accessible
235         # via bind host
236         kingbird_conf_path = "/etc/kingbird/kingbird.conf"
237         installer_type = CI_INSTALLER_TYPE
238         installer_ip = CI_INSTALLER_IP
239         installer_username = CONST.__getattribute__(
240             'multisite_{}_installer_username'.format(installer_type))
241         installer_password = CONST.__getattribute__(
242             'multisite_{}_installer_password'.format(installer_type))
243
244         ssh_options = ("-o UserKnownHostsFile=/dev/null -o "
245                        "StrictHostKeyChecking=no")
246
247         # Get the controller IP from the fuel node
248         cmd = 'sshpass -p %s ssh 2>/dev/null %s %s@%s \
249                 \'fuel node --env 1| grep controller | grep "True\|  1" \
250                 | awk -F\| "{print \$5}"\'' % (installer_password,
251                                                ssh_options,
252                                                installer_username,
253                                                installer_ip)
254         multisite_controller_ip = "".join(os.popen(cmd).read().split())
255
256         # Login to controller and get bind host details
257         cmd = 'sshpass -p %s ssh 2>/dev/null  %s %s@%s "ssh %s \\" \
258             grep -e "^bind_" %s  \\""' % (installer_password,
259                                           ssh_options,
260                                           installer_username,
261                                           installer_ip,
262                                           multisite_controller_ip,
263                                           kingbird_conf_path)
264         bind_details = os.popen(cmd).read()
265         bind_details = "".join(bind_details.split())
266         # Extract port number from the bind details
267         bind_port = re.findall(r"\D(\d{4})", bind_details)[0]
268         # Extract ip address from the bind details
269         bind_host = re.findall(r"\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}",
270                                bind_details)[0]
271         kingbird_endpoint_url = "http://%s:%s/" % (bind_host, bind_port)
272     else:
273         # cmd = "openstack endpoint show kingbird | grep publicurl |\
274         #       awk '{print $4}' | awk -F '/' '{print $3}'"
275         # kingbird_endpoint_url = os.popen(cmd).read()
276         kingbird_endpoint_url = os_utils.get_endpoint(service_type='kingbird')
277
278     try:
279         config.add_section("kingbird")
280     except Exception:
281         logger.info('kingbird section exist')
282     config.set('kingbird', 'endpoint_type', 'publicURL')
283     config.set('kingbird', 'TIME_TO_SYNC', '20')
284     config.set('kingbird', 'endpoint_url', kingbird_endpoint_url)
285     config.set('kingbird', 'api_version', kingbird_api_version)
286     with open(tempest_conf_file, 'wb') as config_file:
287         config.write(config_file)
288
289     backup_tempest_config(tempest_conf_file)
290
291
292 def install_verifier_ext(path):
293     """
294     Install extension to active verifier
295     """
296     logger.info("Installing verifier from existing repo...")
297     tag = get_repo_tag(path)
298     cmd = ("rally verify add-verifier-ext --source {0} "
299            "--version {1}"
300            .format(path, tag))
301     error_msg = ("Problem while adding verifier extension from %s" % path)
302     ft_utils.execute_command_raise(cmd, error_msg=error_msg)