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

[Carbon Black Cloud] Observability Window Restraint #2877

Merged
merged 2 commits into from
Oct 23, 2024

Conversation

nmccullagh-r7
Copy link
Collaborator

@nmccullagh-r7 nmccullagh-r7 commented Oct 16, 2024

Proposed Changes

Description

Restrains the Observability window to a customizable window

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

@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch from 1fd4ff8 to 74998eb Compare October 16, 2024 14:06
@nmccullagh-r7 nmccullagh-r7 changed the title Carbonblack lookback restraint [Carbon Black Cloud] Observability Window Restraint Oct 16, 2024
@nmccullagh-r7 nmccullagh-r7 changed the base branch from master to develop October 16, 2024 14:07
@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch 2 times, most recently from f5bbbce to 8ec8abf Compare October 16, 2024 14:30
@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch 4 times, most recently from 499a823 to 5802205 Compare October 17, 2024 13:21
Copy link
Collaborator

@joneill-r7 joneill-r7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth a quick call, but not sure I'm quite following everything here. Tried my best to add comments on the bits for clarification - might need inline comments if the logic is correct for the next person coming behind to understand.

@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch 3 times, most recently from f57ca6c to f192f17 Compare October 21, 2024 09:31
@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch from 0e9465f to f192f17 Compare October 21, 2024 17:06
@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch from f192f17 to f5e1dbe Compare October 22, 2024 14:07
Copy link
Collaborator

@joneill-r7 joneill-r7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a couple of small comments we should check and probably would catch during testing, but worth checking now

@nmccullagh-r7 nmccullagh-r7 force-pushed the carbonblack-lookback-restraint branch from e48dac5 to 8e1ef7a Compare October 23, 2024 09:24
@nmccullagh-r7 nmccullagh-r7 merged commit 95dca85 into develop Oct 23, 2024
10 checks passed
@nmccullagh-r7 nmccullagh-r7 deleted the carbonblack-lookback-restraint branch October 23, 2024 09:27
nmccullagh-r7 added a commit that referenced this pull request Oct 24, 2024
* Restrain observability Window

* feedback
nmccullagh-r7 added a commit that referenced this pull request Oct 24, 2024
* Restrain observability Window

* feedback
rmurray-r7 pushed a commit that referenced this pull request Oct 29, 2024
* Restrain observability Window

* feedback
nmccullagh-r7 added a commit that referenced this pull request Oct 29, 2024
* Restrain observability Window

* feedback
rmurray-r7 pushed a commit that referenced this pull request Nov 4, 2024
* Restrain observability Window

* feedback
rmurray-r7 pushed a commit that referenced this pull request Nov 4, 2024
* Restrain observability Window

* feedback
nmccullagh-r7 added a commit that referenced this pull request Nov 4, 2024
* Restrain observability Window

* feedback
nmccullagh-r7 added a commit that referenced this pull request Nov 4, 2024
* [Carbon Black Cloud] Observability Window Restraint (#2877)

* Restrain observability Window

* feedback

* [Carbon Black Cloud] One More Bug (#2896)
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.

6 participants