1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-12-11 01:28:09 +00:00
gns3-server/tests/compute/vpcs/test_vpcs_vm.py

295 lines
12 KiB
Python
Raw Normal View History

2015-01-14 17:52:02 +00:00
# -*- 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
2015-01-21 15:43:34 +00:00
import os
2015-04-27 21:12:13 +00:00
import sys
from tests.utils import asyncio_patch, AsyncioMagicMock
from gns3server.utils import parse_version
from unittest.mock import patch, MagicMock, ANY
2015-11-09 09:25:20 +00:00
2016-04-15 15:57:06 +00:00
from gns3server.compute.vpcs.vpcs_vm import VPCSVM
from gns3server.compute.vpcs.vpcs_error import VPCSError
from gns3server.compute.vpcs import VPCS
from gns3server.compute.notification_manager import NotificationManager
2015-01-19 10:22:24 +00:00
2015-01-20 11:46:15 +00:00
2015-01-19 10:22:24 +00:00
@pytest.fixture(scope="module")
2015-01-21 21:21:01 +00:00
def manager(port_manager):
2015-01-19 10:22:24 +00:00
m = VPCS.instance()
2015-01-21 21:21:01 +00:00
m.port_manager = port_manager
2015-01-19 10:22:24 +00:00
return m
2015-01-14 17:52:02 +00:00
2015-01-20 11:46:15 +00:00
2015-01-21 14:50:35 +00:00
@pytest.fixture(scope="function")
def vm(project, manager, ubridge_path):
2015-11-09 09:25:20 +00:00
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
vm._vpcs_version = parse_version("0.9")
vm._start_ubridge = AsyncioMagicMock()
2015-11-09 09:25:20 +00:00
return vm
2015-01-21 14:50:35 +00:00
def test_vm(project, manager):
2015-01-20 12:12:26 +00:00
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
2015-01-14 17:52:02 +00:00
assert vm.name == "test"
assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0f"
2015-01-14 17:52:02 +00:00
2015-01-20 12:04:20 +00:00
2015-11-09 09:25:20 +00:00
def test_vm_check_vpcs_version(loop, vm, manager):
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.9"):
2015-11-09 09:25:20 +00:00
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
assert vm._vpcs_version == parse_version("0.9")
2015-11-11 20:57:58 +00:00
def test_vm_check_vpcs_version_0_6_1(loop, vm, manager):
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.6.1"):
2015-11-11 20:57:58 +00:00
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
assert vm._vpcs_version == parse_version("0.6.1")
2015-11-09 09:25:20 +00:00
def test_vm_invalid_vpcs_version(loop, manager, vm):
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.subprocess_check_output", return_value="Welcome to Virtual PC Simulator, version 0.1"):
2015-01-20 22:27:28 +00:00
with pytest.raises(VPCSError):
nio = manager.create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
vm.port_add_nio_binding(0, nio)
2015-11-09 09:25:20 +00:00
loop.run_until_complete(asyncio.async(vm._check_vpcs_version()))
2015-01-20 22:27:28 +00:00
assert vm.name == "test"
assert vm.id == "00010203-0405-0607-0809-0a0b0c0d0e0f"
2015-01-14 17:52:02 +00:00
2015-01-20 12:04:20 +00:00
2015-11-09 09:25:20 +00:00
def test_vm_invalid_vpcs_path(vm, manager, loop):
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM.vpcs_path", return_value="/tmp/fake/path/vpcs"):
2015-11-09 09:25:20 +00:00
with pytest.raises(VPCSError):
nio = manager.create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2015-11-09 09:25:20 +00:00
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"
2015-01-14 17:52:02 +00:00
2015-01-20 12:04:20 +00:00
2016-03-17 14:15:30 +00:00
def test_start(loop, vm, async_run):
2015-03-26 16:43:00 +00:00
process = MagicMock()
process.returncode = None
2016-03-17 14:15:30 +00:00
with NotificationManager.instance().queue() as queue:
2016-06-27 12:34:34 +00:00
async_run(queue.get(0)) # Ping
2016-03-17 14:15:30 +00:00
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
2016-03-17 14:15:30 +00:00
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process) as mock_exec:
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2016-06-27 12:34:34 +00:00
async_run(vm.port_add_nio_binding(0, nio))
2016-03-17 14:15:30 +00:00
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',
ANY,
2016-03-17 14:15:30 +00:00
'-c',
ANY,
2016-03-17 14:15:30 +00:00
'-t',
'127.0.0.1')
assert vm.is_running()
assert vm.command_line == ' '.join(mock_exec.call_args[0])
(action, event, kwargs) = async_run(queue.get(0))
2016-05-13 15:49:28 +00:00
assert action == "node.updated"
2016-03-17 14:15:30 +00:00
assert event == vm
2015-11-09 09:25:20 +00:00
2016-06-27 12:34:34 +00:00
def test_start_0_6_1(loop, vm, async_run):
2015-11-09 09:25:20 +00:00
"""
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
vm._vpcs_version = parse_version("0.6.1")
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
2015-11-09 09:25:20 +00:00
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process) as mock_exec:
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2016-06-27 12:34:34 +00:00
async_run(vm.port_add_nio_binding(0, nio))
async_run(vm.start())
2015-11-09 09:25:20 +00:00
assert mock_exec.call_args[0] == (vm.vpcs_path,
'-p',
str(vm.console),
'-m', '1',
'-i',
'1',
'-F',
'-s',
ANY,
2015-11-09 09:25:20 +00:00
'-c',
ANY,
2015-11-09 09:25:20 +00:00
'-t',
'127.0.0.1')
2015-01-20 22:27:28 +00:00
assert vm.is_running()
2015-01-20 12:04:20 +00:00
2015-01-15 13:27:33 +00:00
2016-03-17 14:15:30 +00:00
def test_stop(loop, vm, async_run):
2015-01-15 13:27:33 +00:00
process = MagicMock()
2015-02-10 16:24:38 +00:00
# Wait process kill success
future = asyncio.Future()
future.set_result(True)
process.wait.return_value = future
2015-03-26 16:43:00 +00:00
process.returncode = None
2015-02-10 16:24:38 +00:00
2016-03-17 14:15:30 +00:00
with NotificationManager.instance().queue() as queue:
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
2016-03-17 14:15:30 +00:00
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process):
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2016-06-27 12:34:34 +00:00
async_run(vm.port_add_nio_binding(0, nio))
2016-03-17 14:15:30 +00:00
2016-06-27 12:34:34 +00:00
async_run(vm.start())
2016-03-17 14:15:30 +00:00
assert vm.is_running()
2015-03-26 16:43:00 +00:00
2016-03-17 14:15:30 +00:00
with asyncio_patch("gns3server.utils.asyncio.wait_for_process_termination"):
loop.run_until_complete(asyncio.async(vm.stop()))
assert vm.is_running() is False
2016-03-17 14:15:30 +00:00
if sys.platform.startswith("win"):
process.send_signal.assert_called_with(1)
else:
process.terminate.assert_called_with()
2015-04-27 21:12:13 +00:00
2016-03-17 14:16:09 +00:00
async_run(queue.get(0)) #  Ping
async_run(queue.get(0)) #  Started
2016-03-17 14:15:30 +00:00
(action, event, kwargs) = async_run(queue.get(0))
2016-05-13 15:49:28 +00:00
assert action == "node.updated"
2016-03-17 14:15:30 +00:00
assert event == vm
2015-01-20 12:04:20 +00:00
2016-06-27 12:34:34 +00:00
def test_reload(loop, vm, async_run):
2015-01-22 09:55:11 +00:00
process = MagicMock()
2015-02-10 16:24:38 +00:00
# Wait process kill success
future = asyncio.Future()
future.set_result(True)
process.wait.return_value = future
2015-03-26 16:43:00 +00:00
process.returncode = None
2015-02-10 16:24:38 +00:00
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
2015-01-22 09:55:11 +00:00
with asyncio_patch("asyncio.create_subprocess_exec", return_value=process):
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2016-06-27 12:34:34 +00:00
async_run(vm.port_add_nio_binding(0, nio))
async_run(vm.start())
2015-01-22 09:55:11 +00:00
assert vm.is_running()
2015-04-27 08:14:46 +00:00
with asyncio_patch("gns3server.utils.asyncio.wait_for_process_termination"):
2016-06-27 12:34:34 +00:00
async_run(vm.reload())
2015-01-22 09:55:11 +00:00
assert vm.is_running() is True
2015-04-27 21:12:13 +00:00
if sys.platform.startswith("win"):
process.send_signal.assert_called_with(1)
else:
process.terminate.assert_called_with()
2015-01-22 09:55:11 +00:00
2016-06-27 12:34:34 +00:00
def test_add_nio_binding_udp(vm, async_run):
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
2016-06-27 12:34:34 +00:00
async_run(vm.port_add_nio_binding(0, nio))
2015-01-16 15:20:10 +00:00
assert nio.lport == 4242
2015-01-20 12:04:20 +00:00
2015-12-22 12:15:28 +00:00
@pytest.mark.skipif(sys.platform.startswith("win"), reason="Not supported on Windows")
def test_add_nio_binding_tap(vm, ethernet_device):
2016-04-15 15:57:06 +00:00
with patch("gns3server.compute.base_manager.BaseManager.has_privileged_access", return_value=True):
nio = VPCS.instance().create_nio({"type": "nio_tap", "tap_device": ethernet_device})
vm.port_add_nio_binding(0, nio)
2015-06-10 12:33:44 +00:00
assert nio.tap_device == ethernet_device
2015-01-16 15:20:10 +00:00
2015-01-20 12:04:20 +00:00
2015-04-27 21:20:01 +00:00
# def test_add_nio_binding_tap_no_privileged_access(vm):
2016-04-15 15:57:06 +00:00
# with patch("gns3server.compute.base_manager.BaseManager.has_privileged_access", return_value=False):
2015-04-27 21:20:01 +00:00
# with pytest.raises(aiohttp.web.HTTPForbidden):
# nio = VPCS.instance().create_nio({"type": "nio_tap", "tap_device": "test"})
2015-04-27 21:20:01 +00:00
# vm.port_add_nio_binding(0, nio)
# assert vm._ethernet_adapter.ports[0] is None
#
2015-01-20 12:04:20 +00:00
2015-01-21 14:50:35 +00:00
def test_port_remove_nio_binding(vm):
nio = VPCS.instance().create_nio({"type": "nio_udp", "lport": 4242, "rport": 4243, "rhost": "127.0.0.1"})
vm.port_add_nio_binding(0, nio)
2015-01-16 20:39:58 +00:00
vm.port_remove_nio_binding(0)
2015-01-19 10:28:51 +00:00
assert vm._ethernet_adapter.ports[0] is None
2015-01-21 15:43:34 +00:00
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')
2015-01-21 15:43:34 +00:00
assert os.path.exists(filepath)
with open(filepath) as f:
assert f.read() == content
2015-02-03 20:48:20 +00:00
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"
2015-01-21 15:43:34 +00:00
def test_get_startup_script(vm):
2015-05-26 09:51:24 +00:00
content = "echo GNS3 VPCS\nip 192.168.1.2"
2015-01-21 15:43:34 +00:00
vm.startup_script = content
2015-06-10 12:35:53 +00:00
assert vm.startup_script == os.linesep.join(["echo GNS3 VPCS", "ip 192.168.1.2"])
2015-01-21 20:46:16 +00:00
def test_get_startup_script_using_default_script(vm):
content = "echo GNS3 VPCS\nip 192.168.1.2\n"
# Reset script file location
2015-02-03 20:48:20 +00:00
vm._script_file = None
filepath = os.path.join(vm.working_dir, 'startup.vpc')
2015-04-27 21:28:12 +00:00
with open(filepath, 'wb+') as f:
assert f.write(content.encode("utf-8"))
assert vm.startup_script == content
assert vm.script_file == filepath
2015-01-21 20:46:16 +00:00
def test_change_name(vm, tmpdir):
path = os.path.join(vm.working_dir, 'startup.vpc')
2015-01-21 20:46:16 +00:00
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"
2015-02-16 18:14:45 +00:00
def test_close(vm, port_manager, loop):
2016-04-15 15:57:06 +00:00
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM._check_requirements", return_value=True):
2015-01-22 10:34:10 +00:00
with asyncio_patch("asyncio.create_subprocess_exec", return_value=MagicMock()):
vm.start()
2015-02-16 18:14:45 +00:00
loop.run_until_complete(asyncio.async(vm.close()))
2015-01-22 10:34:10 +00:00
assert vm.is_running() is False