feat(device-discovery): vrf discovery for iosxr, iosxr_netconf, nokia_sros, nokia_srl by leoparente · Pull Request #453 · netboxlabs/orb-discovery

leoparente · 2026-06-10T20:19:31Z

Summary

First custom-driver batch implementing get_network_instances() for VRF discovery (follow-up to #452, which works out of the box on ios/eos/junos/nxos/nxos_ssh via upstream NAPALM). All four return the NAPALM OpenConfig network-instances shape consumed by options.discover_vrfs.

Per driver

Driver	Data source	Notes
`iosxr`	`show vrf all detail` via pyIOSXR	Parsed driver-locally — the cisco_xr ntc-template FSM gets stuck on VRF blocks without an address family or with import/export route policies attached (routine in production L3VPN), swallowing the next VRF's header and misattributing its interfaces. The line-stateful block parser has no stuck states; both failure modes are pinned by fixtures (`missing_af_section`, `route_policy_attached`). RD `not set` → absent.
`iosxr_netconf`	One subtree-filtered get on `Cisco-IOS-XR-mpls-vpn-oper` `l3vpn/vrfs`	Same data source the CLI renders; namespace/path verified against the published YANG model. Untrusted replies parse with entity resolution disabled.
`nokia_sros`	One NETCONF get on `configure/service/vprn`	VPRN services map to VRFs; member interfaces keyed `<service>/<interface>` to match `get_interfaces_ip()` naming so downstream VRF attachment joins correctly. RD from `bgp-ipvpn/mpls`. Base router emitted as DEFAULT_INSTANCE.
`nokia_srl`	Three targeted `info from state network-instance` CLI calls	type / interface membership / bgp-vpn RD, parsed by a block-header line parser (nested-block and quoted-name safe). `ip-vrf` → L3VRF, `mac-vrf` → L2VSI, `default` → DEFAULT_INSTANCE; module-prefixed identityrefs tolerated.

Common semantics: default instances carry no interface membership by design (the pipeline only consumes VRF memberships); the NAPALM name filter is honored on every return path including degraded ones; rows named default can never overwrite the seeded DEFAULT_INSTANCE.

Tests

Generic shape-validating test_get_network_instances in BaseDriverTest (auto-skips drivers on the base-class stub or without fixtures)
10 fixture scenarios across the four drivers, including the two XR template-failure cases, a default-named-row guard, and empty-device scenarios
Driver-pin test extended to the nine supported drivers
Full suite: 1742 passed, 174 skipped; ruff clean

Review trail

Codex review (caught SROS interface-key mismatch with get_interfaces_ip() naming + XR default-row overwrite) and two adversarial Claude review rounds (caught the ntc-template stuck-state misattribution — fixed by the driver-local parser — and the name-filter contract gaps on degraded paths). Final round: APPROVED.

🤖 Generated with Claude Code

…_sros, nokia_srl First custom-driver batch implementing get_network_instances(): - iosxr: "show vrf all detail" via pyIOSXR, parsed with the cisco_xr ntc-template; the literal "not set" RD normalizes to empty. - iosxr_netconf: single subtree-filtered NETCONF get on the Cisco-IOS-XR-mpls-vpn-oper l3vpn/vrfs model — the same data source the CLI command renders. - nokia_sros: VPRN services as L3VRFs via one NETCONF get on configure/service/vprn (service-name, bgp-ipvpn/mpls route-distinguisher, interface list); the Base router is the DEFAULT_INSTANCE. - nokia_srl: three targeted "info from state network-instance" CLI calls (type, interface membership, bgp-vpn route distinguisher) parsed with a block-header line parser; ip-vrf maps to L3VRF, mac-vrf to L2VSI. All four emit the NAPALM OpenConfig shape consumed by discover_vrfs. Default-instance interface membership is intentionally left empty — the discovery pipeline only consumes VRF memberships. Adds a generic shape-validating test_get_network_instances to BaseDriverTest (auto-skips drivers without fixtures) with per-driver scenarios, and extends the runner-dispatch pin test to the nine supported drivers. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

chatgpt-codex-connector · 2026-06-10T20:19:38Z

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

github-actions · 2026-06-10T20:20:27Z

Coverage Report

File	Stmts	Miss	Cover	Missing
device_discovery
client.py	66	10	85%	169–188
discovery.py	76	5	93%	102–104, 174–177
entity_metadata.py	13	2	85%	24, 27
interface.py	217	5	98%	141–145, 491–492
main.py	49	2	96%	182, 188
metrics.py	53	1	98%	133
server.py	86	10	88%	44–46, 72–87, 184, 187
stubs.py	160	10	94%	31, 64, 84, 146, 256, 301, 324–329, 341–346
translate.py	283	7	98%	141, 143, 256, 478, 556, 567, 608
translate_chassis.py	175	6	97%	42, 45, 54–55, 149, 405
translate_modules.py	107	1	99%	217
version.py	7	1	86%	14
vrf.py	72	3	96%	67–68, 99
device_discovery/policy
manager.py	61	3	95%	37–38, 161
portscan.py	84	11	87%	34–35, 59–60, 64, 72–76, 117
run.py	88	2	98%	158, 193
runner.py	253	23	91%	276–280, 285–286, 303–304, 397, 631, 650–682
TOTAL	1974	102	95%

Tests	Skipped	Failures	Errors	Time
1917	174 💤	0 ❌	0 🔥	11.063s ⏱️

Copilot

Pull request overview

Adds VRF discovery support for additional custom NAPALM drivers by implementing get_network_instances() in the OpenConfig “network-instances” shape, plus fixtures and test coverage to validate payload shape and driver support across the runner dispatch path.

Changes:

Implement get_network_instances() for iosxr, iosxr_netconf, nokia_sros, and nokia_srl custom drivers.
Add/extend tests to validate getter shape, scenarios/fixtures, and pin the supported-driver matrix for VRF discovery dispatch.
Add driver-specific mocked device outputs and expected OC-shaped results for multiple scenarios (normal/empty/default-row/template edge cases).

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
device-discovery/tests/test_runner_vrf_dispatch.py	Extends the driver pin/matrix test to include the new drivers that implement `get_network_instances()`.
device-discovery/tests/custom_drivers/base_test.py	Adds a generic shape-validating (and fixture-comparing) `test_get_network_instances` to the custom-driver base test suite.
device-discovery/custom_napalm/iosxr.py	Implements IOS-XR VRF discovery by parsing `show vrf all detail` into the NAPALM OC network-instances shape.
device-discovery/custom_napalm/iosxr_netconf.py	Implements IOS-XR NETCONF VRF discovery via a subtree-filtered `Cisco-IOS-XR-mpls-vpn-oper` query and safe XML parsing.
device-discovery/custom_napalm/nokia_sros.py	Implements SR-OS VRF discovery via NETCONF `configure/service/vprn` (VPRN→VRF) parsing into OC shape.
device-discovery/custom_napalm/nokia_srl.py	Implements SR Linux network-instance discovery via targeted CLI `info from state ...` calls and block parsing.
device-discovery/tests/custom_drivers/nokia_sros/mock_data/test_get_network_instances/normal/response.xml	Mock NETCONF response for SR-OS VPRN discovery (normal scenario).
device-discovery/tests/custom_drivers/nokia_sros/mock_data/test_get_network_instances/normal/expected_result.json	Expected OC-shaped SR-OS network-instances for normal scenario.
device-discovery/tests/custom_drivers/nokia_sros/mock_data/test_get_network_instances/no_vprns/response.xml	Mock NETCONF response for SR-OS with no VPRNs.
device-discovery/tests/custom_drivers/nokia_sros/mock_data/test_get_network_instances/no_vprns/expected_result.json	Expected OC-shaped SR-OS network-instances when no VPRNs exist.
device-discovery/tests/custom_drivers/nokia_srl/mock_data/test_get_network_instances/normal/info_from_state_network-instance_type.txt	Mock SRL type output for network-instance discovery.
device-discovery/tests/custom_drivers/nokia_srl/mock_data/test_get_network_instances/normal/info_from_state_network-instance_interface_name.txt	Mock SRL interface membership output for network-instance discovery.
device-discovery/tests/custom_drivers/nokia_srl/mock_data/test_get_network_instances/normal/info_from_state_network-instance_protocols_bgp-vpn_bgp-instance_route-distinguisher_rd.txt	Mock SRL RD output for network-instance discovery.
device-discovery/tests/custom_drivers/nokia_srl/mock_data/test_get_network_instances/normal/expected_result.json	Expected OC-shaped SRL network-instances for normal scenario.
device-discovery/tests/custom_drivers/nokia_srl/mock_data/test_get_network_instances/empty/expected_result.json	Expected OC-shaped SRL network-instances for empty scenario.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/normal/show_vrf_all_detail.txt	Mock IOS-XR CLI output for normal VRF parsing scenario.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/normal/expected_result.json	Expected OC-shaped IOS-XR network-instances for normal scenario.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/missing_af_section/show_vrf_all_detail.txt	Mock IOS-XR CLI output for “missing AF section” edge case.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/missing_af_section/expected_result.json	Expected OC-shaped IOS-XR output for “missing AF section” scenario.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/route_policy_attached/show_vrf_all_detail.txt	Mock IOS-XR CLI output for “route policy attached” edge case.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/route_policy_attached/expected_result.json	Expected OC-shaped IOS-XR output for “route policy attached” scenario.
device-discovery/tests/custom_drivers/iosxr/mock_data/test_get_network_instances/no_vrfs/expected_result.json	Expected OC-shaped IOS-XR output when no VRFs exist.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/normal/response.xml	Mock IOS-XR NETCONF response for normal VRF discovery scenario.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/normal/expected_result.json	Expected OC-shaped IOS-XR NETCONF output for normal scenario.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/no_vrfs/response.xml	Mock IOS-XR NETCONF response when no VRFs exist.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/no_vrfs/expected_result.json	Expected OC-shaped IOS-XR NETCONF output when no VRFs exist.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/default_row/response.xml	Mock IOS-XR NETCONF response containing a `vrf-name=default` row.
device-discovery/tests/custom_drivers/iosxr_netconf/mock_data/test_get_network_instances/default_row/expected_result.json	Expected OC-shaped IOS-XR NETCONF output ensuring the seeded DEFAULT_INSTANCE isn’t overwritten.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…cs in vrf getters Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.

…e default instance Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

leoparente · 2026-06-10T22:46:50Z

@codex review

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e2600d22b2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

…; pin getter ownership The SR Linux getter populated interface membership for the default network instance, contradicting the batch-wide design where default instances carry no membership (the pipeline only consumes VRF memberships). Emit it empty like the other three drivers. Strengthen the driver-pin test to assert which package owns get_network_instances (upstream napalm vs custom_napalm) instead of just "not the base-class stub" — also catches upstream growing its own NotImplementedError-raising override. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

leoparente · 2026-06-11T00:23:55Z

@codex review

chatgpt-codex-connector · 2026-06-11T00:27:47Z

Codex Review: Didn't find any major issues. Keep them coming!

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

… in iosxr_netconf Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated no new comments.

leoparente requested review from MicahParks, grant-nbl, jajeffries, marc-barry, mfiedorowicz, paulstuart and samiura as code owners June 10, 2026 20:19

leoparente mentioned this pull request Jun 10, 2026

docs(device-discovery): vrf discovery via the discover_vrfs option netboxlabs/orb-agent#398

Draft

leoparente requested a review from Copilot June 10, 2026 20:20

Copilot started reviewing on behalf of leoparente June 10, 2026 20:20 View session

leoparente self-assigned this Jun 10, 2026

Copilot AI reviewed Jun 10, 2026

View reviewed changes

Comment thread device-discovery/custom_napalm/iosxr.py

Comment thread device-discovery/custom_napalm/iosxr_netconf.py

Comment thread device-discovery/custom_napalm/nokia_sros.py

samiura approved these changes Jun 10, 2026

View reviewed changes

docs(device-discovery): document the transport-failure return semanti…

74b9e4a

…cs in vrf getters Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

leoparente requested a review from Copilot June 10, 2026 20:31

Copilot started reviewing on behalf of leoparente June 10, 2026 20:32 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

Comment thread device-discovery/custom_napalm/nokia_sros.py

fix(device-discovery): guard sros base-named vprn from overwriting th…

e2600d2

…e default instance Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

leoparente requested a review from Copilot June 10, 2026 20:43

Copilot started reviewing on behalf of leoparente June 10, 2026 20:43 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

Comment thread device-discovery/custom_napalm/nokia_srl.py

chatgpt-codex-connector Bot reviewed Jun 10, 2026

View reviewed changes

Comment thread device-discovery/tests/test_runner_vrf_dispatch.py Outdated

leoparente requested a review from Copilot June 11, 2026 00:23

Copilot started reviewing on behalf of leoparente June 11, 2026 00:23 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

Comment thread device-discovery/tests/test_runner_vrf_dispatch.py

Potential fix for pull request finding

feefd06

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

leoparente requested a review from Copilot June 11, 2026 01:28

Copilot started reviewing on behalf of leoparente June 11, 2026 01:28 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

Comment thread device-discovery/custom_napalm/iosxr_netconf.py Outdated

fix(device-discovery): use the safe xml parser for all netconf parses…

7938cef

… in iosxr_netconf Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

jajeffries approved these changes Jun 11, 2026

View reviewed changes

leoparente requested a review from Copilot June 11, 2026 12:16

Copilot started reviewing on behalf of leoparente June 11, 2026 12:16 View session

Copilot AI reviewed Jun 11, 2026

View reviewed changes

leoparente merged commit 4bb3b55 into develop Jun 11, 2026
10 checks passed

leoparente deleted the feat/device-discovery-vrf-drivers-batch1 branch June 11, 2026 12:23

Conversation

leoparente commented Jun 10, 2026

Summary

Per driver

Tests

Review trail

Uh oh!

chatgpt-codex-connector Bot commented Jun 10, 2026

Uh oh!

github-actions Bot commented Jun 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

leoparente commented Jun 10, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

leoparente commented Jun 11, 2026

Uh oh!

chatgpt-codex-connector Bot commented Jun 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions Bot commented Jun 10, 2026 •

edited

Loading