Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PLGN-432] Dig Version Bump To 2.0.1 (#2027) #2095

Merged
merged 1 commit into from
Nov 1, 2023
Merged

Conversation

abmccann-r7
Copy link
Contributor

@abmccann-r7 abmccann-r7 commented Nov 1, 2023

  • Added empty init file,version bumped and minor changes in plugin.spec.yaml

  • Reverting Dockerfile SDK version

  • Updated SDK

  • Dockerfile changes and unit tests added

  • Removed apk installs

  • unit test

  • forward action unit tests

  • reverse action unit tests

  • add parameterized package to requirements

Proposed Changes

Description

Describe the proposed changes:

  • Added empty __init__.py file to unit_test folder

  • Refreshed with new tooling

  • Implemented unit tests

  • Added new package to requirements.txt

  • Note: The CloudReadyValidator will fail due to issues in the Dockerfile. There are os level dependencies needed for this plugin to function. There is a ticket raised for the investigation into how to remove the apk add and keep the plugin functioning.

PR Requirements

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

Testing

Unit Tests

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

* Added empty init file,version bumped and minor changes in plugin.spec.yaml

* Reverting Dockerfile SDK version

* Updated SDK

* Dockerfile changes and unit tests added

* Removed apk installs

* unit test

* forward action unit tests

* reverse action unit tests

* add parameterized package to requirements
@cmcnally-r7 cmcnally-r7 merged commit a563f05 into master Nov 1, 2023
5 of 6 checks passed
@cmcnally-r7 cmcnally-r7 deleted the dig-2.0.1-release branch November 1, 2023 15:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants