zebra: support brief json for show ip route command

[hnattamaisub]

Added brief option for 'show ip route' command.

The new cli will look like below:
r1# show ip route brief json
{"10.0.0.1/32":[{"protocol":"static","selected":true,"destSelected":true,"distance":1,"metric":0,"installed":true,"nexthopGroupId":6,"vrfId":0,"vrfName":"default","uptime":"00:00:17"}]
,"10.0.0.2/32":[{"protocol":"static","selected":true,"destSelected":true,"distance":1,"metric":0,"installed":true,"nexthopGroupId":5,"vrfId":0,"vrfName":"default","uptime":"00:00:17"}]
,"10.0.0.3/32":[{"protocol":"static","selected":true,"destSelected":true,"distance":1,"metric":0,"installed":true,"nexthopGroupId":6,"vrfId":0,"vrfName":"default","uptime":"00:00:17"}]
,"192.168.1.0/24":[{"protocol":"connected","selected":true,"destSelected":true,"distance":0,"metric":0,"installed":true,"nexthopGroupId":4,"vrfId":0,"vrfName":"default","uptime":"00:00:17"}]
,"192.168.1.1/32":[{"protocol":"local","selected":true,"destSelected":true,"distance":0,"metric":0,"installed":true,"nexthopGroupId":4,"vrfId":0,"vrfName":"default","uptime":"00:00:17"}]
}
r1# show ipv6 route brief json
{"fe80::/64":[{"protocol":"connected","selected":true,"destSelected":true,"distance":0,"metric":0,"installed":true,"nexthopGroupId":8,"vrfId":0,"vrfName":"default","uptime":"00:05:47"}]
}
r1#

[greptile-apps]

Greptile Summary

This PR adds a brief option to show ip route and show ip route vrf all commands, producing a compact JSON output with only essential fields per route (protocol, selected, destSelected, distance, metric, installed, nexthopGroupId, vrfId, vrfName, uptime, and a few conditional flags) instead of the full nexthop details.

Key changes:

• zebra/zebra_vty.c: Adds a bool brief member to struct route_show_ctx. The DEFPY command is extended with [<brief$brief>] for both IPv4 and IPv6 paths. Inside vty_show_ip_route, the JSON output block is restructured — brief fields are emitted unconditionally, with prefix, prefixLen, nexthop arrays, and NHG detail gated behind if (!brief). The brief flag propagates correctly via ctx.brief = !!brief at line 1779 and ctx->brief is used at line 933.
• Tests: Two new tests added to test_static_route_blackhole.py: test_show_ip_route_brief_json verifies required fields are present for each expected prefix, and test_show_ip_route_brief_json_vrf_consistency validates that vrf default, plain (no vrf), and vrf all brief outputs produce consistent prefix sets.
• Docs: doc/user/zebra.rst documents the new option and the VRF-all structure ({"vrf-name": {"prefix": [...]}}) in the brief view.

Previously flagged issues (early return bypassing json_object_array_add, brief hardcoded to false in vrf-all calls, duplicate nexthopGroupId emission) are all resolved in the current code — the ctx struct correctly carries brief through all VRF/table iterations.

Confidence Score: 5/5

Safe to merge — all previously flagged critical issues are resolved and no new bugs found.

All P0/P1 issues raised in prior review rounds (early JSON return bypassing array_add, brief hardcoded false in vrf-all paths, duplicate nexthopGroupId) are fixed in the current commit. The brief flag propagates correctly through the route_show_ctx struct into every VRF/table iteration. The new tests cover the basic field-presence check and VRF consistency. No remaining findings exceed P2.

No files require special attention.

Vulnerabilities

No security concerns identified. The brief flag only affects JSON field filtering in show command output and introduces no new input paths, authentication changes, or data-modification logic.

Important Files Changed

Filename	Overview
zebra/zebra_vty.c	Core implementation of brief JSON output; brief flag correctly propagated via route_show_ctx.brief through all VRF/table iterations; JSON block properly restructured with shared brief/full fields followed by if (!brief) guarded detail section.
tests/topotests/static_route_blackhole/test_static_route_blackhole.py	Two new tests cover brief JSON output and VRF consistency; test routes (blackhole, reject, Null0) will have selected/destSelected/installed flags set so conditional-field assertions are valid for this config.
doc/user/zebra.rst	Documents new brief option, brief JSON field list, and VRF-all structure; accurately describes behavior including VRF-all nesting.
tests/topotests/static_route_blackhole/r1/frr.conf	No changes to route config; existing blackhole/reject/Null0 routes plus interface-derived connected/local routes supply all prefixes tested by the new brief JSON tests.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["show ip route [vrf NAME|all] [brief] json"] --> B["DEFPY show_route handler\nctx.brief = !!brief"]
    B --> C{vrf_all?}
    C -- yes --> D["RB_FOREACH vrfs\nvty_json_key(vrf_name)"]
    D --> E["do_show_ip_route(ctx)"]
    C -- no --> E
    E --> F["do_show_route_helper(ctx)"]
    F --> G["vty_show_ip_route(ctx->brief)"]
    G --> H{json?}
    H -- no --> I["Text output\n(brief ignored)"]
    H -- yes --> J["Emit shared brief fields\nprotocol, selected, distance,\nmetric, installed, nexthopGroupId,\nvrfId, vrfName, uptime"]
    J --> K{brief?}
    K -- yes --> L["json_object_array_add\nReturn brief JSON"]
    K -- no --> M["Emit full fields\nprefix, prefixLen, instance,\ntag, nexthops, backupNexthops,\nNHG detail/summary"]
    M --> L

Loading

_{Reviews (4): Last reviewed commit: "doc: add documentation for 'show ip/ipv6..." | Re-trigger Greptile}

[greptile-apps]

_{4 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}

[mjstapp]

@greptileio rereview

[mjstapp]

@greptileai review this draft

[hnattamaisub]

ci:rerun

[hnattamaisub]

ci:rerun

[mjstapp]

this is zebra, not bgpd, right?

[hnattamaisub]

this is zebra, not bgpd, right?

yes, changed now, thanks

[hnattamaisub]

ci:rerun

[hnattamaisub]

ci:rerun

[riw777]

looks good

[hnattamaisub]

@riw777 can we please merge this , if there is no concern?

[mjstapp]

@greptileai review

[mjstapp]

let's get another pass

[riw777]

looks good, waiting for @mjstapp to clear his comments

[mjstapp]

I'm ok with this now