cleanup; tests for github cli

Author: vivus-ignis

tests/github/test_create_github_release_notes.py

@@ -70,22 +70,17 @@ def test_github_release_page(monkeypatch, downloads_dir, release_s3_bucket):
     class SubmoduleAsRepo(Repo):
         """This will fake a git submodule as a git repository object."""
         def __new__(cls, *args, **kwargs):
-            print('In SubmoduleAsRepo.__new__')
             r = super().__new__(Repo)
             r.__init__(*args, **kwargs)
-            print(f'{r=}')
 
             maybe_gl_submodule = [submodule for submodule in r.submodules if submodule.name.endswith("/gardenlinux")]
             if not maybe_gl_submodule:
                 return r
             else:
                 gl = maybe_gl_submodule[0]
-            print(f'{gl=}')
 
             sr = gl.module()
-            print(f'{sr=}')
             sr.remotes.origin.pull("main")
-            print('git pull done')
             return sr
 
     monkeypatch.setattr("gardenlinux.github.release_notes.helpers.Repo", SubmoduleAsRepo)

tests/github/test_github_script.py

@@ -0,0 +1,80 @@
+import sys
+
+import pytest
+
+import gardenlinux.github.__main__ as gh
+from gardenlinux.constants import GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME
+
+from ..constants import TEST_GARDENLINUX_COMMIT, TEST_GARDENLINUX_RELEASE
+
+
+def test_script_parse_args_wrong_command(monkeypatch, capfd):
+    monkeypatch.setattr(sys, "argv", ["gh", "rejoice"])
+
+    with pytest.raises(SystemExit):
+        gh.main()
+    captured = capfd.readouterr()
+
+    assert "argument command: invalid choice: 'rejoice'" in captured.err, "Expected help message printed"
+
+
+def test_script_parse_args_create_command_required_args(monkeypatch, capfd):
+    monkeypatch.setattr(sys, "argv", ["gh", "create", "--owner", "gardenlinux", "--repo", "gardenlinux"])
+
+    with pytest.raises(SystemExit):
+        gh.main()
+    captured = capfd.readouterr()
+
+    assert "the following arguments are required: --tag, --commit" in captured.err, \
+        "Expected help message on missing arguments for 'create' command"
+
+
+def test_script_parse_args_upload_command_required_args(monkeypatch, capfd):
+    monkeypatch.setattr(sys, "argv", ["gh", "upload", "--owner", "gardenlinux", "--repo", "gardenlinux"])
+
+    with pytest.raises(SystemExit):
+        gh.main()
+    captured = capfd.readouterr()
+
+    assert "the following arguments are required: --release_id, --file_path" in captured.err, \
+        "Expected help message on missing arguments for 'upload' command"
+
+
+def test_script_create_dry_run(monkeypatch, capfd):
+
+    monkeypatch.setattr(sys, "argv", ["gh", "create", "--owner", "gardenlinux", "--repo",
+                        "gardenlinux", "--tag", TEST_GARDENLINUX_RELEASE, "--commit", TEST_GARDENLINUX_COMMIT, "--dry-run"])
+    monkeypatch.setattr("gardenlinux.github.__main__.create_github_release_notes",
+                        lambda tag, commit, bucket: f"{tag} {commit} {bucket}")
+
+    gh.main()
+    captured = capfd.readouterr()
+
+    assert captured.out == f"Dry Run ...\nThis release would be created:\n{TEST_GARDENLINUX_RELEASE} {TEST_GARDENLINUX_COMMIT} {GARDENLINUX_GITHUB_RELEASE_BUCKET_NAME}\n", \
+        "Expected dry-run create to return generated release notes text"
+
+
+def test_script_create(monkeypatch, caplog):
+    monkeypatch.setattr(sys, "argv", ["gh", "create", "--owner", "gardenlinux", "--repo",
+                        "gardenlinux", "--tag", TEST_GARDENLINUX_RELEASE, "--commit", TEST_GARDENLINUX_COMMIT])
+    monkeypatch.setattr("gardenlinux.github.__main__.create_github_release_notes",
+                        lambda tag, commit, bucket: f"{tag} {commit} {bucket}")
+    monkeypatch.setattr("gardenlinux.github.__main__.create_github_release",
+                        lambda a1, a2, a3, a4, a5, a6: TEST_GARDENLINUX_RELEASE)
+
+    gh.main()
+
+    assert any(f"Release created with ID: {TEST_GARDENLINUX_RELEASE}" in record.message for record in caplog.records), \
+        "Expected a release creation confirmation log entry"
+
+
+def test_script_upload_dry_run(monkeypatch, capfd):
+    monkeypatch.setattr(sys, "argv", ["gh", "upload", "--owner", "gardenlinux", "--repo",
+                        "gardenlinux", "--release_id", TEST_GARDENLINUX_RELEASE, "--file_path", "foo", "--dry-run"])
+    monkeypatch.setattr("gardenlinux.github.__main__.upload_to_github_release_page",
+                        lambda a1, a2, a3, a4, dry_run: print(f"dry-run: {dry_run}"))
+
+    gh.main()
+    captured = capfd.readouterr()
+
+    assert captured.out == "dry-run: True\n"