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

SOAR-5457: Enable Black #893

Merged
merged 3 commits into from Apr 28, 2021
Merged

SOAR-5457: Enable Black #893

merged 3 commits into from Apr 28, 2021

Conversation

mberezin-r7
Copy link
Contributor

@mberezin-r7 mberezin-r7 commented Apr 28, 2021

Proposed Changes

Description

Describe the proposed changes:

-This PR re-enables the Black Python linter/formatter in the insightconnect-plugins repo. Black version 21.4b0 fixes a breaking issue that caused inconsistent formatting issues.

  • This PR also formats code that was merged to master while Black was deactivated.

Testing

This PR was tested by running black . on the repository, and checking the results with the Black branched GitHub Action workflow running black . --check.

PR Requirements

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

Style

Review the style guide

Functional Checklist

  • Work fully completed
  • Functional
    • Any new actions/triggers include JSON test files in the tests/ directory created with icon-plugin run -c sample $action > tests/$action.json
    • 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 icon-plugin run -T tests/example.json --debug --jq
      • All actions/triggers shortcut icon-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 icon-plugin run -R tests/example.json --debug --jq
      • All actions/triggers shortcut icon-plugin run -R all --debug --jq (use PR format at end)

Assessment

You must validate your work to reviewers:

  1. Run make validate and make sure everything passes
  2. Run the assessment tool: icon-plugin run -A -R all -T all. For single action validation: icon-plugin run -A -R tests/my_action.json -T tests/my_action.json
  3. Copy (icon-plugin ... | pbcopy) and paste the output in a new post on this PR.
  4. Add UI screenshot of the workflow used for testing
  5. Add UI screenshot of the job output used for testing
  6. Add UI screenshot of the artifact (See rules in UI Checklist) used for testing

@mrinehart-r7 mrinehart-r7 merged commit b556e8d into master Apr 28, 2021
@mrinehart-r7 mrinehart-r7 deleted the SOAR-5457-enable-black branch April 28, 2021 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants