Make the NetBox test suite for GraphQL more adaptable to plugins #9401

New Issue

adam · 2025-12-29T20:49:21+01:00

adam commented

2025-12-29 20:49:21 +01:00

Originally created by @peteeckel on GitHub (Mar 28, 2024).

NetBox version

4.0.0-dev

Feature type

Change to existing functionality

Proposed functionality

As a plugin developer I rely on some - admittedly undocumented - parts of the NetBox test framework for my unit tests. This can be done quite easily for API and view tests using the APITestCase and ModelViewTestCase classes and most of the subclasses of APIViewTestCases and ViewTestCases and for ChangeLoggedFilterSetTests.

There is one exception where adjustment to specific plugin conditions is unnecessarily complicated, though, and that's APITestCase.GraphQLTestCase, and that's for a trivial reason.

The _build_query method calls get_graphql_type_for_model(self.model), which is a utility function in the utilities.api module. This is the only place where this function is used, so it could be moved to a private class method which would make it overridable. Unfortunately this is not the case, so the whole _build_query method needs to be overriden in order to replace it with a function that works for a specific plugin. Overriding the much more complex _build_query method is IMHO problematic.

I see that for _get_graphql_base_name provisions have been made to read graphql_base_name from the model's Meta class, but unfortunately it's not possible to add this property to it yet - that could be a way forward that would make overriding test classes unnecessary altogether if it were pursued further, as get_graphql_type_for_model could be adjusted in much the same was, and the same goes for all the test methods. This is much more flexible and elegant than trying to derive the classes and base names etc. from verbose_name etc.

Use case

Extensive testing of plugin functionality

Database changes

None

External dependencies

None

Originally created by @peteeckel on GitHub (Mar 28, 2024). ### NetBox version 4.0.0-dev ### Feature type Change to existing functionality ### Proposed functionality As a plugin developer I rely on some - admittedly undocumented - parts of the NetBox test framework for my unit tests. This can be done quite easily for API and view tests using the `APITestCase` and `ModelViewTestCase` classes and most of the subclasses of `APIViewTestCases` and `ViewTestCases` and for `ChangeLoggedFilterSetTests`. There is one exception where adjustment to specific plugin conditions is unnecessarily complicated, though, and that's `APITestCase.GraphQLTestCase`, and that's for a trivial reason. The `_build_query` method calls `get_graphql_type_for_model(self.model)`, which is a utility function in the `utilities.api` module. This is the only place where this function is used, so it could be moved to a private class method which would make it overridable. Unfortunately this is not the case, so the whole `_build_query` method needs to be overriden in order to replace it with a function that works for a specific plugin. Overriding the much more complex `_build_query` method is IMHO problematic. I see that for `_get_graphql_base_name` provisions have been made to read `graphql_base_name` from the model's `Meta` class, but unfortunately it's not possible to add this property to it yet - that could be a way forward that would make overriding test classes unnecessary altogether if it were pursued further, as `get_graphql_type_for_model` could be adjusted in much the same was, and the same goes for all the test methods. This is much more flexible and elegant than trying to derive the classes and base names etc. from `verbose_name` etc. ### Use case Extensive testing of plugin functionality ### Database changes None ### External dependencies None

adam added the type: feature topic: plugins netbox status: backlog complexity: high topic: testing labels 2025-12-29 20:49:21 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#9401