feat(anta): Add tag mapping between devices and tests

[titom73]

Overview

The --tags option can be used to target specific devices in your inventory and run only tests configured with this specific tags from your catalog. Expected behaviour is provided below:

Command	Description
none	Run all tests on all devices according tag definition in your inventory and tests catalog. And tests with no tag are executed on all devices
--tags leaf	Run all tests marked with leaf tag on all devices configured with leaf tag. All other tags are ignored
--tags leaf,spine	Run all tests marked with leaf tag on all devices configured with leaf tag. Run all tests marked with spine tag on all devices configured with spine tag. All other tags are ignored

warning
This PR is not implementing device filtering

Usage example

Inventory & Tests

Inventory

---
anta_inventory:
  hosts:
  - host: 192.168.0.10
    name: spine01
    tags: ['fabric', 'spine']
  - host: 192.168.0.11
    name: spine02
    tags: ['fabric', 'spine']
  - host: 192.168.0.12
    name: leaf01
    tags: ['fabric', 'leaf']
  - host: 192.168.0.13
    name: leaf02
    tags: ['fabric', 'leaf']
  - host: 192.168.0.14
    name: leaf03
    tags: ['fabric', 'leaf']
  - host: 192.168.0.15
    name: leaf04
    tags: ['fabric', 'leaf']

Tests

anta.tests.system:
  - VerifyUptime:
      minimum: 10
      filters:
        tags: ['fabric']
  - VerifyReloadCause:
      filters:
        tags: ['leaf', spine']
  - VerifyCoredump:
  - VerifyAgentLogs:
  - VerifyCPUUtilization:
      filters:
        tags: ['leaf']
  - VerifyMemoryUtilization:
  - VerifyFileSystemUtilization:
  - VerifyNTP:

anta.tests.mlag:
  - VerifyMlagStatus:

anta.tests.interfaces:
  - VerifyL3MTU:
      mtu: 1500
      filters:
        tags: ['demo']

CLI output

[gmuloc]

I think we probably need to add in the doc some example of "using tags" and saying what test will be executed or not

[mtache]

What do you think about having the logic below?
Init:

• Assuming tag: leaf is applied to some devices and tests.
• All tests are marked with tag all by default
• All devices are not marked with any tag by default

Logic:

• Tests with tag all are run on every devices
• A test with tag all cannot have any other tag (all includes all the tags)
• All the tests marked with tag: leaf are executed on all devices marked with tag: leaf
• All tests that do not have any tags are skipped
• All tests marked with a tag that do not match any device are skipped

[titom73]

I think we probably need to add in the doc some example of "using tags" and saying what test will be executed or not

I have added a dedicated page for tags and behaviours

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

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

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

[mtache]

Ship it 🐜