Create reports_definition.py for launching reports from pyTenable

[samwmarsh]

Tenable SC launch reports using ID in pytenable

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• Test A
• Test B

Test Configuration:

• Python Version(s) Tested:
• Tenable.sc version (if necessary):

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

[aseemsavio]

Could you provide information on how this was tested? You can refer to existing tests in this directory tests/sc/.

[samwmarsh]

Could you provide information on how this was tested? You can refer to existing tests in this directory tests/sc/.

Hey @aseemsavio , I'm not sure what you're asking me to do with the tests/sc/ folder but that's going to be me not understanding what it is/does. I've tested this locally against an internal version of tenable.sc and it works as intended for launching reportDefinitions, which can then be downloaded with the report endpoint (having returned a report ID).

[aseemsavio]

Hey @samwmarsh no problem at all! We include tests that confirms the behaviour of a new feature we're adding with the respective pull request. Give me some time, I'll let you know the changes required.

[samwmarsh]

@aseemsavio all changes merged thanks

[samwmarsh]

@SteveMcGrath that's all sorted, anything blocking this merge now?

[SteveMcGrath]

I'd say there are still some issues just looking at the test suite.

https://github.com/tenable/pyTenable/actions/runs/3881092089/jobs/6619727711#step:5:258

[samwmarsh]

@SteveMcGrath sorry for the delay on this one, I think I've resolved the test suite issues - seemed to be an issue with typo between file name and imports.

[samwmarsh]

@SteveMcGrath anything this is waiting on?

[SteveMcGrath]

Aside from missing unit tests, looks good.

[SteveMcGrath]

Apologize for the delay, this one got pushed to the bottom of the stack. if you're willing to write the unit tests, I have no issues getting this approved.

[samwmarsh]

Not a python dev by any means but hows that? all checks seem happy.

[SteveMcGrath]

The two tests you wrote look great, just need a test with a success as well. Not anything crazy, we just need to assert that were getting a valid response. maybe check that the ID exists in the response and it should be ready to merge.

[samwmarsh]

Something like that?

[samwmarsh]

FAILED tests/sc/test_report_definition.py::test_report_definition_launch_success - requests.exceptions.ConnectionError: HTTPSConnectionPool(host='securitycenter.home.cugnet.net', port=443): Max retries exceeded with url: /rest/reportDefinition/1/launch (Caused by NewConnectionError('<urllib3.connection.HTTPSConnection object at 0x7f63a12b2990>: Failed to establish a new connection: [Errno -2] Name or service not known'))

I copied this from a different test, is this ok or is there a host value this should be to pass?

[samwmarsh]

Thanks @SteveMcGrath, apologies I've not got access to .sc from my public github location so it was guesswork based off of the api docs!

[SteveMcGrath]

Not a problem, it appeared that the JSON you posted in the cassette wasn't valid, so i tweaked it.