feat(ops): add managed NE management and batch CLI collection

Introduce workbench operations for multi-vendor NE CRUD/connect-test and Netmiko batch collection with job lifecycle controls, log downloads, and paginated run filters.

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
oliver 2026-05-27 23:34:29 +08:00
parent 282dbe75af
commit 042c015045
36 changed files with 3695 additions and 17 deletions

View file

@ -0,0 +1,35 @@
from __future__ import annotations
import unittest
from datetime import datetime
from unittest.mock import MagicMock
from netx_api.collection_job_state import finalize_collection_job
class CollectionJobFinalizeTests(unittest.TestCase):
def test_paused_job_stays_paused_when_all_runs_terminal(self):
job = MagicMock()
job.status = "paused"
job.ended_at = None
job.success_count = 0
job.fail_count = 0
run_ok = MagicMock(status="success")
run_cancel = MagicMock(status="cancelled")
db = MagicMock()
db.query.return_value.filter.return_value.all.return_value = [run_ok, run_cancel]
db.get.return_value = job
finalize_collection_job(db, "job-1")
self.assertEqual(job.status, "paused")
self.assertEqual(job.success_count, 1)
self.assertEqual(job.fail_count, 1)
self.assertIsNotNone(job.ended_at)
db.commit.assert_called_once()
if __name__ == "__main__":
unittest.main()

175
tests/test_managed_ne.py Normal file
View file

@ -0,0 +1,175 @@
from __future__ import annotations
import unittest
from unittest.mock import patch
from cryptography.fernet import Fernet
from fastapi.testclient import TestClient
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker
from sqlalchemy.pool import StaticPool
from netx_api.config import settings
from netx_api.db import Base, get_db
from netx_api.main import app
from netx_api.models import ManagedNE # noqa: F401 — register table on Base
from netx_api.ne_connect import hostname_probe_command, parse_hostname_from_output
from netx_api.ne_crypto import decrypt_secret, encrypt_secret
from netx_api.ne_service import create_managed_ne, import_managed_ne
from netx_api.ne_schemas import ManagedNeCreate
class ManagedNeHostnameParseTests(unittest.TestCase):
def test_huawei_sysname(self):
out = " sysname PE-CORE-01\n"
self.assertEqual(parse_hostname_from_output("huawei", "Huawei", out), "PE-CORE-01")
def test_juniper_hostname(self):
out = "host-name ROUTER-A;\nname ROUTER-A\n"
self.assertEqual(parse_hostname_from_output("juniper", "Juniper", out), "ROUTER-A")
def test_zte_last_line(self):
out = "line1\nZXR10-PE1#"
self.assertEqual(parse_hostname_from_output("zte_zxros", "ZTE", out), "ZXR10-PE1#")
def test_probe_commands(self):
self.assertIn("sysname", hostname_probe_command("huawei", "Huawei") or "")
self.assertEqual(hostname_probe_command("zte_zxros", "ZTE"), None)
class ManagedNeCryptoTests(unittest.TestCase):
def setUp(self):
self._orig = settings.credential_secret_key
settings.credential_secret_key = Fernet.generate_key().decode()
def tearDown(self):
settings.credential_secret_key = self._orig
def test_encrypt_roundtrip(self):
enc = encrypt_secret("secret-pass")
self.assertEqual(decrypt_secret(enc), "secret-pass")
class ManagedNeApiTests(unittest.TestCase):
def setUp(self):
self._orig_key = settings.credential_secret_key
settings.credential_secret_key = Fernet.generate_key().decode()
self.engine = create_engine(
"sqlite://",
connect_args={"check_same_thread": False},
poolclass=StaticPool,
)
ManagedNE.__table__.create(bind=self.engine, checkfirst=True)
self.Session = sessionmaker(bind=self.engine, autoflush=False, autocommit=False)
def override_get_db():
db = self.Session()
try:
yield db
finally:
db.close()
app.dependency_overrides[get_db] = override_get_db
self._session_patch = patch("netx_api.ne_connect.SessionLocal", self.Session)
self._session_patch.start()
self.client = TestClient(app)
def tearDown(self):
app.dependency_overrides.clear()
self._session_patch.stop()
settings.credential_secret_key = self._orig_key
def test_crud_flow(self):
r = self.client.post(
"/v1/managed-ne",
json={
"name": "PE-01",
"vendor": "ZTE",
"device_type": "zte_zxros",
"ip_address": "10.0.0.1",
"port": 22,
"protocol": "ssh",
"username": "admin",
"password": "pass123",
},
)
self.assertEqual(r.status_code, 200, r.text)
ne_id = r.json()["id"]
self.assertNotIn("password", r.json())
r2 = self.client.get(f"/v1/managed-ne/{ne_id}")
self.assertEqual(r2.status_code, 200)
self.assertEqual(r2.json()["ip_address"], "10.0.0.1")
r3 = self.client.patch(f"/v1/managed-ne/{ne_id}", json={"name": "PE-01-upd"})
self.assertEqual(r3.status_code, 200)
self.assertEqual(r3.json()["name"], "PE-01-upd")
r4 = self.client.get("/v1/managed-ne", params={"keyword": "10.0.0"})
self.assertEqual(r4.status_code, 200)
self.assertEqual(r4.json()["total"], 1)
r5 = self.client.delete(f"/v1/managed-ne/{ne_id}")
self.assertEqual(r5.status_code, 200)
def test_create_without_crypto_key(self):
settings.credential_secret_key = ""
r = self.client.post(
"/v1/managed-ne",
json={
"vendor": "ZTE",
"device_type": "zte_zxros",
"ip_address": "10.0.0.2",
"username": "admin",
"password": "x",
},
)
self.assertEqual(r.status_code, 503, r.text)
@patch("netx_api.ne_connect._probe_device", return_value=("pass", "ok", None))
def test_connect_test(self, _mock_probe):
r = self.client.post(
"/v1/managed-ne",
json={
"vendor": "Huawei",
"device_type": "huawei",
"ip_address": "10.0.0.3",
"username": "admin",
"password": "pass",
},
)
ne_id = r.json()["id"]
r2 = self.client.post("/v1/managed-ne/connect-test", json={"ids": [ne_id]})
self.assertEqual(r2.status_code, 200)
self.assertEqual(r2.json()["submitted"], 1)
class ManagedNeServiceImportTests(unittest.TestCase):
def setUp(self):
self._orig = settings.credential_secret_key
settings.credential_secret_key = Fernet.generate_key().decode()
self.engine = create_engine(
"sqlite://",
connect_args={"check_same_thread": False},
poolclass=StaticPool,
)
ManagedNE.__table__.create(bind=self.engine, checkfirst=True)
self.db = sessionmaker(bind=self.engine)()
def tearDown(self):
self.db.close()
settings.credential_secret_key = self._orig
def test_csv_import(self):
csv = (
"device_type,ip,username,password,port,protocol,name,vendor\n"
"zte_zxros,10.1.1.1,u1,p1,22,ssh,NE-A,ZTE\n"
).encode("utf-8")
result = import_managed_ne(self.db, csv, "devices.csv")
self.assertEqual(result.inserted, 1)
self.assertEqual(result.updated, 0)
self.assertEqual(len(result.failed), 0)
if __name__ == "__main__":
unittest.main()

View file

@ -0,0 +1,15 @@
from __future__ import annotations
import unittest
from netx_api.collection_service import _parse_commands
class NeCollectionParseTests(unittest.TestCase):
def test_parse_commands_skips_comments(self):
cmds = _parse_commands("display version\n# comment\ndisplay ip int brief\n")
self.assertEqual(cmds, ["display version", "display ip int brief"])
if __name__ == "__main__":
unittest.main()