3 # Copyright (c) 2017 Okinawa Open Laboratory and others.
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
10 # pylint: disable=missing-docstring
12 """ Utility module of vrouter testcase """
21 from functest.utils.constants import CONST
23 from requests.auth import HTTPBasicAuth
24 from snaps.openstack.utils import nova_utils
27 RESULT_SPRIT_INDEX = {
37 NOVA_CLIENT_API_VERSION = '2'
38 NOVA_CILENT_NETWORK_INFO_INDEX = 0
39 CFY_INFO_OUTPUT_FILE = "output.txt"
41 CIDR_NETWORK_SEGMENT_INFO_INDEX = 0
42 PACKET_LOST_INFO_INDEX = 0
43 PACKET_TOTAL_INFO_INDEX = 1
45 NUMBER_OF_DIGITS_FOR_AVG_TRANSFER = 0
46 NUMBER_OF_DIGITS_FOR_AVG_BANDWIDTH = 0
47 NUMBER_OF_DIGITS_FOR_AVG_JITTER = 3
48 NUMBER_OF_DIGITS_FOR_AVG_PKT_LOSS = 1
51 class Utilvnf(object): # pylint: disable=too-many-instance-attributes
52 """ Utility class of vrouter testcase """
54 logger = logging.getLogger(__name__)
59 data_dir = data_dir = CONST.__getattribute__('dir_router_data')
61 self.vnf_data_dir = data_dir
62 self.opnfv_vnf_data_dir = "opnfv-vnf-data/"
63 self.command_template_dir = "command_template/"
64 self.test_scenario_yaml = "test_scenario.yaml"
65 test_env_config_yaml_file = "test_env_config.yaml"
66 self.test_cmd_map_yaml_file = "test_cmd_map.yaml"
67 self.test_env_config_yaml = os.path.join(
69 self.opnfv_vnf_data_dir,
70 test_env_config_yaml_file)
72 self.blueprint_dir = "opnfv-vnf-vyos-blueprint/"
73 self.blueprint_file_name = "function-test-openstack-blueprint.yaml"
75 if not os.path.exists(self.vnf_data_dir):
76 os.makedirs(self.vnf_data_dir)
78 case_dir = pkg_resources.resource_filename(
79 'functest', 'opnfv_tests/vnf/router')
81 config_file_name = CONST.__getattribute__(
82 'vnf_{}_config'.format("vyos_vrouter"))
84 config_file = os.path.join(case_dir, config_file_name)
86 with open(config_file) as file_fd:
87 vrouter_config_yaml = yaml.safe_load(file_fd)
90 test_data = vrouter_config_yaml.get("test_data")
92 self.logger.debug("Downloading the test data.")
93 vrouter_data_path = self.vnf_data_dir + self.opnfv_vnf_data_dir
95 if not os.path.exists(vrouter_data_path):
96 Repo.clone_from(test_data['url'],
98 branch=test_data['branch'])
100 with open(self.test_env_config_yaml) as file_fd:
101 test_env_config_yaml = yaml.safe_load(file_fd)
104 self.image = test_env_config_yaml.get(
105 "general").get("images").get("vyos")
106 self.tester_image = test_env_config_yaml.get(
107 "general").get("images").get("tester_vm_os")
109 self.test_result_json_file = "test_result.json"
110 if os.path.isfile(self.test_result_json_file):
111 os.remove(self.test_result_json_file)
112 self.logger.debug("removed %s", self.test_result_json_file)
114 def get_nova_client(self):
115 nova_client = nova_utils.nova_client(self.snaps_creds)
119 def set_credentials(self, snaps_creds):
120 self.snaps_creds = snaps_creds
122 def get_address(self, server_name, network_name):
123 nova_client = self.get_nova_client()
124 servers_list = nova_client.servers.list()
127 for server in servers_list:
128 if server.name == server_name:
131 address = server.addresses[
132 network_name][NOVA_CILENT_NETWORK_INFO_INDEX]["addr"]
136 def get_mac_address(self, server_name, network_name):
137 nova_client = self.get_nova_client()
138 servers_list = nova_client.servers.list()
141 for server in servers_list:
142 if server.name == server_name:
145 mac_address = server.addresses[network_name][
146 NOVA_CILENT_NETWORK_INFO_INDEX]["OS-EXT-IPS-MAC:mac_addr"]
150 def reboot_vm(self, server_name):
151 nova_client = self.get_nova_client()
152 servers_list = nova_client.servers.list()
155 for server in servers_list:
156 if server.name == server_name:
163 def delete_vm(self, server_name):
164 nova_client = self.get_nova_client()
165 servers_list = nova_client.servers.list()
168 for server in servers_list:
169 if server.name == server_name:
170 nova_client.servers.delete(server)
175 def get_blueprint_outputs(self, cfy_manager_ip, deployment_name):
176 url = "http://%s/deployments/%s/outputs" % (
177 cfy_manager_ip, deployment_name)
179 response = requests.get(
181 auth=HTTPBasicAuth('admin', 'admin'),
182 headers={'Tenant': 'default_tenant'})
184 resp_data = response.json()
185 self.logger.debug(resp_data)
186 data = resp_data["outputs"]
189 def get_blueprint_outputs_vnfs(self, cfy_manager_ip, deployment_name):
190 outputs = self.get_blueprint_outputs(cfy_manager_ip,
192 vnfs = outputs["vnfs"]
194 for vnf_name in vnfs:
195 vnf_list.append(vnfs[vnf_name])
198 def get_blueprint_outputs_networks(self, cfy_manager_ip, deployment_name):
199 outputs = self.get_blueprint_outputs(cfy_manager_ip,
201 networks = outputs["networks"]
203 for network_name in networks:
204 network_list.append(networks[network_name])
207 def request_vnf_reboot(self, vnf_info_list):
208 for vnf in vnf_info_list:
209 self.logger.debug("reboot the " + vnf["vnf_name"])
210 self.reboot_vm(vnf["vnf_name"])
212 def request_vm_delete(self, vnf_info_list):
213 for vnf in vnf_info_list:
214 self.logger.debug("delete the " + vnf["vnf_name"])
215 self.delete_vm(vnf["vnf_name"])
217 def get_vnf_info_list(self, cfy_manager_ip, topology_deploy_name,
219 network_list = self.get_blueprint_outputs_networks(
221 topology_deploy_name)
222 vnf_info_list = self.get_blueprint_outputs_vnfs(cfy_manager_ip,
223 topology_deploy_name)
224 for vnf in vnf_info_list:
225 vnf_name = vnf["vnf_name"]
226 vnf["os_type"] = self.image["os_type"]
227 vnf["user"] = self.image["user"]
228 vnf["pass"] = self.image["pass"]
230 vnf["target_vnf_flag"] = bool(vnf_name == target_vnf_name)
232 self.logger.debug("vnf name : " + vnf_name)
233 self.logger.debug(vnf_name + " floating ip address : " +
236 for network in network_list:
237 network_name = network["network_name"]
238 ip_address = self.get_address(vnf["vnf_name"],
239 network["network_name"])
240 vnf[network_name + "_ip"] = ip_address
241 mac = self.get_mac_address(vnf["vnf_name"],
242 network["network_name"])
243 vnf[network_name + "_mac"] = mac
245 self.logger.debug(network_name + "_ip of " + vnf["vnf_name"] +
246 " : " + vnf[network_name + "_ip"])
247 self.logger.debug(network_name + "_mac of " + vnf["vnf_name"] +
248 " : " + vnf[network_name + "_mac"])
253 def get_target_vnf(vnf_info_list):
254 for vnf in vnf_info_list:
255 if vnf["target_vnf_flag"]:
261 def get_reference_vnf_list(vnf_info_list):
262 reference_vnf_list = []
263 for vnf in vnf_info_list:
264 if not vnf["target_vnf_flag"]:
265 reference_vnf_list.append(vnf)
267 return reference_vnf_list
270 def get_vnf_info(vnf_info_list, vnf_name):
271 for vnf in vnf_info_list:
272 if vnf["vnf_name"] == vnf_name:
278 def convert_functional_test_result(result_data_list):
280 for result_data in result_data_list:
281 test_kind = result_data["test_kind"]
282 protocol = result_data["protocol"]
283 test_result_data = result_data["result"]
285 if test_kind not in result:
286 result[test_kind] = []
288 result[test_kind].append({protocol: test_result_data})
290 return {"Functional_test": result}
292 def write_result_data(self, result_data):
294 if not os.path.isfile(self.test_result_json_file):
295 file_fd = open(self.test_result_json_file, "w")
298 file_fd = open(self.test_result_json_file, "r")
299 test_result = json.load(file_fd)
302 test_result.append(result_data)
304 file_fd = open(self.test_result_json_file, "w")
305 json.dump(test_result, file_fd)
308 def output_test_result_json(self):
309 if os.path.isfile(self.test_result_json_file):
310 file_fd = open(self.test_result_json_file, "r")
311 test_result = json.load(file_fd)
313 output_json_data = json.dumps(test_result,
316 self.logger.debug("test_result %s", output_json_data)
318 self.logger.debug("Not found %s", self.test_result_json_file)
321 def get_test_scenario(file_path):
322 test_scenario_file = open(file_path,
324 test_scenario_yaml = yaml.safe_load(test_scenario_file)
325 test_scenario_file.close()
326 return test_scenario_yaml["test_scenario_list"]