Compare commits
65 Commits
Author | SHA1 | Date |
---|---|---|
IamTheFij | 75c37b4aa7 | |
IamTheFij | ef7160fe7c | |
IamTheFij | a6c839a31e | |
IamTheFij | ec401c7d6a | |
IamTheFij | 7a5bed0454 | |
IamTheFij | d639b868a1 | |
IamTheFij | ddf509e9a4 | |
IamTheFij | fbb38a9d7d | |
IamTheFij | f0ab45f0c6 | |
IamTheFij | 3eb5fb3d75 | |
IamTheFij | f1352658ae | |
IamTheFij | b8b81825f6 | |
IamTheFij | daedacb35f | |
IamTheFij | 09a7d38bc7 | |
IamTheFij | ff803dbc31 | |
IamTheFij | 5ba06140dc | |
IamTheFij | 302258ce6c | |
IamTheFij | 5423c04df6 | |
IamTheFij | 30801c5927 | |
IamTheFij | 8b9ff334a5 | |
IamTheFij | 08773d61b7 | |
IamTheFij | 6726931916 | |
IamTheFij | b0e327e2cd | |
IamTheFij | ab1f25304b | |
IamTheFij | dfc12ed79e | |
IamTheFij | de7fe72cec | |
IamTheFij | 0f46808403 | |
IamTheFij | face8e9af0 | |
IamTheFij | d555284a01 | |
IamTheFij | 869b0b25b4 | |
IamTheFij | d6c0673a1d | |
IamTheFij | d48daaab10 | |
IamTheFij | e147fad63c | |
IamTheFij | ab0603d1b9 | |
IamTheFij | e6a269af3d | |
IamTheFij | e92283b4e9 | |
IamTheFij | 10849adfb8 | |
IamTheFij | 8a4ac73c8d | |
IamTheFij | fe0d9059aa | |
IamTheFij | 1b367f5ddb | |
IamTheFij | 7ff461fd89 | |
IamTheFij | 8585380eae | |
IamTheFij | d876639c3e | |
IamTheFij | a27e09c77e | |
IamTheFij | 3f23ddd3cc | |
IamTheFij | 1b74126494 | |
IamTheFij | c49c3ca345 | |
IamTheFij | e046c9a92a | |
IamTheFij | de1032cdbb | |
IamTheFij | 199e53fe71 | |
IamTheFij | 61496f3b18 | |
IamTheFij | c8607d0207 | |
IamTheFij | f1c0cb9c40 | |
IamTheFij | 3aa32347e6 | |
IamTheFij | 94b011799d | |
IamTheFij | f36c0b7ff7 | |
IamTheFij | 83e76376d0 | |
IamTheFij | 648784b91c | |
IamTheFij | a6b0f46d7e | |
IamTheFij | 020d9f442e | |
IamTheFij | 279b57c4ef | |
IamTheFij | 657e6884e8 | |
IamTheFij | 3bb8163145 | |
IamTheFij | a9d7cce8ca | |
IamTheFij | cdf473d5e3 |
65
.drone.star
65
.drone.star
|
@ -1,9 +1,12 @@
|
|||
# Build pipelines
|
||||
|
||||
PYTHON_VERSIONS = [
|
||||
# "3.7", doesnt support subscripted types, eg list[str]
|
||||
# "3.8",
|
||||
"3.7",
|
||||
"3.8",
|
||||
"3.9",
|
||||
"3.10",
|
||||
"3.11",
|
||||
"3.12",
|
||||
"latest",
|
||||
]
|
||||
|
||||
|
@ -13,6 +16,19 @@ def main(ctx):
|
|||
|
||||
# Run tests
|
||||
pipelines += tests()
|
||||
pipelines += [{
|
||||
"kind": "pipeline",
|
||||
"name": "lint",
|
||||
"workspace": get_workspace(),
|
||||
"steps": [{
|
||||
"name": "lint",
|
||||
"image": "python:3",
|
||||
"commands": [
|
||||
"python -V",
|
||||
"make lint",
|
||||
]
|
||||
}]
|
||||
}]
|
||||
|
||||
# Add pypi push pipeline
|
||||
pipelines += push_to_pypi()
|
||||
|
@ -41,24 +57,20 @@ def tests():
|
|||
"name": "tests",
|
||||
"workspace": get_workspace(),
|
||||
"steps": [
|
||||
tox_step("python:"+version)
|
||||
test_step("python:"+version)
|
||||
for version in PYTHON_VERSIONS
|
||||
],
|
||||
}]
|
||||
|
||||
|
||||
# Builds a single python test step
|
||||
def tox_step(docker_tag, python_cmd="python", tox_env="py3"):
|
||||
def test_step(docker_tag, python_cmd="python"):
|
||||
return {
|
||||
"name": "test {}".format(docker_tag.replace(":", "")),
|
||||
"image": docker_tag,
|
||||
"environment": {
|
||||
"TOXENV": tox_env,
|
||||
},
|
||||
"commands": [
|
||||
"{} -V".format(python_cmd),
|
||||
"pip install tox",
|
||||
"tox",
|
||||
"make clean-all test"
|
||||
],
|
||||
}
|
||||
|
||||
|
@ -108,37 +120,36 @@ def push_to_pypi():
|
|||
return [{
|
||||
"kind": "pipeline",
|
||||
"name": "deploy to pypi",
|
||||
"depends_on": ["tests"],
|
||||
"depends_on": ["tests", "lint"],
|
||||
"workspace": get_workspace(),
|
||||
"trigger": {
|
||||
"event": ["tag"],
|
||||
"ref": [
|
||||
"refs/heads/main",
|
||||
# "refs/heads/main",
|
||||
"refs/tags/v*",
|
||||
],
|
||||
},
|
||||
"steps": [
|
||||
{
|
||||
"name": "push to test pypi",
|
||||
"image": "python:3",
|
||||
"environment": {
|
||||
"TWINE_USERNAME": {
|
||||
"from_secret": "PYPI_USERNAME",
|
||||
},
|
||||
"TWINE_PASSWORD": {
|
||||
"from_secret": "TEST_PYPI_PASSWORD",
|
||||
},
|
||||
},
|
||||
"commands": ["make upload-test"],
|
||||
},
|
||||
# {
|
||||
# "name": "push to test pypi",
|
||||
# "image": "python:3",
|
||||
# "environment": {
|
||||
# "HATCH_INDEX_USER": {
|
||||
# "from_secret": "PYPI_USERNAME",
|
||||
# },
|
||||
# "HATCH_INDEX_AUTH": {
|
||||
# "from_secret": "TEST_PYPI_PASSWORD",
|
||||
# },
|
||||
# },
|
||||
# "commands": ["make upload-test"],
|
||||
# },
|
||||
{
|
||||
"name": "push to pypi",
|
||||
"image": "python:3",
|
||||
"environment": {
|
||||
"TWINE_USERNAME": {
|
||||
"HATCH_INDEX_USER": {
|
||||
"from_secret": "PYPI_USERNAME",
|
||||
},
|
||||
"TWINE_PASSWORD": {
|
||||
"HATCH_INDEX_AUTH": {
|
||||
"from_secret": "PYPI_PASSWORD",
|
||||
},
|
||||
},
|
||||
|
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
repos:
|
||||
- repo: https://github.com/psf/black
|
||||
rev: 21.12b0
|
||||
rev: 24.4.2
|
||||
hooks:
|
||||
- id: black
|
||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||
rev: v4.1.0
|
||||
rev: v4.6.0
|
||||
hooks:
|
||||
- id: check-added-large-files
|
||||
- id: check-merge-conflict
|
||||
|
@ -14,13 +14,15 @@ repos:
|
|||
- id: trailing-whitespace
|
||||
- id: name-tests-test
|
||||
exclude: tests/(common.py|util.py|(helpers|integration/factories)/(.+).py)
|
||||
- repo: https://github.com/asottile/reorder_python_imports
|
||||
rev: v2.6.0
|
||||
- repo: https://github.com/pycqa/isort
|
||||
rev: 5.13.2
|
||||
hooks:
|
||||
- id: reorder-python-imports
|
||||
- id: isort
|
||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||
rev: v0.930
|
||||
rev: v1.10.0
|
||||
hooks:
|
||||
- id: mypy
|
||||
exclude: docs/
|
||||
additional_dependencies: [ "types-requests" ]
|
||||
additional_dependencies:
|
||||
- "types-requests"
|
||||
- "types-toml"
|
||||
|
|
78
Makefile
78
Makefile
|
@ -5,7 +5,7 @@ ENV := venv
|
|||
.PHONY: default
|
||||
default: test
|
||||
|
||||
# Creates virtualenv
|
||||
# Creates de virtualenv
|
||||
$(ENV):
|
||||
python3 -m venv $(ENV)
|
||||
|
||||
|
@ -13,86 +13,76 @@ $(ENV):
|
|||
$(ENV)/bin/$(NAME): $(ENV)
|
||||
$(ENV)/bin/pip install -r requirements-dev.txt
|
||||
|
||||
# Install tox into virtualenv for running tests
|
||||
$(ENV)/bin/tox: $(ENV)
|
||||
$(ENV)/bin/pip install tox
|
||||
|
||||
# Install wheel for building packages
|
||||
$(ENV)/bin/wheel: $(ENV)
|
||||
$(ENV)/bin/pip install wheel
|
||||
|
||||
# Install twine for uploading packages
|
||||
$(ENV)/bin/twine: $(ENV)
|
||||
$(ENV)/bin/pip install twine
|
||||
# Install hatch into virtualenv for running tests
|
||||
$(ENV)/bin/hatch: $(ENV)
|
||||
$(ENV)/bin/pip install hatch
|
||||
|
||||
# Installs dev requirements to virtualenv
|
||||
.PHONY: devenv
|
||||
devenv: $(ENV)/bin/$(NAME)
|
||||
|
||||
# Generates a smaller env for running tox, which builds it's own env
|
||||
.PHONY: test-env
|
||||
test-env: $(ENV)/bin/tox
|
||||
|
||||
# Generates a small build env for building and uploading dists
|
||||
.PHONY: build-env
|
||||
build-env: $(ENV)/bin/twine $(ENV)/bin/wheel
|
||||
|
||||
# Runs package
|
||||
.PHONY: run
|
||||
run: $(ENV)/bin/$(NAME)
|
||||
$(ENV)/bin/$(NAME)
|
||||
|
||||
# Runs tests with tox
|
||||
# Runs tests for current python
|
||||
.PHONY: test
|
||||
test: $(ENV)/bin/tox
|
||||
$(ENV)/bin/tox
|
||||
test: $(ENV)/bin/hatch
|
||||
$(ENV)/bin/hatch run +py=3 test:run
|
||||
|
||||
# Runs test matrix
|
||||
.PHONY: test-matrix
|
||||
test-matrix: $(ENV)/bin/hatch
|
||||
$(ENV)/bin/hatch run test:run
|
||||
|
||||
# Builds wheel for package to upload
|
||||
.PHONY: build
|
||||
build: $(ENV)/bin/wheel
|
||||
$(ENV)/bin/python setup.py sdist
|
||||
$(ENV)/bin/python setup.py bdist_wheel
|
||||
build: $(ENV)/bin/hatch
|
||||
$(ENV)/bin/hatch build
|
||||
|
||||
# Verify that the python version matches the git tag so we don't push bad shas
|
||||
.PHONY: verify-tag-version
|
||||
verify-tag-version:
|
||||
verify-tag-version: $(ENV)/bin/hatch
|
||||
$(eval TAG_NAME = $(shell [ -n "$(DRONE_TAG)" ] && echo $(DRONE_TAG) || git describe --tags --exact-match))
|
||||
test "v$(shell python setup.py -V)" = "$(TAG_NAME)"
|
||||
test "v$(shell $(ENV)/bin/hatch version)" = "$(TAG_NAME)"
|
||||
|
||||
# Uses twine to upload to pypi
|
||||
# Upload to pypi
|
||||
.PHONY: upload
|
||||
upload: verify-tag-version build $(ENV)/bin/twine
|
||||
$(ENV)/bin/twine upload dist/*
|
||||
upload: verify-tag-version build
|
||||
$(ENV)/bin/hatch publish
|
||||
|
||||
# Uses twine to upload to test pypi
|
||||
.PHONY: upload-test
|
||||
upload-test: verify-tag-version build $(ENV)/bin/twine
|
||||
$(ENV)/bin/twine upload --repository-url https://test.pypi.org/legacy/ dist/*
|
||||
upload-test: build
|
||||
# Bump version to a post version based on num of commits since last tag to prevent overwriting
|
||||
$(ENV)/bin/hatch version $(shell git describe --tags | sed 's/-[0-9a-z]*$$//')
|
||||
$(ENV)/bin/hatch publish --repo test
|
||||
|
||||
# Cleans all build, runtime, and test artifacts
|
||||
.PHONY: clean
|
||||
clean:
|
||||
rm -fr ./build *.egg-info ./htmlcov ./.coverage ./.pytest_cache ./.tox
|
||||
rm -fr ./build *.egg-info ./htmlcov ./.coverage ./.pytest_cache
|
||||
find . -name '*.pyc' -delete
|
||||
find . -name '__pycache__' -delete
|
||||
|
||||
# Cleans dist and env
|
||||
.PHONY: dist-clean
|
||||
dist-clean: clean
|
||||
-$(ENV)/bin/hatch env prune
|
||||
rm -fr ./dist $(ENV)
|
||||
|
||||
# Run linters
|
||||
.PHONY: lint
|
||||
lint: $(ENV)/bin/hatch
|
||||
$(ENV)/bin/hatch run lint:all
|
||||
|
||||
# Install pre-commit hooks
|
||||
.PHONY: install-hooks
|
||||
install-hooks: devenv
|
||||
$(ENV)/bin/pre-commit install -f --install-hooks
|
||||
$(ENV)/bin/hatch run lint:install-hooks
|
||||
|
||||
# Generates test coverage
|
||||
.coverage:
|
||||
$(ENV)/bin/tox
|
||||
.coverage: test
|
||||
|
||||
# Builds coverage html
|
||||
htmlcov/index.html: .coverage
|
||||
$(ENV)/bin/coverage html
|
||||
$(ENV)/bin/hatch run coverage html
|
||||
|
||||
# Opens coverage html in browser (on macOS and some Linux systems)
|
||||
.PHONY: open-coverage
|
||||
|
@ -106,7 +96,7 @@ docs-clean:
|
|||
|
||||
# Builds docs
|
||||
docs/build/html/index.html:
|
||||
$(ENV)/bin/tox -e docs
|
||||
$(ENV)/bin/hatch run docs:build
|
||||
|
||||
# Shorthand for building docs
|
||||
.PHONY: docs
|
||||
|
|
13
README.md
13
README.md
|
@ -28,7 +28,7 @@ In practice, it means that for a project like [StyLua](https://github.com/Johnny
|
|||
--map-system Windows=win64 --map-system Darwin=macos --map-system=linux=Linux \
|
||||
"stylua-{version}-{system}.zip"
|
||||
|
||||
And `release-gitter` will get the release version from the `Cargo.toml`, get the URL from the `git remote`, call the Github API and look for a release matching the templated file name, extract the `stylua` file from the archive, and then make it executable.
|
||||
And `release-gitter` will get the release version from the `Cargo.toml`, get the URL from the `git remote`, call the Github API and look for a release matching the templated file name, extract the `stylua` file from the archive, and then make it executable. Alternatively, if you're project `--version-git-tag` can be used to pull the version from the latest tag. This will automatically do a shallow fetch (depth = 1), but this can be supressed with `--version-git-no-fetch`.
|
||||
|
||||
This allows a single command to be run from a checked out repo from pre-commit on any system to fetch the appropriate binary.
|
||||
|
||||
|
@ -38,6 +38,7 @@ Full usage is as follows:
|
|||
|
||||
usage: release-gitter [-h] [--hostname HOSTNAME] [--owner OWNER] [--repo REPO]
|
||||
[--git-url GIT_URL] [--version VERSION]
|
||||
[--version-git-tag] [--version-git-no-fetch]
|
||||
[--map-system MAP_SYSTEM] [--map-arch MAP_ARCH]
|
||||
[--exec EXEC] [--extract-files EXTRACT_FILES]
|
||||
[--extract-all] [--url-only]
|
||||
|
@ -59,6 +60,10 @@ Full usage is as follows:
|
|||
repo
|
||||
--version VERSION Release version to download. If not provied, it will
|
||||
look for project metadata
|
||||
--version-git-tag, -t
|
||||
Get the release version from a git tag
|
||||
--version-git-no-fetch
|
||||
Shallow fetch tags prior to checking versions
|
||||
--map-system MAP_SYSTEM, -s MAP_SYSTEM
|
||||
Map a platform.system() value to a custom value
|
||||
--map-arch MAP_ARCH, -a MAP_ARCH
|
||||
|
@ -68,3 +73,9 @@ Full usage is as follows:
|
|||
A list of file name to extract from downloaded archive
|
||||
--extract-all, -x Shell commands to execute after download or extraction
|
||||
--url-only Only print the URL and do not download
|
||||
|
||||
### Pre-Commit usage
|
||||
|
||||
This can be used a way to wrap a binary release from a Github or Gitea by adding a `pyproject.toml` file to your current project directory and adding a `.pre-commit-hooks.yaml` file.
|
||||
|
||||
Take a look at the `./sample_pseudo_bin` directory to see an example.
|
||||
|
|
|
@ -13,6 +13,8 @@
|
|||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
project = "release-gitter"
|
||||
copyright = "2021, iamthefij"
|
||||
author = "iamthefij"
|
||||
|
|
107
main_test.py
107
main_test.py
|
@ -1,107 +0,0 @@
|
|||
import unittest
|
||||
from typing import Any
|
||||
from typing import Callable
|
||||
from typing import NamedTuple
|
||||
from typing import Optional
|
||||
from unittest.mock import MagicMock
|
||||
from unittest.mock import patch
|
||||
|
||||
import requests
|
||||
|
||||
import release_gitter
|
||||
|
||||
|
||||
class TestExpression(NamedTuple):
|
||||
t: unittest.TestCase
|
||||
args: list[Any]
|
||||
kwargs: dict[str, Any]
|
||||
expected: Any
|
||||
exception: Optional[type[Exception]]
|
||||
|
||||
def run(self, f: Callable):
|
||||
with self.t.subTest(f=f, args=self.args, kwargs=self.kwargs):
|
||||
try:
|
||||
result = f(*self.args, **self.kwargs)
|
||||
self.t.assertIsNone(
|
||||
self.exception,
|
||||
f"Expected an exception of type {self.exception}, but found none",
|
||||
)
|
||||
self.t.assertEqual(self.expected, result)
|
||||
return result
|
||||
except Exception as e:
|
||||
if self.exception and isinstance(e, self.exception):
|
||||
return e
|
||||
raise
|
||||
|
||||
|
||||
class TestRemoteInfo(unittest.TestCase):
|
||||
def test_parse_remote_info(self):
|
||||
for test_case in (
|
||||
TestExpression(
|
||||
self,
|
||||
["https://github.com/owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("github.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["git@github.com:owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("github.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["ssh://git@git.iamthefij.com/owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("git.iamthefij.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["https://git@example.com/repo"],
|
||||
{},
|
||||
None,
|
||||
release_gitter.InvalidRemoteError,
|
||||
),
|
||||
):
|
||||
test_case.run(release_gitter.get_git_remote)
|
||||
|
||||
def test_generate_release_url(self):
|
||||
for subtest in (
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("github.com", "owner", "repo")],
|
||||
{},
|
||||
"https://api.github.com/repos/owner/repo/releases",
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("git.iamthefij.com", "owner", "repo")],
|
||||
{},
|
||||
"https://git.iamthefij.com/api/v1/repos/owner/repo/releases",
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("gitlab.com", "owner", "repo")],
|
||||
{},
|
||||
None,
|
||||
release_gitter.InvalidRemoteError,
|
||||
),
|
||||
):
|
||||
mock_response = MagicMock(spec=requests.Response)
|
||||
mock_response.json = MagicMock()
|
||||
if subtest.args[0].hostname == "git.iamthefij.com":
|
||||
mock_response.json.return_value = {
|
||||
"paths": {"/repos/{owner}/{repo}/releases": {}},
|
||||
"basePath": "/api/v1",
|
||||
}
|
||||
with patch("requests.get", return_value=mock_response):
|
||||
subtest.run(release_gitter.GitRemoteInfo.get_releases_url)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
|
@ -0,0 +1,192 @@
|
|||
"""
|
||||
This builder functions as a pseudo builder that instead downloads and installs a binary file using
|
||||
release-gitter based on a pyproject.toml file. It's a total hack...
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
from shutil import copy
|
||||
from shutil import copytree
|
||||
from shutil import move
|
||||
|
||||
import toml
|
||||
from wheel.wheelfile import WheelFile
|
||||
|
||||
import release_gitter as rg
|
||||
from release_gitter import removeprefix
|
||||
|
||||
PACKAGE_NAME = "pseudo"
|
||||
|
||||
|
||||
@dataclass
|
||||
class Config:
|
||||
format: str
|
||||
git_url: str
|
||||
hostname: str
|
||||
owner: str
|
||||
repo: str
|
||||
version: str | None = None
|
||||
pre_release: bool = False
|
||||
version_git_tag: bool = False
|
||||
version_git_no_fetch: bool = False
|
||||
map_system: dict[str, str] | None = None
|
||||
map_arch: dict[str, str] | None = None
|
||||
exec: str | None = None
|
||||
extract_all: bool = False
|
||||
extract_files: list[str] | None = None
|
||||
include_extra_files: list[str] | None = None
|
||||
|
||||
|
||||
def download(config: Config) -> list[Path]:
|
||||
release = rg.fetch_release(
|
||||
rg.GitRemoteInfo(config.hostname, config.owner, config.repo), config.version
|
||||
)
|
||||
asset = rg.match_asset(
|
||||
release,
|
||||
config.format,
|
||||
version=config.version,
|
||||
system_mapping=config.map_system,
|
||||
arch_mapping=config.map_arch,
|
||||
)
|
||||
|
||||
files = rg.download_asset(asset, extract_files=config.extract_files)
|
||||
|
||||
# Optionally execute post command
|
||||
if config.exec:
|
||||
rg.check_call(config.exec, shell=True)
|
||||
|
||||
return files
|
||||
|
||||
|
||||
def read_metadata() -> Config:
|
||||
config = toml.load("pyproject.toml").get("tool", {}).get("release-gitter")
|
||||
if not config:
|
||||
raise ValueError("Must have configuration in [tool.release-gitter]")
|
||||
|
||||
git_url = config.pop("git-url", None)
|
||||
remote_info = rg.parse_git_remote(git_url)
|
||||
|
||||
args = Config(
|
||||
format=config.pop("format"),
|
||||
git_url=git_url,
|
||||
hostname=config.pop("hostname", remote_info.hostname),
|
||||
owner=config.pop("owner", remote_info.owner),
|
||||
repo=config.pop("repo", remote_info.repo),
|
||||
)
|
||||
|
||||
for key, value in config.items():
|
||||
setattr(args, str(key).replace("-", "_"), value)
|
||||
|
||||
if args.version is None:
|
||||
args.version = rg.read_version(
|
||||
args.version_git_tag,
|
||||
not args.version_git_no_fetch,
|
||||
)
|
||||
|
||||
if args.extract_all:
|
||||
args.extract_files = []
|
||||
|
||||
return args
|
||||
|
||||
|
||||
class _PseudoBuildBackend:
|
||||
# Should allow passing args as `--build-option`
|
||||
_gitter_args = None
|
||||
|
||||
def prepare_metadata_for_build_wheel(
|
||||
self, metadata_directory, config_settings=None
|
||||
):
|
||||
# Create a .dist-info directory containing wheel metadata inside metadata_directory. Eg {metadata_directory}/{package}-{version}.dist-info/
|
||||
print("Prepare meta", metadata_directory, config_settings)
|
||||
|
||||
metadata = read_metadata()
|
||||
version = removeprefix(metadata.version, "v") if metadata.version else "0.0.0"
|
||||
|
||||
# Returns distinfo dir?
|
||||
dist_info = Path(metadata_directory) / f"{PACKAGE_NAME}-{version}.dist-info"
|
||||
dist_info.mkdir()
|
||||
|
||||
# Write metadata
|
||||
pkg_info = dist_info / "METADATA"
|
||||
pkg_info.write_text(
|
||||
"\n".join(
|
||||
[
|
||||
"Metadata-Version: 2.1",
|
||||
f"Name: {PACKAGE_NAME}",
|
||||
f"Version: {version}",
|
||||
]
|
||||
)
|
||||
)
|
||||
|
||||
# Write wheel info
|
||||
wheel_info = dist_info / "WHEEL"
|
||||
wheel_info.write_text(
|
||||
"\n".join(
|
||||
[
|
||||
"Wheel-Version: 1.0",
|
||||
"Root-Is-Purelib: true",
|
||||
"Tag: py2-none-any",
|
||||
"Tag: py3-none-any",
|
||||
]
|
||||
)
|
||||
)
|
||||
|
||||
return str(dist_info)
|
||||
|
||||
def build_sdist(self, sdist_directory, config_settings=None):
|
||||
# Builds a .tar.gz and places it in specified sdist_directory
|
||||
# That should contain a toplevel drectory of `name-version` containing source files and the pyproject.toml
|
||||
|
||||
# HACK: This isn't needed or used
|
||||
p = Path(sdist_directory + ".dist-info")
|
||||
return p
|
||||
|
||||
def build_wheel(
|
||||
self, wheel_directory, config_settings=None, metadata_directory=None
|
||||
):
|
||||
metadata_directory = Path(metadata_directory)
|
||||
|
||||
metadata = read_metadata()
|
||||
version = removeprefix(metadata.version, "v") if metadata.version else "0.0.0"
|
||||
|
||||
wheel_directory = Path(wheel_directory)
|
||||
wheel_directory.mkdir(exist_ok=True)
|
||||
|
||||
wheel_scripts = wheel_directory / f"{PACKAGE_NAME}-{version}.data/scripts"
|
||||
wheel_scripts.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
copytree(metadata_directory, wheel_directory / metadata_directory.name)
|
||||
|
||||
metadata = read_metadata()
|
||||
files = download(metadata)
|
||||
for file in files:
|
||||
move(file, wheel_scripts / file.name)
|
||||
|
||||
for file_name in metadata.include_extra_files or []:
|
||||
file = Path(file_name)
|
||||
if Path.cwd() in file.absolute().parents:
|
||||
copy(file_name, wheel_scripts / file)
|
||||
else:
|
||||
raise ValueError(
|
||||
f"Cannot include any path that is not within the current directory: {file_name}"
|
||||
)
|
||||
|
||||
print(f"ls {wheel_directory}: {list(wheel_directory.rglob('*'))}")
|
||||
|
||||
wheel_filename = f"{PACKAGE_NAME}-{version}-py2.py3-none-any.whl"
|
||||
with WheelFile(wheel_directory / wheel_filename, "w") as wf:
|
||||
print("Repacking wheel as {}...".format(wheel_filename), end="")
|
||||
# sys.stdout.flush()
|
||||
wf.write_files(wheel_directory)
|
||||
|
||||
return wheel_filename
|
||||
|
||||
|
||||
_BACKEND = _PseudoBuildBackend()
|
||||
|
||||
|
||||
prepare_metadata_for_build_wheel = _BACKEND.prepare_metadata_for_build_wheel
|
||||
build_sdist = _BACKEND.build_sdist
|
||||
build_wheel = _BACKEND.build_wheel
|
|
@ -0,0 +1,69 @@
|
|||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
[project]
|
||||
name = "release-gitter"
|
||||
dynamic = ["version"]
|
||||
description = "Easily download releases from sites like Github and Gitea"
|
||||
readme = "README.md"
|
||||
license = "MIT"
|
||||
classifiers = [
|
||||
"Programming Language :: Python :: 3",
|
||||
"Operating System :: OS Independent",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
]
|
||||
authors = [
|
||||
{ name = "Ian Fijolek", email = "iamthefij@gmail.com" }
|
||||
]
|
||||
maintainers = [
|
||||
{ name = "Ian Fijolek", email = "iamthefij@gmail.com" }
|
||||
]
|
||||
requires-python = ">=3.7"
|
||||
dependencies = ["requests"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
builder = [
|
||||
"toml",
|
||||
"wheel",
|
||||
]
|
||||
|
||||
[project.scripts]
|
||||
release-gitter = "release_gitter:main"
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://git.iamthefij.com/iamthefij/release-gitter"
|
||||
|
||||
[tool.hatch.version]
|
||||
path = "release_gitter.py"
|
||||
|
||||
[tool.hatch.build]
|
||||
include = ["release_gitter.py", "pseudo_builder.py"]
|
||||
|
||||
[tool.hatch.envs.test]
|
||||
dependencies = [
|
||||
"coverage",
|
||||
]
|
||||
|
||||
[tool.hatch.envs.test.scripts]
|
||||
run = [
|
||||
"coverage erase",
|
||||
"coverage run --source=release_gitter -m unittest discover . *_test.py",
|
||||
"coverage report -m # --fail-under 70",
|
||||
]
|
||||
|
||||
[[tool.hatch.envs.test.matrix]]
|
||||
python = ["3", "3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
|
||||
|
||||
[tool.hatch.envs.lint]
|
||||
detached = true
|
||||
dependencies = ["pre-commit"]
|
||||
|
||||
[tool.hatch.envs.lint.scripts]
|
||||
all = "pre-commit run --all-files"
|
||||
install-hooks = "pre-commit install --install-hooks"
|
||||
|
||||
[tool.isort]
|
||||
add_imports = ["from __future__ import annotations"]
|
||||
force_single_line = true
|
||||
profile = "black"
|
|
@ -1,9 +1,12 @@
|
|||
#! /usr/bin/env python3
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import platform
|
||||
from collections.abc import Sequence
|
||||
from dataclasses import dataclass
|
||||
from io import BytesIO
|
||||
from itertools import product
|
||||
from mimetypes import guess_type
|
||||
from pathlib import Path
|
||||
from subprocess import check_call
|
||||
|
@ -11,23 +14,69 @@ from subprocess import check_output
|
|||
from tarfile import TarFile
|
||||
from tarfile import TarInfo
|
||||
from typing import Any
|
||||
from typing import Optional
|
||||
from typing import Union
|
||||
from urllib.parse import urlparse
|
||||
from zipfile import ZipFile
|
||||
|
||||
import requests
|
||||
|
||||
__version__ = "2.3.0"
|
||||
|
||||
# Extract metadata from repo
|
||||
|
||||
class UnsupportedContentTypeError(ValueError):
|
||||
pass
|
||||
|
||||
|
||||
class InvalidRemoteError(ValueError):
|
||||
pass
|
||||
|
||||
|
||||
def removeprefix(s: str, pre: str) -> str:
|
||||
# Duplicate str.removeprefix for py<3.9
|
||||
try:
|
||||
return s.removeprefix(pre) # type: ignore
|
||||
except AttributeError:
|
||||
# Py < 3.9
|
||||
return s[len(pre) :] if s and s.startswith(pre) else s
|
||||
|
||||
|
||||
def removesuffix(s: str, suf: str) -> str:
|
||||
# Duplicate str.removesuffix for py<3.9
|
||||
try:
|
||||
return s.removesuffix(suf) # type: ignore
|
||||
except AttributeError:
|
||||
# Py < 3.9
|
||||
return s[: -len(suf)] if s and s.endswith(suf) else s
|
||||
|
||||
|
||||
SYSTEM_SYNONYMS: list[list[str]] = [
|
||||
["Darwin", "darwin", "MacOS", "macos", "macOS"],
|
||||
["Windows", "windows", "win", "win32", "win64"],
|
||||
["Linux", "linux"],
|
||||
]
|
||||
|
||||
ARCH_SYNONYMS: list[list[str]] = [
|
||||
["arm"],
|
||||
["x86_64", "amd64", "AMD64"],
|
||||
["arm64", "aarch64", "armv8b", "armv8l"],
|
||||
["x86", "i386", "i686"],
|
||||
]
|
||||
|
||||
|
||||
def get_synonyms(value: str, thesaurus: list[list[str]]) -> list[str]:
|
||||
"""Gets synonym list for a given value."""
|
||||
results = [value]
|
||||
|
||||
for l in thesaurus:
|
||||
if value in l:
|
||||
results += l
|
||||
|
||||
return results
|
||||
|
||||
|
||||
@dataclass
|
||||
class GitRemoteInfo:
|
||||
"""Extracts information about a repository"""
|
||||
|
||||
hostname: str
|
||||
owner: str
|
||||
repo: str
|
||||
|
@ -65,8 +114,8 @@ class GitRemoteInfo:
|
|||
)
|
||||
|
||||
|
||||
def get_git_remote(git_url: Optional[str] = None) -> GitRemoteInfo:
|
||||
"""Extract Github repo info from git remote url"""
|
||||
def parse_git_remote(git_url: str | None = None) -> GitRemoteInfo:
|
||||
"""Extract Github repo info from a git remote url"""
|
||||
if not git_url:
|
||||
git_url = (
|
||||
check_output(["git", "remote", "get-url", "origin"]).decode("UTF-8").strip()
|
||||
|
@ -91,10 +140,10 @@ def get_git_remote(git_url: Optional[str] = None) -> GitRemoteInfo:
|
|||
f"{path[1:3]} Could not parse owner and repo from URL {git_url}"
|
||||
)
|
||||
|
||||
return GitRemoteInfo(u.hostname, path[1], path[2].removesuffix(".git"))
|
||||
return GitRemoteInfo(u.hostname, path[1], removesuffix(path[2], ".git"))
|
||||
|
||||
|
||||
def get_cargo_version(p: Path) -> str:
|
||||
def parse_cargo_version(p: Path) -> str:
|
||||
"""Extracts cargo version from a Cargo.toml file"""
|
||||
with p.open() as f:
|
||||
for line in f:
|
||||
|
@ -104,9 +153,24 @@ def get_cargo_version(p: Path) -> str:
|
|||
raise ValueError(f"No version found in {p}")
|
||||
|
||||
|
||||
def read_version() -> Optional[str]:
|
||||
def read_git_tag(fetch: bool = True) -> str | None:
|
||||
"""Get local git tag for current repo
|
||||
|
||||
fetch: optionally fetch tags with depth of 1 from remote"""
|
||||
if fetch:
|
||||
check_call(["git", "fetch", "--tags", "--depth", "1"])
|
||||
|
||||
git_tag = check_output(["git", "describe", "--tags"]).decode("UTF-8").strip()
|
||||
return git_tag or None
|
||||
|
||||
|
||||
def read_version(from_tags: bool = False, fetch: bool = False) -> str | None:
|
||||
"""Read version information from file or from git"""
|
||||
if from_tags:
|
||||
return read_git_tag(fetch)
|
||||
|
||||
matchers = {
|
||||
"Cargo.toml": get_cargo_version,
|
||||
"Cargo.toml": parse_cargo_version,
|
||||
}
|
||||
|
||||
for name, extractor in matchers.items():
|
||||
|
@ -119,13 +183,10 @@ def read_version() -> Optional[str]:
|
|||
return None
|
||||
|
||||
|
||||
# Fetch release and assets from Github
|
||||
|
||||
|
||||
def get_release(
|
||||
def fetch_release(
|
||||
remote: GitRemoteInfo,
|
||||
version: Optional[str] = None
|
||||
# TODO: Accept an argument for pre-release
|
||||
version: str | None = None,
|
||||
pre_release=False,
|
||||
) -> dict[Any, Any]:
|
||||
"""Fetches a release object from a Github repo
|
||||
|
||||
|
@ -141,22 +202,29 @@ def get_release(
|
|||
|
||||
# Return the latest if requested
|
||||
if version is None or version == "latest":
|
||||
return result.json()[0]
|
||||
for release in result.json():
|
||||
if release["prerelease"] and not pre_release:
|
||||
continue
|
||||
|
||||
return release
|
||||
|
||||
# Return matching version
|
||||
for release in result.json():
|
||||
if release["tag_name"].endswith(version):
|
||||
return release
|
||||
|
||||
raise ValueError(f"Could not find release version ending in {version}")
|
||||
raise ValueError(
|
||||
f"Could not find release version ending in {version}."
|
||||
f"{ ' Is it a pre-release?' if not pre_release else ''}"
|
||||
)
|
||||
|
||||
|
||||
def match_asset(
|
||||
release: dict[Any, Any],
|
||||
format: str,
|
||||
version: Optional[str] = None,
|
||||
system_mapping: Optional[dict[str, str]] = None,
|
||||
arch_mapping: Optional[dict[str, str]] = None,
|
||||
version: str | None = None,
|
||||
system_mapping: dict[str, str] | None = None,
|
||||
arch_mapping: dict[str, str] | None = None,
|
||||
) -> dict[Any, Any]:
|
||||
"""Accepts a release and searches for an appropriate asset attached using
|
||||
a provided template and some alternative mappings for version, system, and machine info
|
||||
|
@ -203,21 +271,29 @@ def match_asset(
|
|||
|
||||
system = platform.system()
|
||||
if system_mapping:
|
||||
system = system_mapping.get(system, system)
|
||||
systems = [system_mapping.get(system, system)]
|
||||
else:
|
||||
systems = get_synonyms(system, SYSTEM_SYNONYMS)
|
||||
|
||||
arch = platform.machine()
|
||||
if arch_mapping:
|
||||
arch = arch_mapping.get(arch, arch)
|
||||
archs = [arch_mapping.get(arch, arch)]
|
||||
else:
|
||||
archs = get_synonyms(arch, ARCH_SYNONYMS)
|
||||
|
||||
expected_names = {
|
||||
format.format(
|
||||
version=normalized_version,
|
||||
system=system,
|
||||
arch=arch,
|
||||
version=version_opt,
|
||||
system=system_opt,
|
||||
arch=arch_opt,
|
||||
)
|
||||
for normalized_version in (
|
||||
version.lstrip("v"),
|
||||
"v" + version if not version.startswith("v") else version,
|
||||
for version_opt, system_opt, arch_opt in product(
|
||||
(
|
||||
version.lstrip("v"),
|
||||
"v" + version if not version.startswith("v") else version,
|
||||
),
|
||||
systems,
|
||||
archs,
|
||||
)
|
||||
}
|
||||
|
||||
|
@ -234,15 +310,25 @@ class PackageAdapter:
|
|||
"""Adapts the names and extractall methods from ZipFile and TarFile classes"""
|
||||
|
||||
def __init__(self, content_type: str, response: requests.Response):
|
||||
self._package: Union[TarFile, ZipFile]
|
||||
if content_type == "application/zip":
|
||||
self._package: TarFile | ZipFile
|
||||
if content_type in (
|
||||
"application/zip",
|
||||
"application/x-zip-compressed",
|
||||
):
|
||||
self._package = ZipFile(BytesIO(response.content))
|
||||
elif content_type == "application/x-tar":
|
||||
self._package = TarFile(fileobj=response.raw)
|
||||
elif content_type == "application/x-tar+gzip":
|
||||
elif content_type in (
|
||||
"application/gzip",
|
||||
"application/x-tar+gzip",
|
||||
"application/x-tar+xz",
|
||||
"application/x-compressed-tar",
|
||||
):
|
||||
self._package = TarFile.open(fileobj=BytesIO(response.content), mode="r:*")
|
||||
else:
|
||||
raise ValueError(f"Unknown or unsupported content type {content_type}")
|
||||
raise UnsupportedContentTypeError(
|
||||
f"Unknown or unsupported content type {content_type}"
|
||||
)
|
||||
|
||||
def get_names(self) -> list[str]:
|
||||
"""Get list of all file names in package"""
|
||||
|
@ -255,44 +341,83 @@ class PackageAdapter:
|
|||
f"Unknown package type, cannot extract from {type(self._package)}"
|
||||
)
|
||||
|
||||
def extractall(self, file_names: list[str]) -> list[str]:
|
||||
def extractall(
|
||||
self,
|
||||
path: Path | None,
|
||||
members: list[str] | None,
|
||||
) -> list[str]:
|
||||
"""Extract all or a subset of files from the package
|
||||
|
||||
If the `file_names` list is empty, all files will be extracted"""
|
||||
if not file_names:
|
||||
self._package.extractall()
|
||||
if path is None:
|
||||
path = Path.cwd()
|
||||
if not members:
|
||||
self._package.extractall(path=path)
|
||||
return self.get_names()
|
||||
|
||||
if isinstance(self._package, ZipFile):
|
||||
self._package.extractall(members=file_names)
|
||||
if isinstance(self._package, TarFile):
|
||||
self._package.extractall(members=(TarInfo(name) for name in file_names))
|
||||
missing_members = set(members) - set(self.get_names())
|
||||
if missing_members:
|
||||
raise ValueError(f"Missing members: {missing_members}")
|
||||
|
||||
return file_names
|
||||
if isinstance(self._package, ZipFile):
|
||||
self._package.extractall(path=path, members=members)
|
||||
if isinstance(self._package, TarFile):
|
||||
self._package.extractall(
|
||||
path=path, members=(TarInfo(name) for name in members)
|
||||
)
|
||||
|
||||
return members
|
||||
|
||||
|
||||
def get_asset_package(
|
||||
asset: dict[str, Any], result: requests.Response
|
||||
) -> PackageAdapter:
|
||||
possible_content_types = (
|
||||
asset.get("content_type"),
|
||||
"+".join(t for t in guess_type(asset["name"]) if t is not None),
|
||||
)
|
||||
for content_type in possible_content_types:
|
||||
if not content_type:
|
||||
continue
|
||||
|
||||
try:
|
||||
return PackageAdapter(content_type, result)
|
||||
except UnsupportedContentTypeError:
|
||||
continue
|
||||
else:
|
||||
raise UnsupportedContentTypeError(
|
||||
"Cannot extract files from archive because we don't recognize the content type"
|
||||
)
|
||||
|
||||
|
||||
def download_asset(
|
||||
asset: dict[Any, Any],
|
||||
extract_files: Optional[list[str]] = None,
|
||||
extract_files: list[str] | None = None,
|
||||
destination: Path | None = None,
|
||||
) -> list[Path]:
|
||||
"""Download asset from entity passed in
|
||||
|
||||
Extracts files from archives if provided. Any empty list will extract all files
|
||||
|
||||
Args
|
||||
`asset`: asset dictionary as returned from API
|
||||
`extract_files`: optional list of file paths to extract. An empty list will extract all
|
||||
`destination`: destination directory to put the downloaded assset
|
||||
|
||||
Returns
|
||||
list of Path objects containing all extracted files
|
||||
"""
|
||||
if destination is None:
|
||||
destination = Path.cwd()
|
||||
|
||||
result = requests.get(asset["browser_download_url"])
|
||||
|
||||
content_type = asset.get(
|
||||
"content_type",
|
||||
guess_type(asset["name"]),
|
||||
)
|
||||
if extract_files is not None:
|
||||
if isinstance(content_type, tuple):
|
||||
content_type = "+".join(t for t in content_type if t is not None)
|
||||
if not content_type:
|
||||
raise TypeError(
|
||||
"Cannot extract files from archive because we don't recognize the content type"
|
||||
)
|
||||
package = PackageAdapter(content_type, result)
|
||||
extract_files = package.extractall(extract_files)
|
||||
return [Path.cwd() / name for name in extract_files]
|
||||
package = get_asset_package(asset, result)
|
||||
extract_files = package.extractall(path=destination, members=extract_files)
|
||||
return [destination / name for name in extract_files]
|
||||
|
||||
file_name = Path.cwd() / asset["name"]
|
||||
file_name = destination / asset["name"]
|
||||
with open(file_name, "wb") as f:
|
||||
f.write(result.content)
|
||||
|
||||
|
@ -304,8 +429,8 @@ class MapAddAction(argparse.Action):
|
|||
self,
|
||||
_: argparse.ArgumentParser,
|
||||
namespace: argparse.Namespace,
|
||||
values: Union[str, Sequence[Any], None],
|
||||
option_string: Optional[str] = None,
|
||||
values: str | Sequence[Any] | None,
|
||||
option_string: str | None = None,
|
||||
):
|
||||
# Validate that required value has something
|
||||
if self.required and not values:
|
||||
|
@ -335,12 +460,21 @@ class MapAddAction(argparse.Action):
|
|||
setattr(namespace, self.dest, dest)
|
||||
|
||||
|
||||
def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
||||
def _parse_args(args: list[str] | None = None) -> argparse.Namespace:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument(
|
||||
"format",
|
||||
help="Format template to match assets. Eg `foo-{version}-{system}-{arch}.zip`",
|
||||
help="Format template to match assets. Eg. `foo-{version}-{system}-{arch}.zip`",
|
||||
)
|
||||
parser.add_argument(
|
||||
"destination",
|
||||
metavar="DEST",
|
||||
nargs="?",
|
||||
type=Path,
|
||||
default=Path.cwd(),
|
||||
help="Destination directory. Defaults to current directory",
|
||||
)
|
||||
parser.add_argument("-v", action="store_true", help="verbose logging")
|
||||
parser.add_argument(
|
||||
"--hostname",
|
||||
help="Git repository hostname",
|
||||
|
@ -359,7 +493,23 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
|||
)
|
||||
parser.add_argument(
|
||||
"--version",
|
||||
help="Release version to download. If not provied, it will look for project metadata",
|
||||
help="Release version to download. If not provided, it will look for project metadata",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--prerelease",
|
||||
action="store_true",
|
||||
help="Include pre-release versions in search",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--version-git-tag",
|
||||
"-t",
|
||||
action="store_true",
|
||||
help="Get the release version from a git tag",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--version-git-no-fetch",
|
||||
action="store_true",
|
||||
help="Shallow fetch tags prior to checking versions",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--map-system",
|
||||
|
@ -374,19 +524,21 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
|||
help="Map a platform.machine() value to a custom value",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--exec", "-c", help="Shell commands to execute after download or extraction"
|
||||
"--exec",
|
||||
"-c",
|
||||
help="Shell commands to execute after download or extraction. {} will be expanded to the downloaded asset name.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--extract-files",
|
||||
"-e",
|
||||
action="append",
|
||||
help="A list of file name to extract from downloaded archive",
|
||||
help="A list of file names to extract from the downloaded archive",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--extract-all",
|
||||
"-x",
|
||||
action="store_true",
|
||||
help="Shell commands to execute after download or extraction",
|
||||
help="Extract all files from the downloaded archive",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--url-only",
|
||||
|
@ -398,7 +550,7 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
|||
|
||||
# Merge in fields from args and git remote
|
||||
if not all((parsed_args.owner, parsed_args.repo, parsed_args.hostname)):
|
||||
remote_info = get_git_remote(parsed_args.git_url)
|
||||
remote_info = parse_git_remote(parsed_args.git_url)
|
||||
|
||||
def merge_field(a, b, field):
|
||||
value = getattr(a, field)
|
||||
|
@ -409,7 +561,10 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
|||
merge_field(parsed_args, remote_info, field)
|
||||
|
||||
if parsed_args.version is None:
|
||||
parsed_args.version = read_version()
|
||||
parsed_args.version = read_version(
|
||||
parsed_args.version_git_tag,
|
||||
not parsed_args.version_git_no_fetch,
|
||||
)
|
||||
|
||||
if parsed_args.extract_all:
|
||||
parsed_args.extract_files = []
|
||||
|
@ -417,11 +572,45 @@ def parse_args(args: Optional[list[str]] = None) -> argparse.Namespace:
|
|||
return parsed_args
|
||||
|
||||
|
||||
def main():
|
||||
args = parse_args()
|
||||
def download_release(
|
||||
remote_info: GitRemoteInfo,
|
||||
destination: Path,
|
||||
format: str,
|
||||
version: str | None = None,
|
||||
system_mapping: dict[str, str] | None = None,
|
||||
arch_mapping: dict[str, str] | None = None,
|
||||
extract_files: list[str] | None = None,
|
||||
pre_release=False,
|
||||
) -> list[Path]:
|
||||
"""Convenience method for fetching, downloading and extracting a release"""
|
||||
release = fetch_release(
|
||||
remote_info,
|
||||
version=version,
|
||||
pre_release=pre_release,
|
||||
)
|
||||
asset = match_asset(
|
||||
release,
|
||||
format,
|
||||
version=version,
|
||||
system_mapping=system_mapping,
|
||||
arch_mapping=arch_mapping,
|
||||
)
|
||||
files = download_asset(
|
||||
asset,
|
||||
extract_files=extract_files,
|
||||
destination=destination,
|
||||
)
|
||||
|
||||
release = get_release(
|
||||
GitRemoteInfo(args.hostname, args.owner, args.repo), args.version
|
||||
return files
|
||||
|
||||
|
||||
def main():
|
||||
args = _parse_args()
|
||||
|
||||
release = fetch_release(
|
||||
GitRemoteInfo(args.hostname, args.owner, args.repo),
|
||||
version=args.version,
|
||||
pre_release=args.prerelease,
|
||||
)
|
||||
asset = match_asset(
|
||||
release,
|
||||
|
@ -431,17 +620,24 @@ def main():
|
|||
arch_mapping=args.map_arch,
|
||||
)
|
||||
|
||||
if args.v:
|
||||
print(f"Downloading {asset['name']} from release {release['name']}")
|
||||
|
||||
if args.url_only:
|
||||
print(asset["browser_download_url"])
|
||||
return
|
||||
|
||||
files = download_asset(asset, extract_files=args.extract_files)
|
||||
files = download_asset(
|
||||
asset,
|
||||
extract_files=args.extract_files,
|
||||
destination=args.destination,
|
||||
)
|
||||
|
||||
print(f"Downloaded {', '.join(str(f) for f in files)}")
|
||||
|
||||
# Optionally execute post command
|
||||
if args.exec:
|
||||
check_call(args.exec, shell=True)
|
||||
check_call(args.exec.format(asset["name"]), shell=True)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
|
|
|
@ -0,0 +1,475 @@
|
|||
from __future__ import annotations
|
||||
|
||||
import unittest
|
||||
from itertools import chain
|
||||
from itertools import product
|
||||
from tarfile import TarFile
|
||||
from typing import Any
|
||||
from typing import Callable
|
||||
from typing import NamedTuple
|
||||
from unittest.mock import MagicMock
|
||||
from unittest.mock import mock_open
|
||||
from unittest.mock import patch
|
||||
from zipfile import ZipFile
|
||||
|
||||
import requests
|
||||
|
||||
import release_gitter
|
||||
|
||||
|
||||
class TestExpression(NamedTuple):
|
||||
t: unittest.TestCase
|
||||
args: list[Any]
|
||||
kwargs: dict[str, Any]
|
||||
expected: Any
|
||||
exception: type[Exception] | None = None
|
||||
msg: str | None = None
|
||||
|
||||
def run(self, f: Callable):
|
||||
with self.t.subTest(msg=self.msg, f=f, args=self.args, kwargs=self.kwargs):
|
||||
try:
|
||||
result = f(*self.args, **self.kwargs)
|
||||
self.t.assertIsNone(
|
||||
self.exception,
|
||||
f"Expected an exception of type {self.exception}, but found none",
|
||||
)
|
||||
self.t.assertEqual(self.expected, result)
|
||||
return result
|
||||
except Exception as e:
|
||||
if self.exception and isinstance(e, self.exception):
|
||||
return e
|
||||
raise
|
||||
|
||||
|
||||
class TestGeneral(unittest.TestCase):
|
||||
def test_removesuffix(self):
|
||||
for test_case in (
|
||||
TestExpression(self, ["repo.git", ".git"], {}, "repo"),
|
||||
TestExpression(self, ["repo", ".git"], {}, "repo"),
|
||||
):
|
||||
test_case.run(release_gitter.removesuffix)
|
||||
|
||||
|
||||
class TestRemoteInfo(unittest.TestCase):
|
||||
def test_parse_remote_info(self):
|
||||
for test_case in (
|
||||
TestExpression(
|
||||
self,
|
||||
["https://github.com/owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("github.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["git@github.com:owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("github.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["ssh://git@git.iamthefij.com/owner/repo"],
|
||||
{},
|
||||
release_gitter.GitRemoteInfo("git.iamthefij.com", "owner", "repo"),
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
["https://git@example.com/repo"],
|
||||
{},
|
||||
None,
|
||||
release_gitter.InvalidRemoteError,
|
||||
),
|
||||
):
|
||||
test_case.run(release_gitter.parse_git_remote)
|
||||
|
||||
def test_generate_release_url(self):
|
||||
for subtest in (
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("github.com", "owner", "repo")],
|
||||
{},
|
||||
"https://api.github.com/repos/owner/repo/releases",
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("git.iamthefij.com", "owner", "repo")],
|
||||
{},
|
||||
"https://git.iamthefij.com/api/v1/repos/owner/repo/releases",
|
||||
None,
|
||||
),
|
||||
TestExpression(
|
||||
self,
|
||||
[release_gitter.GitRemoteInfo("gitlab.com", "owner", "repo")],
|
||||
{},
|
||||
None,
|
||||
release_gitter.InvalidRemoteError,
|
||||
),
|
||||
):
|
||||
mock_response = MagicMock(spec=requests.Response)
|
||||
mock_response.json = MagicMock()
|
||||
if subtest.args[0].hostname == "git.iamthefij.com":
|
||||
mock_response.json.return_value = {
|
||||
"paths": {"/repos/{owner}/{repo}/releases": {}},
|
||||
"basePath": "/api/v1",
|
||||
}
|
||||
with patch("requests.get", return_value=mock_response):
|
||||
subtest.run(release_gitter.GitRemoteInfo.get_releases_url)
|
||||
|
||||
|
||||
class TestVersionInfo(unittest.TestCase):
|
||||
def test_no_cargo_file(self):
|
||||
with patch("pathlib.Path.exists", return_value=False):
|
||||
version = release_gitter.read_version()
|
||||
self.assertIsNone(version)
|
||||
|
||||
@patch("pathlib.Path.exists", return_value=True)
|
||||
@patch(
|
||||
"pathlib.Path.open",
|
||||
mock_open(read_data="\n".join(["[package]", 'version = "1.0.0"'])),
|
||||
)
|
||||
def test_cargo_file_has_version(self, *_):
|
||||
version = release_gitter.read_version()
|
||||
self.assertEqual(version, "1.0.0")
|
||||
|
||||
@patch("pathlib.Path.exists", return_value=True)
|
||||
@patch(
|
||||
"pathlib.Path.open",
|
||||
mock_open(read_data="\n".join(["[package]"])),
|
||||
)
|
||||
def test_cargo_file_missing_version(self, *_):
|
||||
with self.assertRaises(ValueError):
|
||||
release_gitter.read_version()
|
||||
|
||||
|
||||
@patch("release_gitter.ZipFile", autospec=True)
|
||||
@patch("release_gitter.BytesIO", autospec=True)
|
||||
class TestContentTypeDetection(unittest.TestCase):
|
||||
def test_asset_encoding_priority(self, *_):
|
||||
package = release_gitter.get_asset_package(
|
||||
{
|
||||
"content_type": "application/x-tar",
|
||||
"name": "test.zip",
|
||||
},
|
||||
MagicMock(spec=["raw", "content"]),
|
||||
)
|
||||
# Tar should take priority over the file name zip extension
|
||||
self.assertIsInstance(package._package, TarFile)
|
||||
|
||||
def test_fallback_to_supported_encoding(self, *_):
|
||||
package = release_gitter.get_asset_package(
|
||||
{
|
||||
"content_type": "application/octetstream",
|
||||
"name": "test.zip",
|
||||
},
|
||||
MagicMock(spec=["raw", "content"]),
|
||||
)
|
||||
# Should fall back to zip extension
|
||||
self.assertIsInstance(package._package, ZipFile)
|
||||
|
||||
def test_missing_only_name_content_type(self, *_):
|
||||
package = release_gitter.get_asset_package(
|
||||
{
|
||||
"name": "test.zip",
|
||||
},
|
||||
MagicMock(spec=["raw", "content"]),
|
||||
)
|
||||
# Should fall back to zip extension
|
||||
self.assertIsInstance(package._package, ZipFile)
|
||||
|
||||
def test_no_content_types(self, *_):
|
||||
with self.assertRaises(release_gitter.UnsupportedContentTypeError):
|
||||
release_gitter.get_asset_package(
|
||||
{
|
||||
"name": "test",
|
||||
},
|
||||
MagicMock(spec=["raw", "content"]),
|
||||
)
|
||||
|
||||
def test_no_supported_content_types(self, *_):
|
||||
with self.assertRaises(release_gitter.UnsupportedContentTypeError):
|
||||
release_gitter.get_asset_package(
|
||||
{
|
||||
"content_type": "application/octetstream",
|
||||
"name": "test",
|
||||
},
|
||||
MagicMock(spec=["raw", "content"]),
|
||||
)
|
||||
|
||||
|
||||
class TestMatchAsset(unittest.TestCase):
|
||||
def test_match_asset_versions(self, *_):
|
||||
# Input variations:
|
||||
# Case 1: Version provided with prefix
|
||||
# Case 2: Version provided without prefix
|
||||
# Case 3: No version provided, tag exists in release
|
||||
# These should be impossible
|
||||
# Case 4: No version provided, tag doesn't exist in release but not in template
|
||||
# Case 5: No version provided, tag doesn't exist in release and is in template
|
||||
|
||||
# Release variations:
|
||||
# Case 1: tag_name with version prefix
|
||||
# Case 2: tag_name without version prefix
|
||||
|
||||
# File variations:
|
||||
# Case 1: file name with version prefix
|
||||
# Case 2: file name without version prefix
|
||||
|
||||
def new_expression(version: str | None, tag_name: str, file_name: str):
|
||||
release = {"tag_name": tag_name, "assets": [{"name": file_name}]}
|
||||
expected = {"name": file_name}
|
||||
return TestExpression(
|
||||
self, [release, "file-{version}.zip", version], {}, expected
|
||||
)
|
||||
|
||||
happy_cases = [
|
||||
new_expression(version, tag_name, file_name)
|
||||
for version, tag_name, file_name in product(
|
||||
("v1.0.0", "1.0.0", None),
|
||||
("v1.0.0", "1.0.0"),
|
||||
("file-v1.0.0.zip", "file-1.0.0.zip"),
|
||||
)
|
||||
]
|
||||
for test_case in happy_cases:
|
||||
test_case.run(release_gitter.match_asset)
|
||||
|
||||
def test_match_asset_systems(self, *_):
|
||||
# Input variations:
|
||||
# Case 1: System mapping provided
|
||||
# Case 2: No system mapping provided
|
||||
|
||||
# Test: We want to show that default matching will work out of the box with some values for the current machine
|
||||
# Test: We want to show that non-standard mappings will always work if provided manually
|
||||
|
||||
def run_with_context(actual_system: str, *args, **kwargs):
|
||||
with patch("platform.system", return_value=actual_system):
|
||||
return release_gitter.match_asset(*args, **kwargs)
|
||||
|
||||
def new_expression(
|
||||
actual_system: str,
|
||||
system_mapping: dict[str, str] | None,
|
||||
file_name: str,
|
||||
expected: dict[str, str],
|
||||
exception: type[Exception] | None = None,
|
||||
msg: str | None = None,
|
||||
):
|
||||
release = {
|
||||
"name": "v1.0.0",
|
||||
"tag_name": "v1.0.0",
|
||||
"assets": [{"name": file_name}],
|
||||
}
|
||||
return TestExpression(
|
||||
self,
|
||||
[actual_system, release, "file-{system}.zip"],
|
||||
{"system_mapping": system_mapping},
|
||||
expected,
|
||||
exception,
|
||||
msg,
|
||||
)
|
||||
|
||||
test_cases = chain(
|
||||
[
|
||||
new_expression(
|
||||
"Earth",
|
||||
None,
|
||||
"file-Earth.zip",
|
||||
{"name": "file-Earth.zip"},
|
||||
msg="Current system always included as an exact match synonym",
|
||||
),
|
||||
new_expression(
|
||||
"Linux",
|
||||
{"Linux": "jumanji"},
|
||||
"file-jumanji.zip",
|
||||
{"name": "file-jumanji.zip"},
|
||||
msg="Non-standard system mapping works",
|
||||
),
|
||||
new_expression(
|
||||
"Linux",
|
||||
{},
|
||||
"file-darwin.zip",
|
||||
{},
|
||||
ValueError,
|
||||
msg="No matching system",
|
||||
),
|
||||
],
|
||||
# Test default mappings
|
||||
(
|
||||
new_expression(
|
||||
actual_system,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default Linux mappings",
|
||||
)
|
||||
for actual_system, file_name in product(
|
||||
("Linux", "linux"),
|
||||
("file-Linux.zip", "file-linux.zip"),
|
||||
)
|
||||
),
|
||||
(
|
||||
new_expression(
|
||||
actual_system,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default macOS mappings",
|
||||
)
|
||||
for actual_system, file_name in product(
|
||||
("Darwin", "darwin", "MacOS", "macos", "macOS"),
|
||||
(
|
||||
"file-Darwin.zip",
|
||||
"file-darwin.zip",
|
||||
"file-MacOS.zip",
|
||||
"file-macos.zip",
|
||||
),
|
||||
)
|
||||
),
|
||||
(
|
||||
new_expression(
|
||||
actual_system,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default Windows mappings",
|
||||
)
|
||||
for actual_system, file_name in product(
|
||||
("Windows", "windows", "win", "win32", "win64"),
|
||||
(
|
||||
"file-Windows.zip",
|
||||
"file-windows.zip",
|
||||
"file-win.zip",
|
||||
"file-win32.zip",
|
||||
"file-win64.zip",
|
||||
),
|
||||
)
|
||||
),
|
||||
)
|
||||
for test_case in test_cases:
|
||||
test_case.run(run_with_context)
|
||||
|
||||
def test_match_asset_archs(self, *_):
|
||||
# Input variations:
|
||||
# Case 1: Arch mapping provided
|
||||
# Case 2: No arch mapping provided
|
||||
|
||||
# Test: We want to show that default matching will work out of the box with some values for the current machine
|
||||
# Test: We want to show that non-standard mappings will always work if provided manually
|
||||
|
||||
def run_with_context(actual_arch: str, *args, **kwargs):
|
||||
with patch("platform.machine", return_value=actual_arch):
|
||||
return release_gitter.match_asset(*args, **kwargs)
|
||||
|
||||
def new_expression(
|
||||
actual_arch: str,
|
||||
arch_mapping: dict[str, str] | None,
|
||||
file_name: str,
|
||||
expected: dict[str, str],
|
||||
exception: type[Exception] | None = None,
|
||||
msg: str | None = None,
|
||||
):
|
||||
release = {
|
||||
"name": "v1.0.0",
|
||||
"tag_name": "v1.0.0",
|
||||
"assets": [{"name": file_name}],
|
||||
}
|
||||
return TestExpression(
|
||||
self,
|
||||
[actual_arch, release, "file-{arch}.zip"],
|
||||
{"arch_mapping": arch_mapping},
|
||||
expected,
|
||||
exception,
|
||||
msg,
|
||||
)
|
||||
|
||||
test_cases = chain(
|
||||
[
|
||||
new_expression(
|
||||
"Earth",
|
||||
None,
|
||||
"file-Earth.zip",
|
||||
{"name": "file-Earth.zip"},
|
||||
msg="Current arch always included as an exact match synonym",
|
||||
),
|
||||
new_expression(
|
||||
"x86_64",
|
||||
{"x86_64": "jumanji"},
|
||||
"file-jumanji.zip",
|
||||
{"name": "file-jumanji.zip"},
|
||||
msg="Non-standard arch mapping works",
|
||||
),
|
||||
new_expression(
|
||||
"x86_64",
|
||||
{},
|
||||
"file-arm.zip",
|
||||
{},
|
||||
ValueError,
|
||||
msg="No matching arch",
|
||||
),
|
||||
],
|
||||
# Test default mappings
|
||||
(
|
||||
new_expression(
|
||||
actual_arch,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default arm mappings",
|
||||
)
|
||||
for actual_arch, file_name in product(
|
||||
("arm",),
|
||||
("file-arm.zip",),
|
||||
)
|
||||
),
|
||||
(
|
||||
new_expression(
|
||||
actual_arch,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default amd64 mappings",
|
||||
)
|
||||
for actual_arch, file_name in product(
|
||||
("amd64", "x86_64", "AMD64"),
|
||||
("file-amd64.zip", "file-x86_64.zip"),
|
||||
)
|
||||
),
|
||||
(
|
||||
new_expression(
|
||||
actual_arch,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default arm64 mappings",
|
||||
)
|
||||
for actual_arch, file_name in product(
|
||||
("arm64", "aarch64", "armv8b", "armv8l"),
|
||||
(
|
||||
"file-arm64.zip",
|
||||
"file-aarch64.zip",
|
||||
"file-armv8b.zip",
|
||||
"file-armv8l.zip",
|
||||
),
|
||||
)
|
||||
),
|
||||
(
|
||||
new_expression(
|
||||
actual_arch,
|
||||
None,
|
||||
file_name,
|
||||
{"name": file_name},
|
||||
msg="Default x86 mappings",
|
||||
)
|
||||
for actual_arch, file_name in product(
|
||||
("x86", "i386", "i686"),
|
||||
("file-x86.zip", "file-i386.zip", "file-i686.zip"),
|
||||
)
|
||||
),
|
||||
)
|
||||
for test_case in test_cases:
|
||||
test_case.run(run_with_context)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
|
@ -1,4 +1,6 @@
|
|||
-e .
|
||||
pytest
|
||||
coverage
|
||||
hatch
|
||||
mypy
|
||||
pre-commit
|
||||
types-requests
|
||||
types-toml
|
||||
|
|
|
@ -0,0 +1,8 @@
|
|||
---
|
||||
- id: stylua
|
||||
name: StyLua
|
||||
description: An opinionated Lua code formatter
|
||||
entry: stylua
|
||||
language: python
|
||||
types:
|
||||
- lua
|
|
@ -0,0 +1,18 @@
|
|||
[build-system]
|
||||
requires = ["release-gitter[builder]"]
|
||||
build-backend = "pseudo_builder"
|
||||
|
||||
[tool.release-gitter]
|
||||
# git-url is not needed if you're in the actual source repo
|
||||
git-url = "https://github.com/JohnnyMorganz/StyLua"
|
||||
# version is not needed if you have a Cargo.toml in the current directory
|
||||
version = "0.11.3"
|
||||
|
||||
extract-files = [ "stylua" ]
|
||||
format = "stylua-{version}-{system}.zip"
|
||||
exec = "chmod +x stylua"
|
||||
|
||||
[tool.release-gitter.map-system]
|
||||
Darwin = "macos"
|
||||
Windows = "win64"
|
||||
Linux = "linux"
|
47
setup.py
47
setup.py
|
@ -1,47 +0,0 @@
|
|||
from codecs import open
|
||||
from os import path
|
||||
|
||||
from setuptools import find_packages
|
||||
from setuptools import setup
|
||||
|
||||
here = path.abspath(path.dirname(__file__))
|
||||
|
||||
# Get the long description from the README file
|
||||
with open(path.join(here, "README.md"), encoding="utf-8") as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name="release-gitter",
|
||||
version="0.1.0",
|
||||
description="Easily download releases from sites like Github and Gitea",
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/markdown",
|
||||
url="https://git.iamthefij.com/iamthefij/release-gitter.git",
|
||||
download_url=(
|
||||
"https://git.iamthefij.com/iamthefij/release-gitter.git/archive/master.tar.gz"
|
||||
),
|
||||
author="iamthefij",
|
||||
author_email="",
|
||||
classifiers=[
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.7",
|
||||
"Programming Language :: Python :: 3.8",
|
||||
"Programming Language :: Python :: 3.9",
|
||||
],
|
||||
keywords="",
|
||||
packages=find_packages(
|
||||
exclude=[
|
||||
"contrib",
|
||||
"docs",
|
||||
"examples",
|
||||
"scripts",
|
||||
"tests",
|
||||
]
|
||||
),
|
||||
install_requires=["requests"],
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"release-gitter=release_gitter:main",
|
||||
],
|
||||
},
|
||||
)
|
17
tox.ini
17
tox.ini
|
@ -1,17 +0,0 @@
|
|||
[tox]
|
||||
envlist = py3
|
||||
|
||||
[testenv]
|
||||
deps =
|
||||
-rrequirements-dev.txt
|
||||
commands =
|
||||
coverage erase
|
||||
coverage run --source=release_gitter -m unittest discover . {posargs:"*_test.py"}
|
||||
# coverage report -m --fail-under 70
|
||||
pre-commit run --all-files
|
||||
|
||||
[testenv:pre-commit]
|
||||
deps =
|
||||
pre-commit
|
||||
commands =
|
||||
pre-commit {posargs}
|
Loading…
Reference in New Issue