Feat(eos_validate_state): ANTA Provide custom ANTA catalog files to validate state #3655
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
role: eos_validate_state
state: CI Updated
github-actions
bot
added
type: documentation
MaheshGSLAB
reviewed
Feb 26, 2024
ansible_collections/arista/avd/plugins/action/eos_validate_state_runner.py
Show resolved
Hide resolved
...ble_collections/arista/avd/plugins/plugin_utils/eos_validate_state_utils/get_anta_results.py
Outdated
Show resolved
Hide resolved
github-actions
bot
added
the
role: build_output_folders
MaheshGSLAB
approved these changes
Feb 28, 2024
gmuloc
reviewed
Feb 28, 2024
ansible_collections/arista/avd/roles/eos_validate_state/python_modules/tests/avdtestmlag.py
Show resolved
Hide resolved
ansible_collections/arista/avd/roles/eos_validate_state/ANTA-Preview.md
Outdated
Show resolved
Hide resolved
| @@ -168,7 +193,7 @@ def get_skipped_tests_from_tags(run_tags: tuple, skip_tags: tuple) -> list[dict] | |||
| return result | |||
|
|
|||
|
|
|||
| def generate_tests(device_name: str, hostvars: Mapping, skipped_tests: list[dict]) -> RawCatalogInput: | |||
| def generate_tests(device_name: str, hostvars: Mapping, skipped_tests: list[dict], custom_catalog: dict | None = None) -> RawCatalogInput: | |||
| """Create the test catalog in a dictionnary format generated from the AVD test classes. | |||
|
|
|||
| Test definitions are generated from the AVD structured_config for each AVD test classes and are merged together to create the final catalog. | |||
There was a problem hiding this comment.
Add here something about custom_catalog
Suggested change
| Test definitions are generated from the AVD structured_config for each AVD test classes and are merged together to create the final catalog. | |
| Test definitions are generated from the AVD structured_config for each AVD test classes and are merged together with an optional custom_catalog to create the final catalog. |
There was a problem hiding this comment.
Fixed in c490e18.
...ble_collections/arista/avd/plugins/plugin_utils/eos_validate_state_utils/get_anta_results.py
Show resolved
Hide resolved
Comment on lines
144
to
146
| with file.open("r", encoding="UTF-8") as fd: | ||
| catalog = load(fd, Loader=CSafeLoader) | ||
| catalog_list.append(catalog) |
There was a problem hiding this comment.
exception handling - what if the file opening is causing issue. e.g. permission denied or malformated yaml?
There was a problem hiding this comment.
We catch all exceptions in the runner. The task will fail for the device that is trying to open the catalog only:
There was a problem hiding this comment.
Fixed in 1461c6d
gmuloc
added
the
one approval
gmuloc
approved these changes
Feb 28, 2024
sugetha24
pushed a commit
to sugetha24/ansible-avd
that referenced
this pull request
Feb 28, 2024
…alidate state (aristanetworks#3655) Co-authored-by: Guillaume Mulocher <gmulocher@arista.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Feature to provide custom ANTA catalog files to validate state.
Related Issue(s)
Fixes #3384
Component(s) name
arista.avd.eos_validate_stateANTA ModeProposed changes
custom_anta_catalogs_diradded<hostname>.ymlor<hostname>.yamlfiles representing a custom ANTA catalog and will merge that catalog on top of the auto-generated AVD tests.<group>.ymlor<group>.yamlcan also be provided,groupbeing an Ansible inventory group. The custom catalog will be merged on top of the auto-generated AVD tests for all devices part of that group.How to test
intended/custom_anta_catalogsfolder:. ├── intended │ ├── custom_anta_catalogs │ │ ├── DC1_L3_LEAVES.yml │ │ └── DC1-LEAF1A.ymlIn this example, the
DC1_L3_LEAVES.ymlcatalog will be applied to all devices under that group andDC1-LEAF1A.ymlcatalog will be applied to this host only. You can also useall.ymlto target all devices in your Ansible inventory.Follow the ANTA documentation to provide custom tests. Here are some examples: https://github.com/arista-netdevops-community/anta/blob/main/examples/tests.yaml
You can then run validate state in ANTA mode -->
ansible-playbook playbooks/fabric-validate.yaml -e use_anta=trueChecklist
User Checklist
Repository Checklist