1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
|
#!/usr/bin/env python
#
# grakiss.wanglei@huawei.com
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
#
import os
import yaml
import utils.dovetail_logger as dt_logger
import utils.dovetail_utils as dt_utils
from utils.dovetail_config import DovetailConfig as dt_cfg
class Container(object):
container_list = {}
has_pull_latest_image = {'yardstick': False, 'functest': False}
logger = None
def __init__(self):
pass
def __str__(self):
pass
@classmethod
def create_log(cls):
cls.logger = dt_logger.Logger(__name__ + '.Container').getLogger()
@classmethod
def get(cls, type):
return cls.container_list[type]
@classmethod
def get_docker_image(cls, type):
try:
return '%s:%s' % (dt_cfg.dovetail_config[type]['image_name'],
dt_cfg.dovetail_config[type]['docker_tag'])
except KeyError as e:
cls.logger.error('There is no %s in %s config file.', e, type)
return None
# get the openrc_volume for creating the container
@classmethod
def openrc_volume(cls, type):
dovetail_config = dt_cfg.dovetail_config
dovetail_config['openrc'] = os.path.join(dovetail_config['config_dir'],
dovetail_config['env_file'])
if os.path.isfile(dovetail_config['openrc']):
openrc = ' -v %s:%s ' % (dovetail_config['openrc'],
dovetail_config[type]['openrc'])
return openrc
else:
cls.logger.error("File %s is not exist", dovetail_config['openrc'])
return None
# set functest envs and TEST_DB_URL for creating functest container
@staticmethod
def set_functest_config(testcase_name):
# These are all just used by Functest's function push_results_to_db.
# And has nothing to do with DoveTail running test cases.
ins_type = os.getenv('INSTALLER_TYPE', "unknown")
scenario = os.getenv('DEPLOY_SCENARIO', "unknown")
ins_type = ''.join([" -e INSTALLER_TYPE=", ins_type])
scenario = ''.join([" -e DEPLOY_SCENARIO=", scenario])
# vpn testcase only runs when scenario name includes bgpvpn
# functest requirements
if 'sdnvpn' in testcase_name:
ins_type = "-e INSTALLER_TYPE=netvirt"
scenario = " -e DEPLOY_SCENARIO=bgpvpn"
node = " -e NODE_NAME=master"
envs = "%s %s %s" % (ins_type, scenario, node)
dovetail_config = dt_cfg.dovetail_config
if dovetail_config['report_dest'].startswith("http"):
report = " -e TEST_DB_URL=%s " % dovetail_config['report_dest']
if dovetail_config['report_dest'] == "file":
func_res_conf = dovetail_config["functest"]['result']
file_path = os.path.join(func_res_conf['dir'],
func_res_conf['file_path'])
report = " -e TEST_DB_URL=file://%s " % file_path
key_vol = " -v /root/.ssh/id_rsa:/root/.ssh/id_rsa "
return "%s %s %s" % (envs, report, key_vol)
# set yardstick external network name and log volume for its container.
# external network is necessary for yardstick.
@classmethod
def set_yardstick_config(cls):
dovetail_config = dt_cfg.dovetail_config
ext_net = dt_utils.get_ext_net_name(dovetail_config['openrc'],
cls.logger)
if ext_net:
envs = "%s%s" % (" -e EXTERNAL_NETWORK=", ext_net)
else:
cls.logger.error("Can't find any external network.")
return None
if dovetail_config['report_dest'].startswith("http"):
cls.logger.info("Yardstick can't push results to DB.")
cls.logger.info("Results will be stored with files.")
log_vol = '-v %s:%s ' % (dovetail_config['result_dir'],
dovetail_config["yardstick"]['result']['log'])
# for yardstick, support pod.yaml configuration
pod_file = os.path.join(dovetail_config['config_dir'],
dovetail_config['pod_file'])
if not os.path.isfile(pod_file):
cls.logger.error("File %s doesn't exist.", pod_file)
return None
key_file = os.path.join(dovetail_config['config_dir'],
dovetail_config['pri_key'])
key_container_path = dovetail_config["yardstick"]['result']['key_path']
if not os.path.isfile(key_file):
cls.logger.debug("Key file %s is not found, maybe can use passwd "
"method in %s to do HA test.", key_file, pod_file)
key_vol = ''
else:
key_vol = '-v %s:%s ' % (key_file, key_container_path)
return "%s %s %s" % (envs, log_vol, key_vol)
@classmethod
def create(cls, type, testcase_name):
dovetail_config = dt_cfg.dovetail_config
docker_image = cls.get_docker_image(type)
opts = dovetail_config[type]['opts']
# credentials file openrc.sh is neccessary
openrc = cls.openrc_volume(type)
if not openrc:
return None
# CI_DEBUG is used for showing the debug logs of the upstream projects
# BUILD_TAG is the unique id for this test
envs = ' -e CI_DEBUG=true'
envs = envs + ' -e BUILD_TAG=%s-%s' % (dovetail_config['build_tag'],
testcase_name)
config = ""
if type.lower() == "functest":
config = cls.set_functest_config(testcase_name)
if type.lower() == "yardstick":
config = cls.set_yardstick_config()
if not config:
return None
# for refstack, support user self_defined configuration
config_volume = \
' -v %s:%s ' % (os.getenv("DOVETAIL_HOME"),
dovetail_config[type]['config']['dir'])
hosts_config = ""
hosts_config_path = os.path.abspath(
os.path.join(os.path.dirname(__file__), os.pardir, 'userconfig'))
try:
with open(os.path.join(hosts_config_path, 'hosts.yaml')) as f:
hosts_info = yaml.safe_load(f)
if hosts_info['hosts_info']:
for host in hosts_info['hosts_info']:
hosts_config += " --add-host "
hosts_config += str(host)
cls.logger.info('get hosts info %s', hosts_config)
except Exception:
cls.logger.warn('fail to get hosts info in %s/hosts.yaml, \
maybe some issue with domain name resolution',
hosts_config_path)
result_volume = ' -v %s:%s ' % (dovetail_config['result_dir'],
dovetail_config[type]['result']['dir'])
cmd = 'sudo docker run %s %s %s %s %s %s %s %s /bin/bash' % \
(opts, envs, config, hosts_config, openrc, config_volume,
result_volume, docker_image)
dt_utils.exec_cmd(cmd, cls.logger)
ret, container_id = \
dt_utils.exec_cmd("sudo docker ps | grep " + docker_image +
" | awk '{print $1}' | head -1", cls.logger)
cls.container_list[type] = container_id
if 'sdnvpn' in str(testcase_name):
prefix_path = dt_cfg.dovetail_config[type]['config']['dir']
file_name = dt_cfg.dovetail_config['sdnvpn_image']
src_path = os.path.join(prefix_path, 'pre_config', file_name)
dest_path = '/home/opnfv/functest/images'
Container.pre_copy(container_id, src_path, dest_path)
return container_id
@classmethod
def get_image_id(cls, image_name):
cmd = 'sudo docker images -q %s' % (image_name)
ret, image_id = dt_utils.exec_cmd(cmd, cls.logger)
if ret == 0:
return image_id
else:
return None
# remove the image according to the image_id
# if there exists containers using this image, then skip
@classmethod
def remove_image(cls, image_id):
cmd = "sudo docker ps -aq -f 'ancestor=%s'" % (image_id)
ret, msg = dt_utils.exec_cmd(cmd, cls.logger)
if msg and ret == 0:
cls.logger.debug('image %s has containers, skip.', image_id)
return True
cmd = 'sudo docker rmi %s' % (image_id)
cls.logger.debug('remove image %s', image_id)
ret, msg = dt_utils.exec_cmd(cmd, cls.logger)
if ret == 0:
cls.logger.debug('remove image %s successfully', image_id)
return True
cls.logger.error('fail to remove image %s.', image_id)
return False
@classmethod
def pull_image_only(cls, image_name):
cmd = 'sudo docker pull %s' % (image_name)
ret, msg = dt_utils.exec_cmd(cmd, cls.logger)
if ret != 0:
cls.logger.error('fail to pull docker image %s!', image_name)
return False
cls.logger.debug('success to pull docker image %s!', image_name)
return True
@classmethod
def pull_image(cls, validate_type):
docker_image = cls.get_docker_image(validate_type)
if not docker_image:
return None
if cls.has_pull_latest_image[validate_type] is True:
cls.logger.debug('%s is already the newest version.', docker_image)
return docker_image
old_image_id = cls.get_image_id(docker_image)
if not cls.pull_image_only(docker_image):
return None
cls.has_pull_latest_image[validate_type] = True
new_image_id = cls.get_image_id(docker_image)
if not new_image_id:
cls.logger.error("fail to get the new image's id %s", docker_image)
return None
if not old_image_id:
return docker_image
if new_image_id == old_image_id:
cls.logger.debug('image %s has no changes, no need to remove.',
docker_image)
else:
cls.remove_image(old_image_id)
return docker_image
@classmethod
def check_image_exist(cls, validate_type):
docker_image = cls.get_docker_image(validate_type)
image_id = cls.get_image_id(docker_image)
return image_id
@classmethod
def clean(cls, container_id):
cmd1 = 'sudo docker stop %s' % (container_id)
dt_utils.exec_cmd(cmd1, cls.logger)
cmd2 = 'sudo docker rm %s' % (container_id)
dt_utils.exec_cmd(cmd2, cls.logger)
@classmethod
def exec_cmd(cls, container_id, sub_cmd, exit_on_error=False):
if sub_cmd == "":
return (1, 'sub_cmd is empty')
cmd = 'sudo docker exec %s /bin/bash -c "%s"' % (container_id, sub_cmd)
return dt_utils.exec_cmd(cmd, cls.logger, exit_on_error)
@classmethod
def pre_copy(cls, container_id, src_path, dest_path,
exit_on_error=False):
if not src_path or not dest_path:
return (1, 'src_path or dest_path is empty')
cmd = 'cp %s %s' % (src_path, dest_path)
return cls.exec_cmd(container_id, cmd, exit_on_error)
|