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

chore: add common action models to shared models folder #459

Conversation

kevin-orlando
Copy link
Contributor

secureli-440

closes #440
Moving common action models to shared models

Changes

  • Moves common action models to shared/models/actions.py

Testing

  • Verifying the application builds correctly should be enough since this just includes moving existing code to a different file location and updating imports

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

@kevin-orlando kevin-orlando changed the title add common action models to shared models folder chore: add common action models to shared models folder Feb 22, 2024
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): .+

@github-actions github-actions bot dismissed their stale review February 22, 2024 15:30

All good!

Copy link
Contributor

@isaac-heist-slalom isaac-heist-slalom left a comment

Choose a reason for hiding this comment

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

Should this PR be against refactor branch instead of main?

dependabot bot added 5 commits February 27, 2024 13:56
…#458)

Bumps [bats-core/bats-action](https://github.com/bats-core/bats-action)
from 1.5.4 to 1.5.5.
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/bats-core/bats-action/commit/dae28e5c0d0d2ecf297b7d8d1ae143f464ca3ee8"><code>dae28e5</code></a>
Merge pull request <a
href="https://redirect.github.com/bats-core/bats-action/issues/1">#1</a>
from bats-core/auto-update-pre-commit-hooks</li>
<li><a
href="https://github.com/bats-core/bats-action/commit/ad83afa27e887b20ee54d65e293fdfbd68609398"><code>ad83afa</code></a>
Merge pull request <a
href="https://redirect.github.com/bats-core/bats-action/issues/2">#2</a>
from lmakarov/feature/actions-cache-v4</li>
<li><a
href="https://github.com/bats-core/bats-action/commit/c2f0f81b262d5d10e27bb200fadaf60728d6c6a3"><code>c2f0f81</code></a>
Switch to actions/cache@v4</li>
<li><a
href="https://github.com/bats-core/bats-action/commit/e40c55d245f79cd42777263b070ee648a46e9b87"><code>e40c55d</code></a>
[create-pull-request] automated change</li>
<li>See full diff in <a
href="https://github.com/bats-core/bats-action/compare/1.5.4...1.5.5">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=bats-core/bats-action&package-manager=github_actions&previous-version=1.5.4&new-version=1.5.5)](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>
…elease from 9.1.0 to 9.1.1 (#462)

Bumps
[python-semantic-release/python-semantic-release](https://github.com/python-semantic-release/python-semantic-release)
from 9.1.0 to 9.1.1.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/python-semantic-release/python-semantic-release/releases">python-semantic-release/python-semantic-release's
releases</a>.</em></p>
<blockquote>
<h1>v9.1.1 (2024-02-25)</h1>
<h2>Fix</h2>
<ul>
<li>fix(parse_git_url): fix bad url with dash (<a
href="https://github.com/python-semantic-release/python-semantic-release/commit/1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33"><code>1c25b8e</code></a>)</li>
</ul>
<h2>Style</h2>
<ul>
<li>style: beautify 1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33 (<a
href="https://github.com/python-semantic-release/python-semantic-release/commit/85b2a2f5cf4c49aa3e394dfe3574e24266f93bfc"><code>85b2a2f</code></a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/python-semantic-release/python-semantic-release/blob/master/CHANGELOG.md">python-semantic-release/python-semantic-release's
changelog</a>.</em></p>
<blockquote>
<h2>v9.1.1 (2024-02-25)</h2>
<h3>Fix</h3>
<ul>
<li>fix(parse_git_url): fix bad url with dash (<a
href="https://github.com/python-semantic-release/python-semantic-release/commit/1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33"><code>1c25b8e</code></a>)</li>
</ul>
<h3>Style</h3>
<ul>
<li>style: beautify 1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33 (<a
href="https://github.com/python-semantic-release/python-semantic-release/commit/85b2a2f5cf4c49aa3e394dfe3574e24266f93bfc"><code>85b2a2f</code></a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/python-semantic-release/python-semantic-release/commit/c82bd673c30da94a02e039963c8c4c8a51758096"><code>c82bd67</code></a>
9.1.1</li>
<li><a
href="https://github.com/python-semantic-release/python-semantic-release/commit/85b2a2f5cf4c49aa3e394dfe3574e24266f93bfc"><code>85b2a2f</code></a>
style: beautify 1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33</li>
<li><a
href="https://github.com/python-semantic-release/python-semantic-release/commit/1c25b8e6f1e43c15ca7d5a59dca0a13767f9bc33"><code>1c25b8e</code></a>
fix(parse_git_url): fix bad url with dash</li>
<li>See full diff in <a
href="https://github.com/python-semantic-release/python-semantic-release/compare/v9.1.0...v9.1.1">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=python-semantic-release/python-semantic-release&package-manager=github_actions&previous-version=9.1.0&new-version=9.1.1)](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>
Bumps [poethepoet](https://github.com/nat-n/poethepoet) from 0.24.4 to
0.25.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/nat-n/poethepoet/releases">poethepoet's
releases</a>.</em></p>
<blockquote>
<h2>v0.25.0</h2>
<h2>Enhancements</h2>
<ul>
<li>Make args work as expected on ref tasks by <a
href="https://github.com/nat-n"><code>@​nat-n</code></a> in <a
href="https://redirect.github.com/nat-n/poethepoet/pull/201">nat-n/poethepoet#201</a></li>
</ul>
<p><strong>Full Changelog</strong>: <a
href="https://github.com/nat-n/poethepoet/compare/v0.24.4...v0.25.0">https://github.com/nat-n/poethepoet/compare/v0.24.4...v0.25.0</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/nat-n/poethepoet/commit/b57f631194e4d3d92d4e08550fe0eeaa065e63e4"><code>b57f631</code></a>
Bump version to 0.25.0</li>
<li><a
href="https://github.com/nat-n/poethepoet/commit/49aa93c5fea14dc7b430b01cf6888cea7ee8f142"><code>49aa93c</code></a>
Make args work as expected on ref tasks (<a
href="https://redirect.github.com/nat-n/poethepoet/issues/201">#201</a>)</li>
<li>See full diff in <a
href="https://github.com/nat-n/poethepoet/compare/v0.24.4...v0.25.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=poethepoet&package-manager=pip&previous-version=0.24.4&new-version=0.25.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>
Bumps [pytest](https://github.com/pytest-dev/pytest) from 8.0.1 to
8.0.2.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/pytest-dev/pytest/releases">pytest's
releases</a>.</em></p>
<blockquote>
<h2>8.0.2</h2>
<h1>pytest 8.0.2 (2024-02-24)</h1>
<h2>Bug Fixes</h2>
<ul>
<li><a
href="https://redirect.github.com/pytest-dev/pytest/issues/11895">#11895</a>:
Fix collection on Windows where initial paths contain the short version
of a path (for example <code>c:\PROGRA~1\tests</code>).</li>
<li><a
href="https://redirect.github.com/pytest-dev/pytest/issues/11953">#11953</a>:
Fix an <code>IndexError</code> crash raising from
<code>getstatementrange_ast</code>.</li>
<li><a
href="https://redirect.github.com/pytest-dev/pytest/issues/12021">#12021</a>:
Reverted a fix to [--maxfail]{.title-ref} handling in pytest 8.0.0
because it caused a regression in pytest-xdist whereby session fixture
teardowns may get executed multiple times when the max-fails is
reached.</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/pytest-dev/pytest/commit/31afeeb0df0e8bdab1325b5992a2cc733e981e82"><code>31afeeb</code></a>
Prepare release version 8.0.2</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/1b00a2f4fba7859c31dab4f5afdd9e1f07cbdd1e"><code>1b00a2f</code></a>
Merge pull request <a
href="https://redirect.github.com/pytest-dev/pytest/issues/12025">#12025</a>
from pytest-dev/backport-12022-to-8.0.x</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/ff2f66d84affb0fbcbf841b1897c7599026730bc"><code>ff2f66d</code></a>
[8.0.x] Revert &quot;Fix teardown error reporting when
<code>--maxfail=1</code> (<a
href="https://redirect.github.com/pytest-dev/pytest/issues/11721">#11721</a>)&quot;</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/8a8eed609c3c20da452446e1686df41ebda96d11"><code>8a8eed6</code></a>
[8.0.x] Fix collection of short paths on Windows (<a
href="https://redirect.github.com/pytest-dev/pytest/issues/12024">#12024</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/74346f027c205e5daffe66801094293744e8d85f"><code>74346f0</code></a>
[8.0.x] Allow Sphinx 7.x (<a
href="https://redirect.github.com/pytest-dev/pytest/issues/12005">#12005</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/b7657b4d6b69ee26e00d9a71c4d208506f644462"><code>b7657b4</code></a>
[8.0.x] Disallow Sphinx 6 and 7 (<a
href="https://redirect.github.com/pytest-dev/pytest/issues/12001">#12001</a>)</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/feb7c5e12ee3374b2c7c773614d76811ad21a4f4"><code>feb7c5e</code></a>
Merge pull request <a
href="https://redirect.github.com/pytest-dev/pytest/issues/11999">#11999</a>
from pytest-dev/backport-11996-to-8.0.x</li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/090965574ece50c6be955719ced2a9cf8daaee17"><code>0909655</code></a>
[8.0.x] code: fix <code>IndexError</code> crash in
<code>getstatementrange_ast</code></li>
<li><a
href="https://github.com/pytest-dev/pytest/commit/68524d48586e7f8d070fc1146e5ff90e770d0382"><code>68524d4</code></a>
Merge pull request <a
href="https://redirect.github.com/pytest-dev/pytest/issues/11993">#11993</a>
from pytest-dev/release-8.0.1</li>
<li>See full diff in <a
href="https://github.com/pytest-dev/pytest/compare/8.0.1...8.0.2">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=pytest&package-manager=pip&previous-version=8.0.1&new-version=8.0.2)](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>
Bumps [coverage](https://github.com/nedbat/coveragepy) from 7.4.2 to
7.4.3.
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/nedbat/coveragepy/blob/master/CHANGES.rst">coverage's
changelog</a>.</em></p>
<blockquote>
<h2>Version 7.4.3 — 2024-02-23</h2>
<ul>
<li>Fix: in some cases, coverage could fail with a RuntimeError:
&quot;Set changed
size during iteration.&quot; This is now fixed, closing <code>issue
1733</code>_.</li>
</ul>
<p>.. _issue 1733: <a
href="https://redirect.github.com/nedbat/coveragepy/issues/1733">nedbat/coveragepy#1733</a></p>
<p>.. _changes_7-4-2:</p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/nedbat/coveragepy/commit/1af36247955118a351999f40a6049baa179583ce"><code>1af3624</code></a>
docs: sample HTML for 7.4.3</li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/f06c5e43f7dd3c0f6734120fc002212fd069efa3"><code>f06c5e4</code></a>
docs: prep for 7.4.3</li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/08fc997b6b3d881e8e5082b71ad6d6bcc4e2f752"><code>08fc997</code></a>
fix: get atomic copies of iterables when flushing data. <a
href="https://redirect.github.com/nedbat/coveragepy/issues/1733">#1733</a></li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/4e34571a0b18c8819cfa27e3149e05edfb397198"><code>4e34571</code></a>
build: put a time limit on the Python nightly tests</li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/a1d8d2961c9793cf8d3fa09666012190cdec9214"><code>a1d8d29</code></a>
build: make targets should use underscores not dashes</li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/f7d40a0f11f1830596a359db81d4b505415f7908"><code>f7d40a0</code></a>
build: tweak the release instructions</li>
<li><a
href="https://github.com/nedbat/coveragepy/commit/0f19b82390ad1bf57b617d0820b07766d90011c1"><code>0f19b82</code></a>
build: bump version</li>
<li>See full diff in <a
href="https://github.com/nedbat/coveragepy/compare/7.4.2...7.4.3">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=coverage&package-manager=pip&previous-version=7.4.2&new-version=7.4.3)](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>
@JordoHeffernan
Copy link
Contributor

Apologies for this not being clearer in the AC, but the intent for this ticket was to also go through all the files that currently live in the actions directory (so build.py, scan.py etc.). And move those to the newly created actions.py file. I also think it might help to call that file actions_models.py? I could go either way on that though.

JordoHeffernan and others added 5 commits February 27, 2024 14:04
secureli-432

<!-- Include general description here -->
Improve UX by adding informational print to the console while update
action is running.

## Changes
<!-- A detailed list of changes -->
* Added progress bar from Rich package to indicate that repos are
updating

## 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.
 -->
* All existing unit tests are passing
* Screenshot of progress bar:

![image](https://github.com/slalombuild/secureli/assets/127901972/3c4e7a8e-72b0-40d8-a732-b7001a13f592)

## Clean Code Checklist
<!-- This is here to support you. Some/most checkboxes may not apply to
your change -->
- [x] 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
- [x] No commented-out code included


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

Co-authored-by: Jordan Heffernan <[email protected]>
secureli-466

<!-- Include general description here -->
Fix for issue where secureli --version errors out when not run in a repo
that has secureli initialized.

## Changes
<!-- A detailed list of changes -->
* Fixed bug

## 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.
 -->
* Added unit tests
* All existing unit tests passing

## 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
- [ ] Appropriate exception handling added
- [ ] Thoughtful logging included
- [ ] Documentation is updated
- [ ] Follow-up work is documented in TODOs
- [ ] 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
-->
secureli-442

Includes links to external documentation in `CONTRIBUTING.md`


## Changes
* Includes links to external docs

## Testing
* N/A

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


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

---------

Co-authored-by: Kathleen Hogan <[email protected]>
Co-authored-by: Jordan Heffernan <[email protected]>
@kevin-orlando
Copy link
Contributor Author

Apologies for this not being clearer in the AC, but the intent for this ticket was to also go through all the files that currently live in the actions directory (so build.py, scan.py etc.). And move those to the newly created actions.py file. I also think it might help to call that file actions_models.py? I could go either way on that though.

The action file ended up being the only one with model classes, but let me know if I'm missing something!

I named the model file actions.py since it was nested under a model folder already and the import seemed cleaner with secureli.shared.models.actions. Let me know if that works or if the other way seems better.

@kevin-orlando kevin-orlando changed the base branch from main to refactor/secureli-000-modular-refactor February 28, 2024 04:33
@JordoHeffernan
Copy link
Contributor

Apologies for this not being clearer in the AC, but the intent for this ticket was to also go through all the files that currently live in the actions directory (so build.py, scan.py etc.). And move those to the newly created actions.py file. I also think it might help to call that file actions_models.py? I could go either way on that though.

The action file ended up being the only one with model classes, but let me know if I'm missing something!

I named the model file actions.py since it was nested under a model folder already and the import seemed cleaner with secureli.shared.models.actions. Let me know if that works or if the other way seems better.

That naming convention works for me, just wanted to double check. And after looking at the other files, you're totally right about action.py being the only file with model classes in it.

@isaac-heist-slalom it is now targeting the refactor branch, if this goes in, are you far enough along that it will cause major MCs? If so maybe hold off just a little bit for this and the other PR that's open to keep going on the restructure

@kevin-orlando kevin-orlando deleted the feature/secureli-440-move-action-shared-items branch March 1, 2024 23:55
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.

Move all model class items from ACTION files to shared/models.py
4 participants