Fix ISIS authentication configuration for Cisco FNTs - #6032
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates IS-IS authentication logic across several test suites to accommodate platform-specific differences on Cisco devices. By leveraging an existing deviation, the changes ensure that authentication is correctly applied to the interface-level container for Cisco platforms while maintaining standard behavior for others. Additionally, the PR enhances test reliability by introducing robust error checking and synchronization waits for device and link states. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new deviation set_isis_auth_with_interface_authentication_container across multiple IS-IS and MPLS tests to conditionally configure IS-IS authentication at the interface level instead of the hello level. It also improves test robustness by checking the return value of PushAndStart and waiting for interface and link operational status. The reviewer feedback highlights several violations of the repository style guide, specifically recommending the removal of static time.Sleep calls and ensuring that neighbor resolution (WaitForARP) is performed before proceeding with the tests.
| if err := ts.PushAndStart(t); err != nil { | ||
| t.Fatalf("PushAndStart failed: %v", err) | ||
| } | ||
|
|
||
| // Do not consume the IS-IS adjacency timeout while either end of the link | ||
| // is still becoming operational after the OTG configuration push. | ||
| gnmi.Await(t, ts.DUT, gnmi.OC().Interface(ts.DUTPort1.Name()).OperStatus().State(), 2*time.Minute, oc.Interface_OperStatus_UP) | ||
| gnmi.Await(t, otg, gnmi.OTG().Port(ts.ATEPort1.ID()).Link().State(), 2*time.Minute, otgtelemetry.Port_Link_UP) |
There was a problem hiding this comment.
According to the Repository Style Guide, tests that configure and start OTG protocols and traffic must ensure neighbor resolution (ARP for IPv4) has completed before starting traffic. Avoid waiting for IPv6 neighbor resolution (ND) if there are no native IPv6 flows destined for a configured VLAN or interface, as the ATE will not initiate Neighbor Discovery, causing the test to fail on platforms that do not send proactive Router Advertisements (RAs).
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| // Do not consume the IS-IS adjacency timeout while either end of the link | |
| // is still becoming operational after the OTG configuration push. | |
| gnmi.Await(t, ts.DUT, gnmi.OC().Interface(ts.DUTPort1.Name()).OperStatus().State(), 2*time.Minute, oc.Interface_OperStatus_UP) | |
| gnmi.Await(t, otg, gnmi.OTG().Port(ts.ATEPort1.ID()).Link().State(), 2*time.Minute, otgtelemetry.Port_Link_UP) | |
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| // Do not consume the IS-IS adjacency timeout while either end of the link | |
| // is still becoming operational after the OTG configuration push. | |
| gnmi.Await(t, ts.DUT, gnmi.OC().Interface(ts.DUTPort1.Name()).OperStatus().State(), 2*time.Minute, oc.Interface_OperStatus_UP) | |
| gnmi.Await(t, otg, gnmi.OTG().Port(ts.ATEPort1.ID()).Link().State(), 2*time.Minute, otgtelemetry.Port_Link_UP) | |
| otgutils.WaitForARP(t, otg, ts.ATETop, "IPv4") |
References
- Avoid waiting for IPv6 neighbor resolution (ND) in OTG tests if there are no native IPv6 flows destined for a configured VLAN or interface. (link)
| if err := ts.PushAndStart(t); err != nil { | ||
| t.Fatalf("PushAndStart failed: %v", err) | ||
| } | ||
| time.Sleep(time.Minute * 2) |
There was a problem hiding this comment.
According to the Repository Style Guide, static time.Sleep calls after pushing configurations or starting protocols are an anti-pattern and must be avoided. Instead, use otgutils.WaitForARP to dynamically wait for IPv4 neighbor resolution before proceeding. Avoid waiting for IPv6 neighbor resolution (ND) if there are no native IPv6 flows destined for a configured VLAN or interface.
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| time.Sleep(time.Minute * 2) | |
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| otgutils.WaitForARP(t, otg, ts.ATETop, "IPv4") |
References
- Avoid using static sleeps after pushing configurations or starting protocols in OTG tests. Instead, rely on dynamic waiting mechanisms like WaitForARP. (link)
- Avoid waiting for IPv6 neighbor resolution (ND) in OTG tests if there are no native IPv6 flows destined for a configured VLAN or interface. (link)
| if err := ts.PushAndStart(t); err != nil { | ||
| t.Fatalf("PushAndStart failed: %v", err) | ||
| } | ||
| time.Sleep(time.Minute * 2) |
There was a problem hiding this comment.
According to the Repository Style Guide, static time.Sleep calls after pushing configurations or starting protocols are an anti-pattern and must be avoided. Instead, use otgutils.WaitForARP to dynamically wait for IPv4 neighbor resolution before proceeding. Avoid waiting for IPv6 neighbor resolution (ND) if there are no native IPv6 flows destined for a configured VLAN or interface.
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| time.Sleep(time.Minute * 2) | |
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| otgutils.WaitForARP(t, otg, ts.ATETop, "IPv4") |
References
- Avoid using static sleeps after pushing configurations or starting protocols in OTG tests. Instead, rely on dynamic waiting mechanisms like WaitForARP. (link)
- Avoid waiting for IPv6 neighbor resolution (ND) in OTG tests if there are no native IPv6 flows destined for a configured VLAN or interface. (link)
| if err := ts.PushAndStart(t); err != nil { | ||
| t.Fatalf("PushAndStart failed: %v", err) | ||
| } | ||
| time.Sleep(time.Minute * 2) |
There was a problem hiding this comment.
According to the Repository Style Guide, static time.Sleep calls after pushing configurations or starting protocols are an anti-pattern and must be avoided. Instead, use otgutils.WaitForARP to dynamically wait for IPv4 neighbor resolution before proceeding. Avoid waiting for IPv6 neighbor resolution (ND) if there are no native IPv6 flows destined for a configured VLAN or interface.
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| time.Sleep(time.Minute * 2) | |
| if err := ts.PushAndStart(t); err != nil { | |
| t.Fatalf("PushAndStart failed: %v", err) | |
| } | |
| otgutils.WaitForARP(t, otg, ts.ATETop, "IPv4") |
References
- Avoid using static sleeps after pushing configurations or starting protocols in OTG tests. Instead, rely on dynamic waiting mechanisms like WaitForARP. (link)
- Avoid waiting for IPv6 neighbor resolution (ND) in OTG tests if there are no native IPv6 flows destined for a configured VLAN or interface. (link)
2 participants
Summary
This commit updates five FNT/configuration paths to support Cisco IS-IS P2P authentication using the existing
set_isis_auth_with_interface_authentication_containerdeviation.No new deviation was created. The existing deviation helper and metadata field are reused.
The changes cover:
For Cisco platforms, authentication is configured under the ISIS interface-level
authenticationcontainer. Other platforms continue using the existing level-specifichello-authenticationcontainer.Reliability changes
PushAndStart.