Refactor the vyos_vrouter to adopt VNF abstraction

JIRA: FUNCTEST-788

1.Modifying code of vyos_vrouter to inherit vnf abstraction class.
2.Adding vyos_vrouter code from our repo to functest.
3.Adding unit test of vyos_vrouter.
4.Doing test of modified vyos_vrouter codes on our labs.

Change-Id: I77e4be8b2a140ea0176c607f2be736599f893ace
Signed-off-by: Shuya Nakama <shuya.nakama@okinawaopenlabs.org>

1 files changed, 148 insertions, 0 deletions

diff --git a/functest/opnfv_tests/vnf/router/vnf_controller/vm_controller.py b/functest/opnfv_tests/vnf/router/vnf_controller/vm_controller.py
new file mode 100644
index 000000000..cd228fe26
--- /dev/null
+++ b/functest/opnfv_tests/vnf/router/vnf_controller/vm_controller.py
@@ -0,0 +1,148 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2017 Okinawa Open Laboratory and others.
+#
+# 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
+
+"""vm controll module"""
+
+import logging
+import os
+import time
+import yaml
+
+from functest.opnfv_tests.vnf.router.utilvnf import Utilvnf
+from functest.opnfv_tests.vnf.router.vnf_controller.command_generator import (
+    CommandGenerator)
+from functest.opnfv_tests.vnf.router.vnf_controller.ssh_client import (
+    SshClient)
+
+
+class VmController(object):
+    """vm controll class"""
+
+    logger = logging.getLogger(__name__)
+
+    def __init__(self, util_info):
+        self.logger.debug("initialize vm controller")
+        self.command_gen = CommandGenerator()
+        credentials = util_info["credentials"]
+
+        self.util = Utilvnf()
+        self.util.set_credentials(credentials["username"],
+                                  credentials["password"],
+                                  credentials["auth_url"],
+                                  credentials["tenant_name"],
+                                  credentials["region_name"])
+
+        with open(self.util.test_env_config_yaml) as file_fd:
+            test_env_config_yaml = yaml.safe_load(file_fd)
+        file_fd.close()
+
+        self.reboot_wait = test_env_config_yaml.get("general").get(
+            "reboot_wait")
+        self.command_wait = test_env_config_yaml.get("general").get(
+            "command_wait")
+        self.ssh_connect_timeout = test_env_config_yaml.get("general").get(
+            "ssh_connect_timeout")
+        self.ssh_connect_retry_count = test_env_config_yaml.get("general").get(
+            "ssh_connect_retry_count")
+
+    def command_gen_from_template(self, command_file_path, cmd_input_param):
+        (command_file_dir, command_file_name) = os.path.split(
+            command_file_path)
+        template = self.command_gen.load_template(command_file_dir,
+                                                  command_file_name)
+        return self.command_gen.command_create(template,
+                                               cmd_input_param)
+
+    def config_vm(self, vm_info, test_cmd_file_path,
+                  cmd_input_param, prompt_file_path):
+        ssh = self.connect_ssh_and_config_vm(vm_info,
+                                             test_cmd_file_path,
+                                             cmd_input_param,
+                                             prompt_file_path)
+        if ssh is None:
+            return False
+
+        ssh.close()
+
+        return True
+
+    def connect_ssh_and_config_vm(self, vm_info, test_cmd_file_path,
+                                  cmd_input_param, prompt_file_path):
+
+        key_filename = None
+        if "key_path" in vm_info:
+            key_filename = vm_info["key_path"]
+
+        ssh = SshClient(ip_address=vm_info["floating_ip"],
+                        user=vm_info["user"],
+                        password=vm_info["pass"],
+                        key_filename=key_filename)
+
+        result = ssh.connect(self.ssh_connect_timeout,
+                             self.ssh_connect_retry_count)
+        if not result:
+            self.logger.debug("try to vm reboot.")
+            self.util.reboot_vm(vm_info["vnf_name"])
+            time.sleep(self.reboot_wait)
+            result = ssh.connect(self.ssh_connect_timeout,
+                                 self.ssh_connect_retry_count)
+            if not result:
+                return None
+
+        (result, _) = self.command_create_and_execute(
+            ssh,
+            test_cmd_file_path,
+            cmd_input_param,
+            prompt_file_path)
+        if not result:
+            ssh.close()
+            return None
+
+        return ssh
+
+    def command_create_and_execute(self, ssh, test_cmd_file_path,
+                                   cmd_input_param, prompt_file_path):
+        prompt_file = open(prompt_file_path,
+                           'r')
+        prompt = yaml.safe_load(prompt_file)
+        prompt_file.close()
+        config_mode_prompt = prompt["config_mode"]
+
+        commands = self.command_gen_from_template(test_cmd_file_path,
+                                                  cmd_input_param)
+        return self.command_list_execute(ssh,
+                                         commands,
+                                         config_mode_prompt)
+
+    def command_list_execute(self, ssh, command_list, prompt):
+        res_data_list = []
+        for command in command_list:
+            self.logger.debug("Command : " + command)
+            (res, res_data) = self.command_execute(ssh,
+                                                   command,
+                                                   prompt)
+            self.logger.debug("Response : " + res_data)
+            res_data_list.append(res_data)
+            if not res:
+                return res, res_data_list
+
+            time.sleep(self.command_wait)
+
+        return True, res_data_list
+
+    def command_execute(self, ssh, command, prompt):
+        res_data = ssh.send(command, prompt)
+        if res_data is None:
+            self.logger.info("retry send command : " + command)
+            res_data = ssh.send(command,
+                                prompt)
+            if not ssh.error_check(res_data):
+                return False, res_data
+
+        return True, res_data