Files
turnstone/tests/test_node_info.py
T
Patrick Buckley 24f59a6c53 feat: add per-node metadata with auto-collection, admin API, and cons… (#318)
* feat: add per-node metadata with auto-collection, admin API, and console UI

Adds a normalized node_metadata table for structured per-node key/value
metadata with source tracking (auto/user/config).  Auto-populated fields
(hostname, OS, arch, interfaces, cpu_count) are collected at server startup
via stdlib; user-defined fields are managed through the admin API, CLI, or
config.toml [metadata] section.

Storage: migration 035, 7 new protocol methods (get, get_all, set,
set_bulk, delete, delete_by_source, filter), both SQLite and PostgreSQL
backends.  Filtering uses single-query GROUP BY/HAVING for efficiency.

Console API: GET/PUT/DELETE endpoints under /admin/nodes/{node_id}/metadata
with auto-source protection.  cluster_nodes gains meta.* query param
filtering; cluster_node_detail attaches metadata to responses.

Frontend: new Nodes admin tab with collapsible per-node sections, inline
add form, delete with confirmation.  Read-only metadata panel in node
detail drill-down.  Proper design token usage, accessibility (ARIA,
keyboard nav, screen reader labels), and mobile responsiveness.

CLI: turnstone-admin list-node-metadata, set-node-metadata, and
delete-node-metadata subcommands.

64 tests (25 storage, 19 node_info, 20 existing unaffected).

* fix: resolve CI typecheck and test failures

- Fix mypy error: use %-style format string instead of structlog kwargs
  for standard Logger.warning() in console server
- Fix test_get_nodes assertion to include new node_ids=None parameter
- Add debug logging to _collect_interfaces empty except block

* fix: address Copilot review feedback on node metadata

- Clear stale auto/config metadata before upserting on startup
- Wrap metadata filter in try/except with graceful fallback
- Add metadata field to NodeDetailResponse schema
- Use _VALID_NODE_ID regex for consistent node_id validation
- Defensive JSON decode in admin_get_node_metadata
- Switch to read_json_or_400 and require_storage_or_503 helpers
- Add SetNodeMetadataValueRequest for single-key PUT endpoint
- Add bulk GET /admin/node-metadata endpoint (replaces N+1 fetches)
- Update frontend to use single bulk metadata fetch

* feat: add admin.nodes permission scope for node metadata

- Add admin.nodes to builtin-admin role via migration 035
- Switch all node metadata handlers from admin.settings to admin.nodes
- Register admin.nodes in the admin panel permission set
- Node detail metadata panel fetches from cluster endpoint (no admin
  permission needed) instead of admin endpoint

* fix: address second round of Copilot feedback

- Replace inline onclick handlers with data-* attributes and event
  delegation to prevent JS string context XSS
- Move NodeMetadataEntry before NodeDetailResponse and use it as the
  typed metadata field (was list[dict[str, Any]])
- Clean up config metadata on shutdown (was only cleaning auto)
2026-04-06 03:08:19 -07:00

138 lines
4.6 KiB
Python

"""Tests for auto-populated node metadata collection."""
from __future__ import annotations
import json
from unittest.mock import patch
from turnstone.core.node_info import (
_collect_interfaces,
_is_loopback_or_link_local,
collect_node_info,
)
class TestCollectNodeInfo:
def test_returns_dict(self):
info = collect_node_info()
assert isinstance(info, dict)
def test_expected_keys_present(self):
info = collect_node_info()
# These should always be available on any platform
assert "hostname" in info
assert "os" in info
assert "arch" in info
assert "python" in info
def test_values_json_serializable(self):
info = collect_node_info()
for _key, value in info.items():
serialized = json.dumps(value)
assert isinstance(serialized, str)
def test_hostname_is_string(self):
info = collect_node_info()
assert isinstance(info["hostname"], str)
assert len(info["hostname"]) > 0
def test_cpu_count_is_int(self):
info = collect_node_info()
if "cpu_count" in info:
assert isinstance(info["cpu_count"], int)
assert info["cpu_count"] > 0
def test_interfaces_is_dict(self):
info = collect_node_info()
if "interfaces" in info:
assert isinstance(info["interfaces"], dict)
for iface, ips in info["interfaces"].items():
assert isinstance(iface, str)
assert isinstance(ips, list)
def test_one_field_failure_does_not_block_others(self):
"""Individual field failures must not prevent other fields from collecting."""
with patch("turnstone.core.node_info.socket.gethostname", side_effect=OSError("boom")):
info = collect_node_info()
assert "hostname" not in info
# Other fields should still be present
assert "os" in info
assert "arch" in info
assert "python" in info
def test_none_value_excluded(self):
with patch("turnstone.core.node_info.os.cpu_count", return_value=None):
info = collect_node_info()
assert "cpu_count" not in info
assert "hostname" in info
def test_interface_failure_does_not_block_fields(self):
"""Interface collection failure must not prevent scalar fields."""
with patch(
"turnstone.core.node_info._collect_interfaces",
side_effect=RuntimeError("boom"),
):
info = collect_node_info()
assert "interfaces" not in info
assert "hostname" in info
assert "os" in info
class TestCollectInterfaces:
def test_returns_dict(self):
result = _collect_interfaces()
assert isinstance(result, dict)
def test_values_are_string_lists(self):
result = _collect_interfaces()
for label, ips in result.items():
assert isinstance(label, str)
assert isinstance(ips, list)
for ip in ips:
assert isinstance(ip, str)
def test_no_loopback_in_results(self):
result = _collect_interfaces()
for _label, ips in result.items():
for ip in ips:
assert not ip.startswith("127.")
assert ip != "::1"
assert not ip.startswith("fe80:")
def test_getaddrinfo_oserror_returns_empty(self):
with patch(
"turnstone.core.node_info.socket.getaddrinfo",
side_effect=OSError("no network"),
):
result = _collect_interfaces()
assert result == {}
def test_all_loopback_returns_empty(self):
import socket
mock_addrs = [
(socket.AF_INET, socket.SOCK_STREAM, 6, "", ("127.0.0.1", 0)),
(socket.AF_INET6, socket.SOCK_STREAM, 6, "", ("::1", 0, 0, 0)),
]
with patch("turnstone.core.node_info.socket.getaddrinfo", return_value=mock_addrs):
result = _collect_interfaces()
assert result == {}
class TestIsLoopbackOrLinkLocal:
def test_ipv4_loopback(self):
assert _is_loopback_or_link_local("127.0.0.1") is True
assert _is_loopback_or_link_local("127.0.1.1") is True
def test_ipv6_loopback(self):
assert _is_loopback_or_link_local("::1") is True
def test_link_local(self):
assert _is_loopback_or_link_local("fe80::1") is True
assert _is_loopback_or_link_local("fe80:abc::def") is True
def test_normal_addresses(self):
assert _is_loopback_or_link_local("10.0.0.5") is False
assert _is_loopback_or_link_local("192.168.1.1") is False
assert _is_loopback_or_link_local("2001:db8::1") is False