Test Catalog
AntaCatalog ¶
AntaCatalog(tests: list[AntaTestDefinition] | None = None, filename: str | Path | None = None)
Class representing an ANTA Catalog.
It can be instantiated using its constructor or one of the static methods: parse()
, from_list()
or from_dict()
Args:
tests: A list of AntaTestDefinition instances.
filename: The path from which the catalog is loaded.
Source code in anta/catalog.py
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
|
filename
property
¶
filename: Path | None
Path of the file used to create this AntaCatalog instance.
tests
property
writable
¶
tests: list[AntaTestDefinition]
List of AntaTestDefinition in this catalog.
build_indexes ¶
build_indexes(filtered_tests: set[str] | None = None) -> None
Indexes tests by their tags for quick access during filtering operations.
If a filtered_tests
set is provided, only the tests in this set will be indexed.
This method populates two attributes: - tag_to_tests: A dictionary mapping each tag to a set of tests that contain it. - tests_without_tags: A set of tests that do not have any tags.
Once the indexes are built, the indexes_built
attribute is set to True.
Source code in anta/catalog.py
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 |
|
dump ¶
dump() -> AntaCatalogFile
Return an AntaCatalogFile instance from this AntaCatalog instance.
Returns:
Type | Description |
---|---|
An AntaCatalogFile instance containing tests of this AntaCatalog instance.
|
|
Source code in anta/catalog.py
388 389 390 391 392 393 394 395 396 397 398 399 |
|
from_dict
staticmethod
¶
from_dict(data: RawCatalogInput, filename: str | Path | None = None) -> AntaCatalog
Create an AntaCatalog instance from a dictionary data structure.
See RawCatalogInput type alias for details.
It is the data structure returned by yaml.load()
function of a valid
YAML Test Catalog file.
Args:
data: Python dictionary used to instantiate the AntaCatalog instance
filename: value to be set as AntaCatalog instance attribute
Source code in anta/catalog.py
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
|
from_list
staticmethod
¶
from_list(data: ListAntaTestTuples) -> AntaCatalog
Create an AntaCatalog instance from a list data structure.
See ListAntaTestTuples type alias for details.
Args:
data: Python list used to instantiate the AntaCatalog instance
Source code in anta/catalog.py
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 |
|
get_tests_by_tags ¶
get_tests_by_tags(tags: set[str], *, strict: bool = False) -> set[AntaTestDefinition]
Return all tests that match a given set of tags, according to the specified strictness.
Args:
tags: The tags to filter tests by. If empty, return all tests without tags.
strict: If True, returns only tests that contain all specified tags (intersection).
If False, returns tests that contain any of the specified tags (union).
Returns:
Type | Description |
---|---|
set[AntaTestDefinition]: A set of tests that match the given tags.
|
|
Raises:
Type | Description |
---|---|
ValueError: If the indexes have not been built prior to method call.
|
|
Source code in anta/catalog.py
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 |
|
merge ¶
merge(catalog: AntaCatalog) -> AntaCatalog
Merge two AntaCatalog instances.
Args:
catalog: AntaCatalog instance to merge to this instance.
Returns:
Type | Description |
---|---|
A new AntaCatalog instance containing the tests of the two instances.
|
|
Source code in anta/catalog.py
375 376 377 378 379 380 381 382 383 384 385 386 |
|
parse
staticmethod
¶
parse(filename: str | Path) -> AntaCatalog
Create an AntaCatalog instance from a test catalog file.
Args:
filename: Path to test catalog YAML file
Source code in anta/catalog.py
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 |
|
AntaTestDefinition ¶
AntaTestDefinition(**data: type[AntaTest] | AntaTest.Input | dict[str, Any] | None)
Bases: BaseModel
Define a test with its associated inputs.
test: An AntaTest concrete subclass inputs: The associated AntaTest.Input subclass instance
Source code in anta/catalog.py
65 66 67 68 69 70 71 72 73 74 75 |
|
check_inputs ¶
check_inputs() -> AntaTestDefinition
Check the inputs
field typing.
The inputs
class attribute needs to be an instance of the AntaTest.Input subclass defined in the class test
.
Source code in anta/catalog.py
118 119 120 121 122 123 124 125 126 127 |
|
instantiate_inputs
classmethod
¶
instantiate_inputs(data: AntaTest.Input | dict[str, Any] | None, info: ValidationInfo) -> AntaTest.Input
Ensure the test inputs can be instantiated and thus are valid.
If the test has no inputs, allow the user to omit providing the inputs
field.
If the test has inputs, allow the user to provide a valid dictionary of the input fields.
This model validator will instantiate an Input class from the test
class field.
Source code in anta/catalog.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
|
serialize_model ¶
serialize_model() -> dict[str, AntaTest.Input]
Serialize the AntaTestDefinition model.
The dictionary representing the model will be look like:
<AntaTest subclass name>:
<AntaTest.Input compliant dictionary>
Returns:
Type | Description |
---|---|
A dictionary representing the model.
|
|
Source code in anta/catalog.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 |
|
AntaCatalogFile ¶
Bases: RootModel[dict[ImportString[Any], list[AntaTestDefinition]]]
Represents an ANTA Test Catalog File.
Example:
A valid test catalog file must have the following structure:
```
<Python module>:
- <AntaTest subclass>:
<AntaTest.Input compliant dictionary>
```
check_tests
classmethod
¶
check_tests(data: Any) -> Any
Allow the user to provide a Python data structure that only has string values.
This validator will try to flatten and import Python modules, check if the tests classes are actually defined in their respective Python module and instantiate Input instances with provided value to validate test inputs.
Source code in anta/catalog.py
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
|
flatten_modules
staticmethod
¶
flatten_modules(data: dict[str, Any], package: str | None = None) -> dict[ModuleType, list[Any]]
Allow the user to provide a data structure with nested Python modules.
Example:
```
anta.tests.routing:
generic:
- <AntaTestDefinition>
bgp:
- <AntaTestDefinition>
```
`anta.tests.routing.generic` and `anta.tests.routing.bgp` are importable Python modules.
Source code in anta/catalog.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
yaml ¶
yaml() -> str
Return a YAML representation string of this model.
Returns:
Type | Description |
---|---|
The YAML representation string of this model.
|
|
Source code in anta/catalog.py
230 231 232 233 234 235 236 237 238 239 240 241 |
|