starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Rename "Report" to "Tests" #5415

New Issue
Closed
opened 2025-12-29 19:27:43 +01:00 by adam · 4 comments
adam commented 2025-12-29 19:27:43 +01:00
Owner
Copy Link

Originally created by @tb-killa on GitHub (Sep 23, 2021).

NetBox version

v3.0.3

Feature type

Change to existing functionality

Proposed functionality

Rename "Reports" to "Tests".

Use case

Reports were added in Netbox to allowed the user to execute custom logic within NetBox and save output comprising discrete log messages to the database as a "report result." But from the Logic themselves, this Logic are more "Tests" as an active "Report". Custom Scripts in Netbox are Parts which are very similar to reports, but had the ability to process user input.
As there is substantial functional overlap between "Reports" and "Custom Scripts" , it could makes sense to merge the two features but from first of all the simplest Solution would be to rename "Reports" to "Tests" or another meaningful Name.

Database changes

Rename Reports to "Tests" or another meaningful Name.

External dependencies

None

Originally created by @tb-killa on GitHub (Sep 23, 2021). ### NetBox version v3.0.3 ### Feature type Change to existing functionality ### Proposed functionality Rename "Reports" to "Tests". ### Use case Reports were added in Netbox to allowed the user to execute custom logic within NetBox and save output comprising discrete log messages to the database as a "report result." But from the Logic themselves, this Logic are more "Tests" as an active "Report". Custom Scripts in Netbox are Parts which are very similar to reports, but had the ability to process user input. As there is substantial functional overlap between "Reports" and "Custom Scripts" , it could makes sense to merge the two features but from first of all the simplest Solution would be to rename "Reports" to "Tests" or another meaningful Name. ### Database changes Rename Reports to "Tests" or another meaningful Name. ### External dependencies None
adam added the type: feature label 2025-12-29 19:27:43 +01:00
adam closed this issue 2025-12-29 19:27:43 +01:00
adam commented 2025-12-29 19:27:43 +01:00
Author
Owner
Copy Link

@PieterL75 commented on GitHub (Sep 23, 2021):

To me, these are Reports... I get an overview of IP usage, get free vlans etc..
I dont really 'test' anything with it..

@PieterL75 commented on GitHub (Sep 23, 2021): To me, these are Reports... I get an overview of IP usage, get free vlans etc.. I dont really 'test' anything with it..
adam commented 2025-12-29 19:27:43 +01:00
Author
Owner
Copy Link

@tb-killa commented on GitHub (Sep 23, 2021):

@PieterL75 Do you use "Reports" or "Custom Scripts" ??
I know that if someone know how to use them it will be usable but from the official stuff its completly more an "test"ing.

From the "https://netbox.readthedocs.io/en/stable/customization/reports/"

A NetBox report is a mechanism for validating the integrity of data within NetBox. Running a report allows the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write reports to check that:

All top-of-rack switches have a console connection
Every router has a loopback interface with an IP address assigned
Each interface description conforms to a standard format
Every site has a minimum set of VLANs defined
All IP addresses have a parent prefix
...and so on. Reports are completely customizable, so there's practically no limit to what you can test for.

i think an "report" show be exactly what you actually mentioned, overviews and much more.

@tb-killa commented on GitHub (Sep 23, 2021): @PieterL75 Do you use "Reports" or "Custom Scripts" ?? I know that if someone know how to use them it will be usable but from the official stuff its completly more an "test"ing. From the "https://netbox.readthedocs.io/en/stable/customization/reports/" > A NetBox report is a mechanism for validating the integrity of data within NetBox. Running a report allows the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write reports to check that: >All top-of-rack switches have a console connection >Every router has a loopback interface with an IP address assigned >Each interface description conforms to a standard format >Every site has a minimum set of VLANs defined >All IP addresses have a parent prefix >...and so on. Reports are completely customizable, so there's practically no limit to what you can test for. i think an "report" show be exactly what you actually mentioned, overviews and much more.
adam commented 2025-12-29 19:27:44 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 26, 2021):

The name "reports" is perfectly fine. Renaming it to tests would only introduce confusion.

@jeremystretch commented on GitHub (Sep 26, 2021): The name "reports" is perfectly fine. Renaming it to tests would only introduce confusion.
adam commented 2025-12-29 19:27:44 +01:00
Author
Owner
Copy Link

@tb-killa commented on GitHub (Sep 26, 2021):

What maybe could be an good replacement would be the naming "data integrity".
An Report would be something where an User is allowed to query for needing informations with something like https://pypi.org/project/django-sql-explorer/ (maybe oben new FR for it if you allowed?)

@tb-killa commented on GitHub (Sep 26, 2021): What maybe could be an good replacement would be the naming "data integrity". An Report would be something where an User is allowed to query for needing informations with something like https://pypi.org/project/django-sql-explorer/ (maybe oben new FR for it if you allowed?)
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#5415
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?