Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 51 additions & 4 deletions tooling/extension-bindings/ci/publish-maven.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from __future__ import annotations

import argparse
import re
import shutil
import subprocess
import tempfile
Expand Down Expand Up @@ -82,20 +83,66 @@ def already_published(coordinate: Coordinate) -> bool:
raise


def numbers(version: str) -> tuple[int, ...] | None:
"""The numbers of a plain release version such as 0.1.0, or None for anything else."""
return tuple(int(part) for part in version.split(".")) if re.fullmatch(r"[0-9]+(?:\.[0-9]+)*", version) else None


def in_range(version: str, spec: str) -> bool:
"""Whether a release version satisfies a Maven version requirement: a version, or a range such as [0.1.0,0.2.0)."""
found = numbers(version)
if found is None:
return False
if spec[:1] not in "[(":
return found == numbers(spec)
match = re.fullmatch(r"([\[(])\s*([0-9.]*)\s*(?:(,)\s*([0-9.]*)\s*)?([\])])", spec)
if match is None:
raise ValueError(f"cannot read the version range {spec}")
opening, low, comma, high, closing = match.groups()
if not comma:
return opening == "[" and closing == "]" and found == numbers(low)
if low and (found < numbers(low) or (found == numbers(low) and opening == "(")):
return False
return not (high and (found > numbers(high) or (found == numbers(high) and closing == ")")))


def metadata_versions(group: str, artifact: str) -> list[str]:
"""The versions Maven Central lists for an artifact, or none when it is not there."""
url = f"{CENTRAL}/{group.replace('.', '/')}/{artifact}/maven-metadata.xml"
try:
with urllib.request.urlopen(url, timeout=30) as response:
root = ET.parse(response).getroot()
except urllib.error.HTTPError as error:
if error.code == 404:
return []
raise
return [(item.text or "").strip() for item in root.findall("./versioning/versions/version")]


def available(dependency: Coordinate) -> bool:
"""Whether Maven Central has a version that satisfies what a package depends on."""
group, artifact, spec = dependency
if spec[:1] not in "[(":
return already_published(dependency)
return any(in_range(version, spec) for version in metadata_versions(group, artifact))


def publication_order(packages: dict[Coordinate, dict]) -> list[Coordinate]:
"""Order the selected packages so every one comes after the selected packages it depends on."""
ordered: list[Coordinate] = []
state: dict[Coordinate, int] = {}
by_name = {(group, artifact): (group, artifact, version) for group, artifact, version in packages}

def visit(coordinate: Coordinate) -> None:
if state.get(coordinate) == 2:
return
if state.get(coordinate) == 1:
raise ValueError(f"package dependency cycle at {':'.join(coordinate)}")
state[coordinate] = 1
for dependency in sorted(packages[coordinate]["dependencies"]):
if dependency in packages:
visit(dependency)
for group, artifact, spec in sorted(packages[coordinate]["dependencies"]):
selected = by_name.get((group, artifact))
if selected is not None and in_range(selected[2], spec):
visit(selected)
state[coordinate] = 2
ordered.append(coordinate)

Expand All @@ -111,7 +158,7 @@ def run(command: list[str], cwd: Path) -> subprocess.CompletedProcess:
def check_dependencies(coordinate: Coordinate, dependencies: list[Coordinate]) -> None:
"""A real upload is built against Maven Central, so what a package depends on must be public first."""
for dependency in dependencies:
if not already_published(dependency):
if not available(dependency):
raise ValueError(
f"{':'.join(coordinate)} depends on {':'.join(dependency)}, which is not on Maven Central yet. "
f"Publish it first, press Publish in the Portal at {DEPLOYMENTS}, wait until it is on Central, "
Expand Down
49 changes: 49 additions & 0 deletions tooling/extension-bindings/ci/test_publish_maven.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,55 @@ def test_dependencies_are_ordered_before_their_dependents(self) -> None:
with self.assertRaisesRegex(ValueError, "cycle"):
script.publication_order(packages)

def test_version_requirements_are_matched_like_maven_does(self) -> None:
for version, spec, expected in (
("0.1.0", "0.1.0", True),
("0.1.1", "0.1.0", False),
("0.1.0", "[0.1.0,0.2.0)", True),
("0.1.9", "[0.1.0,0.2.0)", True),
("0.2.0", "[0.1.0,0.2.0)", False),
("0.0.9", "[0.1.0,0.2.0)", False),
("0.2.0", "[0.1.0,0.2.0]", True),
("0.1.0", "(0.1.0,0.2.0)", False),
("1.0.0", "[0.1.0,)", True),
("0.1.0", "[0.1.0]", True),
("0.1.1", "[0.1.0]", False),
("0.2.0-rc.1", "[0.1.0,1.0.0)", False),
):
self.assertEqual(script.in_range(version, spec), expected, f"{version} in {spec}")
with self.assertRaisesRegex(ValueError, "cannot read the version range"):
script.in_range("0.1.0", "[nonsense")

def test_a_range_is_met_by_any_version_central_lists(self) -> None:
dependency = (GROUP, "addon", "[0.1.0,0.2.0)")
with patch.object(script, "metadata_versions", return_value=["0.0.9", "0.1.3"]):
self.assertTrue(script.available(dependency))
with patch.object(script, "metadata_versions", return_value=["0.2.0"]):
self.assertFalse(script.available(dependency))
with patch.object(script, "metadata_versions", return_value=[]):
self.assertFalse(script.available(dependency))
with patch.object(script, "already_published", return_value=True) as exact:
self.assertTrue(script.available((GROUP, "addon", "0.1.0")))
exact.assert_called_once()

def test_central_metadata_lists_versions_and_a_missing_artifact_lists_none(self) -> None:
body = b"<metadata><versioning><versions><version>0.1.0</version><version>0.1.1</version></versions></versioning></metadata>"
with patch.object(script.urllib.request, "urlopen", return_value=io.BytesIO(body)) as opened:
self.assertEqual(script.metadata_versions(GROUP, "addon"), ["0.1.0", "0.1.1"])
self.assertEqual(
opened.call_args.args[0], "https://repo1.maven.org/maven2/io/example/bindings/addon/maven-metadata.xml"
)
missing = urllib.error.HTTPError("u", 404, "Not Found", {}, None)
with patch.object(script.urllib.request, "urlopen", side_effect=missing):
self.assertEqual(script.metadata_versions(GROUP, "addon"), [])

def test_a_dependency_on_a_range_is_ordered_after_the_selected_package_that_meets_it(self) -> None:
needs, provides = (GROUP, "aaa-needs", "0.1.0"), (GROUP, "zzz-provides", "0.1.0")
packages = {needs: {"dependencies": [(GROUP, "zzz-provides", "[0.1.0,0.2.0)")]}, provides: {"dependencies": []}}
self.assertEqual(script.publication_order(packages), [provides, needs])
packages = {needs: {"dependencies": [(GROUP, "zzz-provides", "[0.2.0,0.3.0)")]}, provides: {"dependencies": []}}
self.assertEqual(script.publication_order(packages), [needs, provides], "the selected version is not what it needs")

def test_a_dry_run_builds_into_a_local_repository_and_never_uploads(self) -> None:
with patch.object(script, "run") as run, patch.object(script, "already_published", return_value=False):
count = script.publish(self.root, self.targets, False)
Expand Down