You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AntaCatalog.merge_catalogs() -> AntaCatalog.merge() (AntaCatalog.merge() is deprecated. Does this comply with SemVer ?)
AntaInventoryInput -> AntaInventoryFile (to be consistent with AntaCatalogFile)
Move classes/modules:
anta.reporter.ReportTable to its own module like CSV and Markdown
anta.reporter.ReportJinja to its own module like CSV and Markdown
Remove unused classes:
AntaParamsBaseModel. <<< this is used in AntaTemplate but maybe we could instead group this as a base AntaBaseModel with extra config set to False.
AntaCatalogFile has a to_json() method (that is just the pydantic model_dump_json() method) and not the AntaInventoryInput model. <<< not sure it is in the right category of "unused class"
Make AntaCommand and AntaTemplate not pydantic class to avoid validation
Method signatures:
AntaTest.test() returns Coroutine[Any, Any, TestResult] but should return None.
Is the AntaTest.anta_test decorator really needed? We could just implement it as a run function that would be called by the framework and avoid the need for the user to decorate the AntaTest.test() function. The eos_data could be provided via another public method.
SemVer
publish a proper SemVer documentation with the public API for ANTA (i.e. what's expecting not too break inside a common major release train)
Tests/Inputs
Remove BgpAddressFamily, replaced by BgpPeer
Rename BgpPeer.capabilites to BgpPeer.address_families
Remove VerifyBGPSpecificPeers, replaced by VerifyBGPPeerSession with added AFI/SAFI checks
Update VerifyBGPPeerCount and VerifyBGPPeersHealth with BgpPeer
Remove input ClassVar and deprecated input models
The text was updated successfully, but these errors were encountered:
mtache
changed the title
refactor: AntaDevice.cache and AntaDevice.cache_locks should be private attributes
refactor: restrict attributes visibility
Jan 13, 2025
mtache
changed the title
refactor: restrict attributes visibility
refactor: umbrella issue for ANTA 2.0.0
Jan 13, 2025
Taking notes while building ANTA UML diagram (#1004) and 2.0.0 Public API documentation... To be discussed.
Pubic attributes and methods that should be private:
AntaDevice.cache
AntaDevice.cache_locks
AntaTemplate.params_schema
AntaCatalog.flatten_modules()
AntaCatalog.check_tests()
(that is a pydantic validator)AntaTest.nrfu_task
,AntaTest.progress
andAntaTest.update_progress()
AntaTest.collect()
Rename public attributes and methods:
TestResult.name
->TestResult.device
AntaIntenvory.get_inventory()
->AntaInventory.filter()
AntaIntenvory.connect_inventory()
->AntaInventory.connect()
AntaIntenvory.add_device()
->AntaInventory.add()
AntaCatalog.merge_catalogs()
->AntaCatalog.merge()
(AntaCatalog.merge()
is deprecated. Does this comply with SemVer ?)AntaInventoryInput
->AntaInventoryFile
(to be consistent withAntaCatalogFile
)Move classes/modules:
anta.reporter.ReportTable
to its own module like CSV and Markdownanta.reporter.ReportJinja
to its own module like CSV and MarkdownRemove unused classes:
AntaParamsBaseModel
. <<< this is used in AntaTemplate but maybe we could instead group this as a base AntaBaseModel with extra config set to False.AntaCatalogFile
has ato_json()
method (that is just the pydanticmodel_dump_json()
method) and not theAntaInventoryInput
model. <<< not sure it is in the right category of "unused class"Make AntaCommand and AntaTemplate not pydantic class to avoid validation
Method signatures:
AntaTest.test()
returnsCoroutine[Any, Any, TestResult]
but should returnNone
.AntaTest.anta_test
decorator really needed? We could just implement it as arun
function that would be called by the framework and avoid the need for the user to decorate theAntaTest.test()
function. Theeos_data
could be provided via another public method.SemVer
Tests/Inputs
BgpAddressFamily
, replaced byBgpPeer
BgpPeer.capabilites
toBgpPeer.address_families
VerifyBGPSpecificPeers
, replaced byVerifyBGPPeerSession
with added AFI/SAFI checksVerifyBGPPeerCount
andVerifyBGPPeersHealth
withBgpPeer
ClassVar
and deprecated input modelsThe text was updated successfully, but these errors were encountered: