mirror of
https://github.com/hansjone/netx.git
synced 2026-10-09 00:50:46 +08:00
oliver
d3d7f62a02
Support composite-username bastion login for automated connect-test and exec, with bastion-managed or manual target credential modes. Co-authored-by: Cursor <cursoragent@cursor.com>
125 lines
4.5 KiB
Python
125 lines
4.5 KiB
Python
from __future__ import annotations
|
|
|
|
import unittest
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
from netx_api.ne_session_factory import (
|
|
default_bastion_username_template,
|
|
open_netmiko_connection,
|
|
render_hop_command,
|
|
)
|
|
|
|
|
|
class BastionTemplateTests(unittest.TestCase):
|
|
def test_default_bastion_username_template(self) -> None:
|
|
self.assertEqual(
|
|
default_bastion_username_template(),
|
|
"{hop_user}@{target_user}@{target_ip}@{hop_host}",
|
|
)
|
|
|
|
def test_render_bastion_composite_username(self) -> None:
|
|
creds = {
|
|
"hop_vendor": "bastion",
|
|
"hop_username": "ZTE-TSM",
|
|
"hop_host": "10.34.145.27",
|
|
"username": "ca-oper",
|
|
"ip_address": "114.0.44.11",
|
|
"hop_protocol": "ssh",
|
|
"hop_vrf": "",
|
|
}
|
|
out = render_hop_command("", creds)
|
|
self.assertEqual(out, "ZTE-TSM@ca-oper@114.0.44.11@10.34.145.27")
|
|
|
|
def test_render_custom_bastion_template(self) -> None:
|
|
creds = {
|
|
"hop_vendor": "bastion",
|
|
"hop_username": "admin",
|
|
"hop_host": "1.2.3.4",
|
|
"username": "root",
|
|
"ip_address": "5.6.7.8",
|
|
"hop_command_template": "{hop_user}#{target_user}@{target_ip}",
|
|
"hop_protocol": "ssh",
|
|
"hop_vrf": "",
|
|
}
|
|
out = render_hop_command(creds["hop_command_template"], creds)
|
|
self.assertEqual(out, "admin#root@5.6.7.8")
|
|
|
|
|
|
class BastionConnectRoutingTests(unittest.TestCase):
|
|
@patch("netx_api.ne_session_factory._connect_via_bastion")
|
|
@patch("netx_api.ne_session_factory._connect_direct")
|
|
def test_open_routes_to_bastion_when_enabled(self, direct, bastion) -> None:
|
|
bastion.return_value = MagicMock()
|
|
creds = {"hop_enabled": True, "hop_vendor": "bastion"}
|
|
open_netmiko_connection(creds)
|
|
bastion.assert_called_once()
|
|
direct.assert_not_called()
|
|
|
|
@patch("netx_api.ne_session_factory._connect_via_bastion")
|
|
@patch("netx_api.ne_session_factory._connect_via_linux_hop")
|
|
def test_open_routes_linux_not_bastion(self, linux, bastion) -> None:
|
|
linux.return_value = MagicMock()
|
|
creds = {"hop_enabled": True, "hop_vendor": "linux"}
|
|
open_netmiko_connection(creds)
|
|
linux.assert_called_once()
|
|
bastion.assert_not_called()
|
|
|
|
|
|
class BastionConnectImplTests(unittest.TestCase):
|
|
@patch("netx_api.ne_session_factory.ConnectHandler")
|
|
def test_bastion_managed_skips_secondary_auth(self, connect_handler) -> None:
|
|
from netx_api.ne_session_factory import _connect_via_bastion
|
|
|
|
conn = MagicMock()
|
|
connect_handler.return_value = conn
|
|
creds = {
|
|
"hop_host": "10.34.145.27",
|
|
"hop_username": "ZTE-TSM",
|
|
"hop_password": "vault-pass",
|
|
"hop_port": 22,
|
|
"device_type": "zte_zxros",
|
|
"protocol": "ssh",
|
|
"username": "ca-oper",
|
|
"ip_address": "114.0.44.11",
|
|
"password": "",
|
|
"hop_target_auth_mode": "bastion_managed",
|
|
"hop_vendor": "bastion",
|
|
"hop_protocol": "ssh",
|
|
"hop_vrf": "",
|
|
}
|
|
_connect_via_bastion(creds)
|
|
kwargs = connect_handler.call_args.kwargs
|
|
self.assertEqual(kwargs["host"], "10.34.145.27")
|
|
self.assertEqual(kwargs["username"], "ZTE-TSM@ca-oper@114.0.44.11@10.34.145.27")
|
|
self.assertEqual(kwargs["password"], "vault-pass")
|
|
conn.disconnect.assert_not_called()
|
|
|
|
@patch("netx_api.ne_session_factory._interactive_target_auth")
|
|
@patch("netx_api.ne_session_factory._read_channel")
|
|
@patch("netx_api.ne_session_factory.ConnectHandler")
|
|
def test_bastion_manual_invokes_secondary_auth(self, connect_handler, _read, interact) -> None:
|
|
from netx_api.ne_session_factory import _connect_via_bastion
|
|
|
|
conn = MagicMock()
|
|
connect_handler.return_value = conn
|
|
creds = {
|
|
"hop_host": "10.0.0.1",
|
|
"hop_username": "bastion-user",
|
|
"hop_password": "bastion-pass",
|
|
"hop_port": 2222,
|
|
"device_type": "cisco_ios",
|
|
"protocol": "ssh",
|
|
"username": "target-user",
|
|
"ip_address": "10.0.0.2",
|
|
"password": "target-pass",
|
|
"hop_target_auth_mode": "manual",
|
|
"hop_vendor": "bastion",
|
|
"hop_protocol": "ssh",
|
|
"hop_vrf": "",
|
|
}
|
|
_connect_via_bastion(creds)
|
|
interact.assert_called_once_with(conn, "target-user", "target-pass")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|