Use mock github when in dry run mode (#355)

Author: blink1073

jupyter_releaser/actions/common.py

@@ -1,6 +1,8 @@
 import os
+import tempfile
 from contextlib import contextmanager
 
+from jupyter_releaser.util import ensure_mock_github
 from jupyter_releaser.util import run as _run
 
 
@@ -30,6 +32,12 @@ def setup():
                 print(f"Using GITHUB_REF: {ref}")
                 os.environ["RH_BRANCH"] = "/".join(ref.split("/")[2:])
 
+        if os.environ.get("RH_DRY_RUN", "").lower() == "true":
+            static_dir = os.path.join(tempfile.gettempdir(), "gh_static")
+            os.makedirs(static_dir, exist_ok=True)
+            os.environ["RH_GITHUB_STATIC_DIR"] = static_dir
+            ensure_mock_github()
+
 
 def run_action(target, *args, **kwargs):
     with make_group(target):

jupyter_releaser/changelog.py

@@ -3,7 +3,6 @@
 import re
 from pathlib import Path
 
-from ghapi.core import GhApi
 from github_activity import generate_activity_md
 
 from jupyter_releaser import util
@@ -13,7 +12,7 @@
 PR_PREFIX = "Automated Changelog Entry"
 
 
-def format_pr_entry(target, number, auth=None):
+def format_pr_entry(target, number, auth=None, dry_run=False):
     """Format a PR entry in the style used by our changelogs.
 
     Parameters
@@ -24,14 +23,16 @@ def format_pr_entry(target, number, auth=None):
         The PR number to resolve
     auth : str, optional
         The GitHub authorization token
+    dry_run: bool, optional
+        Whether this is a dry run.
 
     Returns
     -------
     str
         A formatted PR entry
     """
     owner, repo = target.split("/")
-    gh = GhApi(owner=owner, repo=repo, token=auth)
+    gh = util.get_gh_object(dry_run=dry_run, owner=owner, repo=repo, token=auth)
     pull = gh.pulls.get(number)
     title = pull.title
     url = pull.html_url
@@ -51,6 +52,7 @@ def get_version_entry(
     until=None,
     auth=None,
     resolve_backports=False,
+    dry_run=False,
 ):
     """Get a changelog for the changes since the last tag on the given branch.
 
@@ -74,6 +76,8 @@ def get_version_entry(
         The GitHub authorization token
     resolve_backports: bool, optional
         Whether to resolve backports to the original PR
+    dry_run: bool, optional
+        Whether this is a dry run.
 
     Returns
     -------
@@ -120,7 +124,7 @@ def get_version_entry(
         # Look for a backport, either manual or automatic.
         match = re.search(r"Backport PR #(\d+) on branch", line)
         if match:
-            entry[ind] = format_pr_entry(repo, match.groups()[0])
+            entry[ind] = format_pr_entry(repo, match.groups()[0], dry_run=dry_run)
 
     # Remove github actions PRs
     gh_actions = "[@github-actions](https://github.com/github-actions)"

jupyter_releaser/cli.py

@@ -578,11 +578,12 @@ def draft_release(
 
 @main.command()
 @add_options(auth_options)
+@add_options(dry_run_options)
 @click.argument("release-url", nargs=1)
 @use_checkout_dir()
-def delete_release(auth, release_url):
+def delete_release(auth, dry_run, release_url):
     """Delete a draft GitHub release by url to the release page"""
-    lib.delete_release(auth, release_url)
+    lib.delete_release(auth, release_url, dry_run)
 
 
 @main.command()
@@ -675,11 +676,12 @@ def publish_assets(
 
 @main.command()
 @add_options(auth_options)
+@add_options(dry_run_options)
 @click.argument("release-url", nargs=1)
 @use_checkout_dir()
-def publish_release(auth, release_url):
+def publish_release(auth, dry_run, release_url):
     """Publish GitHub release"""
-    lib.publish_release(auth, release_url)
+    lib.publish_release(auth, dry_run, release_url)
 
 
 @main.command()

jupyter_releaser/lib.py

@@ -14,7 +14,6 @@
 
 import requests
 import toml
-from ghapi.core import GhApi
 from packaging.version import parse as parse_version
 from pkginfo import SDist, Wheel
 
@@ -183,17 +182,14 @@ def make_changelog_pr(auth, branch, repo, title, commit_message, body, dry_run=F
 
     # Create the pull
     owner, repo_name = repo.split("/")
-    gh = GhApi(owner=owner, repo=repo_name, token=auth)
+    gh = util.get_gh_object(dry_run=dry_run, owner=owner, repo=repo_name, token=auth)
 
     base = branch
     head = pr_branch
     maintainer_can_modify = True
 
-    if dry_run:
-        util.log("Skipping pull request due to dry run")
-        return
-
-    util.run(f"git push origin {pr_branch}")
+    if not dry_run:
+        util.run(f"git push origin {pr_branch}")
 
     #  title, head, base, body, maintainer_can_modify, draft, issue
     pull = gh.pulls.create(title, head, base, body, maintainer_can_modify, False, None)
@@ -255,11 +251,8 @@ def draft_release(
         util.log(post_version_message.format(post_version=post_version))
         util.run(f'git commit -a -m "Bump to {post_version}"')
 
-    if dry_run:
-        return
-
     owner, repo_name = repo.split("/")
-    gh = GhApi(owner=owner, repo=repo_name, token=auth)
+    gh = util.get_gh_object(dry_run=dry_run, owner=owner, repo=repo_name, token=auth)
 
     # Remove draft releases over a day old
     if bool(os.environ.get("GITHUB_ACTIONS")):
@@ -273,7 +266,7 @@ def draft_release(
                 gh.repos.delete_release(release.id)
 
     remote_url = util.run("git config --get remote.origin.url")
-    if not os.path.exists(remote_url):
+    if not dry_run and not os.path.exists(remote_url):
         util.run(f"git push origin HEAD:{branch} --follow-tags --tags")
 
     util.log(f"Creating release for {version}")
@@ -292,14 +285,14 @@ def draft_release(
     util.actions_output("release_url", release.html_url)
 
 
-def delete_release(auth, release_url):
+def delete_release(auth, release_url, dry_run=False):
     """Delete a draft GitHub release by url to the release page"""
     match = re.match(util.RELEASE_HTML_PATTERN, release_url)
     match = match or re.match(util.RELEASE_API_PATTERN, release_url)
     if not match:
         raise ValueError(f"Release url is not valid: {release_url}")
 
-    gh = GhApi(owner=match["owner"], repo=match["repo"], token=auth)
+    gh = util.get_gh_object(dry_run=dry_run, owner=match["owner"], repo=match["repo"], token=auth)
     release = util.release_for_url(gh, release_url)
     for asset in release.assets:
         gh.repos.delete_release_asset(asset.id)
@@ -320,7 +313,8 @@ def extract_release(
     """Download and verify assets from a draft GitHub release"""
     match = parse_release_url(release_url)
     owner, repo = match["owner"], match["repo"]
-    gh = GhApi(owner=owner, repo=repo, token=auth)
+
+    gh = util.get_gh_object(dry_run=dry_run, owner=owner, repo=repo, token=auth)
     release = util.release_for_url(gh, release_url)
     branch = release.target_commitish
     assets = release.assets
@@ -494,14 +488,14 @@ def publish_assets(
         util.log("No files to upload")
 
 
-def publish_release(auth, release_url):
+def publish_release(auth, dry_run, release_url):
     """Publish GitHub release"""
     util.log(f"Publishing {release_url}")
 
     match = parse_release_url(release_url)
 
     # Take the release out of draft
-    gh = GhApi(owner=match["owner"], repo=match["repo"], token=auth)
+    gh = util.get_gh_object(dry_run=dry_run, owner=match["owner"], repo=match["repo"], token=auth)
     release = util.release_for_url(gh, release_url)
 
     release = gh.repos.update_release(
@@ -625,7 +619,8 @@ def forwardport_changelog(auth, ref, branch, repo, username, changelog_path, dry
     """Forwardport Changelog Entries to the Default Branch"""
     # Set up the git repo with the branch
     match = parse_release_url(release_url)
-    gh = GhApi(owner=match["owner"], repo=match["repo"], token=auth)
+
+    gh = util.get_gh_object(dry_run=dry_run, owner=match["owner"], repo=match["repo"], token=auth)
     release = util.release_for_url(gh, release_url)
     tag = release.tag_name
     source_branch = release.target_commitish

jupyter_releaser/mock_github.py

@@ -1,6 +1,7 @@
 import atexit
 import datetime
 import os
+import pickle
 import tempfile
 import uuid
 from typing import Dict, List
@@ -13,14 +14,34 @@
 
 app = FastAPI()
 
-static_dir = tempfile.TemporaryDirectory()
-atexit.register(static_dir.cleanup)
-app.mount("/static", StaticFiles(directory=static_dir.name), name="static")
+if "RH_GITHUB_STATIC_DIR" in os.environ:
+    static_dir = os.environ["RH_GITHUB_STATIC_DIR"]
+else:
+    static_dir_obj = tempfile.TemporaryDirectory()
+    atexit.register(static_dir_obj.cleanup)
+    static_dir = static_dir_obj.name
 
-releases: Dict[int, "Release"] = {}
-pulls: Dict[int, "PullRequest"] = {}
-release_ids_for_asset: Dict[int, int] = {}
-tag_refs: Dict[str, "Tag"] = {}
+app.mount("/static", StaticFiles(directory=static_dir), name="static")
+
+
+def load_from_pickle(name):
+    source_file = os.path.join(static_dir, name + ".pkl")
+    if not os.path.exists(source_file):
+        return {}
+    with open(source_file, "rb") as fid:
+        return pickle.load(fid)
+
+
+def write_to_pickle(name, data):
+    source_file = os.path.join(static_dir, name + ".pkl")
+    with open(source_file, "wb") as fid:
+        pickle.dump(data, fid)
+
+
+releases: Dict[int, "Release"] = load_from_pickle("releases")
+pulls: Dict[int, "PullRequest"] = load_from_pickle("pulls")
+release_ids_for_asset: Dict[int, int] = load_from_pickle("release_ids_for_asset")
+tag_refs: Dict[str, "Tag"] = load_from_pickle("tag_refs")
 
 
 class Asset(BaseModel):
@@ -112,6 +133,7 @@ async def create_a_release(owner: str, repo: str, request: Request) -> Release:
         **data,
     )
     releases[model.id] = model
+    write_to_pickle("releases", releases)
     return model
 
 
@@ -122,6 +144,7 @@ async def update_a_release(owner: str, repo: str, release_id: int, request: Requ
     model = releases[release_id]
     for name, value in data.items():
         setattr(model, name, value)
+    write_to_pickle("releases", releases)
     return model
 
 
@@ -131,7 +154,7 @@ async def upload_a_release_asset(owner: str, repo: str, release_id: int, request
     model = releases[release_id]
     asset_id = uuid.uuid4().int
     name = request.query_params["name"]
-    with open(f"{static_dir.name}/{asset_id}", "wb") as fid:
+    with open(f"{static_dir}/{asset_id}", "wb") as fid:
         async for chunk in request.stream():
             fid.write(chunk)
     headers = request.headers
@@ -145,27 +168,34 @@ async def upload_a_release_asset(owner: str, repo: str, release_id: int, request
     )
     release_ids_for_asset[asset_id] = release_id
     model.assets.append(asset)
+    write_to_pickle("releases", releases)
+    write_to_pickle("release_ids_for_asset", release_ids_for_asset)
 
 
 @app.delete("/repos/{owner}/{repo}/releases/assets/{asset_id}")
 async def delete_a_release_asset(owner: str, repo: str, asset_id: int) -> None:
     """https://docs.github.com/en/rest/releases/assets#delete-a-release-asset"""
     release = releases[release_ids_for_asset[asset_id]]
-    os.remove(f"{static_dir.name}/{asset_id}")
+    os.remove(f"{static_dir}/{asset_id}")
     release.assets = [a for a in release.assets if a.id != asset_id]
+    del release_ids_for_asset[asset_id]
+    write_to_pickle("releases", releases)
+    write_to_pickle("release_ids_for_asset", release_ids_for_asset)
 
 
 @app.delete("/repos/{owner}/{repo}/releases/{release_id}")
 def delete_a_release(owner: str, repo: str, release_id: int) -> None:
     """https://docs.github.com/en/rest/releases/releases#delete-a-release"""
     del releases[release_id]
+    write_to_pickle("releases", releases)
 
 
 @app.get("/repos/{owner}/{repo}/pulls/{pull_number}")
 def get_a_pull_request(owner: str, repo: str, pull_number: int) -> PullRequest:
     """https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request"""
     if pull_number not in pulls:
         pulls[pull_number] = PullRequest()
+    write_to_pickle("pulls", pulls)
     return pulls[pull_number]
 
 
@@ -174,6 +204,7 @@ def create_a_pull_request(owner: str, repo: str) -> PullRequest:
     """https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request"""
     pull = PullRequest()
     pulls[pull.number] = pull
+    write_to_pickle("releases", releases)
     return pull
 
 
@@ -188,6 +219,7 @@ def create_tag_ref(tag_ref: str, sha: str) -> None:
     """Create a remote tag ref object for testing"""
     tag = Tag(ref=f"refs/tags/{tag_ref}", object=TagObject(sha=sha))
     tag_refs[tag_ref] = tag
+    write_to_pickle("tag_refs", tag_refs)
 
 
 @app.get("/repos/{owner}/{repo}/git/matching-refs/tags/{tag_ref}")

jupyter_releaser/tests/conftest.py

@@ -6,12 +6,11 @@
 from pathlib import Path
 
 from click.testing import CliRunner
-from ghapi import core
 from pytest import fixture
 
 from jupyter_releaser import cli, util
 from jupyter_releaser.tests import util as testutil
-from jupyter_releaser.util import MOCK_GITHUB_URL, run, start_mock_github
+from jupyter_releaser.util import ensure_mock_github, run
 
 
 @fixture(autouse=True)
@@ -26,7 +25,6 @@ def mock_env(mocker):
                 del env[key]
 
     mocker.patch.dict(os.environ, env, clear=True)
-    core.GH_HOST = MOCK_GITHUB_URL
 
     try:
         run("git config --global user.name")
@@ -191,8 +189,9 @@ def wrapped(cmd, **kwargs):
 
 @fixture
 def mock_github():
-    proc = start_mock_github()
+    proc = ensure_mock_github()
     yield proc
 
-    proc.kill()
-    proc.wait()
+    if proc:
+        proc.kill()
+        proc.wait()