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 import config
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__)
58 self.vnf_data_dir = getattr(config.CONF, 'dir_router_data')
59 self.opnfv_vnf_data_dir = "opnfv-vnf-data/"
60 self.command_template_dir = "command_template/"
61 self.test_scenario_yaml = "test_scenario.yaml"
62 test_env_config_yaml_file = "test_env_config.yaml"
63 self.test_cmd_map_yaml_file = "test_cmd_map.yaml"
64 self.test_env_config_yaml = os.path.join(
66 self.opnfv_vnf_data_dir,
67 test_env_config_yaml_file)
69 self.blueprint_dir = "opnfv-vnf-vyos-blueprint/"
70 self.blueprint_file_name = "function-test-openstack-blueprint.yaml"
72 if not os.path.exists(self.vnf_data_dir):
73 os.makedirs(self.vnf_data_dir)
75 case_dir = pkg_resources.resource_filename(
76 'functest', 'opnfv_tests/vnf/router')
78 config_file_name = getattr(
79 config.CONF, 'vnf_{}_config'.format("vyos_vrouter"))
81 config_file = os.path.join(case_dir, config_file_name)
83 with open(config_file) as file_fd:
84 vrouter_config_yaml = yaml.safe_load(file_fd)
87 test_data = vrouter_config_yaml.get("test_data")
89 self.logger.debug("Downloading the test data.")
90 vrouter_data_path = self.vnf_data_dir + self.opnfv_vnf_data_dir
92 if not os.path.exists(vrouter_data_path):
93 Repo.clone_from(test_data['url'],
95 branch=test_data['branch'])
97 with open(self.test_env_config_yaml) as file_fd:
98 test_env_config_yaml = yaml.safe_load(file_fd)
101 self.image = test_env_config_yaml.get(
102 "general").get("images").get("vyos")
103 self.tester_image = test_env_config_yaml.get(
104 "general").get("images").get("tester_vm_os")
106 self.test_result_json_file = "test_result.json"
107 if os.path.isfile(self.test_result_json_file):
108 os.remove(self.test_result_json_file)
109 self.logger.debug("removed %s", self.test_result_json_file)
111 def get_nova_client(self):
112 nova_client = nova_utils.nova_client(self.snaps_creds)
116 def set_credentials(self, snaps_creds):
117 self.snaps_creds = snaps_creds
119 def get_address(self, server_name, network_name):
120 nova_client = self.get_nova_client()
121 servers_list = nova_client.servers.list()
124 for server in servers_list:
125 if server.name == server_name:
128 address = server.addresses[
129 network_name][NOVA_CILENT_NETWORK_INFO_INDEX]["addr"]
133 def get_mac_address(self, server_name, network_name):
134 nova_client = self.get_nova_client()
135 servers_list = nova_client.servers.list()
138 for server in servers_list:
139 if server.name == server_name:
142 mac_address = server.addresses[network_name][
143 NOVA_CILENT_NETWORK_INFO_INDEX]["OS-EXT-IPS-MAC:mac_addr"]
147 def reboot_vm(self, server_name):
148 nova_client = self.get_nova_client()
149 servers_list = nova_client.servers.list()
152 for server in servers_list:
153 if server.name == server_name:
160 def delete_vm(self, server_name):
161 nova_client = self.get_nova_client()
162 servers_list = nova_client.servers.list()
165 for server in servers_list:
166 if server.name == server_name:
167 nova_client.servers.delete(server)
172 def get_blueprint_outputs(self, cfy_manager_ip, deployment_name):
173 url = "http://%s/deployments/%s/outputs" % (
174 cfy_manager_ip, deployment_name)
176 response = requests.get(
178 auth=HTTPBasicAuth('admin', 'admin'),
179 headers={'Tenant': 'default_tenant'})
181 resp_data = response.json()
182 self.logger.debug(resp_data)
183 data = resp_data["outputs"]
186 def get_blueprint_outputs_vnfs(self, cfy_manager_ip, deployment_name):
187 outputs = self.get_blueprint_outputs(cfy_manager_ip,
189 vnfs = outputs["vnfs"]
191 for vnf_name in vnfs:
192 vnf_list.append(vnfs[vnf_name])
195 def get_blueprint_outputs_networks(self, cfy_manager_ip, deployment_name):
196 outputs = self.get_blueprint_outputs(cfy_manager_ip,
198 networks = outputs["networks"]
200 for network_name in networks:
201 network_list.append(networks[network_name])
204 def request_vnf_reboot(self, vnf_info_list):
205 for vnf in vnf_info_list:
206 self.logger.debug("reboot the " + vnf["vnf_name"])
207 self.reboot_vm(vnf["vnf_name"])
209 def request_vm_delete(self, vnf_info_list):
210 for vnf in vnf_info_list:
211 self.logger.debug("delete the " + vnf["vnf_name"])
212 self.delete_vm(vnf["vnf_name"])
214 def get_vnf_info_list(self, cfy_manager_ip, topology_deploy_name,
216 network_list = self.get_blueprint_outputs_networks(
218 topology_deploy_name)
219 vnf_info_list = self.get_blueprint_outputs_vnfs(cfy_manager_ip,
220 topology_deploy_name)
221 for vnf in vnf_info_list:
222 vnf_name = vnf["vnf_name"]
223 vnf["os_type"] = self.image["os_type"]
224 vnf["user"] = self.image["user"]
225 vnf["pass"] = self.image["pass"]
227 vnf["target_vnf_flag"] = bool(vnf_name == target_vnf_name)
229 self.logger.debug("vnf name : " + vnf_name)
230 self.logger.debug(vnf_name + " floating ip address : " +
233 for network in network_list:
234 network_name = network["network_name"]
235 ip_address = self.get_address(vnf["vnf_name"],
236 network["network_name"])
237 vnf[network_name + "_ip"] = ip_address
238 mac = self.get_mac_address(vnf["vnf_name"],
239 network["network_name"])
240 vnf[network_name + "_mac"] = mac
242 self.logger.debug(network_name + "_ip of " + vnf["vnf_name"] +
243 " : " + vnf[network_name + "_ip"])
244 self.logger.debug(network_name + "_mac of " + vnf["vnf_name"] +
245 " : " + vnf[network_name + "_mac"])
250 def get_target_vnf(vnf_info_list):
251 for vnf in vnf_info_list:
252 if vnf["target_vnf_flag"]:
258 def get_reference_vnf_list(vnf_info_list):
259 reference_vnf_list = []
260 for vnf in vnf_info_list:
261 if not vnf["target_vnf_flag"]:
262 reference_vnf_list.append(vnf)
264 return reference_vnf_list
267 def get_vnf_info(vnf_info_list, vnf_name):
268 for vnf in vnf_info_list:
269 if vnf["vnf_name"] == vnf_name:
275 def convert_functional_test_result(result_data_list):
277 for result_data in result_data_list:
278 test_kind = result_data["test_kind"]
279 protocol = result_data["protocol"]
280 test_result_data = result_data["result"]
282 if test_kind not in result:
283 result[test_kind] = []
285 result[test_kind].append({protocol: test_result_data})
287 return {"Functional_test": result}
289 def write_result_data(self, result_data):
291 if not os.path.isfile(self.test_result_json_file):
292 file_fd = open(self.test_result_json_file, "w")
295 file_fd = open(self.test_result_json_file, "r")
296 test_result = json.load(file_fd)
299 test_result.append(result_data)
301 file_fd = open(self.test_result_json_file, "w")
302 json.dump(test_result, file_fd)
305 def output_test_result_json(self):
306 if os.path.isfile(self.test_result_json_file):
307 file_fd = open(self.test_result_json_file, "r")
308 test_result = json.load(file_fd)
310 output_json_data = json.dumps(test_result,
313 self.logger.debug("test_result %s", output_json_data)
315 self.logger.debug("Not found %s", self.test_result_json_file)
318 def get_test_scenario(file_path):
319 test_scenario_file = open(file_path,
321 test_scenario_yaml = yaml.safe_load(test_scenario_file)
322 test_scenario_file.close()
323 return test_scenario_yaml["test_scenario_list"]