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 """
22 from snaps.openstack.utils import nova_utils
24 from functest.utils import config
26 RESULT_SPRIT_INDEX = {
36 NOVA_CLIENT_API_VERSION = '2'
37 NOVA_CILENT_NETWORK_INFO_INDEX = 0
38 CFY_INFO_OUTPUT_FILE = "output.txt"
40 CIDR_NETWORK_SEGMENT_INFO_INDEX = 0
41 PACKET_LOST_INFO_INDEX = 0
42 PACKET_TOTAL_INFO_INDEX = 1
44 NUMBER_OF_DIGITS_FOR_AVG_TRANSFER = 0
45 NUMBER_OF_DIGITS_FOR_AVG_BANDWIDTH = 0
46 NUMBER_OF_DIGITS_FOR_AVG_JITTER = 3
47 NUMBER_OF_DIGITS_FOR_AVG_PKT_LOSS = 1
50 class Utilvnf(object): # pylint: disable=too-many-instance-attributes
51 """ Utility class of vrouter testcase """
53 logger = logging.getLogger(__name__)
57 self.vnf_data_dir = getattr(config.CONF, 'dir_router_data')
58 self.opnfv_vnf_data_dir = "opnfv-vnf-data/"
59 self.command_template_dir = "command_template/"
60 self.test_scenario_yaml = "test_scenario.yaml"
61 test_env_config_yaml_file = "test_env_config.yaml"
62 self.test_cmd_map_yaml_file = "test_cmd_map.yaml"
63 self.test_env_config_yaml = os.path.join(
65 self.opnfv_vnf_data_dir,
66 test_env_config_yaml_file)
68 self.blueprint_dir = "opnfv-vnf-vyos-blueprint/"
69 self.blueprint_file_name = "function-test-openstack-blueprint.yaml"
71 if not os.path.exists(self.vnf_data_dir):
72 os.makedirs(self.vnf_data_dir)
74 case_dir = pkg_resources.resource_filename(
75 'functest', 'opnfv_tests/vnf/router')
77 config_file_name = getattr(
78 config.CONF, 'vnf_{}_config'.format("vyos_vrouter"))
80 config_file = os.path.join(case_dir, config_file_name)
82 with open(config_file) as file_fd:
83 vrouter_config_yaml = yaml.safe_load(file_fd)
86 test_data = vrouter_config_yaml.get("test_data")
88 self.logger.debug("Downloading the test data.")
89 vrouter_data_path = self.vnf_data_dir + self.opnfv_vnf_data_dir
91 if not os.path.exists(vrouter_data_path):
92 Repo.clone_from(test_data['url'],
94 branch=test_data['branch'])
96 with open(self.test_env_config_yaml) as file_fd:
97 test_env_config_yaml = yaml.safe_load(file_fd)
100 self.image = test_env_config_yaml.get(
101 "general").get("images").get("vyos")
102 self.tester_image = test_env_config_yaml.get(
103 "general").get("images").get("tester_vm_os")
105 self.test_result_json_file = "test_result.json"
106 if os.path.isfile(self.test_result_json_file):
107 os.remove(self.test_result_json_file)
108 self.logger.debug("removed %s", self.test_result_json_file)
110 def get_nova_client(self):
111 nova_client = nova_utils.nova_client(self.snaps_creds)
115 def set_credentials(self, snaps_creds):
116 self.snaps_creds = snaps_creds
118 def get_address(self, server_name, network_name):
119 nova_client = self.get_nova_client()
120 servers_list = nova_client.servers.list()
123 for server in servers_list:
124 if server.name == server_name:
127 address = server.addresses[
128 network_name][NOVA_CILENT_NETWORK_INFO_INDEX]["addr"]
132 def get_mac_address(self, server_name, network_name):
133 nova_client = self.get_nova_client()
134 servers_list = nova_client.servers.list()
137 for server in servers_list:
138 if server.name == server_name:
141 mac_address = server.addresses[network_name][
142 NOVA_CILENT_NETWORK_INFO_INDEX]["OS-EXT-IPS-MAC:mac_addr"]
146 def reboot_vm(self, server_name):
147 nova_client = self.get_nova_client()
148 servers_list = nova_client.servers.list()
151 for server in servers_list:
152 if server.name == server_name:
159 def delete_vm(self, server_name):
160 nova_client = self.get_nova_client()
161 servers_list = nova_client.servers.list()
164 for server in servers_list:
165 if server.name == server_name:
166 nova_client.servers.delete(server)
171 def get_blueprint_outputs(self, cfy_manager_ip, deployment_name):
172 url = "http://%s/deployments/%s/outputs" % (
173 cfy_manager_ip, deployment_name)
175 response = requests.get(
177 auth=requests.auth.HTTPBasicAuth('admin', 'admin'),
178 headers={'Tenant': 'default_tenant'})
180 resp_data = response.json()
181 self.logger.debug(resp_data)
182 data = resp_data["outputs"]
185 def get_blueprint_outputs_vnfs(self, cfy_manager_ip, deployment_name):
186 outputs = self.get_blueprint_outputs(cfy_manager_ip,
188 vnfs = outputs["vnfs"]
190 for vnf_name in vnfs:
191 vnf_list.append(vnfs[vnf_name])
194 def get_blueprint_outputs_networks(self, cfy_manager_ip, deployment_name):
195 outputs = self.get_blueprint_outputs(cfy_manager_ip,
197 networks = outputs["networks"]
199 for network_name in networks:
200 network_list.append(networks[network_name])
203 def request_vnf_reboot(self, vnf_info_list):
204 for vnf in vnf_info_list:
205 self.logger.debug("reboot the %s", vnf["vnf_name"])
206 self.reboot_vm(vnf["vnf_name"])
208 def request_vm_delete(self, vnf_info_list):
209 for vnf in vnf_info_list:
210 self.logger.debug("delete the %s", vnf["vnf_name"])
211 self.delete_vm(vnf["vnf_name"])
213 def get_vnf_info_list(self, cfy_manager_ip, topology_deploy_name,
215 network_list = self.get_blueprint_outputs_networks(
217 topology_deploy_name)
218 vnf_info_list = self.get_blueprint_outputs_vnfs(cfy_manager_ip,
219 topology_deploy_name)
220 for vnf in vnf_info_list:
221 vnf_name = vnf["vnf_name"]
222 vnf["os_type"] = self.image["os_type"]
223 vnf["user"] = self.image["user"]
224 vnf["pass"] = self.image["pass"]
226 vnf["target_vnf_flag"] = bool(vnf_name == target_vnf_name)
228 self.logger.debug("vnf name : %s", vnf_name)
229 self.logger.debug(vnf_name + " floating ip address : " +
232 for network in network_list:
233 network_name = network["network_name"]
234 ip_address = self.get_address(vnf["vnf_name"],
235 network["network_name"])
236 vnf[network_name + "_ip"] = ip_address
237 mac = self.get_mac_address(vnf["vnf_name"],
238 network["network_name"])
239 vnf[network_name + "_mac"] = mac
241 self.logger.debug(network_name + "_ip of " + vnf["vnf_name"] +
242 " : " + vnf[network_name + "_ip"])
243 self.logger.debug(network_name + "_mac of " + vnf["vnf_name"] +
244 " : " + vnf[network_name + "_mac"])
249 def get_target_vnf(vnf_info_list):
250 for vnf in vnf_info_list:
251 if vnf["target_vnf_flag"]:
257 def get_reference_vnf_list(vnf_info_list):
258 reference_vnf_list = []
259 for vnf in vnf_info_list:
260 if not vnf["target_vnf_flag"]:
261 reference_vnf_list.append(vnf)
263 return reference_vnf_list
266 def get_vnf_info(vnf_info_list, vnf_name):
267 for vnf in vnf_info_list:
268 if vnf["vnf_name"] == vnf_name:
274 def convert_functional_test_result(result_data_list):
276 for result_data in result_data_list:
277 test_kind = result_data["test_kind"]
278 protocol = result_data["protocol"]
279 test_result_data = result_data["result"]
281 if test_kind not in result:
282 result[test_kind] = []
284 result[test_kind].append({protocol: test_result_data})
286 return {"Functional_test": result}
288 def write_result_data(self, result_data):
290 if not os.path.isfile(self.test_result_json_file):
291 file_fd = open(self.test_result_json_file, "w")
294 file_fd = open(self.test_result_json_file, "r")
295 test_result = json.load(file_fd)
298 test_result.append(result_data)
300 file_fd = open(self.test_result_json_file, "w")
301 json.dump(test_result, file_fd)
304 def output_test_result_json(self):
305 if os.path.isfile(self.test_result_json_file):
306 file_fd = open(self.test_result_json_file, "r")
307 test_result = json.load(file_fd)
309 output_json_data = json.dumps(test_result,
312 self.logger.debug("test_result %s", output_json_data)
314 self.logger.debug("Not found %s", self.test_result_json_file)
317 def get_test_scenario(file_path):
318 test_scenario_file = open(file_path,
320 test_scenario_yaml = yaml.safe_load(test_scenario_file)
321 test_scenario_file.close()
322 return test_scenario_yaml["test_scenario_list"]