Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix(eos_validate_state): ANTA Fix the report to have consistent test descriptions, categories and input details #3743

Merged
merged 5 commits into from
Mar 26, 2024

Conversation

carl-baillargeon
Copy link
Contributor

@carl-baillargeon carl-baillargeon commented Mar 15, 2024

Change Summary

Update the report of validate state to have consistent test descriptions, categories and input. See below for an example.

This new structure will be a lot easier to work with when we will add more tests in the future. It is also consistent if a user provides a custom catalog. The same category will be reported instead of having AVD categories mixed with ANTA categories like Routing and Routing Table.

Related Issue(s)

Fixes #3712 #3713 #3714

Component(s) name

arista.avd.eos_validate_state ANTA

Proposed changes

We now have the following columns:

  • ID --> Test ID
  • DUT --> Device Under Test
  • Categories --> Test categories reported from the test engine (ANTA)
  • Test --> ANTA test name
  • Description --> Description of the test reported from ANTA
  • Inputs --> Inputs and context that AVD generated for the test
  • Result --> PASS, FAIL, etc.
  • Messages --> Messages in the result from ANTA. Usually the reason why the test failed.

Update to the report:
image

How to test

ansible-playbook playbooks/fabric-validate.yml -e use_anta=true

Check the report to make sure there are no typos, confusion or missing stuff.

Checklist

User Checklist

  • N/A

Repository Checklist

  • My code has been rebased from devel before I start
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation and documentation have been updated accordingly.
  • I have updated molecule CI testing accordingly. (check the box if not applicable)

@carl-baillargeon carl-baillargeon requested review from a team as code owners March 15, 2024 02:22
@github-actions github-actions bot added role: eos_validate_state state: CI Updated CI scenario have been updated in the PR labels Mar 15, 2024
@carl-baillargeon carl-baillargeon changed the title Fix(eos_validate_state): ANTA Fix the report to have proper test descriptions and input details Fix(eos_validate_state): ANTA Fix the report to have consistent test descriptions, categories and input details Mar 15, 2024
@carlbuchmann carlbuchmann added this to the v4.7.0 milestone Mar 24, 2024
Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gmuloc gmuloc added the one approval This PR has one approval and is only missing one more. label Mar 26, 2024
@gmuloc gmuloc merged commit 9d2b38a into aristanetworks:devel Mar 26, 2024
38 checks passed
@carl-baillargeon carl-baillargeon deleted the fix/report branch May 18, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EPIC - eos_validate_state ANTA one approval This PR has one approval and is only missing one more. rn: Fix(eos_validate_state) role: eos_validate_state state: CI Updated CI scenario have been updated in the PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the BGP peer name in the Test column of the eos_validate_state report
5 participants