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.

Sign up for GitHub

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

Jump to bottom

feat: add logic to handle overwriting existing pre-commit hooks #410

Merged
merged 4 commits into from
Jan 31, 2024
Merged

feat: add logic to handle overwriting existing pre-commit hooks #410

merged 4 commits into from
Jan 31, 2024

Conversation

kevin-orlando
Copy link
Contributor

@kevin-orlando kevin-orlando commented Jan 30, 2024 •
edited
Loading

secureli-372

closes #372

Handles overwriting existing pre-commit install in the user's repo on new install

Changes

  • Adds logic to check if pre-commit hook exists and if so, creates a backup of the current file and overwrites it with SeCureLI's pre-commit content
  • Print a warning to the user to let them know that the file is being overwritten and that a backup is created

Testing

Initialize SeCureLI on a git repo with an existing pre-commit file
Screenshot 2024-01-30 at 2 01 42 PM

Clean Code Checklist

  • Meets acceptance criteria for issue
  • New logic is covered with automated tests
  • 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

github-actions[bot]
github-actions bot previously requested changes Jan 30, 2024
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

PR title failed to match (chore|style|test|feat|fix|docs|ci): .+

@kevin-orlando kevin-orlando changed the title add logic to handle overwriting existing pre-commit hooks feat: add logic to handle overwriting existing pre-commit hooks Jan 30, 2024
joe-stafford
joe-stafford approved these changes Jan 30, 2024
View reviewed changes
Copy link
Contributor

@joe-stafford joe-stafford left a comment

Choose a reason for hiding this comment

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

LGTM!

@kevin-orlando kevin-orlando merged commit 7741740 into main Jan 31, 2024
5 checks passed
@kevin-orlando kevin-orlando deleted the feature/secureli-372-existing-hook-info branch January 31, 2024 20:37
JordoHeffernan pushed a commit that referenced this pull request Mar 22, 2024
@dependabot
chore: pip: Bump pytest-mock from 3.12.0 to 3.14.0 (#491)
645683e 
Bumps [pytest-mock](https://github.com/pytest-dev/pytest-mock) from
3.12.0 to 3.14.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest-mock/releases">pytest-mock's
releases</a>.</em></p>
<blockquote>
<h2>v3.14.0</h2>
<ul>
<li><a
href="https://redirect.github.com/pytest-dev/pytest-mock/pull/415">#415</a>:
<code>MockType</code> and <code>AsyncMockType</code> can be imported
from <code>pytest_mock</code> for type annotation purposes.</li>
<li><a
href="https://redirect.github.com/pytest-dev/pytest-mock/issues/420">#420</a>:
Fixed a regression which would cause <code>mocker.patch.object</code> to
not being properly cleared between tests.</li>
</ul>
<h2>v3.13.0</h2>
<ul>
<li><a
href="https://redirect.github.com/pytest-dev/pytest-mock/pull/417">#417</a>:
<code>spy</code> now has <code>spy_return_list</code>, which is a list
containing all the values returned by the spied function.</li>
<li><code>pytest-mock</code> now requires
<code>pytest&gt;=6.2.5</code>.</li>
<li><a
href="https://redirect.github.com/pytest-dev/pytest-mock/pull/410">#410</a>:
pytest-mock's <code>setup.py</code> file is removed.
If you relied on this file, e.g. to install pytest using <code>setup.py
install</code>,
please see <a
href="https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html#summary">Why
you shouldn't invoke setup.py directly</a> for alternatives.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest-mock/blob/main/CHANGELOG.rst">pytest-mock's
changelog</a>.</em></p>
<blockquote>
<h2>3.14.0 (2024-03-21)</h2>
<ul>
<li>
<p><code>[#415](pytest-dev/pytest-mock#415)
&lt;https://github.com/pytest-dev/pytest-mock/pull/415&gt;</code>_:
<code>MockType</code> and <code>AsyncMockType</code> can be imported
from <code>pytest_mock</code> for type annotation purposes.</p>
</li>
<li>
<p><code>[#420](pytest-dev/pytest-mock#420)
&lt;https://github.com/pytest-dev/pytest-mock/issues/420&gt;</code>_:
Fixed a regression which would cause <code>mocker.patch.object</code> to
not being properly cleared between tests.</p>
</li>
</ul>
<h2>3.13.0 (2024-03-21)</h2>
<ul>
<li><code>[#417](pytest-dev/pytest-mock#417)
&lt;https://github.com/pytest-dev/pytest-mock/pull/417&gt;</code>_:
<code>spy</code> now has <code>spy_return_list</code>, which is a list
containing all the values returned by the spied function.</li>
<li><code>pytest-mock</code> now requires
<code>pytest&gt;=6.2.5</code>.</li>
<li><code>[#410](pytest-dev/pytest-mock#410)
&lt;https://github.com/pytest-dev/pytest-mock/pull/410&gt;</code><em>:
pytest-mock's <code>setup.py</code> file is removed.
If you relied on this file, e.g. to install pytest using <code>setup.py
install</code>,
please see <code>Why you shouldn't invoke setup.py directly
&lt;https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html#summary&gt;</code></em>
for alternatives.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/8733134b6194395e9cd3c745adcc9a9c09b0279e"><code>8733134</code></a>
Update CHANGELOG for 3.14.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/5257e3c0df0a18bca4028daa9e6d2d91870ff576"><code>5257e3c</code></a>
Refactor MockCache to have a narrow interface</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/4faf92ae233afadac3831ab570531e540dc87830"><code>4faf92a</code></a>
Fix regression with mocker.patch not being undone correctly</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/6bd8712a14a1a11d348354318fdbad3fd9bbdb78"><code>6bd8712</code></a>
Drop pre-Python 3.8 support code</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/366966bff1e3ca2e1455d704dd59991da5593877"><code>366966b</code></a>
Export <code>MockType</code>/<code>AsyncMockType</code> for type
annotations (<a
href="https://redirect.github.com/pytest-dev/pytest-mock/issues/415">#415</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/852116b0af33db27fe595847c091631dcf059a1c"><code>852116b</code></a>
Merge pull request <a
href="https://redirect.github.com/pytest-dev/pytest-mock/issues/418">#418</a>
from pytest-dev/release-3.13.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/ef9461b8b5bdcdd416841b986cf4e1d336c84266"><code>ef9461b</code></a>
Add instructions on how to start deploy from command-line</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/5b9d2858f507e04cc97a3c206f55d7d5505ae71c"><code>5b9d285</code></a>
Release 3.13.0</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/6d5d6dc2274cea96b6919a4a2a6dc7a3394ef11d"><code>6d5d6dc</code></a>
Implement <code>spy_return_list</code> (<a
href="https://redirect.github.com/pytest-dev/pytest-mock/issues/417">#417</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest-mock/commit/dc28a0ec7b66372fbc6e0cf1bbe443ce7ca465cd"><code>dc28a0e</code></a>
[pre-commit.ci] pre-commit autoupdate (<a
href="https://redirect.github.com/pytest-dev/pytest-mock/issues/416">#416</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/pytest-dev/pytest-mock/compare/v3.12.0...v3.14.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest-mock&package-manager=pip&previous-version=3.12.0&new-version=3.14.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joe-stafford joe-stafford joe-stafford approved these changes

@tdurk93 tdurk93 tdurk93 approved these changes

@github-actions github-actions[bot] github-actions[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

When writing pre-commit hook, merge with existing hook logic
3 participants
@kevin-orlando @tdurk93 @joe-stafford