[PLGN-362]- Pager Duty - Refactor to use requests rather than pypd

[rbowden-r7]

Proposed Changes

Description

https://issues.corp.rapid7.com/browse/PLGN-362

The current version of the plugin uses the PYPD package to make calls to the pager duty api (https://github.com/PagerDuty/pagerduty-api-python-client) this has been deprecated for a while and some of the calls are no longer working

Describe the proposed changes:

• To update all of the actions to now use http requests rather than pypd
• to update the spec / help.d to ensure that all the actions now have correct examples
• to add in the unit tests for all of the actions
• to remove the action for get_user_by_email as this does not seem to be supported via an http request, user info can still be fetched via user ID

PR Requirements

Developers, verify you have completed the following items by checking them off:

Testing

All of the actions have been tested locally in a docker container using postman to create the requests and the outputs have been verified when looking at the pager duty UI

Unit Tests

new unit tests have been added for all actions

Review our documentation on generating and writing plugin unit tests

• Unit tests written for any new or updated code

In-Product Tests

If you are an InsightConnect customer or have access to an InsightConnect instance, the following in-product tests should be done:

• Screenshot of job output with the plugin changes
• Screenshot of the changed connection, actions, or triggers input within the InsightConnect workflow builder

Style

Review the style guide

• For dependencies, pin OS package and Python package versions
• For security, set least privileged account with USER nobody in the Dockerfile when possible
• For size, use the slim SDK images when possible: rapid7/insightconnect-python-3-38-slim-plugin:{sdk-version-num} and rapid7/insightconnect-python-3-38-plugin:{sdk-version-num}
• For error handling, use of PluginException and ConnectionTestException
• For logging, use self.logger
• For docs, use changelog style
• For docs, validate markdown with insight-plugin validate which calls icon_validate to lint help.md

Functional Checklist

• Work fully completed
• Functional
  • Any new actions/triggers include JSON test files in the tests/ directory created with insight-plugin samples
  • Tests should all pass unless it's a negative test. Negative tests have a naming convention of tests/$action_bad.json
  • Unsuccessful tests should fail by raising an exception causing the plugin to die and an object should be returned on successful test
  • Add functioning test results to PR, sanitize any output if necessary
    • Single action/trigger insight-plugin run -T tests/example.json --debug --jq
    • All actions/triggers shortcut insight-plugin run -T all --debug --jq (use PR format at end)
  • Add functioning run results to PR, sanitize any output if necessary
    • Single action/trigger insight-plugin run -R tests/example.json --debug --jq
    • All actions/triggers shortcut insight-plugin run --debug --jq (use PR format at end)

Assessment

You must validate your work to reviewers:

1. Run insight-plugin validate and make sure everything passes
2. Run the assessment tool: insight-plugin run -A. For single action validation: insight-plugin run tests/{file}.json -A
3. Copy (insight-plugin ... | pbcopy) and paste the output in a new post on this PR
4. Add required screenshots from the In-Product Tests section

[cmcnally-r7]

Some more changes while I get through the rest

[cmcnally-r7]

I just left 🔴 for any areas I felt contained sensitive info that need updated in the plugin.spec.yaml

Refer to the style guide for input examples we use:
https://docs.rapid7.com/insightconnect/style-guide#input-examples

[joneill-r7]

Minor tidy up comments, and looks like the get use by email action could still be supported? If that query parameter doesn't work, we could try a call to the endpoint with high limits (1000?) and search the users that are returned to get the user? I'm guessing on most workflows that this would be a common first step to get the user ID to feed into next steps.