test methods require specific naming 'test_*'

[hackcl]

Change Type

Addition

Area

Customization

Proposed Changes

If you create a Report class which should contain multiple tests it is required that each test starts with 'test_*' to be correct and to avoid an invalid Report.

[hackcl]

I would open a pull request as owner. 6fd27f8

[jeffgdotorg]

Thanks for helping improve the NetBox documentation!

Because we're on the cusp of releasing the first beta of NetBox 4.0, I'm going to make an unusual request. Please bear with me, I think you'll understand.

One big thing that changes between 3.7 and 4.0 is that Reports cease to be their own "thing" and are merged into a special case of Custom Scripts. We've already done the work in the feature branch (which is where we've been doing the work that will become 4.0) to remove the Reports documentation and roll it into the Custom Scripts docs. Since this hint is valuable but not earth-shaking, and because merging your proposed PR would create a merge conflict the next time we go to make a periodic merge of develop into feature, we ask you to reformulate your proposed changes as follows:

• Retarget your change to the Custom Scripts module in the feature branch. You'll need to find the right place for it, as we did some reorganizing in there.
• Revise your change to conform with our conventions for use of Markdown in the NetBox docs. Specifically, please use backticks around both the method prefix and the example method name.

This implies that your change won't make it into 3.7.x, but we can live with that and are happy to adopt it for 4.0.x.

[hackcl]

@jeffgdotorg , Issue can be closed as I found the part I wanted to add already in the documentation for the new scripts:

netbox/docs/customization/custom-scripts.md

Line 157 in 0abd094

A script can define one or more test methods to report on certain conditions. All test methods must have a name beginning with `test_` and accept no arguments beyond `self`.