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 """vm controll module"""
19 from functest.opnfv_tests.vnf.router.utilvnf import Utilvnf
20 from functest.opnfv_tests.vnf.router.vnf_controller.command_generator import (
22 from functest.opnfv_tests.vnf.router.vnf_controller.ssh_client import (
26 class VmController(object):
27 """vm controll class"""
29 logger = logging.getLogger(__name__)
31 def __init__(self, util_info):
32 self.logger.debug("initialize vm controller")
33 self.command_gen = CommandGenerator()
34 credentials = util_info["credentials"]
37 self.util.set_credentials(credentials["cloud"])
39 with open(self.util.test_env_config_yaml) as file_fd:
40 test_env_config_yaml = yaml.safe_load(file_fd)
43 self.command_wait = test_env_config_yaml.get("general").get(
45 self.ssh_connect_timeout = test_env_config_yaml.get("general").get(
46 "ssh_connect_timeout")
47 self.ssh_connect_retry_count = test_env_config_yaml.get("general").get(
48 "ssh_connect_retry_count")
50 def command_gen_from_template(self, command_file_path, cmd_input_param):
51 (command_file_dir, command_file_name) = os.path.split(
53 template = self.command_gen.load_template(command_file_dir,
55 return self.command_gen.command_create(template,
58 def config_vm(self, vm_info, test_cmd_file_path,
59 cmd_input_param, prompt_file_path):
60 ssh = self.connect_ssh_and_config_vm(vm_info,
71 def connect_ssh_and_config_vm(self, vm_info, test_cmd_file_path,
72 cmd_input_param, prompt_file_path):
75 if "key_path" in vm_info:
76 key_filename = vm_info["key_path"]
78 ssh = SshClient(ip_address=vm_info["floating_ip"],
80 password=vm_info["pass"],
81 key_filename=key_filename)
83 result = ssh.connect(self.ssh_connect_timeout,
84 self.ssh_connect_retry_count)
87 "Cannot establish connection to IP '%s'. Aborting!",
91 (result, _) = self.command_create_and_execute(
102 def command_create_and_execute(self, ssh, test_cmd_file_path,
103 cmd_input_param, prompt_file_path):
104 prompt_file = open(prompt_file_path,
106 prompt = yaml.safe_load(prompt_file)
108 config_mode_prompt = prompt["config_mode"]
110 commands = self.command_gen_from_template(test_cmd_file_path,
112 return self.command_list_execute(ssh,
116 def command_list_execute(self, ssh, command_list, prompt):
118 for command in command_list:
119 self.logger.debug("Command : %s", command)
120 (res, res_data) = self.command_execute(ssh,
123 self.logger.debug("Response : %s", res_data)
124 res_data_list.append(res_data)
126 return res, res_data_list
128 time.sleep(self.command_wait)
130 return True, res_data_list
132 def command_execute(self, ssh, command, prompt):
133 res_data = ssh.send(command, prompt)
135 self.logger.info("retry send command : %s", command)
136 res_data = ssh.send(command,
138 if not ssh.error_check(res_data):
139 return False, res_data
141 return True, res_data