feat(anta.tests): Added testcase to verify vlan internal allocation policy #528
Conversation
This file contains hidden or 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
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
carl-baillargeon
requested changes
Jan 29, 2024
There was a problem hiding this comment.
Thanks Mahesh. Since vlan.py is a new module, you need to create the documentation: anta/docs/api/tests.vlan.md and add the section in anta/docs/api/tests.md.
Finally add your newly created MD file to mkdocs.yml. Double check the doc with mkdocs serve.
Thanks
anta/custom_types.py
Outdated
| @@ -66,3 +66,4 @@ def interface_case_sensitivity(v: str) -> str: | |||
| EncryptionAlgorithm = Literal["RSA", "ECDSA"] | |||
| RsaKeySize = Literal[2048, 3072, 4096] | |||
| EcdsaKeySize = Literal[256, 384, 521] | |||
| VlanPolicy = Literal["ascending", "descending"] | |||
There was a problem hiding this comment.
I doubt this custom type will be reused in another test so you can specify the type directly in the model.
anta/tests/vlan.py
Outdated
| class Input(AntaTest.Input): | ||
| """Inputs for the VerifyVlanInternalPolicy test.""" | ||
|
|
||
| policy: VlanPolicy |
There was a problem hiding this comment.
Suggested change
| policy: VlanPolicy | |
| policy: Literal["ascending", "descending"] |
tests/units/anta_tests/test_vlan.py
Outdated
| # Use of this source code is governed by the Apache License 2.0 | ||
| # that can be found in the LICENSE file. | ||
| """ | ||
| Tests for anta.tests.security.py |
There was a problem hiding this comment.
Suggested change
| Tests for anta.tests.security.py | |
| Tests for anta.tests.vlan.py |
|
Conflicts have been resolved. A maintainer will review the pull request shortly. |
carl-baillargeon
requested changes
Feb 14, 2024
docs/api/tests.md
Outdated
| @@ -27,6 +27,7 @@ This section describes all the available tests provided by ANTA package. | |||
| - [Software](tests.software.md) | |||
| - [STP](tests.stp.md) | |||
| - [System](tests.system.md) | |||
| - [Vlan](tests.vlan.md) | |||
There was a problem hiding this comment.
Suggested change
| - [Vlan](tests.vlan.md) | |
| - [VLAN](tests.vlan.md) |
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 vi
2FBC
ewing 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
Added testcase to verify vlan internal allocation policy.
success: The test will pass if the VLAN internal allocation policy is either ascending or descending and the VLANs are within the specified range.
failure: The test will fail if the VLAN internal allocation policy is neither ascending nor descending or the VLANs are outside the specified range.
Fixes #527
Checklist:
pre-commit run)tox -e testenv)