Feat: New anta_workflow plugin using PyAVD

[carl-baillargeon]

Change Summary

• anta_workflow Ansible action plugin
• get_device_anta_catalog function in PyAVD to generate the ANTA catalogs
• get_fabric_data function in PyAVD to generate the fabric mappings used to generate the catalogs
• ANTA test index with their input factories in PyAVD

Requirements

NEEDS ANTA v1.3.0

On ANTA:

• feat(anta): Add Markdown report option to ANTA anta#740
• feat(anta): add test atomic results anta#937
• feat(anta.tests): Add VerifyBGPPeerSession + minor fixes on other BGP tests  anta#987
• fix(anta): Fix various issues in CSV and Markdown reporters anta#990

On AVD:

• Feat(eos_designs): Added rack, pod, dc, fabric information in the structured_config metadata #4827

Component(s) name

PyAVD

Proposed changes

Example playbook for anta_runner role:

---
- name: Validate AVD
  hosts: GLOBAL
  check_mode: yes
  tasks:
    - name: Run ANTA on EOS devices
      import_role:
        name: arista.avd.anta_runner

Example playbook for anta_workflow plugin:

---
- name: ANTA Workflow
  arista.avd.anta_workflow:
    device_list: "{{ ansible_play_hosts }}"
    anta_catalog:
      output_dir: "/my_avd_project/anta/catalogs"
      structured_config_dir: "/my_avd_project/intended/structured_configs"
      structured_config_suffix: ".yml"
      scope:
        boundary: "fabric"
        allow_bgp_external: true
        allow_bgp_vrfs: true
      filters:
        skip_tests:
          - VerifyNTP
    custom_catalog:
      input_dir: "/my_avd_project/anta/my_catalogs"
    anta_logging:
      log_dir: "/my_avd_project/anta/logs"
    report:
      fabric_data_output: "/my_avd_project/anta/reports/fabric_data.json"
      csv_output: "/my_avd_project/anta/reports/anta_results.csv"
      md_output: "/my_avd_project/anta/reports/anta_results.md"
      json_output: "/my_avd_project/anta/reports/anta_results.json"
      filters:
        hide_statuses:
          - success
  register: anta
  delegate_to: localhost
  run_once: true

To-do list

• Add reporting using anta.reporter.csv_reporter and anta.reporter.md_reporter. We should also be able to filter statuses (from plugin arguments) using ResultManager.filter()
• Input factory for VerifyAVTRole 4e20dbf
• Input factory for VerifyMlagStatus
• Input factory for VerifyRoutingProtocolModel 4e20dbf
• Input factory for VerifyAPIHttpsSSL
• Input factory for VerifySpecificIPSecConn 4e20dbf
• Input factory for VerifyStunClient 4e20dbf
• Input factory for VerifyNTP 4e20dbf
• Input factory for VerifyReloadCause 4e20dbf
• VerifyLLDP factory: Add support for validate_state: false configuration 4e20dbf
• VerifyReachability factory: Add WAN VTEPs support - DPS to DPS reachability 4e20dbf
• VerifyEnvironmentPower factory: accepted_pwr_supply_states is not yet implemented in the AVD structured config schema
• VerifyEnvrionmentCooling factory: accepted_fan_states is not yet implemented in the AVD structured config schema
• VerifyTransceiversManufacturers: accepted_xcvr_manufacturers is not yet implemented in the AVD structured config schema
• Update FabricData to add DPS mappings 4e20dbf
• Add the ability to skip specific inputs from a test for granular testing - Boundary
• Create the Ansible role (anta_runner) that will run the action plugin anta_workflows - Similar to cv_deploy & cv_workflows 18d98be
• Complete anta_workflow plugin documentation under plugins.modules
• Complete README.md for anta_runner role
• Add support for BGP VRFs (see Feat(eos_validate_state): Add validation for BGP IPv4 peers in VRFs #4538)
• Molecule tests - Need to add more runs when Feat(eos_designs): Added rack, pod, dc, fabric information in the structured_config metadata #4827 is merged
• Unit tests in PyAVD - Need to add FabricData boundary testing when Feat(eos_designs): Added rack, pod, dc, fabric information in the structured_config metadata #4827 is merged

Some tests don't require any inputs, in that case we just update PYAVD_TEST_INDEX

Phase 2: Add all ANTA tests 🥇

[github-actions]

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4196
# Activate the virtual environment
source test-avd-pr-4196/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/carl-baillargeon/avd.git@feat/move_anta_to_pyavd#subdirectory=python-avd" --force
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/carl-baillargeon/avd.git#/ansible_collections/arista/avd/,feat/move_anta_to_pyavd --force
# Optional: Install AVD examples
cd test-avd-pr-4196
ansible-playbook arista.avd.install_examples

[sonarqubecloud]

Quality Gate passed

Issues
7 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[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.