92 lines
5.1 KiB
Markdown
Executable file
92 lines
5.1 KiB
Markdown
Executable file
<!--
|
|
~ Copyright (c) 2023-2024 Arista Networks, Inc.
|
|
~ Use of this source code is governed by the Apache License 2.0
|
|
~ that can be found in the LICENSE file.
|
|
-->
|
|
|
|
# Arista Network Test Automation (ANTA) Framework
|
|
|
|
| **Code** | [](https://github.com/astral-sh/ruff) [](https://numpydoc.readthedocs.io/en/latest/format.html) [](https://sonarcloud.io/summary/new_code?id=aristanetworks_anta) [](https://sonarcloud.io/summary/overall?id=aristanetworks_anta) |
|
|
| :------------: | :-------|
|
|
| **License** | [](https://github.com/aristanetworks/anta/blob/main/LICENSE) |
|
|
| **GitHub** | [](https://github.com/aristanetworks/anta/actions/workflows/code-testing.yml)   [](https://github.com/aristanetworks/anta/releases/) [](https://github.com/aristanetworks/anta/graphs/contributors) |
|
|
| **PyPi** |     |
|
|
|
|
ANTA is Python framework that automates tests for Arista devices.
|
|
|
|
- ANTA provides a [set of tests](api/tests.md) to validate the state of your network
|
|
- ANTA can be used to:
|
|
- Automate NRFU (Network Ready For Use) test on a preproduction network
|
|
- Automate tests on a live network (periodically or on demand)
|
|
- ANTA can be used with:
|
|
- As a [Python library](advanced_usages/as-python-lib.md) in your own application
|
|
- The [ANTA CLI](cli/overview.md)
|
|
|
|
|
|
|
|
## Install ANTA library
|
|
|
|
The library will **NOT** install the necessary dependencies for the CLI.
|
|
|
|
```bash
|
|
# Install ANTA as a library
|
|
pip install anta
|
|
```
|
|
|
|
## Install ANTA CLI
|
|
|
|
If you plan to use ANTA only as a CLI tool you can use `pipx` to install it.
|
|
[`pipx`](https://pipx.pypa.io/stable/) is a tool to install and run python applications in isolated environments. Refer to `pipx` instructions to install on your system.
|
|
`pipx` installs ANTA in an isolated python environment and makes it available globally.
|
|
|
|
<!-- markdownlint-disable no-emphasis-as-heading -->
|
|
**This is not recommended if you plan to contribute to ANTA**
|
|
<!-- markdownlint-enable no-emphasis-as-heading -->
|
|
|
|
```bash
|
|
# Install ANTA CLI with pipx
|
|
$ pipx install anta[cli]
|
|
|
|
# Run ANTA CLI
|
|
$ anta --help
|
|
Usage: anta [OPTIONS] COMMAND [ARGS]...
|
|
|
|
Arista Network Test Automation (ANTA) CLI
|
|
|
|
Options:
|
|
--version Show the version and exit.
|
|
--log-file FILE Send the logs to a file. If logging level is
|
|
DEBUG, only INFO or higher will be sent to
|
|
stdout. [env var: ANTA_LOG_FILE]
|
|
-l, --log-level [CRITICAL|ERROR|WARNING|INFO|DEBUG]
|
|
ANTA logging level [env var:
|
|
ANTA_LOG_LEVEL; default: INFO]
|
|
--help Show this message and exit.
|
|
|
|
Commands:
|
|
check Commands to validate configuration files
|
|
debug Commands to execute EOS commands on remote devices
|
|
exec Commands to execute various scripts on EOS devices
|
|
get Commands to get information from or generate inventories
|
|
nrfu Run ANTA tests on devices
|
|
```
|
|
|
|
You can also still choose to install it with directly with `pip`:
|
|
|
|
```bash
|
|
pip install anta[cli]
|
|
```
|
|
|
|
## Documentation
|
|
|
|
The documentation is published on [ANTA package website](https://anta.arista.com).
|
|
|
|
## Contribution guide
|
|
|
|
Contributions are welcome. Please refer to the [contribution guide](contribution.md)
|
|
|
|
## Credits
|
|
|
|
Thank you to [Jeremy Schulman](https://github.com/jeremyschulman) for [aio-eapi](https://github.com/jeremyschulman/aio-eapi/tree/main/aioeapi).
|
|
|
|
Thank you to [Angélique Phillipps](https://github.com/aphillipps), [Colin MacGiollaEáin](https://github.com/colinmacgiolla), [Khelil Sator](https://github.com/ksator), [Matthieu Tache](https://github.com/mtache), [Onur Gashi](https://github.com/onurgashi), [Paul Lavelle](https://github.com/paullavelle), [Guillaume Mulocher](https://github.com/gmuloc) and [Thomas Grimonet](https://github.com/titom73) for their contributions and guidances.
|