mirror of
https://github.com/GNS3/gns3-server
synced 2024-11-25 01:38:08 +00:00
507 lines
17 KiB
Python
507 lines
17 KiB
Python
#!/usr/bin/env 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 os
|
||
import uuid
|
||
import json
|
||
import asyncio
|
||
import pytest
|
||
import aiohttp
|
||
import zipfile
|
||
from uuid import uuid4
|
||
from unittest.mock import patch
|
||
|
||
from tests.utils import asyncio_patch
|
||
from gns3server.compute.project import Project
|
||
from gns3server.compute.notification_manager import NotificationManager
|
||
from gns3server.compute.vpcs import VPCS, VPCSVM
|
||
from gns3server.config import Config
|
||
|
||
|
||
@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, loop):
|
||
vm = manager.create_vm("test", project.id, "00010203-0405-0607-0809-0a0b0c0d0e0f")
|
||
return loop.run_until_complete(asyncio.async(vm))
|
||
|
||
|
||
def test_affect_uuid():
|
||
p = Project(project_id='00010203-0405-0607-0809-0a0b0c0d0e0f')
|
||
assert p.id == '00010203-0405-0607-0809-0a0b0c0d0e0f'
|
||
|
||
|
||
def test_path(tmpdir):
|
||
|
||
directory = Config.instance().get_section_config("Server").get("project_directory")
|
||
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=True):
|
||
with patch("gns3server.compute.project.Project._get_default_project_directory", return_value=directory):
|
||
p = Project(project_id=str(uuid4()))
|
||
assert p.path == os.path.join(directory, p.id)
|
||
assert os.path.exists(os.path.join(directory, p.id))
|
||
assert not os.path.exists(os.path.join(p.path, ".gns3_temporary"))
|
||
|
||
|
||
def test_init_path(tmpdir):
|
||
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=True):
|
||
p = Project(path=str(tmpdir), project_id=str(uuid4()))
|
||
assert p.path == str(tmpdir)
|
||
|
||
|
||
def test_changing_path_temporary_flag(tmpdir):
|
||
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=True):
|
||
p = Project(temporary=True, project_id=str(uuid4()))
|
||
assert os.path.exists(p.path)
|
||
original_path = p.path
|
||
assert os.path.exists(os.path.join(p.path, ".gns3_temporary"))
|
||
|
||
p.path = str(tmpdir)
|
||
|
||
|
||
def test_temporary_path():
|
||
p = Project(temporary=True, project_id=str(uuid4()))
|
||
assert os.path.exists(p.path)
|
||
assert os.path.exists(os.path.join(p.path, ".gns3_temporary"))
|
||
|
||
|
||
def test_remove_temporary_flag():
|
||
p = Project(temporary=True, project_id=str(uuid4()))
|
||
assert os.path.exists(p.path)
|
||
assert os.path.exists(os.path.join(p.path, ".gns3_temporary"))
|
||
p.temporary = False
|
||
assert not os.path.exists(os.path.join(p.path, ".gns3_temporary"))
|
||
|
||
|
||
def test_changing_path_not_allowed(tmpdir):
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=False):
|
||
with pytest.raises(aiohttp.web.HTTPForbidden):
|
||
p = Project(project_id=str(uuid4()))
|
||
p.path = str(tmpdir)
|
||
|
||
|
||
def test_changing_path_with_quote_not_allowed(tmpdir):
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=True):
|
||
with pytest.raises(aiohttp.web.HTTPForbidden):
|
||
p = Project(project_id=str(uuid4()))
|
||
p.path = str(tmpdir / "project\"53")
|
||
|
||
|
||
def test_json(tmpdir):
|
||
p = Project(project_id=str(uuid4()))
|
||
assert p.__json__() == {"name": p.name, "project_id": p.id, "temporary": False}
|
||
|
||
|
||
def test_vm_working_directory(tmpdir, vm):
|
||
directory = Config.instance().get_section_config("Server").get("project_directory")
|
||
|
||
with patch("gns3server.compute.project.Project.is_local", return_value=True):
|
||
p = Project(project_id=str(uuid4()))
|
||
assert p.vm_working_directory(vm) == os.path.join(directory, p.id, 'project-files', vm.module_name, vm.id)
|
||
assert os.path.exists(p.vm_working_directory(vm))
|
||
|
||
|
||
def test_mark_vm_for_destruction(vm):
|
||
project = Project(project_id=str(uuid4()))
|
||
project.add_vm(vm)
|
||
project.mark_vm_for_destruction(vm)
|
||
assert len(project._vms_to_destroy) == 1
|
||
assert len(project.vms) == 0
|
||
|
||
|
||
def test_commit(manager, loop):
|
||
project = Project(project_id=str(uuid4()))
|
||
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
|
||
project.add_vm(vm)
|
||
directory = project.vm_working_directory(vm)
|
||
project.mark_vm_for_destruction(vm)
|
||
assert len(project._vms_to_destroy) == 1
|
||
assert os.path.exists(directory)
|
||
loop.run_until_complete(asyncio.async(project.commit()))
|
||
assert len(project._vms_to_destroy) == 0
|
||
assert os.path.exists(directory) is False
|
||
assert len(project.vms) == 0
|
||
|
||
|
||
def test_commit_permission_issue(manager, loop):
|
||
project = Project(project_id=str(uuid4()))
|
||
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
|
||
project.add_vm(vm)
|
||
directory = project.vm_working_directory(vm)
|
||
project.mark_vm_for_destruction(vm)
|
||
assert len(project._vms_to_destroy) == 1
|
||
assert os.path.exists(directory)
|
||
os.chmod(directory, 0)
|
||
with pytest.raises(aiohttp.web.HTTPInternalServerError):
|
||
loop.run_until_complete(asyncio.async(project.commit()))
|
||
os.chmod(directory, 700)
|
||
|
||
|
||
def test_project_delete(loop):
|
||
project = Project(project_id=str(uuid4()))
|
||
directory = project.path
|
||
assert os.path.exists(directory)
|
||
loop.run_until_complete(asyncio.async(project.delete()))
|
||
assert os.path.exists(directory) is False
|
||
|
||
|
||
def test_project_delete_permission_issue(loop):
|
||
project = Project(project_id=str(uuid4()))
|
||
directory = project.path
|
||
assert os.path.exists(directory)
|
||
os.chmod(directory, 0)
|
||
with pytest.raises(aiohttp.web.HTTPInternalServerError):
|
||
loop.run_until_complete(asyncio.async(project.delete()))
|
||
os.chmod(directory, 700)
|
||
|
||
|
||
def test_project_add_vm(manager):
|
||
project = Project(project_id=str(uuid4()))
|
||
vm = VPCSVM("test", "00010203-0405-0607-0809-0a0b0c0d0e0f", project, manager)
|
||
project.add_vm(vm)
|
||
assert len(project.vms) == 1
|
||
|
||
|
||
def test_project_close(loop, vm, project):
|
||
|
||
with asyncio_patch("gns3server.compute.vpcs.vpcs_vm.VPCSVM.close") as mock:
|
||
loop.run_until_complete(asyncio.async(project.close()))
|
||
assert mock.called
|
||
assert vm.id not in vm.manager._vms
|
||
|
||
|
||
def test_project_close_temporary_project(loop, manager):
|
||
"""A temporary project is deleted when closed"""
|
||
|
||
project = Project(temporary=True, project_id=str(uuid4()))
|
||
directory = project.path
|
||
assert os.path.exists(directory)
|
||
loop.run_until_complete(asyncio.async(project.close()))
|
||
assert os.path.exists(directory) is False
|
||
|
||
|
||
def test_get_default_project_directory(monkeypatch):
|
||
|
||
monkeypatch.undo()
|
||
project = Project(project_id=str(uuid4()))
|
||
path = os.path.normpath(os.path.expanduser("~/GNS3/projects"))
|
||
assert project._get_default_project_directory() == path
|
||
assert os.path.exists(path)
|
||
|
||
|
||
def test_clean_project_directory(tmpdir):
|
||
|
||
# A non anonymous project with uuid.
|
||
project1 = tmpdir / uuid4()
|
||
project1.mkdir()
|
||
|
||
# A non anonymous project.
|
||
oldproject = tmpdir / uuid4()
|
||
oldproject.mkdir()
|
||
|
||
# an anonymous project
|
||
project2 = tmpdir / uuid4()
|
||
project2.mkdir()
|
||
tmp = (project2 / ".gns3_temporary")
|
||
with open(str(tmp), 'w+') as f:
|
||
f.write("1")
|
||
|
||
with patch("gns3server.config.Config.get_section_config", return_value={"project_directory": str(tmpdir)}):
|
||
Project.clean_project_directory()
|
||
|
||
assert os.path.exists(str(project1))
|
||
assert os.path.exists(str(oldproject))
|
||
assert not os.path.exists(str(project2))
|
||
|
||
|
||
def test_list_files(tmpdir, loop):
|
||
|
||
with patch("gns3server.config.Config.get_section_config", return_value={"project_directory": str(tmpdir)}):
|
||
project = Project(project_id=str(uuid4()))
|
||
path = project.path
|
||
os.makedirs(os.path.join(path, "vm-1", "dynamips"))
|
||
with open(os.path.join(path, "vm-1", "dynamips", "test.bin"), "w+") as f:
|
||
f.write("test")
|
||
open(os.path.join(path, "vm-1", "dynamips", "test.ghost"), "w+").close()
|
||
with open(os.path.join(path, "test.txt"), "w+") as f:
|
||
f.write("test2")
|
||
|
||
files = loop.run_until_complete(asyncio.async(project.list_files()))
|
||
|
||
assert files == [
|
||
{
|
||
"path": "test.txt",
|
||
"md5sum": "ad0234829205b9033196ba818f7a872b"
|
||
},
|
||
{
|
||
"path": os.path.join("vm-1", "dynamips", "test.bin"),
|
||
"md5sum": "098f6bcd4621d373cade4e832627b4f6"
|
||
}
|
||
]
|
||
|
||
|
||
def test_emit(async_run):
|
||
|
||
with NotificationManager.instance().queue() as queue:
|
||
(action, event, context) = async_run(queue.get(0.5)) # Ping
|
||
|
||
project = Project(project_id=str(uuid4()))
|
||
project.emit("test", {})
|
||
(action, event, context) = async_run(queue.get(0.5))
|
||
assert action == "test"
|
||
assert context["project_id"] == project.id
|
||
|
||
|
||
def test_export(tmpdir):
|
||
project = Project(project_id=str(uuid.uuid4()))
|
||
path = project.path
|
||
os.makedirs(os.path.join(path, "vm-1", "dynamips"))
|
||
|
||
# The .gns3 should be renamed project.gns3 in order to simplify import
|
||
with open(os.path.join(path, "test.gns3"), 'w+') as f:
|
||
f.write("{}")
|
||
|
||
with open(os.path.join(path, "vm-1", "dynamips", "test"), 'w+') as f:
|
||
f.write("HELLO")
|
||
with open(os.path.join(path, "vm-1", "dynamips", "test_log.txt"), 'w+') as f:
|
||
f.write("LOG")
|
||
os.makedirs(os.path.join(path, "project-files", "snapshots"))
|
||
with open(os.path.join(path, "project-files", "snapshots", "test"), 'w+') as f:
|
||
f.write("WORLD")
|
||
|
||
z = project.export()
|
||
|
||
with open(str(tmpdir / 'zipfile.zip'), 'wb') as f:
|
||
for data in z:
|
||
f.write(data)
|
||
|
||
with zipfile.ZipFile(str(tmpdir / 'zipfile.zip')) as myzip:
|
||
with myzip.open("vm-1/dynamips/test") as myfile:
|
||
content = myfile.read()
|
||
assert content == b"HELLO"
|
||
|
||
assert 'test.gns3' not in myzip.namelist()
|
||
assert 'project.gns3' in myzip.namelist()
|
||
assert 'project-files/snapshots/test' not in myzip.namelist()
|
||
assert 'vm-1/dynamips/test_log.txt' not in myzip.namelist()
|
||
|
||
|
||
def test_export_fix_path(tmpdir):
|
||
"""
|
||
Fix absolute image path
|
||
"""
|
||
|
||
project = Project(project_id=str(uuid.uuid4()))
|
||
path = project.path
|
||
|
||
topology = {
|
||
"topology": {
|
||
"nodes": [
|
||
{
|
||
"properties": {
|
||
"image": "/tmp/c3725-adventerprisek9-mz.124-25d.image"
|
||
},
|
||
"type": "C3725"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
|
||
with open(os.path.join(path, "test.gns3"), 'w+') as f:
|
||
json.dump(topology, f)
|
||
|
||
z = project.export()
|
||
with open(str(tmpdir / 'zipfile.zip'), 'wb') as f:
|
||
for data in z:
|
||
f.write(data)
|
||
|
||
with zipfile.ZipFile(str(tmpdir / 'zipfile.zip')) as myzip:
|
||
with myzip.open("project.gns3") as myfile:
|
||
content = myfile.read().decode()
|
||
topology = json.loads(content)
|
||
assert topology["topology"]["nodes"][0]["properties"]["image"] == "c3725-adventerprisek9-mz.124-25d.image"
|
||
|
||
|
||
def test_export_with_images(tmpdir):
|
||
"""
|
||
Fix absolute image path
|
||
"""
|
||
project_id = str(uuid.uuid4())
|
||
project = Project(project_id=project_id)
|
||
path = project.path
|
||
|
||
os.makedirs(str(tmpdir / "IOS"))
|
||
with open(str(tmpdir / "IOS" / "test.image"), "w+") as f:
|
||
f.write("AAA")
|
||
|
||
topology = {
|
||
"topology": {
|
||
"nodes": [
|
||
{
|
||
"properties": {
|
||
"image": "test.image"
|
||
},
|
||
"type": "C3725"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
|
||
with open(os.path.join(path, "test.gns3"), 'w+') as f:
|
||
json.dump(topology, f)
|
||
|
||
with patch("gns3server.compute.Dynamips.get_images_directory", return_value=str(tmpdir / "IOS"),):
|
||
z = project.export(include_images=True)
|
||
with open(str(tmpdir / 'zipfile.zip'), 'wb') as f:
|
||
for data in z:
|
||
f.write(data)
|
||
|
||
with zipfile.ZipFile(str(tmpdir / 'zipfile.zip')) as myzip:
|
||
myzip.getinfo("images/IOS/test.image")
|
||
|
||
|
||
def test_export_with_vm(tmpdir):
|
||
project_id = str(uuid.uuid4())
|
||
project = Project(project_id=project_id)
|
||
path = project.path
|
||
os.makedirs(os.path.join(path, "vm-1", "dynamips"))
|
||
|
||
# The .gns3 should be renamed project.gns3 in order to simplify import
|
||
with open(os.path.join(path, "test.gns3"), 'w+') as f:
|
||
f.write("{}")
|
||
|
||
with open(os.path.join(path, "vm-1", "dynamips", "test"), 'w+') as f:
|
||
f.write("HELLO")
|
||
with open(os.path.join(path, "vm-1", "dynamips", "test_log.txt"), 'w+') as f:
|
||
f.write("LOG")
|
||
os.makedirs(os.path.join(path, "project-files", "snapshots"))
|
||
with open(os.path.join(path, "project-files", "snapshots", "test"), 'w+') as f:
|
||
f.write("WORLD")
|
||
|
||
os.makedirs(os.path.join(path, "servers", "vm", "project-files", "docker"))
|
||
with open(os.path.join(path, "servers", "vm", "project-files", "docker", "busybox"), 'w+') as f:
|
||
f.write("DOCKER")
|
||
|
||
z = project.export()
|
||
|
||
with open(str(tmpdir / 'zipfile.zip'), 'wb') as f:
|
||
for data in z:
|
||
f.write(data)
|
||
|
||
with zipfile.ZipFile(str(tmpdir / 'zipfile.zip')) as myzip:
|
||
with myzip.open("vm-1/dynamips/test") as myfile:
|
||
content = myfile.read()
|
||
assert content == b"HELLO"
|
||
|
||
assert 'test.gns3' not in myzip.namelist()
|
||
assert 'project.gns3' in myzip.namelist()
|
||
assert 'project-files/snapshots/test' not in myzip.namelist()
|
||
assert 'vm-1/dynamips/test_log.txt' not in myzip.namelist()
|
||
assert 'servers/vm/project-files/docker/busybox' not in myzip.namelist()
|
||
assert 'project-files/docker/busybox' in myzip.namelist()
|
||
|
||
|
||
def test_import(tmpdir):
|
||
|
||
project_id = str(uuid.uuid4())
|
||
project = Project(name="test", project_id=project_id)
|
||
|
||
topology = {
|
||
"project_id": str(uuid.uuid4()),
|
||
"name": "testtest",
|
||
"topology": {
|
||
"nodes": [
|
||
{
|
||
"server_id": 3,
|
||
"type": "VPCSDevice"
|
||
},
|
||
{
|
||
"server_id": 3,
|
||
"type": "QemuVM"
|
||
}
|
||
]
|
||
}
|
||
}
|
||
|
||
with open(str(tmpdir / "project.gns3"), 'w+') as f:
|
||
json.dump(topology, f)
|
||
with open(str(tmpdir / "b.png"), 'w+') as f:
|
||
f.write("B")
|
||
|
||
zip_path = str(tmpdir / "project.zip")
|
||
with zipfile.ZipFile(zip_path, 'w') as myzip:
|
||
myzip.write(str(tmpdir / "project.gns3"), "project.gns3")
|
||
myzip.write(str(tmpdir / "b.png"), "b.png")
|
||
myzip.write(str(tmpdir / "b.png"), "project-files/dynamips/test")
|
||
myzip.write(str(tmpdir / "b.png"), "project-files/qemu/test")
|
||
|
||
with open(zip_path, "rb") as f:
|
||
project.import_zip(f)
|
||
|
||
assert os.path.exists(os.path.join(project.path, "b.png"))
|
||
assert os.path.exists(os.path.join(project.path, "test.gns3"))
|
||
assert os.path.exists(os.path.join(project.path, "project-files/dynamips/test"))
|
||
assert os.path.exists(os.path.join(project.path, "servers/vm/project-files/qemu/test"))
|
||
|
||
with open(os.path.join(project.path, "test.gns3")) as f:
|
||
content = json.load(f)
|
||
|
||
assert content["name"] == "test"
|
||
assert content["project_id"] == project_id
|
||
assert content["topology"]["servers"] == [
|
||
{
|
||
"id": 1,
|
||
"local": True,
|
||
"vm": False
|
||
},
|
||
{
|
||
"id": 2,
|
||
"local": False,
|
||
"vm": True
|
||
},
|
||
]
|
||
assert content["topology"]["nodes"][0]["server_id"] == 1
|
||
assert content["topology"]["nodes"][1]["server_id"] == 2
|
||
|
||
|
||
def test_import_with_images(tmpdir):
|
||
|
||
project_id = str(uuid.uuid4())
|
||
project = Project(name="test", project_id=project_id)
|
||
|
||
with open(str(tmpdir / "test.image"), 'w+') as f:
|
||
f.write("B")
|
||
|
||
zip_path = str(tmpdir / "project.zip")
|
||
with zipfile.ZipFile(zip_path, 'w') as myzip:
|
||
myzip.write(str(tmpdir / "test.image"), "images/IOS/test.image")
|
||
|
||
with open(zip_path, "rb") as f:
|
||
project.import_zip(f)
|
||
|
||
# TEST import images
|
||
path = os.path.join(project._config().get("images_path"), "IOS", "test.image")
|
||
assert os.path.exists(path), path
|