mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-08-27 12:30:13 +03:00
7d3cbf1023
Config.update_config() applies submitted options to the main configuration file via configparser read-modify-write: unknown options are preserved, null removes an option, the merged view of all files is validated as ServerConfig before anything is written (a bad file would kill the FileWatcher polling loop), and the write is atomic (.tmp + os.replace, mode 0600). Options whose effective value is owned by a later configuration file raise ConfigConflictError instead of writing a no-op. The reload logic is factored into reload_and_notify() and the file watcher callback is exception-guarded so polling never dies.
280 lines
9.0 KiB
Python
280 lines
9.0 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (C) 2020 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 configparser
|
|
import os
|
|
import pytest
|
|
|
|
from gns3server.config import Config
|
|
from gns3server.config import ConfigConflictError
|
|
from gns3server.config import ServerConfig
|
|
from pydantic import ValidationError
|
|
|
|
|
|
def load_config(tmpdir, settings):
|
|
"""
|
|
Create a configuration file for
|
|
the test.
|
|
|
|
:params tmpdir: Temporary directory
|
|
:params settings: Configuration settings
|
|
:returns: Configuration instance
|
|
"""
|
|
|
|
path = write_config(tmpdir, settings)
|
|
return Config(files=[path])
|
|
|
|
|
|
def write_config(tmpdir, settings):
|
|
"""
|
|
Write a configuration file for the test.
|
|
|
|
:params tmpdir: Temporary directory
|
|
:params settings: Configuration settings
|
|
:returns: File path
|
|
"""
|
|
|
|
path = str(tmpdir / "server.conf")
|
|
config = configparser.ConfigParser()
|
|
config.read_dict(settings)
|
|
with open(path, "w+") as f:
|
|
config.write(f)
|
|
return path
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"setting, value, result",
|
|
(
|
|
("allowed_interfaces", "", []),
|
|
("allowed_interfaces", "eth0", ["eth0"]),
|
|
("allowed_interfaces", "eth1,eth2", ["eth1", "eth2"]),
|
|
("additional_images_paths", "", []),
|
|
("additional_images_paths", "/path/to/dir1", ["/path/to/dir1"]),
|
|
("additional_images_paths", "/path/to/dir1;/path/to/dir2", ["/path/to/dir1", "/path/to/dir2"])
|
|
)
|
|
)
|
|
def test_server_settings_to_list(tmpdir, setting: str, value: str, result: str):
|
|
|
|
config = load_config(tmpdir, {
|
|
"Server": {
|
|
setting: value
|
|
}
|
|
})
|
|
|
|
assert config.settings.model_dump(exclude_unset=True)["Server"][setting] == result
|
|
|
|
|
|
def test_reload(tmpdir):
|
|
|
|
config = load_config(tmpdir, {
|
|
"Server": {
|
|
"host": "127.0.0.1"
|
|
}
|
|
})
|
|
|
|
assert config.settings.Server.host == "127.0.0.1"
|
|
|
|
write_config(tmpdir, {
|
|
"Server": {
|
|
"host": "192.168.1.2"
|
|
}
|
|
})
|
|
|
|
config.reload()
|
|
assert config.settings.Server.host == "192.168.1.2"
|
|
|
|
|
|
def test_server_password_hidden():
|
|
|
|
server_settings = {"Server": {"compute_password": "password123"}}
|
|
config = ServerConfig(**server_settings)
|
|
assert str(config.Server.compute_password) == "**********"
|
|
assert config.Server.compute_password.get_secret_value() == "password123"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"settings, exception_expected",
|
|
(
|
|
({"protocol": "https1"}, True),
|
|
({"console_start_port_range": 15000, "console_end_port_range": 20000}, False),
|
|
({"console_start_port_range": 0}, True),
|
|
({"console_start_port_range": 68000}, True),
|
|
({"console_end_port_range": 15000}, False),
|
|
({"console_end_port_range": 0}, True),
|
|
({"console_end_port_range": 68000}, True),
|
|
({"console_start_port_range": 10000, "console_end_port_range": 5000}, True),
|
|
({"vnc_console_start_port_range": 6000}, False),
|
|
({"vnc_console_start_port_range": 1000}, True),
|
|
({"vnc_console_end_port_range": 6000}, False),
|
|
({"vnc_console_end_port_range": 1000}, True),
|
|
({"vnc_console_start_port_range": 7000, "vnc_console_end_port_range": 6000}, True),
|
|
({"enable_ssl": True, "certfile": "/path/to/certfile", "certkey": "/path/to/certkey"}, True),
|
|
({"enable_ssl": True}, True),
|
|
({"enable_ssl": True, "certfile": "/path/to/certfile"}, True),
|
|
({"enable_ssl": True, "certkey": "/path/to/certkey"}, True)
|
|
)
|
|
)
|
|
def test_server_settings(settings: dict, exception_expected: bool):
|
|
|
|
server_settings = {"Server": settings}
|
|
|
|
if exception_expected:
|
|
with pytest.raises(ValidationError):
|
|
ServerConfig(**server_settings)
|
|
else:
|
|
ServerConfig(**server_settings)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"settings, exception_expected",
|
|
(
|
|
({"vmnet_start_range": 0}, True),
|
|
({"vmnet_start_range": 256}, True),
|
|
({"vmnet_end_range": 0}, True),
|
|
({"vmnet_end_range": 256}, True),
|
|
({"vmnet_start_range": 2, "vmnet_end_range": 10}, False),
|
|
({"vmnet_start_range": 5, "vmnet_end_range": 3}, True)
|
|
)
|
|
)
|
|
def test_vmware_settings(settings: dict, exception_expected: bool):
|
|
|
|
vmware_settings = {"VMware": settings}
|
|
|
|
if exception_expected:
|
|
with pytest.raises(ValidationError):
|
|
ServerConfig(**vmware_settings)
|
|
else:
|
|
ServerConfig(**vmware_settings)
|
|
|
|
|
|
def test_update_config_writes_ini_types(tmpdir):
|
|
|
|
path = str(tmpdir / "server.conf")
|
|
with open(path, "w+") as f:
|
|
f.write("# a comment\n[Server]\nhost = 127.0.0.1\nfrobnicate = 42\n")
|
|
|
|
config = Config(files=[path])
|
|
changed = config.update_config({
|
|
"Server": {
|
|
"port": 3081,
|
|
"report_errors": False,
|
|
"allowed_interfaces": ["eth0", "eth1"],
|
|
"default_symbol_theme": "Classic",
|
|
"additional_images_paths": ["/path/to/dir1", "/path/to/dir2"],
|
|
}
|
|
})
|
|
|
|
parsed = configparser.ConfigParser()
|
|
parsed.read(path)
|
|
assert parsed["Server"]["port"] == "3081"
|
|
assert parsed["Server"]["report_errors"] == "False"
|
|
assert parsed["Server"]["allowed_interfaces"] == "eth0,eth1"
|
|
assert parsed["Server"]["default_symbol_theme"] == "Classic"
|
|
assert parsed["Server"]["additional_images_paths"] == "/path/to/dir1;/path/to/dir2"
|
|
# options not submitted are left untouched, including unknown ones
|
|
assert parsed["Server"]["host"] == "127.0.0.1"
|
|
assert parsed["Server"]["frobnicate"] == "42"
|
|
|
|
# in-memory settings have been reloaded
|
|
assert config.settings.Server.port == 3081
|
|
assert config.settings.Server.report_errors is False
|
|
assert config.settings.Server.allowed_interfaces == ["eth0", "eth1"]
|
|
assert changed == [
|
|
"Server.additional_images_paths",
|
|
"Server.allowed_interfaces",
|
|
"Server.default_symbol_theme",
|
|
"Server.port",
|
|
"Server.report_errors",
|
|
]
|
|
|
|
|
|
def test_update_config_null_removes_option(tmpdir):
|
|
|
|
path = write_config(tmpdir, {"Server": {"host": "127.0.0.1"}})
|
|
config = Config(files=[path])
|
|
|
|
config.update_config({"Server": {"host": None}})
|
|
|
|
parsed = configparser.ConfigParser()
|
|
parsed.read(path)
|
|
assert not parsed.has_option("Server", "host")
|
|
assert config.settings.Server.host == "0.0.0.0" # default restored
|
|
|
|
|
|
def test_update_config_validation_failure_leaves_file_unchanged(tmpdir):
|
|
|
|
path = write_config(tmpdir, {"Server": {"console_start_port_range": "5000"}})
|
|
config = Config(files=[path])
|
|
with open(path) as f:
|
|
file_content_before = f.read()
|
|
|
|
# cross-field violation (console_end_port_range must be > console_start_port_range)
|
|
with pytest.raises(ValidationError):
|
|
config.update_config({"Server": {"console_start_port_range": 10000, "console_end_port_range": 5000}})
|
|
|
|
with open(path) as f:
|
|
assert f.read() == file_content_before
|
|
|
|
|
|
def test_update_config_conflict(tmpdir):
|
|
|
|
main_path = write_config(tmpdir, {"Server": {"host": "127.0.0.1"}})
|
|
override_path = str(tmpdir / "override.conf")
|
|
with open(override_path, "w+") as f:
|
|
f.write("[Server]\nhost = 10.0.0.1\n")
|
|
|
|
config = Config(files=[main_path, override_path])
|
|
assert config.settings.Server.host == "10.0.0.1" # later file takes precedence
|
|
|
|
with pytest.raises(ConfigConflictError):
|
|
config.update_config({"Server": {"host": "192.168.1.1"}})
|
|
with pytest.raises(ConfigConflictError):
|
|
config.update_config({"Server": {"host": None}})
|
|
|
|
with open(main_path) as f:
|
|
assert "host = 127.0.0.1" in f.read() # main file untouched
|
|
|
|
|
|
def test_update_config_creates_missing_main_file(tmpdir):
|
|
|
|
path = write_config(tmpdir, {"Server": {"host": "127.0.0.1"}})
|
|
config = Config(files=[path])
|
|
os.remove(path)
|
|
|
|
config.update_config({"Server": {"port": 3081}})
|
|
|
|
parsed = configparser.ConfigParser()
|
|
parsed.read(path)
|
|
assert parsed["Server"]["port"] == "3081"
|
|
assert not parsed.has_option("Server", "host") # removed file means defaults
|
|
|
|
|
|
def test_reload_and_notify(tmpdir):
|
|
|
|
path = write_config(tmpdir, {"Server": {"host": "127.0.0.1"}})
|
|
config = Config(files=[path])
|
|
|
|
notified = []
|
|
config.listen_for_config_changes(lambda: notified.append(True))
|
|
|
|
write_config(tmpdir, {"Server": {"host": "192.168.1.2"}})
|
|
config.reload_and_notify()
|
|
|
|
assert config.settings.Server.host == "192.168.1.2"
|
|
assert notified == [True]
|