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

Feature/secureli 460 custom regex #564

Merged
merged 22 commits into from
Jun 11, 2024

Conversation

doug-szeto-slalom
Copy link
Contributor

secureli-460

Adds new new-pattern parameter to secureli update and updates secureli scan to check for custom regex

Changes

Testing

  • run secureli update --new-pattern <custom-regex-pattern>
  • verify that your custom regex pattern was added to .secureli.yaml
  • modify any file (other than .secureli.yaml) to include text that matches your custom regex
  • stage the changes
  • run secureli scan and verify the scan fails
  • revert the changes and run secureli scan and verify the scan passes

Clean Code Checklist

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • [ x Appropriate exception handling added
  • Thoughtful logging included
  • Documentation is updated
  • Follow-up work is documented in TODOs
  • TODOs have a ticket associated with them
  • No commented-out code included

@itoltz
Copy link
Contributor

itoltz commented Jun 10, 2024

Code looks good. Could you add some info about this new feature to README.md?

@doug-szeto-slalom doug-szeto-slalom merged commit 1917cca into main Jun 11, 2024
5 checks passed
@doug-szeto-slalom doug-szeto-slalom deleted the feature/secureli-460-custom-regex branch June 11, 2024 16:41
shrutitirpude pushed a commit that referenced this pull request Jun 11, 2024
secureli-460

Adds new `new-pattern` parameter to `secureli update` and updates
`secureli scan` to check for custom regex


## Changes

*

## Testing
<!--
Mention updated tests and any manual testing performed.
Are aspects not yet tested or not easily testable?
Feel free to include screenshots if appropriate.
 -->
* run `secureli update --new-pattern <custom-regex-pattern>`
* verify that your custom regex pattern was added to `.secureli.yaml`
* modify any file (other than .secureli.yaml) to include text that
matches your custom regex
* stage the changes
* run `secureli scan` and verify the scan fails
* revert the changes and run `secureli scan` and verify the scan passes

## Clean Code Checklist
<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->
- [x] Meets acceptance criteria for issue
- [x] New logic is covered with automated tests
- [ x Appropriate exception handling added
- [x] Thoughtful logging included
- [x] Documentation is updated
- [x] Follow-up work is documented in TODOs
- [x] TODOs have a ticket associated with them
- [x] No commented-out code included


<!--
Github-flavored markdown reference:
https://docs.github.com/en/get-started/writing-on-github
-->

---------

Co-authored-by: Rachel Teal <[email protected]>
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.

Create command for users to submit custom regex pattern for security scan
4 participants