8000 feat(anta): use aioeapi to handle a device session by mtache · Pull Request #122 · aristanetworks/anta · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

feat(anta): use aioeapi to handle a device session #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 35 commits into from
Jan 4, 2023
Merged

feat(anta): use aioeapi to handle a device session #122

merged 35 commits into from
Jan 4, 2023

Conversation

mtache
Copy link
Collaborator
@mtache mtache commented Sep 19, 2022 •
edited
Loading

Using asyncio framework will help improving performances when running tests on a large network with a high number of tests.
First step is to refactor the anta.inventory module to use an async library, this PR tries an attempt with aio-eapi.
This PR must also refactor all the tests as coroutines and modify the scripts to run the asyncio event loop.

Modifications to anta.inventory

The session attribute of InventoryDevice is now a aioeapi.Device object.
auto_connect is removed from the constructor: this would cause to run an asyncio event loop in an object constructor and prevent fine control from a ANTA user script on the asyncio scheduling.

_is_device_online() uses aioeapi.Device.check_connection() to only tries to open a port on the device.
_ refresh_device_fact() updates all the device flags and reduce the number of API calls compared to the previous implementation.

connect_inventory() is a coroutine that needs to be called in a ANTA user script to establish connection towards the devices.

async def main():
   await anta_inventory.connect_inventory()

When using a containerlab topology on macOS, we need to use port forwarding to localhost to access eAPI endpoints.
The current inventory only supports IP addresses. This PR supports hostnames (DNS names instead of IP), ports and alias names in the inventory.

The following inventory works with this PR:

anta_inventory:
  hosts:
  - name: spine1
    host: localhost
    port: 44301
  - name: spine2
    host: localhost
    port: 44302
  - name: leaf1
    host: localhost
    port: 44311
  - name: leaf1
    host: localhost
    port: 44312
  - name: leaf3
    host: localhost
    port: 44313
  - name: leaf4
    host: localhost
    port: 44314

@mtache mtache requested a review from gmuloc September 19, 2022 21:13
@mtache mtache requested review from titom73 and ksator September 19, 2022 21:13
@github-actions
Copy link
Contributor
github-actions bot commented Oct 7, 2022

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions
Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

mtache added 20 commits December 14, 2022 15:50
@mtache
feat(anta.inventory): add eAPIUIrl model to build valid eAPI URL and …
b82785d 
…handle default values
@mtache
feat(anta.inventory): extend InventoryDevice model to handle hostname…
2e4c9dd 
… (DNS names, not only IP) and device alias names.
@mtache
feat(anta.tests): update test to support the new InventoryDevice model
29d0392
@mtache
fix(anta.inventory): typing
63af799
@mtache
make: add configuration for VSCode debugger and linting
71f279f
@mtache
feat(anta.inventory): extend InventoryDevice model to handle hostname…
ab81d73 
… (DNS names, not only IP) and device alias names.
@mtache
feat(anta.result_manager): add support for adding a list of results
951c414
@mtache
fix(anta.loader): do not crash when test_catalog is None
62e5735
@mtache
refactor(anta.inventory): remove unused code
1aa6601
@mtache
feat(anta.inventory): add the ability to filter the inventory on cons…
0a95fe3 
…truction
@mtache
refactor(anta.inventory): remove unused code
befbf90
@mtache
refactor(anta.tests): refactor as coroutines
0b8e598
@mtache
refactor(anta-tester): use asyncio
54d1cb6
@mtache
feat(anta.inventory): remove eAPIUrl model. Build device session in m…
f346ecc 
…odel validator.

feat(anta.inventory): remove eAPIUrl model. Build device session in model validator.

lint inventory
@mtache
feat(anta.inventory): return exceptions when gathering coroutines
88a53a5
@mtache
lint: fix pylint and mypy errors
89e86d7
@mtache
pytest(anta.inventory): update tests for inventory
d7bc2fa
@mtache
make: update requirements with ao-eapi
8bc1a2d
@mtache
pytest(anta.tests): Updated pytest for async tests
02039d9
@mtache
ci: drop Python 3.7 support due to 3.8 required for aio-eapi
e18b121
@gmuloc gmuloc mentioned this pull request Dec 14, 2022
Merged
gmuloc
gmuloc approved these changes Jan 3, 2023
View reviewed changes
Copy link
Collaborator
@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but someone should try it on some env ;)

@mtache mtache merged commit 6d50ac7 into aristanetworks:master Jan 4, 2023
@mtache mtache deleted the asyncio branch January 4, 2023 17:51
This was referenced Jan 6, 2023
Closed
Open
@titom73 titom73 mentioned this pull request Jan 11, 2023
Closed
@titom73 titom73 changed the title feat(anta.inventory): use aioeapi to handle a device session feat(anta): use aioeapi to handle a device session Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gmuloc gmuloc gmuloc approved these changes

@titom73 titom73 Awaiting requested review from titom73

@ksator ksator Awaiting requested review from ksator

Assignees

@mtache mtache

Labels
rn: feat(anta)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mtache @gmuloc
0