pre_run for Reports #6057

New Issue

adam · 2025-12-29T19:36:10+01:00

adam commented

2025-12-29 19:36:10 +01:00

Originally created by @hagbarddenstore on GitHub (Feb 7, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.1.7

Feature type

New functionality

Proposed functionality

Add a new function stub to the Reports class to be executed before any tests are executed.

Use case

If you're running multiple tests against the same dataset, it would be beneficial to be able to load the dataset once instead of loading it per test.

Example:

For each virtual machine, validate that vCPUs is set, validate that memory is set, validate that platform is set, validate that a primary IP is set, etc.

All of them are executed against the same dataset, which is loaded multiple times.

Database changes

None

External dependencies

None

Originally created by @hagbarddenstore on GitHub (Feb 7, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.1.7 ### Feature type New functionality ### Proposed functionality Add a new function stub to the `Reports` class to be executed before any tests are executed. ### Use case If you're running multiple tests against the same dataset, it would be beneficial to be able to load the dataset once instead of loading it per test. Example: For each virtual machine, validate that vCPUs is set, validate that memory is set, validate that platform is set, validate that a primary IP is set, etc. All of them are executed against the same dataset, which is loaded multiple times. ### Database changes None ### External dependencies None

adam added the status: accepted type: feature labels 2025-12-29 19:36:10 +01:00

adam closed this issue

2025-12-29 19:36:10 +01:00

adam commented

2025-12-29 19:36:11 +01:00

@bistraque commented on GitHub (Feb 7, 2022):

You can simply override the run method. Something like:

def run(self, job_result):
    # retrieve your data
    data = ...
    # store it in report object, test_xxx() methods can access it when called
    self.data = data
    super().run(job_result)

@bistraque commented on GitHub (Feb 7, 2022): You can simply override the `run `method. Something like: ``` def run(self, job_result): # retrieve your data data = ... # store it in report object, test_xxx() methods can access it when called self.data = data super().run(job_result) ```

adam commented

2025-12-29 19:36:11 +01:00

@jeremystretch commented on GitHub (Feb 7, 2022):

@bistraque is correct in that this can be accomplished by overriding the run() method, although I think there's a valid argument to introduce pre_run() as a convenience method given that we already have post_run() for a similar purpose.

@jeremystretch commented on GitHub (Feb 7, 2022): @bistraque is correct in that this can be accomplished by overriding the `run()` method, although I think there's a valid argument to introduce `pre_run()` as a convenience method given that we already have `post_run()` for a similar purpose.

adam commented

2025-12-29 19:36:11 +01:00

@jeremystretch commented on GitHub (Feb 7, 2022):

I'm going to tag this for v3.2. I'm not comfortable implementing it in a v3.1.x release as it has the potential to be a breaking change (i.e. for any script which already defines a pre_run() method).

@jeremystretch commented on GitHub (Feb 7, 2022): I'm going to tag this for v3.2. I'm not comfortable implementing it in a v3.1.x release as it has the potential to be a breaking change (i.e. for any script which already defines a `pre_run()` method).

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#6057