-
Notifications
You must be signed in to change notification settings - Fork 29
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.
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
feat(anta.tests)!: Implement caching #394
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mtache
reviewed
Sep 14, 2023
Conflicts have been resolved. A maintainer will review the pull request shortly. |
gmuloc
reviewed
Sep 25, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Let's add a way in the inventory to disable the
cache
per device if needed - Let's add a CLI to disable the cache completely as well (as mentioned in your PR)
- Documentation to add as well with examples maybe
- Disabling cache for a command
- Disabling cache globally
- Disabling cache for a device from the inventory
gmuloc
reviewed
Sep 28, 2023
titom73
approved these changes
Sep 28, 2023
titom73
approved these changes
Sep 28, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good after resolving points raised by @gmuloc
gmuloc
approved these changes
Sep 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Implement caching with
aiocache
library.Cache key design:
<device_name>:<uid>
The
uid
is a new property attribute ofAntaCommand
, which is a UID generated from the command, version, revision and output format.Each UID has its own asyncio Lock. This way, coroutines that need to access the cache for different
uid
's can do so concurrently.Caching is implemented in the
AntaDevice.collect_commands
async function where the innercollect_command
function first checks if thecommand.uid
is present in the cache and if it is,command.output
will be populate by the cache. If not, thecollect()
function will be run as usual and the output will be saved in the cache.Fixes #342
Tasks:
aiocache
plugins for cache hit ratio, etc.click
CLI options to tweak caching (TTL, etc.)Caveats:
AntaDevice
class, we might need a lock cleanup strategy to optimize performance when running thousands of tests on hundreds devices.Checklist:
pre-commit run
)tox -e testenv
)