Skip to content

Closes #131 - Develop Plugin Tests - API #263

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
Merged
merged 5 commits into from
Jul 9, 2025
Merged

Closes #131 - Develop Plugin Tests - API #263

merged 5 commits into from
Jul 9, 2025

Conversation

pheus
Copy link
Contributor

@pheus pheus commented May 17, 2025

Pull Request

Related Issue

Fixes: #131 [Housekeeping] Develop Plugin Tests – API

New Behavior

  • Adds and improves API view tests for the NetBox ACLs plugin.
  • Introduces comprehensive tests for:
    • AccessList API views (including device and virtual machine targets).
    • ACLInterfaceAssignment API views.
    • ACLStandardRule and ACLExtendedRule API views.
  • Improves test structure by splitting test cases into dedicated modules under the api/ test directory.

Contrast to Current Behavior

  • Previously, all API tests were located in a single, flat file (test_api.py) with limited coverage.
  • Now tests are modularized, easier to maintain, and offer broader coverage of plugin functionality.
  • Additional cases now test objects like virtual machines and ensure direction/assignment logic behaves correctly.

Discussion: Benefits and Drawbacks

Benefits:

  • Improves test coverage, ensuring plugin behavior is validated across different models and conditions.
  • Boosts maintainability through improved file structure and simplified test data setup.
  • Provides a solid foundation for future API changes or enhancements.

Drawbacks:

  • None significant. No functional or runtime changes—only test-related improvements.

Fully isolated to test files.

Changes to the Documentation

  • No changes required. These updates apply strictly to internal test coverage.

Proposed Release Note Entry

  • Restructured and expanded API test coverage for Access Lists and Interface Assignments.

Double Check

  • I have explained my PR according to the information in the comments
    or in a linked issue.
  • My PR targets the dev branch.

pheus added 5 commits May 17, 2025 09:41
@pheus
chore(tests): Move API tests to dedicated directory
82a6ea0 
Renames `test_api.py` to `api/test_accesslists.py` to improve test
organization and maintainability. This is a structural change
with no modifications to test logic.
@pheus
chore(tests): Restructure API test files for clarity
539c73a 
Moved `AppTest` class to a separate file `test_app.py` for better
organization. Simplified imports by removing unused dependencies in
`test_access_lists.py`.
@pheus
chore(tests): Enhance AccessList API view tests
9a3dcfa 
Refactors and extends AccessList API view test cases. Adds support for
testing virtual machines and improves test data setup by using
`assigned_object` directly instead of separate fields for object type
and ID.
@pheus
chore(tests): Add ACLInterfaceAssignment API view tests
33865aa 
Introduces tests for ACLInterfaceAssignment API views. Covers device and
virtual machine interfaces with various ACL directions and assignments,
ensuring comprehensive test coverage for API behavior.
@pheus
chore(tests): Add API view tests for ACL rules
a1f8260 
Introduces comprehensive tests for ACLStandardRule and ACLExtendedRule
API views to ensure functionality and correctness. Adds setup data
and permissions for both standard and extended ACL rule types.
@cruse1977 cruse1977 merged commit cc38ad2 into netbox-community:dev Jul 9, 2025
6 checks passed
@pheus pheus deleted the housekeeping/131-develop-plugin-tests-api branch July 9, 2025 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Housekeeping]: Develop Plugin Tests - API
2 participants
@pheus @cruse1977