Feat(eos_validate_state): ANTA New action plugin to generate the reports

[carl-baillargeon]

Change Summary

New action plugin to generate the reports from the ANTA test results.

Related Issue(s)

#3304

Component(s) name

arista.avd.eos_validate_state ANTA Mode

Proposed changes

eos_validate_state_reports.py is the action plugin.

The current eos_validate_state_runner will now save the results into a JSON file per host in the test_results_dir directory. The report plugin will load all results from all play hosts, process them and gather statistics.

ResultsManager class is responsible of storing the results and statistics and will be consumed by CSVReport and MDReport classes to generate the CSV and MD reports.

only_failed_tests can still be used to only write the failed tests in the reports.

validation_report_csv and validation_report_md can be set to false to avoid report generation and only run the tests.

How to test

---
- name: Validate AVD
  hosts: GLOBAL
  tasks:
    - name: Validate states on EOS devices
      import_role:
        name: arista.avd.eos_validate_state
      vars:
        # Some of these are defaults but can be changed
        validation_role:
          only_failed_tests: False
          validation_report_csv: True
          validation_report_md: True
        # To enable ANTA
        use_anta: True
        save_catalog: True
        logging_level: WARNING

Checklist

User Checklist

• Module documentation and general documentation
• Add a debug option to save the raw ANTA results
• Add an option to have a report per device? No

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)

[github-actions]

Conflicts have been resolved. A maintainer will review the pull request shortly.

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[github-actions]

Conflicts have been resolved. A maintainer will review the pull request shortly.

[gmuloc]

To summarize most of @JulioPDX's comments in the PR - the auto generated doc for module where we are using ansible-doc-extractor would need some love for lists and some escaping being done (e.g. ;). which renders weirdly in mkdocs

[gmuloc]

LGTM

[carlbuchmann]

LGTM - validated in lab