test(refactor): test_update_actions to use Action rather than dataclasses.OwnerRepo | dataclasses.CommitVersion

Author: Sven Siegmund

ruff.toml

@@ -45,6 +45,7 @@ select = [
     "N811",    # constant-imported-as-non-constant
 ]
 "tests/e2e/test_update_actions.py" = [
+    "F401",    # unused-import
     "N811",    # constant-imported-as-non-constant
 ]
 

scripts/update-test_update_actions.sh

@@ -34,12 +34,12 @@ actions_from_all_workflows() {
 
 get_actions_from_all_workflows_with_their_latest_commits_and_versions() {
     actions_from_all_workflows | while read owner repo old_commit old_version; do
-        url="https://api.github.com/repos/$owner/$repo/tags" 
+        url="https://api.github.com/repos/$owner/$repo/tags"
 
         if [ -n "$CI_STARTER_GH_API_TOKEN" ]; then
-            tags=$(curl -s -H "Authorization: token $CI_STARTER_GH_API_TOKEN" "$url")
+            tags=$(curl -sS -H "Authorization: token $CI_STARTER_GH_API_TOKEN" "$url")
         else
-            tags=$(curl -s "$url")
+            tags=$(curl -sS "$url")
         fi
 
         latest_release=$(echo "$tags" | jq -rc '.[0]')
@@ -62,7 +62,9 @@ find_line_where_original_code_continues() {
 
 generate_code() {
     get_actions_from_all_workflows_with_their_latest_commits_and_versions | while read owner repo commit version; do
-        printf "    expected_actions[OwnerRepo(\"%s\", \"%s\")] = CommitVersion(\"%s\", \"%s\")\n" "$owner" "$repo" "$commit" "$version"
+        name="$owner/$repo"
+        printf '    expected_actions["%s"] = Action(owner="%s", repo="%s", commit="%s", version=Version.parse("%s"),)\n' \
+            "$name" "$owner" "$repo" "$commit" "$version"
     done
     printf "\n"
 }

tests/e2e/test_update_actions.py

@@ -2,10 +2,11 @@
 
 from click.testing import CliRunner, Result
 from ruamel.yaml import YAML as Yaml
+from semver.version import Version
 
+from ci_starter.action import Action
 from ci_starter.cli import cli
 from ci_starter.constants import GITHUB_WORKFLOWS_DIR
-from ci_starter.dataclasses import CommitVersion, OwnerRepo
 from ci_starter.utils import get_actions
 from tests.e2e.constants import SUCCESSFUL_RETURN_CODE
 
@@ -18,34 +19,59 @@ def test_update_action(cli_runner: CliRunner, test_project_path_str, step_parser
 
     workflows = Path(test_project_path_str, GITHUB_WORKFLOWS_DIR).rglob("*.yml")
 
-    expected_actions: dict[OwnerRepo, CommitVersion] = {}
+    expected_actions: dict[str, Action] = {}
 
     # adding keys and values to expected_actions is managed by scripts/update-test_update_actions.sh
-    expected_actions[OwnerRepo("actions", "checkout")] = CommitVersion(
-        "08c6903cd8c0fde910a37f88322edcfb5dd907a8", "5.0.0"
+    expected_actions["actions/checkout"] = Action(
+        owner="actions",
+        repo="checkout",
+        commit="08c6903cd8c0fde910a37f88322edcfb5dd907a8",
+        version=Version.parse("5.0.0"),
     )
-    expected_actions[OwnerRepo("actions", "download-artifact")] = CommitVersion(
-        "634f93cb2916e3fdff6788551b99b062d0335ce0", "5.0.0"
+    expected_actions["actions/download-artifact"] = Action(
+        owner="actions",
+        repo="download-artifact",
+        commit="634f93cb2916e3fdff6788551b99b062d0335ce0",
+        version=Version.parse("5.0.0"),
     )
-    expected_actions[OwnerRepo("actions", "setup-python")] = CommitVersion(
-        "e797f83bcb11b83ae66e0230d6156d7c80228e7c", "6.0.0"
+    expected_actions["actions/setup-python"] = Action(
+        owner="actions",
+        repo="setup-python",
+        commit="e797f83bcb11b83ae66e0230d6156d7c80228e7c",
+        version=Version.parse("6.0.0"),
     )
-    expected_actions[OwnerRepo("actions", "upload-artifact")] = CommitVersion(
-        "ea165f8d65b6e75b540449e92b4886f43607fa02", "4.6.2"
+    expected_actions["actions/upload-artifact"] = Action(
+        owner="actions",
+        repo="upload-artifact",
+        commit="ea165f8d65b6e75b540449e92b4886f43607fa02",
+        version=Version.parse("4.6.2"),
     )
-    expected_actions[OwnerRepo("astral-sh", "ruff-action")] = CommitVersion(
-        "57714a7c8a2e59f32539362ba31877a1957dded1", "3.5.1"
+    expected_actions["astral-sh/ruff-action"] = Action(
+        owner="astral-sh",
+        repo="ruff-action",
+        commit="57714a7c8a2e59f32539362ba31877a1957dded1",
+        version=Version.parse("3.5.1"),
     )
-    expected_actions[OwnerRepo("astral-sh", "setup-uv")] = CommitVersion(
-        "eb1897b8dc4b5d5bfe39a428a8f2304605e0983c", "7.0.0"
+    expected_actions["astral-sh/setup-uv"] = Action(
+        owner="astral-sh",
+        repo="setup-uv",
+        commit="eb1897b8dc4b5d5bfe39a428a8f2304605e0983c",
+        version=Version.parse("7.0.0"),
     )
-    expected_actions[OwnerRepo("pypa", "gh-action-pypi-publish")] = CommitVersion(
-        "ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e", "1.13.0"
+    expected_actions["pypa/gh-action-pypi-publish"] = Action(
+        owner="pypa",
+        repo="gh-action-pypi-publish",
+        commit="ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e",
+        version=Version.parse("1.13.0"),
     )
 
     for file in workflows:
         data = step_parser.load(file)
         for action in get_actions(data):
-            actual_commit_and_version = CommitVersion(action.commit, str(action.version))
-            expected_commit_and_version = expected_actions[OwnerRepo(action.owner, action.repo)]
-            assert actual_commit_and_version == expected_commit_and_version
+            actual_commit = action.commit
+            actual_version = action.version
+            expected_commit = expected_actions[action.name].commit
+            expected_version = expected_actions[action.name].version
+
+            assert actual_commit == expected_commit
+            assert actual_version == expected_version