Merge pull request #102 from afshin/clean-up

General code base clean up

Author: Steven Silvester

.github/actions/check-release/action.yml

@@ -35,7 +35,7 @@ runs:
         # Install Jupyter Releaser from git unless we are testing Releaser itself
         if ! command -v jupyter-releaser &> /dev/null
         then
-            pip install -q git+https://github.com/jupyter-server/jupyter_releaser.git
+            pip install -q git+https://github.com/jupyter-server/jupyter_releaser.git@v1
         fi
 
         export RH_IS_CHECK_RELEASE=true

.pre-commit-config.yaml

@@ -22,3 +22,8 @@ repos:
       - id: check-case-conflict
       - id: check-executables-have-shebangs
       - id: requirements-txt-fixer
+  - repo: https://github.com/pre-commit/mirrors-pylint
+    rev: v3.0.0a3
+    hooks:
+      - id: pylint
+        args: [--disable=all, --enable=unused-import]

jupyter_releaser/changelog.py

@@ -67,10 +67,9 @@ def get_version_entry(
     """
     since = since or util.get_latest_tag(branch)
 
-    branch = branch.split("/")[-1]
     util.log(f"Getting changes to {repo} since {since} on branch {branch}...")
 
-    until = util.run(f'git --no-pager log -n 1 origin/{branch} --pretty=format:"%H"')
+    until = util.run(f'git --no-pager log -n 1 {branch} --pretty=format:"%H"')
     until = until.replace("%", "")
 
     md = generate_activity_md(

jupyter_releaser/lib.py

@@ -9,7 +9,6 @@
 from glob import glob
 from pathlib import Path
 from subprocess import CalledProcessError
-from tempfile import TemporaryDirectory
 
 import requests
 from ghapi.core import GhApi
@@ -278,6 +277,9 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
     # Prepare a git checkout
     prep_git(None, branch, f"{owner}/{repo}", auth, None, None)
 
+    orig_dir = os.getcwd()
+    os.chdir(util.CHECKOUT_NAME)
+
     # Clean the dist folder
     dist = Path(dist_dir)
     if dist.exists():
@@ -318,8 +320,7 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
 
     # Get the commmit message for the tag
     commit_message = ""
-    checkout = osp.join(os.getcwd(), util.CHECKOUT_NAME)
-    commit_message = util.run(f"git log --format=%B -n 1 {sha}", cwd=checkout)
+    commit_message = util.run(f"git log --format=%B -n 1 {sha}")
 
     for asset in assets:
         # Check the sha against the published sha
@@ -337,6 +338,8 @@ def extract_release(auth, dist_dir, dry_run, release_url, npm_install_options):
         if not valid:  # pragma: no cover
             raise ValueError(f"Invalid file {asset.name}")
 
+    os.chdir(orig_dir)
+
 
 def parse_release_url(release_url):
     """Parse a release url into a regex match"""
@@ -354,7 +357,7 @@ def publish_assets(dist_dir, npm_token, npm_cmd, twine_cmd, dry_run):
         # in a temporary directory
         if len(glob(f"{dist_dir}/*.whl")):
             python.start_local_pypi()
-            twine_cmd = "twine upload --repository-url=http://localhost:8081"
+            twine_cmd = "twine upload --repository-url=http://0.0.0.0:8081"
             os.environ["TWINE_USERNAME"] = "foo"
             os.environ["TWINE_PASSWORD"] = "bar"
         npm_cmd = "npm publish --dry-run"
@@ -488,6 +491,12 @@ def prep_git(ref, branch, repo, auth, username, url):
     else:
         util.run(checkout_cmd)
 
+    # Check for detached head state, create branch if needed
+    try:
+        util.run("git symbolic-ref -q HEAD")
+    except Exception:
+        util.run(f"git switch -c {branch}")
+
     # Install the package
     # install python package in editable mode with test deps
     if util.SETUP_PY.exists():

jupyter_releaser/tests/conftest.py

@@ -3,14 +3,12 @@
 import json
 import os
 import os.path as osp
-import traceback
 from pathlib import Path
 from urllib.request import OpenerDirector
 
 from click.testing import CliRunner
 from pytest import fixture
 
-from jupyter_releaser import changelog
 from jupyter_releaser import cli
 from jupyter_releaser import util
 from jupyter_releaser.tests import util as testutil

jupyter_releaser/tests/test_cli.py

@@ -9,29 +9,19 @@
 from pathlib import Path
 from subprocess import CalledProcessError
 from unittest.mock import call
-from unittest.mock import MagicMock
-from unittest.mock import patch
-from unittest.mock import PropertyMock
 
 import pytest
-from pytest import fixture
 
 from jupyter_releaser import changelog
-from jupyter_releaser import cli
-from jupyter_releaser import npm
-from jupyter_releaser import python
 from jupyter_releaser import util
 from jupyter_releaser.tests.util import CHANGELOG_ENTRY
-from jupyter_releaser.tests.util import create_npm_package
-from jupyter_releaser.tests.util import create_python_package
 from jupyter_releaser.tests.util import get_log
 from jupyter_releaser.tests.util import HTML_URL
 from jupyter_releaser.tests.util import mock_changelog_entry
 from jupyter_releaser.tests.util import MockHTTPResponse
 from jupyter_releaser.tests.util import MockRequestResponse
 from jupyter_releaser.tests.util import PR_ENTRY
 from jupyter_releaser.tests.util import REPO_DATA
-from jupyter_releaser.tests.util import TOML_CONFIG
 from jupyter_releaser.tests.util import VERSION_SPEC
 from jupyter_releaser.util import bump_version
 from jupyter_releaser.util import normalize_path
@@ -58,6 +48,38 @@ def test_prep_git_pr(py_package, runner):
     assert util.get_branch() == "foo", util.get_branch()
 
 
+def test_prep_git_tag(py_package, runner):
+    tag = "v0.1"
+    util.run(f"git tag {tag}")
+    result = runner(
+        ["prep-git", "--git-url", py_package],
+        env=dict(GITHUB_ACTIONS="", RH_REF=f"refs/tags/{tag}", RH_BRANCH=tag),
+    )
+
+    log = get_log()
+    assert "before-prep-git" not in log
+    assert "after-prep-git" in log
+
+    os.chdir(util.CHECKOUT_NAME)
+    assert util.get_branch() == tag, util.get_branch()
+
+
+def test_prep_git_slashes(py_package, runner):
+    branch = "a/b/c"
+    util.run(f"git checkout -b {branch} foo")
+    result = runner(
+        ["prep-git", "--git-url", py_package],
+        env=dict(GITHUB_ACTIONS="", RH_REF=f"refs/heads/{branch}", RH_BRANCH=branch),
+    )
+
+    log = get_log()
+    assert "before-prep-git" not in log
+    assert "after-prep-git" in log
+
+    os.chdir(util.CHECKOUT_NAME)
+    assert util.get_branch() == branch, util.get_branch()
+
+
 def test_prep_git_full(py_package, tmp_path, mocker, runner):
     """Full GitHub Actions simulation (Push)"""
 
@@ -239,6 +261,37 @@ def test_build_changelog_backport(py_package, mocker, runner, open_mock):
     run("pre-commit run -a")
 
 
+def test_build_changelog_slashes(py_package, mocker, runner, open_mock):
+    branch = "a/b/c"
+    util.run(f"git checkout -b {branch} foo")
+    env = dict(RH_REF=f"refs/heads/{branch}", RH_BRANCH=branch)
+    run("pre-commit run -a")
+
+    changelog_path = "CHANGELOG.md"
+
+    runner(["prep-git", "--git-url", py_package], env=env)
+    runner(["bump-version", "--version-spec", VERSION_SPEC], env=env)
+
+    mocked_gen = mocker.patch("jupyter_releaser.changelog.generate_activity_md")
+    mocked_gen.return_value = CHANGELOG_ENTRY
+    runner(["build-changelog", "--changelog-path", changelog_path], env=env)
+
+    log = get_log()
+    assert "before-build-changelog" in log
+    assert "after-build-changelog" in log
+
+    changelog_path = Path(util.CHECKOUT_NAME) / "CHANGELOG.md"
+    text = changelog_path.read_text(encoding="utf-8")
+    assert changelog.START_MARKER in text
+    assert changelog.END_MARKER in text
+    assert PR_ENTRY in text
+
+    assert len(re.findall(changelog.START_MARKER, text)) == 1
+    assert len(re.findall(changelog.END_MARKER, text)) == 1
+
+    run("pre-commit run -a")
+
+
 def test_draft_changelog_full(py_package, mocker, runner, open_mock, git_prep):
     mock_changelog_entry(py_package, runner, mocker)
     runner(["draft-changelog", "--version-spec", VERSION_SPEC])
@@ -476,7 +529,7 @@ def test_extract_dist_py(py_package, runner, mocker, open_mock, tmp_path, git_pr
     shutil.move(f"{util.CHECKOUT_NAME}/dist", "staging")
 
     def helper(path, **kwargs):
-        return MockRequestResponse(f"staging/dist/{path}")
+        return MockRequestResponse(f"{py_package}/staging/dist/{path}")
 
     get_mock = mocker.patch("requests.get", side_effect=helper)
 
@@ -519,7 +572,7 @@ def test_extract_dist_npm(npm_dist, runner, mocker, open_mock, tmp_path):
     shutil.move(f"{util.CHECKOUT_NAME}/dist", "staging")
 
     def helper(path, **kwargs):
-        return MockRequestResponse(f"staging/dist/{path}")
+        return MockRequestResponse(f"{npm_dist}/staging/dist/{path}")
 
     get_mock = mocker.patch("requests.get", side_effect=helper)
 

jupyter_releaser/tests/test_functions.py

@@ -1,7 +1,6 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import json
-import os
 import shutil
 from pathlib import Path
 

jupyter_releaser/util.py

@@ -106,7 +106,7 @@ def get_branch():
     elif os.environ.get("GITHUB_REF"):
         # GitHub Action Push Event
         # e.g. refs/heads/feature-branch-1
-        branch = os.environ["GITHUB_REF"].split("/")[-1]
+        branch = "/".join(os.environ["GITHUB_REF"].split("/")[2:])
     else:
         branch = run("git branch --show-current")
     return branch