YueGuobin 1e0d123f4b
Merge branch '3.1' into fix/duplicate-device-configs-merge
Resolve conflicts against the upstream wave (PRs #2952-#2965, incl. the
typed-response/schema hardening and the drop of Python 3.10):

- controller/node.py: keep upstream's _transitioning/_confirm_status
  lifecycle guard; the kernel-anchor link wiring (node_started) runs
  after the transition completes.
- controller/link.py: keep upstream's add_node rollback (release_ports
  on create failure) and delete via release_ports; release_ports now
  resolves ports live (same staleness reason as _bind_members) and
  discards the node link unconditionally.
- schemas/controller/links.py: extend LinkFilterType with the eight
  kernel-datapath filter types and LinkFilterParameter.type with "str"
  so the newly typed /available_filters response validates; Link.filters
  stays a free-form dict — the vocabulary is capability-gated per link
  and validated by the controller (409), not by a strict request schema.
- schemas/controller/topology.py: drop the type: ignore made redundant
  by the dict filters field.
- tests: route-level filter validation now expects the controller's 409
  (unknown types, out-of-range values); packet_loss correlation is a
  valid kernel parameter (positive test added); OpenAPI assertions match
  the free-form filters property.
2026-10-09 10:03:50 +08:00

598 lines
19 KiB
Python

#!/usr/bin/env python
#
# 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 asyncio
from unittest.mock import MagicMock
import pytest
import pytest_asyncio
from gns3server.controller.controller_error import ControllerError
from gns3server.controller.link import Link
from gns3server.controller.node import Node
from gns3server.controller.ports.ethernet_port import EthernetPort
from gns3server.controller.ports.serial_port import SerialPort
from tests.utils import AsyncioBytesIO, AsyncioMagicMock
@pytest_asyncio.fixture
async def link(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 1, 3)]
link = Link(project)
link.create = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 1, 3)
return link
def test_eq(project, link):
assert link == Link(project, link_id=link.id)
assert link != "a"
assert link != Link(project)
@pytest.mark.asyncio
async def test_add_node(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
assert link._nodes == [
{
"node": node1,
"port": node1._ports[0],
"adapter_number": 0,
"port_number": 4,
"label": {
"text": "0/4",
"style": "font-family: TypeWriter;font-size: 10.0;font-weight: bold;fill: #000000;fill-opacity: 1.0;",
},
}
]
assert project.dump.called
assert not link._project.emit_notification.called
assert not link.create.called
# We call link.created only when both side are created
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
await link.add_node(node2, 0, 4)
assert link.create.called
link._project.emit_notification.assert_called_with("link.created", link.asdict())
assert link in node2.links
@pytest.mark.asyncio
async def test_add_node_already_connected(project, compute):
"""
Raise an error if we try to use an already connected port
"""
project.dump = AsyncioMagicMock()
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 4)
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
await link.add_node(node2, 0, 4)
assert link.create.called
link2 = Link(project)
link2.create = AsyncioMagicMock()
with pytest.raises(ControllerError):
await link2.add_node(node1, 0, 4)
@pytest.mark.asyncio
async def test_add_node_already_connected_after_node_update(project, compute):
"""
A node update (any compute node.updated notification) rebuilds its port
objects; the port must still count as used afterwards, or the duplicate
link reaches the compute and fails on the already-bound NIO instead of
being refused here.
"""
project.dump = AsyncioMagicMock()
node1 = Node(project, compute, "node1", node_type="qemu")
node2 = Node(project, compute, "node2", node_type="qemu")
link = Link(project)
link.create = AsyncioMagicMock()
link.node_updated = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 0)
await link.add_node(node2, 0, 0)
await node1.parse_node_response({"status": "started"})
link2 = Link(project)
link2.create = AsyncioMagicMock()
with pytest.raises(ControllerError, match="already used"):
await link2.add_node(node1, 0, 0)
@pytest.mark.asyncio
async def test_link_delete_after_node_update_releases_port(project, compute):
"""
Link.delete drops the port's link reference through the port object it
stored at add_node time; a node update since then rebuilt the port list,
so that stored object is stale. The delete must release the *live* port,
or the next link on it is refused with "Port is already used".
"""
project.dump = AsyncioMagicMock()
node1 = Node(project, compute, "node1", node_type="qemu")
node2 = Node(project, compute, "node2", node_type="qemu")
link = Link(project)
link.create = AsyncioMagicMock()
link.node_updated = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 0)
await link.add_node(node2, 0, 0)
# a node update (e.g. the status change of a start) rebuilds the ports
await node1.parse_node_response({"status": "started"})
await link.delete()
link2 = Link(project)
link2.create = AsyncioMagicMock()
await link2.add_node(node1, 0, 0) # must not raise "Port is already used"
@pytest.mark.asyncio
async def test_add_node_cloud(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="cloud")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 0, 4)
@pytest.mark.asyncio
async def test_add_node_cloud_to_cloud(project, compute):
"""
Cloud to cloud connection is not allowed
"""
node1 = Node(project, compute, "node1", node_type="cloud")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="cloud")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 4)
with pytest.raises(ControllerError):
await link.add_node(node2, 0, 4)
@pytest.mark.asyncio
async def test_add_node_same_node(project, compute):
"""
Connection to the same node is not allowed
"""
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4), EthernetPort("E1", 0, 0, 5)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 4)
with pytest.raises(ControllerError):
await link.add_node(node1, 0, 5)
@pytest.mark.asyncio
async def test_add_node_serial_to_ethernet(project, compute):
"""
Serial to ethernet connection is not allowed
"""
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [SerialPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
await link.add_node(node1, 0, 4)
with pytest.raises(ControllerError):
await link.add_node(node2, 0, 4)
@pytest.mark.asyncio
async def test_json(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 1, 3)]
link = Link(project)
link.create = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 1, 3)
assert link.asdict() == {
"link_id": link.id,
"project_id": project.id,
"nodes": [
{
"node_id": node1.id,
"adapter_number": 0,
"port_number": 4,
"label": {
"text": "0/4",
"style": "font-family: TypeWriter;font-size: 10.0;font-weight: bold;fill: #000000;fill-opacity: 1.0;",
},
},
{
"node_id": node2.id,
"adapter_number": 1,
"port_number": 3,
"label": {
"text": "1/3",
"style": "font-family: TypeWriter;font-size: 10.0;font-weight: bold;fill: #000000;fill-opacity: 1.0;",
},
},
],
"filters": {},
"markers": {},
"show_filters_icon": True,
"link_style": {},
"suspend": False,
"wireshark": False,
"link_type": "ethernet",
"kernel_datapath": False,
"capturing": False,
"capture_file_name": None,
"capture_file_path": None,
"capture_compute_id": None,
}
assert link.asdict(topology_dump=True) == {
"link_id": link.id,
"nodes": [
{
"node_id": node1.id,
"adapter_number": 0,
"port_number": 4,
"label": {
"text": "0/4",
"style": "font-family: TypeWriter;font-size: 10.0;font-weight: bold;fill: #000000;fill-opacity: 1.0;",
},
},
{
"node_id": node2.id,
"adapter_number": 1,
"port_number": 3,
"label": {
"text": "1/3",
"style": "font-family: TypeWriter;font-size: 10.0;font-weight: bold;fill: #000000;fill-opacity: 1.0;",
},
},
],
"link_style": {},
"filters": {},
"markers": {},
"show_filters_icon": True,
"suspend": False,
}
@pytest.mark.asyncio
async def test_json_serial_link(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [SerialPort("S0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [SerialPort("S0", 0, 1, 3)]
link = Link(project)
link.create = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 1, 3)
assert link.asdict()["link_type"] == "serial"
@pytest.mark.asyncio
async def test_default_capture_file_name(project, compute):
node1 = Node(project, compute, "Hello@", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "w0.rld", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 1, 3)]
link = Link(project)
link.create = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 1, 3)
assert link.default_capture_file_name() == "Hello_0-4_to_w0rld_1-3.pcap"
@pytest.mark.asyncio
async def test_start_capture(link):
async def fake_reader():
return AsyncioBytesIO()
link.read_pcap_from_source = fake_reader
link._project.emit_notification = MagicMock()
await link.start_capture(capture_file_name="test.pcap")
assert link._capturing
assert link._capture_file_name == "test.pcap"
link._project.emit_notification.assert_called_with("link.updated", link.asdict())
@pytest.mark.asyncio
async def test_stop_capture(link):
link._capturing = True
link._project.emit_notification = MagicMock()
await link.stop_capture()
assert link._capturing is False
link._project.emit_notification.assert_called_with("link.updated", link.asdict())
@pytest.mark.asyncio
async def test_delete(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
await link.add_node(node2, 0, 4)
assert link in node2.links
await link.delete()
assert link not in node2.links
@pytest.mark.asyncio
async def test_update_filters(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
await link.add_node(node2, 0, 4)
link.update = AsyncioMagicMock()
assert link._created
await link.update_filters({"packet_loss": [10], "delay": [50, 10], "frequency_drop": [0], "bpf": [" \n "]})
assert link.filters == {"packet_loss": [10], "delay": [50, 10]}
assert link.update.called
@pytest.mark.asyncio
async def test_update_filters_unchanged_is_noop(project, compute):
"""Re-sending an identical filters dict skips the datapath reconcile."""
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 0, 4)
link.update = AsyncioMagicMock()
await link.update_filters({"packet_loss": [10]})
assert link.update.call_count == 1
await link.update_filters({"packet_loss": [10]})
assert link.update.call_count == 1
@pytest.mark.asyncio
async def test_update_filters_unchanged_window_drop_still_reconciles(project, compute):
"""
window_drop's outage schedule is measured from the apply, so an
unchanged re-send must re-arm it instead of being skipped as a no-op.
"""
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = AsyncioMagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 0, 4)
# window_drop is kernel-only: this synthetic link has no real wiring,
# so declare the kernel datapath the way _link_data does at runtime
link._link_data = [{"type": "nio_bridge"}]
link.update = AsyncioMagicMock()
await link.update_filters({"window_drop": [3000, 5000, 100]})
assert link.update.call_count == 1
await link.update_filters({"window_drop": [3000, 5000, 100]})
assert link.update.call_count == 2
@pytest.mark.asyncio
async def test_available_filters(project, compute):
node1 = Node(project, compute, "node1", node_type="ethernet_switch")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock()
assert link.available_filters() == []
# The brctl Ethernet switch hosts filters on its per-port uBridge relays
await link.add_node(node1, 0, 4)
assert len(link.available_filters()) > 0
node2 = Node(project, compute, "node2", node_type="vpcs")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
await link.add_node(node2, 0, 4)
assert len(link.available_filters()) > 0
@pytest.mark.asyncio
async def test_update_link_style(project, compute):
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 1, 3)]
link = Link(project)
link.create = AsyncioMagicMock()
link._project.emit_notification = MagicMock()
project.dump = MagicMock()
await link.add_node(node1, 0, 4)
await link.add_node(node2, 1, 3)
await link.update_link_style(
{
"color": "#00ff00",
"width": 3,
"type": 1,
"link_type": "flowchart",
"bezier_curviness": 150,
"flowchart_roundness": 20,
}
)
assert link.asdict()["link_style"] == {
"color": "#00ff00",
"width": 3,
"type": 1,
"link_type": "flowchart",
"bezier_curviness": 150,
"flowchart_roundness": 20,
}
link._project.emit_notification.assert_called_with("link.updated", link.asdict())
assert project.dump.called
@pytest.mark.asyncio
async def test_add_node_concurrent_same_port(project, compute):
project.dump = MagicMock()
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4), EthernetPort("E1", 0, 0, 5)]
node3 = Node(project, compute, "node3", node_type="qemu")
node3._ports = [EthernetPort("E0", 0, 0, 4)]
async def slow_create():
await asyncio.sleep(0)
async def connect(other, other_port):
link = Link(project)
link.create = slow_create
try:
await link.add_node(other, 0, other_port)
await link.add_node(node1, 0, 4)
except ControllerError as e:
return e
return link
results = await asyncio.gather(connect(node2, 4), connect(node3, 4))
errors = [r for r in results if isinstance(r, ControllerError)]
assert len(errors) == 1
assert errors[0].code == "port_in_use"
assert node1._ports[0].link in results
@pytest.mark.asyncio
async def test_add_node_create_failure_releases_ports(project, compute):
project.dump = MagicMock()
node1 = Node(project, compute, "node1", node_type="qemu")
node1._ports = [EthernetPort("E0", 0, 0, 4)]
node2 = Node(project, compute, "node2", node_type="qemu")
node2._ports = [EthernetPort("E0", 0, 0, 4)]
link = Link(project)
link.create = AsyncioMagicMock(side_effect=ControllerError("boom"))
await link.add_node(node1, 0, 4)
with pytest.raises(ControllerError):
await link.add_node(node2, 0, 4)
assert node1._ports[0].link is None
assert node2._ports[0].link is None
assert not node1.links
assert not node2.links
def test_node_get_port_by_name_and_free_port(project, compute):
node = Node(project, compute, "node1", node_type="qemu")
node._ports = [EthernetPort("E1", 0, 0, 1), EthernetPort("E0", 0, 0, 0), SerialPort("S0", 0, 1, 0)]
assert node.get_port_by_name("E0") is node._ports[1]
assert node.get_port_by_name("nope") is None
assert node.get_free_port() is node._ports[1]
assert node.get_free_port("serial") is node._ports[2]
node._ports[1].link = object()
assert node.get_free_port("ethernet") is node._ports[0]
node._ports[0].link = object()
assert node.get_free_port("ethernet") is None