Merge "Integrate new Domino package"
[functest.git] / functest / opnfv_tests / openstack / tempest / conf_utils.py
1 #!/usr/bin/env 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 logging
12 import os
13 import pkg_resources
14 import shutil
15 import subprocess
16
17 import yaml
18
19 from functest.utils.constants import CONST
20 import functest.utils.functest_utils as ft_utils
21 import functest.utils.openstack_utils as os_utils
22
23
24 IMAGE_ID_ALT = None
25 FLAVOR_ID_ALT = None
26 GLANCE_IMAGE_PATH = os.path.join(
27     CONST.__getattribute__('dir_functest_images'),
28     CONST.__getattribute__('openstack_image_file_name'))
29 TEMPEST_RESULTS_DIR = os.path.join(CONST.__getattribute__('dir_results'),
30                                    'tempest')
31 TEMPEST_CUSTOM = pkg_resources.resource_filename(
32     'functest', 'opnfv_tests/openstack/tempest/custom_tests/test_list.txt')
33 TEMPEST_BLACKLIST = pkg_resources.resource_filename(
34     'functest', 'opnfv_tests/openstack/tempest/custom_tests/blacklist.txt')
35 TEMPEST_DEFCORE = pkg_resources.resource_filename(
36     'functest',
37     'opnfv_tests/openstack/tempest/custom_tests/defcore_req.txt')
38 TEMPEST_RAW_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_raw_list.txt')
39 TEMPEST_LIST = os.path.join(TEMPEST_RESULTS_DIR, 'test_list.txt')
40 REFSTACK_RESULTS_DIR = os.path.join(CONST.__getattribute__('dir_results'),
41                                     'refstack')
42 TEMPEST_CONF_YAML = pkg_resources.resource_filename(
43     'functest', 'opnfv_tests/openstack/tempest/custom_tests/tempest_conf.yaml')
44 TEST_ACCOUNTS_FILE = pkg_resources.resource_filename(
45     'functest',
46     'opnfv_tests/openstack/tempest/custom_tests/test_accounts.yaml')
47
48 CI_INSTALLER_TYPE = CONST.__getattribute__('INSTALLER_TYPE')
49 CI_INSTALLER_IP = CONST.__getattribute__('INSTALLER_IP')
50
51 """ logging configuration """
52 logger = logging.getLogger(__name__)
53
54
55 def get_verifier_id():
56     """
57     Returns verifier id for current Tempest
58     """
59     cmd = ("rally verify list-verifiers | awk '/" +
60            CONST.__getattribute__('tempest_deployment_name') +
61            "/ {print $2}'")
62     p = subprocess.Popen(cmd, shell=True,
63                          stdout=subprocess.PIPE,
64                          stderr=subprocess.STDOUT)
65     deployment_uuid = p.stdout.readline().rstrip()
66     if deployment_uuid == "":
67         logger.error("Tempest verifier not found.")
68         raise Exception('Error with command:%s' % cmd)
69     return deployment_uuid
70
71
72 def get_verifier_deployment_id():
73     """
74     Returns deployment id for active Rally deployment
75     """
76     cmd = ("rally deployment list | awk '/" +
77            CONST.__getattribute__('rally_deployment_name') +
78            "/ {print $2}'")
79     p = subprocess.Popen(cmd, shell=True,
80                          stdout=subprocess.PIPE,
81                          stderr=subprocess.STDOUT)
82     deployment_uuid = p.stdout.readline().rstrip()
83     if deployment_uuid == "":
84         logger.error("Rally deployment not found.")
85         raise Exception('Error with command:%s' % cmd)
86     return deployment_uuid
87
88
89 def get_verifier_repo_dir(verifier_id):
90     """
91     Returns installed verifier repo directory for Tempest
92     """
93     if not verifier_id:
94         verifier_id = get_verifier_id()
95
96     return os.path.join(CONST.__getattribute__('dir_rally_inst'),
97                         'verification',
98                         'verifier-{}'.format(verifier_id),
99                         'repo')
100
101
102 def get_verifier_deployment_dir(verifier_id, deployment_id):
103     """
104     Returns Rally deployment directory for current verifier
105     """
106     if not verifier_id:
107         verifier_id = get_verifier_id()
108
109     if not deployment_id:
110         deployment_id = get_verifier_deployment_id()
111
112     return os.path.join(CONST.__getattribute__('dir_rally_inst'),
113                         'verification',
114                         'verifier-{}'.format(verifier_id),
115                         'for-deployment-{}'.format(deployment_id))
116
117
118 def get_repo_tag(repo):
119     """
120     Returns last tag of current branch
121     """
122     cmd = ("git -C {0} describe --abbrev=0 HEAD".format(repo))
123     p = subprocess.Popen(cmd, stdout=subprocess.PIPE, shell=True)
124     tag = p.stdout.readline().rstrip()
125
126     return str(tag)
127
128
129 def backup_tempest_config(conf_file):
130     """
131     Copy config file to tempest results directory
132     """
133     if not os.path.exists(TEMPEST_RESULTS_DIR):
134         os.makedirs(TEMPEST_RESULTS_DIR)
135     shutil.copyfile(conf_file,
136                     os.path.join(TEMPEST_RESULTS_DIR, 'tempest.conf'))
137
138
139 def configure_tempest(deployment_dir, image_id=None, flavor_id=None,
140                       compute_cnt=None):
141     """
142     Calls rally verify and updates the generated tempest.conf with
143     given parameters
144     """
145     conf_file = configure_verifier(deployment_dir)
146     configure_tempest_update_params(conf_file, image_id, flavor_id,
147                                     compute_cnt)
148
149
150 def configure_tempest_defcore(deployment_dir, image_id, flavor_id,
151                               image_id_alt, flavor_id_alt, tenant_id):
152     """
153     Add/update needed parameters into tempest.conf file
154     """
155     conf_file = configure_verifier(deployment_dir)
156     configure_tempest_update_params(conf_file, image_id, flavor_id)
157
158     logger.debug("Updating selected tempest.conf parameters for defcore...")
159     config = ConfigParser.RawConfigParser()
160     config.read(conf_file)
161     config.set('DEFAULT', 'log_file', '{}/tempest.log'.format(deployment_dir))
162     config.set('oslo_concurrency', 'lock_path',
163                '{}/lock_files'.format(deployment_dir))
164     generate_test_accounts_file(tenant_id=tenant_id)
165     config.set('auth', 'test_accounts_file', TEST_ACCOUNTS_FILE)
166     config.set('scenario', 'img_dir', '{}'.format(deployment_dir))
167     config.set('scenario', 'img_file', 'tempest-image')
168     config.set('compute', 'image_ref', image_id)
169     config.set('compute', 'image_ref_alt', image_id_alt)
170     config.set('compute', 'flavor_ref', flavor_id)
171     config.set('compute', 'flavor_ref_alt', flavor_id_alt)
172
173     with open(conf_file, 'wb') as config_file:
174         config.write(config_file)
175
176     confpath = pkg_resources.resource_filename(
177         'functest',
178         'opnfv_tests/openstack/refstack_client/refstack_tempest.conf')
179     shutil.copyfile(conf_file, confpath)
180
181
182 def generate_test_accounts_file(tenant_id):
183     """
184     Add needed tenant and user params into test_accounts.yaml
185     """
186
187     logger.debug("Add needed params into test_accounts.yaml...")
188     accounts_list = [
189         {
190             'tenant_name':
191                 CONST.__getattribute__('tempest_identity_tenant_name'),
192             'tenant_id': str(tenant_id),
193             'username': CONST.__getattribute__('tempest_identity_user_name'),
194             'password':
195                 CONST.__getattribute__('tempest_identity_user_password')
196         }
197     ]
198
199     with open(TEST_ACCOUNTS_FILE, "w") as f:
200         yaml.dump(accounts_list, f, default_flow_style=False)
201
202
203 def configure_tempest_update_params(tempest_conf_file, image_id=None,
204                                     flavor_id=None, compute_cnt=1):
205     """
206     Add/update needed parameters into tempest.conf file
207     """
208     logger.debug("Updating selected tempest.conf parameters...")
209     config = ConfigParser.RawConfigParser()
210     config.read(tempest_conf_file)
211     config.set(
212         'compute',
213         'fixed_network_name',
214         CONST.__getattribute__('tempest_private_net_name'))
215     config.set('compute', 'volume_device_name',
216                CONST.__getattribute__('tempest_volume_device_name'))
217     if CONST.__getattribute__('tempest_use_custom_images'):
218         if image_id is not None:
219             config.set('compute', 'image_ref', image_id)
220         if IMAGE_ID_ALT is not None:
221             config.set('compute', 'image_ref_alt', IMAGE_ID_ALT)
222     if CONST.__getattribute__('tempest_use_custom_flavors'):
223         if flavor_id is not None:
224             config.set('compute', 'flavor_ref', flavor_id)
225         if FLAVOR_ID_ALT is not None:
226             config.set('compute', 'flavor_ref_alt', FLAVOR_ID_ALT)
227     if compute_cnt > 1:
228         # enable multinode tests
229         config.set('compute', 'min_compute_nodes', compute_cnt)
230
231     config.set('identity', 'region', 'RegionOne')
232     if os_utils.is_keystone_v3():
233         auth_version = 'v3'
234     else:
235         auth_version = 'v2'
236     config.set('identity', 'auth_version', auth_version)
237     config.set(
238         'validation', 'ssh_timeout',
239         CONST.__getattribute__('tempest_validation_ssh_timeout'))
240     config.set('object-storage', 'operator_role',
241                CONST.__getattribute__('tempest_object_storage_operator_role'))
242
243     if CONST.__getattribute__('OS_ENDPOINT_TYPE') is not None:
244         sections = config.sections()
245         if os_utils.is_keystone_v3():
246             config.set('identity', 'v3_endpoint_type',
247                        CONST.__getattribute__('OS_ENDPOINT_TYPE'))
248             if 'identity-feature-enabled' not in sections:
249                 config.add_section('identity-feature-enabled')
250                 config.set('identity-feature-enabled', 'api_v2', False)
251                 config.set('identity-feature-enabled', 'api_v2_admin', False)
252         services_list = ['compute',
253                          'volume',
254                          'image',
255                          'network',
256                          'data-processing',
257                          'object-storage',
258                          'orchestration']
259         for service in services_list:
260             if service not in sections:
261                 config.add_section(service)
262             config.set(service, 'endpoint_type',
263                        CONST.__getattribute__('OS_ENDPOINT_TYPE'))
264
265     logger.debug('Add/Update required params defined in tempest_conf.yaml '
266                  'into tempest.conf file')
267     with open(TEMPEST_CONF_YAML) as f:
268         conf_yaml = yaml.safe_load(f)
269     if conf_yaml:
270         sections = config.sections()
271         for section in conf_yaml:
272             if section not in sections:
273                 config.add_section(section)
274             sub_conf = conf_yaml.get(section)
275             for key, value in sub_conf.items():
276                 config.set(section, key, value)
277
278     with open(tempest_conf_file, 'wb') as config_file:
279         config.write(config_file)
280
281     backup_tempest_config(tempest_conf_file)
282
283
284 def configure_verifier(deployment_dir):
285     """
286     Execute rally verify configure-verifier, which generates tempest.conf
287     """
288     tempest_conf_file = os.path.join(deployment_dir, "tempest.conf")
289     if os.path.isfile(tempest_conf_file):
290         logger.debug("Verifier is already configured.")
291         logger.debug("Reconfiguring the current verifier...")
292         cmd = "rally verify configure-verifier --reconfigure"
293     else:
294         logger.info("Configuring the verifier...")
295         cmd = "rally verify configure-verifier"
296     ft_utils.execute_command(cmd)
297
298     logger.debug("Looking for tempest.conf file...")
299     if not os.path.isfile(tempest_conf_file):
300         logger.error("Tempest configuration file %s NOT found."
301                      % tempest_conf_file)
302         raise Exception("Tempest configuration file %s NOT found."
303                         % tempest_conf_file)
304     else:
305         return tempest_conf_file