mirror of
https://github.com/GNS3/gns3-server
synced 2024-12-27 09:18:09 +00:00
9d28f4c0c3
This move the allocation of aux port to the base vm. Also now the free of console port during the close is in the base VM. An aux port is allocated to the docker container but not used for the moment. Ref https://github.com/GNS3/gns3-gui/issues/1039
293 lines
12 KiB
Python
293 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2015 GNS3 Technologies Inc.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import pytest
|
|
import aiohttp
|
|
import asyncio
|
|
import os
|
|
import sys
|
|
|
|
from tests.utils import asyncio_patch
|
|
from pkg_resources import parse_version
|
|
from unittest.mock import patch, MagicMock
|
|
|
|
from gns3server.modules.vpcs.vpcs_vm import VPCSVM
|
|
from gns3server.modules.vpcs.vpcs_error import VPCSError
|
|
from gns3server.modules.vpcs import VPCS
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def manager(port_manager):
|
|
m = VPCS.instance()
|
|
m.port_manager = port_manager
|
|
return m
|
|
|
|
|
|
@pytest.fixture(scope="function")
|
|
def vm(project, manager):
|
|
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
|
|
vm._vpcs_version = parse_version("0.9")
|
|
return vm
|
|
|
|
|
|
def test_vm(project, manager):
|
|
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
|
|
assert vm.name == "test"
|
|
assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0f"
|
|
|
|
|
|
def test_vm_check_vpcs_version(loop, vm, manager):
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.9"):
|
|
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
|
|
assert vm._vpcs_version == parse_version("0.9")
|
|
|
|
|
|
def test_vm_check_vpcs_version_0_6_1(loop, vm, manager):
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.6.1"):
|
|
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
|
|
assert vm._vpcs_version == parse_version("0.6.1")
|
|
|
|
|
|
def test_vm_invalid_vpcs_version(loop, manager, vm):
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.1"):
|
|
with pytest.raises(VPCSError):
|
|
nio = manager.create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
|
|
assert vm.name == "test"
|
|
assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0f"
|
|
|
|
|
|
def test_vm_invalid_vpcs_path(vm, manager, loop):
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM.vpcs_path", return_value="/tmp/fake/path/vpcs"):
|
|
with pytest.raises(VPCSError):
|
|
nio = manager.create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
loop.run_until_complete(asyncio.async(vm.start()))
|
|
assert vm.name == "test"
|
|
assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0e"
|
|
|
|
|
|
def test_start(loop, vm):
|
|
process = MagicMock()
|
|
process.returncode = None
|
|
queue = vm.project.get_listen_queue()
|
|
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
|
|
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process) as mock_exec:
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
loop.run_until_complete(asyncio.async(vm.start()))
|
|
assert mock_exec.call_args[0] == (vm.vpcs_path,
|
|
'-p',
|
|
str(vm.console),
|
|
'-m', '1',
|
|
'-i',
|
|
'1',
|
|
'-F',
|
|
'-R',
|
|
'-s',
|
|
'4242',
|
|
'-c',
|
|
'4243',
|
|
'-t',
|
|
'127.0.0.1')
|
|
assert vm.is_running()
|
|
assert vm.command_line == ' '.join(mock_exec.call_args[0])
|
|
(action, event) = queue.get_nowait()
|
|
assert action == "vm.started"
|
|
assert event == vm
|
|
|
|
|
|
def test_start_0_6_1(loop, vm):
|
|
"""
|
|
Version 0.6.1 doesn't have the -R options. It's not require
|
|
because GNS3 provide a patch for this.
|
|
"""
|
|
process = MagicMock()
|
|
process.returncode = None
|
|
queue = vm.project.get_listen_queue()
|
|
vm._vpcs_version = parse_version("0.6.1")
|
|
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
|
|
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process) as mock_exec:
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
loop.run_until_complete(asyncio.async(vm.start()))
|
|
assert mock_exec.call_args[0] == (vm.vpcs_path,
|
|
'-p',
|
|
str(vm.console),
|
|
'-m', '1',
|
|
'-i',
|
|
'1',
|
|
'-F',
|
|
'-s',
|
|
'4242',
|
|
'-c',
|
|
'4243',
|
|
'-t',
|
|
'127.0.0.1')
|
|
assert vm.is_running()
|
|
(action, event) = queue.get_nowait()
|
|
assert action == "vm.started"
|
|
assert event == vm
|
|
|
|
|
|
def test_stop(loop, vm):
|
|
process = MagicMock()
|
|
|
|
# Wait process kill success
|
|
future = asyncio.Future()
|
|
future.set_result(True)
|
|
process.wait.return_value = future
|
|
process.returncode = None
|
|
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
|
|
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process):
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
|
|
loop.run_until_complete(asyncio.async(vm.start()))
|
|
assert vm.is_running()
|
|
|
|
queue = vm.project.get_listen_queue()
|
|
|
|
with asyncio_patch("gns3server.utils.asyncio.wait_for_process_termination"):
|
|
loop.run_until_complete(asyncio.async(vm.stop()))
|
|
assert vm.is_running() is False
|
|
|
|
if sys.platform.startswith("win"):
|
|
process.send_signal.assert_called_with(1)
|
|
else:
|
|
process.terminate.assert_called_with()
|
|
|
|
(action, event) = queue.get_nowait()
|
|
assert action == "vm.stopped"
|
|
assert event == vm
|
|
|
|
|
|
def test_reload(loop, vm):
|
|
process = MagicMock()
|
|
|
|
# Wait process kill success
|
|
future = asyncio.Future()
|
|
future.set_result(True)
|
|
process.wait.return_value = future
|
|
process.returncode = None
|
|
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
|
|
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process):
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
loop.run_until_complete(asyncio.async(vm.start()))
|
|
assert vm.is_running()
|
|
|
|
with asyncio_patch("gns3server.utils.asyncio.wait_for_process_termination"):
|
|
loop.run_until_complete(asyncio.async(vm.reload()))
|
|
assert vm.is_running() is True
|
|
|
|
if sys.platform.startswith("win"):
|
|
process.send_signal.assert_called_with(1)
|
|
else:
|
|
process.terminate.assert_called_with()
|
|
|
|
|
|
def test_add_nio_binding_udp(vm):
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
assert nio.lport == 4242
|
|
|
|
|
|
@pytest.mark.skipif(sys.platform.startswith("win"), reason="Not supported on Windows")
|
|
def test_add_nio_binding_tap(vm, ethernet_device):
|
|
with patch("gns3server.modules.base_manager.BaseManager.has_privileged_access", return_value=True):
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_tap", "tap_device": ethernet_device})
|
|
vm.port_add_nio_binding(0, nio)
|
|
assert nio.tap_device == ethernet_device
|
|
|
|
|
|
# def test_add_nio_binding_tap_no_privileged_access(vm):
|
|
# with patch("gns3server.modules.base_manager.BaseManager.has_privileged_access", return_value=False):
|
|
# with pytest.raises(aiohttp.web.HTTPForbidden):
|
|
# nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_tap", "tap_device": "test"})
|
|
# vm.port_add_nio_binding(0, nio)
|
|
# assert vm._ethernet_adapter.ports[0] is None
|
|
#
|
|
|
|
def test_port_remove_nio_binding(vm):
|
|
nio = VPCS.instance().create_nio(vm.vpcs_path, {"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
|
|
vm.port_add_nio_binding(0, nio)
|
|
vm.port_remove_nio_binding(0)
|
|
assert vm._ethernet_adapter.ports[0] is None
|
|
|
|
|
|
def test_update_startup_script(vm):
|
|
content = "echo GNS3 VPCS\nip 192.168.1.2\n"
|
|
vm.startup_script = content
|
|
filepath = os.path.join(vm.working_dir, 'startup.vpc')
|
|
assert os.path.exists(filepath)
|
|
with open(filepath) as f:
|
|
assert f.read() == content
|
|
|
|
|
|
def test_update_startup_script_h(vm):
|
|
content = "setname %h\n"
|
|
vm.name = "pc1"
|
|
vm.startup_script = content
|
|
assert os.path.exists(vm.script_file)
|
|
with open(vm.script_file) as f:
|
|
assert f.read() == "setname pc1\n"
|
|
|
|
|
|
def test_get_startup_script(vm):
|
|
content = "echo GNS3 VPCS\nip 192.168.1.2"
|
|
vm.startup_script = content
|
|
assert vm.startup_script == os.linesep.join(["echo GNS3 VPCS", "ip 192.168.1.2"])
|
|
|
|
|
|
def test_get_startup_script_using_default_script(vm):
|
|
content = "echo GNS3 VPCS\nip 192.168.1.2\n"
|
|
|
|
# Reset script file location
|
|
vm._script_file = None
|
|
|
|
filepath = os.path.join(vm.working_dir, 'startup.vpc')
|
|
with open(filepath, 'wb+') as f:
|
|
assert f.write(content.encode("utf-8"))
|
|
|
|
assert vm.startup_script == content
|
|
assert vm.script_file == filepath
|
|
|
|
|
|
def test_change_name(vm, tmpdir):
|
|
path = os.path.join(vm.working_dir, 'startup.vpc')
|
|
vm.name = "world"
|
|
with open(path, 'w+') as f:
|
|
f.write("name world")
|
|
vm.name = "hello"
|
|
assert vm.name == "hello"
|
|
with open(path) as f:
|
|
assert f.read() == "name hello"
|
|
|
|
|
|
def test_close(vm, port_manager, loop):
|
|
with asyncio_patch("gns3server.modules.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
|
|
with asyncio_patch("asyncio.create_subprocess_exec", return_value=MagicMock()):
|
|
vm.start()
|
|
loop.run_until_complete(asyncio.async(vm.close()))
|
|
assert vm.is_running() is False
|