Adding upstream version 0.14.0.
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
parent
ecf5ca3300
commit
6721599912
GPG key ID:
FBB4F0E80A80222F
211 changed files with 12174 additions and 6401 deletions
162
anta/runner.py
162
anta/runner.py
|
|
@ -2,80 +2,156 @@
|
|||
# Use of this source code is governed by the Apache License 2.0
|
||||
# that can be found in the LICENSE file.
|
||||
# pylint: disable=too-many-branches
|
||||
"""
|
||||
ANTA runner function
|
||||
"""
|
||||
"""ANTA runner function."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
import logging
|
||||
from typing import Tuple
|
||||
import os
|
||||
import resource
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
from anta import GITHUB_SUGGESTION
|
||||
from anta.catalog import AntaCatalog, AntaTestDefinition
|
||||
from anta.device import AntaDevice
|
||||
from anta.inventory import AntaInventory
|
||||
from anta.logger import anta_log_exception
|
||||
from anta.logger import anta_log_exception, exc_to_str
|
||||
from anta.models import AntaTest
|
||||
from anta.result_manager import ResultManager
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from anta.inventory import AntaInventory
|
||||
from anta.result_manager import ResultManager
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
AntaTestRunner = Tuple[AntaTestDefinition, AntaDevice]
|
||||
AntaTestRunner = tuple[AntaTestDefinition, AntaDevice]
|
||||
|
||||
# Environment variable to set ANTA's maximum number of open file descriptors.
|
||||
# Maximum number of file descriptor the ANTA process will be able to open.
|
||||
# This limit is independent from the system's hard limit, the lower will be used.
|
||||
DEFAULT_NOFILE = 16384
|
||||
try:
|
||||
__NOFILE__ = int(os.environ.get("ANTA_NOFILE", DEFAULT_NOFILE))
|
||||
except ValueError as exception:
|
||||
logger.warning("The ANTA_NOFILE environment variable value is invalid: %s\nDefault to %s.", exc_to_str(exception), DEFAULT_NOFILE)
|
||||
__NOFILE__ = DEFAULT_NOFILE
|
||||
|
||||
|
||||
async def main(manager: ResultManager, inventory: AntaInventory, catalog: AntaCatalog, tags: list[str] | None = None, established_only: bool = True) -> None:
|
||||
"""
|
||||
Main coroutine to run ANTA.
|
||||
Use this as an entrypoint to the test framwork in your script.
|
||||
def log_cache_statistics(devices: list[AntaDevice]) -> None:
|
||||
"""Log cache statistics for each device in the inventory.
|
||||
|
||||
Args:
|
||||
----
|
||||
devices: List of devices in the inventory.
|
||||
"""
|
||||
for device in devices:
|
||||
if device.cache_statistics is not None:
|
||||
msg = (
|
||||
f"Cache statistics for '{device.name}': "
|
||||
f"{device.cache_statistics['cache_hits']} hits / {device.cache_statistics['total_commands_sent']} "
|
||||
f"command(s) ({device.cache_statistics['cache_hit_ratio']})"
|
||||
)
|
||||
logger.info(msg)
|
||||
else:
|
||||
logger.info("Caching is not enabled on %s", device.name)
|
||||
|
||||
|
||||
async def main( # noqa: PLR0912 PLR0913 too-many-branches too-many-arguments - keep the main method readable
|
||||
manager: ResultManager,
|
||||
inventory: AntaInventory,
|
||||
catalog: AntaCatalog,
|
||||
devices: set[str] | None = None,
|
||||
tests: set[str] | None = None,
|
||||
tags: set[str] | None = None,
|
||||
*,
|
||||
established_only: bool = True,
|
||||
) -> None:
|
||||
# pylint: disable=too-many-arguments
|
||||
"""Run ANTA.
|
||||
|
||||
Use this as an entrypoint to the test framework in your script.
|
||||
ResultManager object gets updated with the test results.
|
||||
|
||||
Args:
|
||||
----
|
||||
manager: ResultManager object to populate with the test results.
|
||||
inventory: AntaInventory object that includes the device(s).
|
||||
catalog: AntaCatalog object that includes the list of tests.
|
||||
tags: List of tags to filter devices from the inventory. Defaults to None.
|
||||
established_only: Include only established device(s). Defaults to True.
|
||||
|
||||
Returns:
|
||||
any: ResultManager object gets updated with the test results.
|
||||
devices: devices on which to run tests. None means all devices.
|
||||
tests: tests to run against devices. None means all tests.
|
||||
tags: Tags to filter devices from the inventory.
|
||||
established_only: Include only established device(s).
|
||||
"""
|
||||
limits = resource.getrlimit(resource.RLIMIT_NOFILE)
|
||||
logger.debug("Initial limit numbers for open file descriptors for the current ANTA process: Soft Limit: %s | Hard Limit: %s", limits[0], limits[1])
|
||||
nofile = __NOFILE__ if limits[1] > __NOFILE__ else limits[1]
|
||||
logger.debug("Setting soft limit for open file descriptors for the current ANTA process to %s", nofile)
|
||||
resource.setrlimit(resource.RLIMIT_NOFILE, (nofile, limits[1]))
|
||||
limits = resource.getrlimit(resource.RLIMIT_NOFILE)
|
||||
|
||||
if not catalog.tests:
|
||||
logger.info("The list of tests is empty, exiting")
|
||||
return
|
||||
if len(inventory) == 0:
|
||||
logger.info("The inventory is empty, exiting")
|
||||
return
|
||||
await inventory.connect_inventory()
|
||||
devices: list[AntaDevice] = list(inventory.get_inventory(established_only=established_only, tags=tags).values())
|
||||
|
||||
if not devices:
|
||||
logger.info(
|
||||
f"No device in the established state '{established_only}' "
|
||||
f"{f'matching the tags {tags} ' if tags else ''}was found. There is no device to run tests against, exiting"
|
||||
)
|
||||
# Filter the inventory based on tags and devices parameters
|
||||
selected_inventory = inventory.get_inventory(
|
||||
tags=tags,
|
||||
devices=devices,
|
||||
)
|
||||
await selected_inventory.connect_inventory()
|
||||
|
||||
# Remove devices that are unreachable
|
||||
inventory = selected_inventory.get_inventory(established_only=established_only)
|
||||
|
||||
if not inventory.devices:
|
||||
msg = f'No reachable device {f"matching the tags {tags} " if tags else ""}was found.{f" Selected devices: {devices} " if devices is not None else ""}'
|
||||
logger.warning(msg)
|
||||
return
|
||||
coros = []
|
||||
|
||||
# Select the tests from the catalog
|
||||
if tests:
|
||||
catalog = AntaCatalog(catalog.get_tests_by_names(tests))
|
||||
|
||||
# Using a set to avoid inserting duplicate tests
|
||||
tests_set: set[AntaTestRunner] = set()
|
||||
for device in devices:
|
||||
selected_tests: set[AntaTestRunner] = set()
|
||||
|
||||
# Create AntaTestRunner tuples from the tags
|
||||
for device in inventory.devices:
|
||||
if tags:
|
||||
# If there are CLI tags, only execute tests with matching tags
|
||||
tests_set.update((test, device) for test in catalog.get_tests_by_tags(tags))
|
||||
selected_tests.update((test, device) for test in catalog.get_tests_by_tags(tags))
|
||||
else:
|
||||
# If there is no CLI tags, execute all tests without filters
|
||||
tests_set.update((t, device) for t in catalog.tests if t.inputs.filters is None or t.inputs.filters.tags is None)
|
||||
# If there is no CLI tags, execute all tests that do not have any filters
|
||||
selected_tests.update((t, device) for t in catalog.tests if t.inputs.filters is None or t.inputs.filters.tags is None)
|
||||
|
||||
# Then add the tests with matching tags from device tags
|
||||
tests_set.update((t, device) for t in catalog.get_tests_by_tags(device.tags))
|
||||
selected_tests.update((t, device) for t in catalog.get_tests_by_tags(device.tags))
|
||||
|
||||
tests: list[AntaTestRunner] = list(tests_set)
|
||||
|
||||
if not tests:
|
||||
logger.info(f"There is no tests{f' matching the tags {tags} ' if tags else ' '}to run on current inventory. " "Exiting...")
|
||||
if not selected_tests:
|
||||
msg = f"There is no tests{f' matching the tags {tags} ' if tags else ' '}to run in the current test catalog and device inventory, please verify your inputs."
|
||||
logger.warning(msg)
|
||||
return
|
||||
|
||||
for test_definition, device in tests:
|
||||
run_info = (
|
||||
"--- ANTA NRFU Run Information ---\n"
|
||||
f"Number of devices: {len(selected_inventory)} ({len(inventory)} established)\n"
|
||||
f"Total number of selected tests: {len(selected_tests)}\n"
|
||||
f"Maximum number of open file descriptors for the current ANTA process: {limits[0]}\n"
|
||||
"---------------------------------"
|
||||
)
|
||||
logger.info(run_info)
|
||||
if len(selected_tests) > limits[0]:
|
||||
logger.warning(
|
||||
"The number of concurrent tests is higher than the open file descriptors limit for this ANTA process.\n"
|
||||
"Errors may occur while running the tests.\n"
|
||||
"Please consult the ANTA FAQ."
|
||||
)
|
||||
|
||||
for test_definition, device in selected_tests:
|
||||
try:
|
||||
test_instance = test_definition.test(device=device, inputs=test_definition.inputs)
|
||||
|
||||
|
|
@ -88,22 +164,16 @@ async def main(manager: ResultManager, inventory: AntaInventory, catalog: AntaCa
|
|||
[
|
||||
f"There is an error when creating test {test_definition.test.__module__}.{test_definition.test.__name__}.",
|
||||
f"If this is not a custom test implementation: {GITHUB_SUGGESTION}",
|
||||
]
|
||||
],
|
||||
)
|
||||
anta_log_exception(e, message, logger)
|
||||
|
||||
if AntaTest.progress is not None:
|
||||
AntaTest.nrfu_task = AntaTest.progress.add_task("Running NRFU Tests...", total=len(coros))
|
||||
|
||||
logger.info("Running ANTA tests...")
|
||||
test_results = await asyncio.gather(*coros)
|
||||
for r in test_results:
|
||||
manager.add_test_result(r)
|
||||
for device in devices:
|
||||
if device.cache_statistics is not None:
|
||||
logger.info(
|
||||
f"Cache statistics for '{device.name}': "
|
||||
f"{device.cache_statistics['cache_hits']} hits / {device.cache_statistics['total_commands_sent']} "
|
||||
f"command(s) ({device.cache_statistics['cache_hit_ratio']})"
|
||||
)
|
||||
else:
|
||||
logger.info(f"Caching is not enabled on {device.name}")
|
||||
manager.add(r)
|
||||
|
||||
log_cache_statistics(inventory.devices)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue