# -*- 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 . import pytest import os import stat import sys import uuid import aiohttp from tests.utils import asyncio_patch from unittest.mock import patch, MagicMock, PropertyMock pytestmark = pytest.mark.skipif(sys.platform.startswith("win"), reason="Not supported on Windows") @pytest.fixture def fake_iou_bin(tmpdir): """Create a fake IOU image on disk""" path = str(tmpdir / "iou.bin") with open(path, "w+") as f: f.write('\x7fELF\x01\x01\x01') os.chmod(path, stat.S_IREAD | stat.S_IEXEC) return path @pytest.fixture def base_params(tmpdir, fake_iou_bin): """Return standard parameters""" return {"name": "PC TEST 1", "path": fake_iou_bin} @pytest.fixture def vm(server, project, base_params): response = server.post("/projects/{project_id}/iou/vms".format(project_id=project.id), base_params) assert response.status == 201 return response.json def startup_config_file(project, vm): directory = os.path.join(project.path, "project-files", "iou", vm["vm_id"]) os.makedirs(directory, exist_ok=True) return os.path.join(directory, "startup-config.cfg") def test_iou_create(server, project, base_params): response = server.post("/projects/{project_id}/iou/vms".format(project_id=project.id), base_params) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms" assert response.json["name"] == "PC TEST 1" assert response.json["project_id"] == project.id assert response.json["serial_adapters"] == 2 assert response.json["ethernet_adapters"] == 2 assert response.json["ram"] == 256 assert response.json["nvram"] == 128 assert response.json["l1_keepalives"] is False def test_iou_create_with_params(server, project, base_params): params = base_params params["ram"] = 1024 params["nvram"] = 512 params["serial_adapters"] = 4 params["ethernet_adapters"] = 0 params["l1_keepalives"] = True params["startup_config_content"] = "hostname test" params["use_default_iou_values"] = True params["iourc_content"] = "test" response = server.post("/projects/{project_id}/iou/vms".format(project_id=project.id), params, example=True) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms" assert response.json["name"] == "PC TEST 1" assert response.json["project_id"] == project.id assert response.json["serial_adapters"] == 4 assert response.json["ethernet_adapters"] == 0 assert response.json["ram"] == 1024 assert response.json["nvram"] == 512 assert response.json["l1_keepalives"] is True assert response.json["use_default_iou_values"] is True assert "startup-config.cfg" in response.json["startup_config"] with open(startup_config_file(project, response.json)) as f: assert f.read() == "hostname test" assert "iourc" in response.json["iourc_path"] def test_iou_create_startup_config_already_exist(server, project, base_params): """We don't erase a startup-config if already exist at project creation""" vm_id = str(uuid.uuid4()) startup_config_file_path = startup_config_file(project, {'vm_id': vm_id}) with open(startup_config_file_path, 'w+') as f: f.write("echo hello") params = base_params params["vm_id"] = vm_id params["startup_config_content"] = "hostname test" response = server.post("/projects/{project_id}/iou/vms".format(project_id=project.id), params, example=True) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms" assert "startup-config.cfg" in response.json["startup_config"] with open(startup_config_file(project, response.json)) as f: assert f.read() == "echo hello" def test_iou_get(server, project, vm): response = server.get("/projects/{project_id}/iou/vms/{vm_id}".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert response.status == 200 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}" assert response.json["name"] == "PC TEST 1" assert response.json["project_id"] == project.id assert response.json["serial_adapters"] == 2 assert response.json["ethernet_adapters"] == 2 assert response.json["ram"] == 256 assert response.json["nvram"] == 128 assert response.json["l1_keepalives"] is False def test_iou_start(server, vm): with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.start", return_value=True) as mock: response = server.post("/projects/{project_id}/iou/vms/{vm_id}/start".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert mock.called assert response.status == 204 def test_iou_stop(server, vm): with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.stop", return_value=True) as mock: response = server.post("/projects/{project_id}/iou/vms/{vm_id}/stop".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert mock.called assert response.status == 204 def test_iou_reload(server, vm): with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.reload", return_value=True) as mock: response = server.post("/projects/{project_id}/iou/vms/{vm_id}/reload".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert mock.called assert response.status == 204 def test_iou_delete(server, vm): with asyncio_patch("gns3server.modules.iou.IOU.delete_vm", return_value=True) as mock: response = server.delete("/projects/{project_id}/iou/vms/{vm_id}".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert mock.called assert response.status == 204 def test_iou_update(server, vm, tmpdir, free_console_port, project): params = { "name": "test", "console": free_console_port, "ram": 512, "nvram": 2048, "ethernet_adapters": 4, "serial_adapters": 0, "l1_keepalives": True, "startup_config_content": "hostname test", "use_default_iou_values": True, "iourc_content": "test" } response = server.put("/projects/{project_id}/iou/vms/{vm_id}".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), params, example=True) assert response.status == 200 assert response.json["name"] == "test" assert response.json["console"] == free_console_port assert response.json["ethernet_adapters"] == 4 assert response.json["serial_adapters"] == 0 assert response.json["ram"] == 512 assert response.json["nvram"] == 2048 assert response.json["l1_keepalives"] is True assert response.json["use_default_iou_values"] is True assert "startup-config.cfg" in response.json["startup_config"] with open(startup_config_file(project, response.json)) as f: assert f.read() == "hostname test" assert "iourc" in response.json["iourc_path"] def test_iou_nio_create_udp(server, vm): response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/1/ports/0/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), {"type": "nio_udp", "lport": 4242, "rport": 4343, "rhost": "127.0.0.1"}, example=True) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio" assert response.json["type"] == "nio_udp" def test_iou_nio_create_ethernet(server, vm, ethernet_device): response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/1/ports/0/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), {"type": "nio_generic_ethernet", "ethernet_device": ethernet_device, }, example=True) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio" assert response.json["type"] == "nio_generic_ethernet" assert response.json["ethernet_device"] == ethernet_device def test_iou_nio_create_ethernet_different_port(server, vm, ethernet_device): response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/0/ports/3/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), {"type": "nio_generic_ethernet", "ethernet_device": ethernet_device, }, example=False) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio" assert response.json["type"] == "nio_generic_ethernet" assert response.json["ethernet_device"] == ethernet_device def test_iou_nio_create_tap(server, vm, ethernet_device): with patch("gns3server.modules.base_manager.BaseManager._has_privileged_access", return_value=True): response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/1/ports/0/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), {"type": "nio_tap", "tap_device": ethernet_device}) assert response.status == 201 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio" assert response.json["type"] == "nio_tap" def test_iou_delete_nio(server, vm): server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/1/ports/0/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), {"type": "nio_udp", "lport": 4242, "rport": 4343, "rhost": "127.0.0.1"}) response = server.delete("/projects/{project_id}/iou/vms/{vm_id}/adapters/1/ports/0/nio".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert response.status == 204 assert response.route == "/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/nio" def test_iou_start_capture(server, vm, tmpdir, project): with patch("gns3server.modules.iou.iou_vm.IOUVM.is_running", return_value=True) as mock: with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.start_capture") as start_capture: params = {"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"} response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/0/ports/0/start_capture".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), body=params, example=True) assert response.status == 200 assert start_capture.called assert "test.pcap" in response.json["pcap_file_path"] def test_iou_start_capture_not_started(server, vm, tmpdir): with patch("gns3server.modules.iou.iou_vm.IOUVM.is_running", return_value=False) as mock: with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.start_capture") as start_capture: params = {"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"} response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/0/ports/0/start_capture".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), body=params) assert not start_capture.called assert response.status == 409 def test_iou_stop_capture(server, vm, tmpdir, project): with patch("gns3server.modules.iou.iou_vm.IOUVM.is_running", return_value=True) as mock: with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.stop_capture") as stop_capture: response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/0/ports/0/stop_capture".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert response.status == 204 assert stop_capture.called def test_iou_stop_capture_not_started(server, vm, tmpdir): with patch("gns3server.modules.iou.iou_vm.IOUVM.is_running", return_value=False) as mock: with asyncio_patch("gns3server.modules.iou.iou_vm.IOUVM.stop_capture") as stop_capture: response = server.post("/projects/{project_id}/iou/vms/{vm_id}/adapters/0/ports/0/stop_capture".format(project_id=vm["project_id"], vm_id=vm["vm_id"])) assert not stop_capture.called assert response.status == 409 def test_get_configs_without_configs_file(server, vm): response = server.get("/projects/{project_id}/iou/vms/{vm_id}/configs".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert response.status == 200 assert "startup_config" not in response.json assert "private_config" not in response.json def test_get_configs_with_startup_config_file(server, project, vm): path = startup_config_file(project, vm) with open(path, "w+") as f: f.write("TEST") response = server.get("/projects/{project_id}/iou/vms/{vm_id}/configs".format(project_id=vm["project_id"], vm_id=vm["vm_id"]), example=True) assert response.status == 200 assert response.json["startup_config_content"] == "TEST" def test_vms(server, tmpdir, fake_iou_bin): with patch("gns3server.modules.IOU.get_images_directory", return_value=str(tmpdir)): response = server.get("/iou/vms", example=True) assert response.status == 200 assert response.json == [{"filename": "iou.bin"}] def test_upload_vm(server, tmpdir): with patch("gns3server.modules.IOU.get_images_directory", return_value=str(tmpdir),): response = server.post("/iou/vms/test2", body="TEST", raw=True) assert response.status == 204 with open(str(tmpdir / "test2")) as f: assert f.read() == "TEST" def test_upload_vm_permission_denied(server, tmpdir): with open(str(tmpdir / "test2"), "w+") as f: f.write("") os.chmod(str(tmpdir / "test2"), 0) with patch("gns3server.modules.IOU.get_images_directory", return_value=str(tmpdir),): response = server.post("/iou/vms/test2", body="TEST", raw=True) assert response.status == 409