Skip to content

Restrict prerelease versions when updating by id. #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zooba wants to merge 1 commit into
base: main
Choose a base branch
from
+100 −31
Open

Restrict prerelease versions when updating by id. #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions src/manage/install_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ def _expand_versions_by_tag(versions):
yield {**v, "tag": t}


def select_package(index_downloader, tag, platform=None, *, urlopen=_urlopen, by_id=False):
def select_package(index_downloader, tag, platform=None, *, urlopen=_urlopen, by_id=False, allow_pre=True):
"""Finds suitable package from index.json that looks like:
{"versions": [
{"id": ..., "company": ..., "tag": ..., "url": ..., "hash": {"sha256": hexdigest}},
Expand All @@ -63,17 +63,24 @@ def select_package(index_downloader, tag, platform=None, *, urlopen=_urlopen, by
try:
if by_id:
for v in index.versions:
if not allow_pre and v["sort-version"].is_prerelease:
continue
if v["id"].casefold() == tag.casefold():
return v
raise LookupError("Could not find a runtime matching '{}' at '{}'".format(
tag, sanitise_url(index.source_url)
))
if platform:
try:
return index.find_to_install(tag + platform)
v = index.find_to_install(tag + platform)
except LookupError:
pass
return index.find_to_install(tag)
else:
if allow_pre or not v["sort-version"].is_prerelease:
return v
v = index.find_to_install(tag)
if allow_pre or not v["sort-version"].is_prerelease:
return v
except LookupError as ex:
first_exc = ex

Expand Down Expand Up @@ -367,7 +374,7 @@ def _same_install(i, j):
return i["id"] == j["id"] and i["sort-version"] == j["sort-version"]


def _find_one(cmd, source, tag, *, installed=None, by_id=False):
def _find_one(cmd, source, tag, *, installed=None, by_id=False, allow_pre=True):
if by_id:
LOGGER.debug("Searching for Python with ID %s", tag)
elif tag:
Expand All @@ -377,7 +384,7 @@ def _find_one(cmd, source, tag, *, installed=None, by_id=False):

download_cache = cmd.scratch.setdefault("install_command.download_cache", {})
downloader = IndexDownloader(cmd, source, Index, {}, download_cache)
install = select_package(downloader, tag, cmd.default_platform, by_id=by_id)
install = select_package(downloader, tag, cmd.default_platform, by_id=by_id, allow_pre=allow_pre)

# Ensure the requested source URL is in the install
if install and source:
Expand Down Expand Up @@ -829,14 +836,16 @@ def execute(cmd):
# Fallthrough is safe - cmd.tags is empty
elif cmd.update:
LOGGER.verbose("No tags provided, updating all installs:")
from .verutils import Version
for install in installed:
first_exc = None
update = None
allow_pre = Version(install['sort-version']).is_prerelease
for source in [install.get('source'), cmd.source, cmd.fallback_source]:
if not source:
continue
try:
update = _find_one(cmd, source, install['id'], by_id=True)
update = _find_one(cmd, source, install['id'], by_id=True, allow_pre=allow_pre)
if update:
break
except LookupError:
Expand Down
110 changes: 85 additions & 25 deletions tests/test_install_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from manage import install_command as IC
from manage import installs
from manage.exceptions import NoInstallFoundError
from manage.logging import LOGGER


def test_print_cli_shortcuts(patched_installs, assert_log, monkeypatch, tmp_path):
Expand Down Expand Up @@ -225,50 +226,51 @@ def __init__(self, tmp_path, *args, **kwargs):
self.scratch = {
"install_command.download_cache": self.download_cache,
}
self.automatic = kwargs.get("automatic", False)
self.by_id = kwargs.get("by_id", False)
self.default_install_tag = kwargs.get("default_install_tag", "1")
self.default_platform = kwargs.get("default_platform", "-32")
self.default_tag = kwargs.get("default_tag", "1")
self.download = kwargs.get("download")
self.automatic = kwargs.pop("automatic", False)
self.by_id = kwargs.pop("by_id", False)
self.default_install_tag = kwargs.pop("default_install_tag", "1")
self.default_platform = kwargs.pop("default_platform", "-32")
self.default_tag = kwargs.pop("default_tag", "1")
self.download = kwargs.pop("download", None)
if self.download:
self.download = tmp_path / self.download
self.download_dir = tmp_path / kwargs.get("download_dir", "_cache")
self.dry_run = kwargs.get("dry_run", True)
self.fallback_source = kwargs.get("fallback_source")
self.force = kwargs.get("force", True)
self.from_script = kwargs.get("from_script")
self.log_file = kwargs.get("log_file")
self.refresh = kwargs.get("refresh", False)
self.repair = kwargs.get("repair", False)
self.shebang_can_run_anything = kwargs.get("shebang_can_run_anything", False)
self.shebang_can_run_anything_silently = kwargs.get("shebang_can_run_anything_silently", False)
self.source = kwargs.get("source", "http://example.com/index.json")
self.target = kwargs.get("target")
self.download_dir = tmp_path / kwargs.pop("download_dir", "_cache")
self.dry_run = kwargs.pop("dry_run", True)
self.fallback_source = kwargs.pop("fallback_source", None)
self.force = kwargs.pop("force", True)
self.from_script = kwargs.pop("from_script", None)
self.log_file = kwargs.pop("log_file", None)
self.refresh = kwargs.pop("refresh", False)
self.repair = kwargs.pop("repair", False)
self.shebang_can_run_anything = kwargs.pop("shebang_can_run_anything", False)
self.shebang_can_run_anything_silently = kwargs.pop("shebang_can_run_anything_silently", False)
self.source = kwargs.pop("source", "http://example.com/index.json")
self.target = kwargs.pop("target", None)
if self.target:
self.target = tmp_path / self.target
self.update = kwargs.get("update", False)
self.virtual_env = kwargs.get("virtual_env")
self.update = kwargs.pop("update", False)
self.virtual_env = kwargs.pop("virtual_env", None)

self.index_installs = [
*kwargs.pop("index_installs", ()),
{
"schema": 1,
"id": "test-1.1-32",
"id": "test-32",
"sort-version": "1.1",
"company": "Test",
"tag": "1.1-32",
"install-for": ["1", "1.1", "1.1-32"],
"install-for": ["1-32", "1.1-32", "1.1-32"],
"display-name": "Test 1.1 (32)",
"executable": "test.exe",
"url": "about:blank",
},
{
"schema": 1,
"id": "test-1.0-32",
"id": "test-32",
"sort-version": "1.0",
"company": "Test",
"tag": "1.0-32",
"install-for": ["1", "1.0", "1.0-32"],
"install-for": ["1-32", "1.0-32", "1.0-32"],
"display-name": "Test 1.0 (32)",
"executable": "test.exe",
"url": "about:blank",
Expand All @@ -280,8 +282,13 @@ def __init__(self, tmp_path, *args, **kwargs):
self.installs = [{
**self.index_installs[-1],
"source": self.source,
"prefix": tmp_path / "test-1.0-32",
"prefix": tmp_path / "test-32",
}]
assert not kwargs

def ask_yn(self, prompt, *args):
LOGGER.info(prompt, *args)
return True

def get_log_file(self):
return self.log_file
Expand All @@ -302,6 +309,7 @@ def test_install_simple(tmp_path, assert_log):
IC.execute(cmd)
assert_log(
assert_log.skip_until("Searching for Python matching %s", ["1.1"]),
assert_log.skip_until(".*Your existing %s install.*", ["Test 1.0 (32)", "Test 1.1 (32)"]),
assert_log.skip_until("Installing %s", ["Test 1.1 (32)"]),
("Tag: %s\\\\%s", ["Test", "1.1-32"]),
)
Expand All @@ -317,6 +325,58 @@ def test_install_already_installed(tmp_path, assert_log):
)



def test_install_update(tmp_path, assert_log):
cmd = InstallCommandTestCmd(tmp_path, update=True, force=False,
index_installs=[
{"schema": 1, "id": "test-32", "sort-version": "1.2rc1",
"display-name": "Test 1.2rc1 (32)",
"company": "Test", "tag": "1.2rc-32",
"install-for": ["1-32", "1.2-32", "1.2rc1-32"]}
],
)

IC.execute(cmd)
assert_log(
assert_log.skip_until("Searching for Python with ID %s", ["test-32"]),
assert_log.skip_until("Updating to %s", ["Test 1.1 (32)"]),
)


def test_install_update_explicit(tmp_path, assert_log):
cmd = InstallCommandTestCmd(tmp_path, "1", update=True, force=False,
index_installs=[
{"schema": 1, "id": "test-32", "sort-version": "1.2rc1",
"display-name": "Test 1.2rc1 (32)",
"company": "Test", "tag": "1.2rc-32",
"install-for": ["1-32", "1.2-32", "1.2rc1-32"]}
],
)

IC.execute(cmd)
assert_log(
assert_log.skip_until("Searching for Python matching %s", ["1"]),
assert_log.skip_until("Updating to %s", ["Test 1.1 (32)"]),
)


def test_install_update_explicit_pre(tmp_path, assert_log):
cmd = InstallCommandTestCmd(tmp_path, "1rc", update=True, force=False,
index_installs=[
{"schema": 1, "id": "test-32", "sort-version": "1.2rc1",
"display-name": "Test 1.2rc1 (32)",
"company": "Test", "tag": "1.2rc-32",
"install-for": ["1-32", "1.2-32", "1.2rc1-32"]}
],
)

IC.execute(cmd)
assert_log(
assert_log.skip_until("Searching for Python matching %s", ["1rc"]),
assert_log.skip_until("Updating to %s", ["Test 1.2rc1 (32)"]),
)


def test_install_from_script(tmp_path, assert_log):
cmd = InstallCommandTestCmd(tmp_path, from_script=tmp_path / "t.py")

Expand Down
Loading