Skip to content
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

feat(anta): Added the test case to verify SNMP error counters #836

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(anta): Added the test case to verify SNMP error counters #836

wants to merge 2 commits into from

Conversation

vitthalmagadum
Copy link
Contributor

Description

Verifies the number of SNMP error counter(s) processed.

By default, all  error counters will be checked for any non-zero values.
An optional list of specific error counters can be provided for granular testing.

Expected Results
----------------
* Success: The test will pass if the SNMP error counter(s) are zero/None.
* Failure: The test will fail if the SNMP error counter(s) are non-zero/not None/Not Found or is not configured.

Fixes #834

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have run pre-commit for code linting and typing (pre-commit run)
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes (tox -e testenv)

MaheshGSLAB
MaheshGSLAB reviewed Sep 30, 2024
View reviewed changes
anta/tests/snmp.py Outdated
@@ -237,3 +249,73 @@ def test(self) -> None:
self.result.is_failure(f"Expected `{self.inputs.contact}` as the contact, but found `{contact}` instead.")
else:
self.result.is_success()


class VerifySNMPErrors(AntaTest):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
class VerifySNMPErrors(AntaTest):
class VerifySnmpErrors(AntaTest):

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated.

anta/tests/snmp.py Outdated

error_counters: (
list[
Literal[
Copy link
Contributor

Choose a reason for hiding this comment

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

since we already defined the error list then use the same here so me should not update it on multiple places

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. Added model validator. Thanks!!

anta/tests/snmp.py Outdated

# Verify SNMP PDU counters.
if not (snmp_counters := get_value(command_output, "counters")):
self.result.is_failure("SNMP counter details not found.")
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
self.result.is_failure("SNMP counter details not found.")
self.result.is_failure("SNMP counter details are not found.")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

anta/tests/snmp.py
return

# In case SNMP error counters not provided, It will check all the error counters.
if not error_counters:
Copy link
Contributor

Choose a reason for hiding this comment

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

same as other PR, iterate on actual command output not on defined list

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need to iterate only defined error counters as in actual output we have error counters and trapPDUs also.

tests/units/anta_tests/test_snmp.py Outdated
"inputs": {},
"expected": {
"result": "failure",
"messages": ["The following SNMP error counter(s) are not found or have non-zero counter:\ninVersionErrs, inParseErrs, outBadValueErrs"],
Copy link
Contributor

Choose a reason for hiding this comment

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

make a dict of all failure error and value as error count or not found

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added dict in failure.

@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Oct 1, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
93.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Oct 1, 2024

CodSpeed Performance Report

Merging #836 will not alter performance

Comparing vitthalmagadum:issue_834 (45bf6e8) with main (3408217)

Summary

✅ 4 untouched benchmarks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaheshGSLAB MaheshGSLAB Awaiting requested review from MaheshGSLAB

At least 1 approving review is required to merge this pull request.

Assignees

@vitthalmagadum vitthalmagadum

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add the test case to verify SNMP error counters
2 participants
@vitthalmagadum @MaheshGSLAB