Implement an SNMP back-end selection option in `zino.toml` #396

lunkwill42 · 2025-02-19T14:44:31Z

Scope and purpose

Part of fix for #383. Dependent on #394 and #395.

This adds an option snmp.backend to the configuration file zino.toml (defaulting to the new netsnmp-cffi back-end).

Since netsnmp-cffi is a new back-end, still in development, this allows users to optionally go back to the original PySNMP-based back-end in case they experience stability issues with the new solution.

This pull request

adds an option configuration option to zino.toml
changes how SNMP back-ends are selected/loaded

Contributor Checklist

Every pull request should have this checklist filled out, no matter how small it is.
More information about contributing to Zino can be found in the
README.

Added a changelog fragment for towncrier
Added/amended tests for new/changed code
Added/changed documentation
Linted/formatted the code with black, ruff and isort, easiest by using pre-commit
The first line of the commit message continues the sentence "If applied, this commit will ...", starts with a capital letter, does not end with punctuation and is 50 characters or less long. See https://cbea.ms/git-commit/
If applicable: Created new issues if this PR does not fix the issue completely/there is further work to be done

github-actions · 2025-02-19T14:45:38Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Elapsed time
✅ PYTHON	black	73	1.42s
✅ PYTHON	isort	73	0.56s
✅ PYTHON	ruff	73	0.03s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

github-actions · 2025-02-19T14:45:40Z

Test results

3 files 3 suites 1m 15s ⏱️
660 tests 660 ✅ 0 💤 0 ❌
1 932 runs 1 930 ✅ 2 💤 0 ❌

Results for commit 77c07f6.

♻️ This comment has been updated with latest results.

codecov · 2025-02-19T14:45:57Z

Codecov Report

Attention: Patch coverage is 98.76543% with 1 line in your changes missing coverage. Please review.

Project coverage is 98.59%. Comparing base (980ac89) to head (77c07f6).
Report is 16 commits behind head on master.

Files with missing lines	Patch %	Lines
src/zino/trapd/__init__.py	93.33%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #396      +/-   ##
==========================================
+ Coverage   98.46%   98.59%   +0.14%     
==========================================
  Files          83       83              
  Lines        9971    10021      +50     
==========================================
+ Hits         9817     9880      +63     
+ Misses        154      141      -13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

johannaengland

It would be good to document somewhere that it is not enough to change the snmp.backend setting in the config for a running Zino, but that it needs to be restarted for it to come into effect

src/zino/snmp/netsnmpy_backend.py

src/zino/snmp/__init__.py

src/zino/trapd/__init__.py

src/zino/trapd/pysnmp_backend.py

tests/snmp/netsnmpy_backend_test.py

lunkwill42 · 2025-03-10T12:45:25Z

It would be good to document somewhere that it is not enough to change the snmp.backend setting in the config for a running Zino, but that it needs to be restarted for it to come into effect

Doesn't every change to zino.toml require a restart to take effect, @johannaengland ?

johannaengland · 2025-03-10T12:51:42Z

It would be good to document somewhere that it is not enough to change the snmp.backend setting in the config for a running Zino, but that it needs to be restarted for it to come into effect

Doesn't every change to zino.toml require a restart to take effect, @johannaengland ?

Yes, it does, I mixed up polldevs.cf and zino.toml 😅

lunkwill42 · 2025-03-10T15:39:23Z

Keeping this in draft mode until I'm satisfied with test coverage

lunkwill42 · 2025-03-11T14:52:51Z

Coverage looks ok now, so taking out of draft

src/zino/snmp/netsnmpy_backend.py

src/zino/trapd/__init__.py

hmpf

See questions

This adds functionality to `zino.snmp` and `zino.trapd` to select between the supported back-ends. This is mostly geared at loading a single default back-end for the running process, but will allow for importing more than one back-end, for example for testing scenarios.

Instead of the Zino main program initializing the netsnmpy backend explicitly, ensure the call goes out to the selected backend instead.

This just ensure the example program can keep running.

A back-end needs to be loaded before much of the Zino code can be tested, but since multiple back-ends can eventually be imported, the test suite can still target explicit back-ends if needed.

src/zino/snmp/pysnmp_backend.py

johannaengland

Just a nitpick about test names 😁

tests/getuptime_test.py

Because I changed two lines to make the script work, CodeCov insists I need coverage of those lines - but getuptime.py had no coverage to begin with. Not really very relevant to this particular PR, but it turns out that getuptime.py actually didn't work as intended, which these tests discovered - so overall, this is a good thing :)

As commented in code-review.

sonarqubecloud · 2025-03-12T14:32:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

lunkwill42 requested review from stveit and johannaengland February 19, 2025 14:44

lunkwill42 self-assigned this Feb 19, 2025

lunkwill42 changed the title ~~Implements an SNMP back-end selection option in zino.toml~~ Implement an SNMP back-end selection option in zino.toml Feb 20, 2025

johannaengland force-pushed the feature/add-snmp-backend-selection-option branch from 9df3750 to acf514d Compare February 27, 2025 09:10

johannaengland requested changes Feb 27, 2025

View reviewed changes

lunkwill42 force-pushed the feature/use-netsnmp-cffi-for-traps branch from a97452c to decef88 Compare March 10, 2025 13:54

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch from acf514d to 82ed56a Compare March 10, 2025 14:05

lunkwill42 force-pushed the feature/use-netsnmp-cffi-for-traps branch from decef88 to 1ed57cf Compare March 10, 2025 14:09

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch from 82ed56a to 0745cbb Compare March 10, 2025 14:10

lunkwill42 requested a review from johannaengland March 10, 2025 14:29

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch from 0745cbb to 5895c86 Compare March 10, 2025 15:38

lunkwill42 force-pushed the feature/use-netsnmp-cffi-for-traps branch from 0e9cd93 to cceb873 Compare March 11, 2025 07:53

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch 2 times, most recently from d62026d to f066705 Compare March 11, 2025 14:50

lunkwill42 marked this pull request as ready for review March 11, 2025 14:52

hmpf reviewed Mar 12, 2025

View reviewed changes

src/zino/snmp/netsnmpy_backend.py Show resolved Hide resolved

hmpf reviewed Mar 12, 2025

View reviewed changes

src/zino/trapd/__init__.py Show resolved Hide resolved

hmpf reviewed Mar 12, 2025

View reviewed changes

lunkwill42 requested a review from hmpf March 12, 2025 13:12

stveit approved these changes Mar 12, 2025

View reviewed changes

lunkwill42 mentioned this pull request Mar 12, 2025

Add netsnmp-cffi as alternative SNMP trap receiver back-end #395

Merged

6 tasks

lunkwill42 force-pushed the feature/use-netsnmp-cffi-for-traps branch from cceb873 to 980ac89 Compare March 12, 2025 13:56

lunkwill42 added 8 commits March 12, 2025 14:57

Add config option for selecting SNMP back-end

7dcf8e4

Add exception classes for back-end loading errors

4b47b3a

Move back-end initialization to back-end

1e92b77

Instead of the Zino main program initializing the netsnmpy backend explicitly, ensure the call goes out to the selected backend instead.

Make back-end initializer for PySNMP

3c5944e

Load back-end in getuptime example program

9f0b26a

This just ensure the example program can keep running.

Load a default SNMP back-end in test suite

7c22928

A back-end needs to be loaded before much of the Zino code can be tested, but since multiple back-ends can eventually be imported, the test suite can still target explicit back-ends if needed.

Add tests for SNMP engine selection

4f59f06

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch from 20b06d0 to 4eccdf0 Compare March 12, 2025 13:57

hmpf approved these changes Mar 12, 2025

View reviewed changes

src/zino/snmp/pysnmp_backend.py Show resolved Hide resolved

johannaengland approved these changes Mar 12, 2025

View reviewed changes

tests/getuptime_test.py Outdated Show resolved Hide resolved

lunkwill42 added 2 commits March 12, 2025 14:31

Improve get_new_snmp_engine() docstring.

77c07f6

As commented in code-review.

lunkwill42 force-pushed the feature/add-snmp-backend-selection-option branch from 4eccdf0 to 77c07f6 Compare March 12, 2025 14:32

Base automatically changed from feature/use-netsnmp-cffi-for-traps to master March 12, 2025 14:37

lunkwill42 merged commit c5965ee into master Mar 12, 2025
11 checks passed

lunkwill42 deleted the feature/add-snmp-backend-selection-option branch March 12, 2025 14:38

Implement an SNMP back-end selection option in zino.toml #396

Implement an SNMP back-end selection option in zino.toml #396

Uh oh!

Conversation

lunkwill42 commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Scope and purpose

This pull request

Contributor Checklist

Uh oh!

github-actions bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦙 MegaLinter status: ✅ SUCCESS

Uh oh!

github-actions bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test results

Uh oh!

codecov bot commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

johannaengland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lunkwill42 commented Mar 10, 2025

Uh oh!

johannaengland commented Mar 10, 2025

Uh oh!

lunkwill42 commented Mar 10, 2025

Uh oh!

lunkwill42 commented Mar 11, 2025

Uh oh!

Uh oh!

Uh oh!

hmpf left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

johannaengland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Mar 12, 2025

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

Implement an SNMP back-end selection option in `zino.toml` #396

Implement an SNMP back-end selection option in `zino.toml` #396

lunkwill42 commented Feb 19, 2025 •

edited

Loading

github-actions bot commented Feb 19, 2025 •

edited

Loading

github-actions bot commented Feb 19, 2025 •

edited

Loading

codecov bot commented Feb 19, 2025 •

edited

Loading