Skip to content
Draft
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
472 changes: 472 additions & 0 deletions .github/scripts/dependency_age.py

Large diffs are not rendered by default.

29 changes: 29 additions & 0 deletions .github/scripts/tests/fixtures/gradle-newest-too-new.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[
{
"version": "9.5-rc-1",
"buildTime": "20260420120000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": true
},
{
"version": "9.4.2",
"buildTime": "20260423130000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false
},
{
"version": "9.4.1",
"buildTime": "20260422110000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false
}
]
20 changes: 20 additions & 0 deletions .github/scripts/tests/fixtures/gradle-no-eligible.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[
{
"version": "9.5-rc-1",
"buildTime": "20260420120000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": true
},
{
"version": "9.4.2",
"buildTime": "20260423130000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false
}
]
35 changes: 35 additions & 0 deletions .github/scripts/tests/fixtures/gradle-prerelease-filtering.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[
{
"version": "9.5.0-rc-4",
"buildTime": "20260420120000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false,
"rcFor": "9.5.0",
"milestoneFor": ""
},
{
"version": "9.6.0-milestone-1",
"buildTime": "20260419120000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false,
"rcFor": "",
"milestoneFor": "9.6.0"
},
{
"version": "9.4.1",
"buildTime": "20260422110000+0000",
"snapshot": false,
"nightly": false,
"releaseNightly": false,
"broken": false,
"activeRc": false,
"rcFor": "",
"milestoneFor": ""
}
]
18 changes: 18 additions & 0 deletions .github/scripts/tests/fixtures/maven-newest-too-new.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"response": {
"docs": [
{
"v": "4.0.0",
"timestamp": "2026-04-23T13:00:00Z"
},
{
"v": "4.0.0-beta-3",
"timestamp": "2026-04-21T12:00:00Z"
},
{
"v": "3.9.8",
"timestamp": "2026-04-20T12:00:00Z"
}
]
}
}
14 changes: 14 additions & 0 deletions .github/scripts/tests/fixtures/surefire-boundary.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"response": {
"docs": [
{
"v": "3.5.6",
"timestamp": "2026-04-23T13:00:00Z"
},
{
"v": "3.5.5",
"timestamp": "2026-04-22T12:00:00Z"
}
]
}
}
260 changes: 260 additions & 0 deletions .github/scripts/tests/test_dependency_age.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,260 @@
import json
import os
import re
import shutil
import subprocess
import tempfile
import unittest
from pathlib import Path


REPO_ROOT = Path(__file__).resolve().parents[3]
SCRIPT = REPO_ROOT / ".github/scripts/dependency_age.py"
FIXTURES = Path(__file__).resolve().parent / "fixtures"
NOW = "2026-04-24T12:00:00Z"
OUTPUT_PATTERN = re.compile(
r"^(cutoff_at|found|version|published_at|reason|reverted_files)=(.*)$"
)


class DependencyAgeScriptTest(unittest.TestCase):
def run_script(self, *args: str, env: dict[str, str] | None = None) -> subprocess.CompletedProcess[str]:
process_env = os.environ.copy()
if env:
process_env.update(env)
return subprocess.run(
["python3", str(SCRIPT), *args],
cwd=REPO_ROOT,
capture_output=True,
text=True,
check=False,
env=process_env,
)

def parse_outputs(self, stdout: str) -> dict[str, str]:
outputs: dict[str, str] = {}
for line in stdout.splitlines():
match = OUTPUT_PATTERN.match(line)
if match:
outputs[match.group(1)] = match.group(2)
return outputs

def test_selects_previous_gradle_release_when_newest_is_too_new(self) -> None:
result = self.run_script(
"select-gradle",
"--now",
NOW,
"--versions-file",
str(FIXTURES / "gradle-newest-too-new.json"),
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["version"], "9.4.1")
self.assertEqual(outputs["published_at"], "2026-04-22T11:00:00Z")
self.assertEqual(outputs["cutoff_at"], "2026-04-22T12:00:00Z")

def test_reports_when_no_eligible_gradle_release_exists(self) -> None:
result = self.run_script(
"select-gradle",
"--now",
NOW,
"--versions-file",
str(FIXTURES / "gradle-no-eligible.json"),
)

self.assertEqual(result.returncode, 1, result.stdout)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["found"], "false")
self.assertIn("No eligible stable Gradle release", outputs["reason"])

def test_selects_previous_maven_release_when_newest_is_too_new(self) -> None:
result = self.run_script(
"select-maven",
"--now",
NOW,
"--group-id",
"org.apache.maven",
"--artifact-id",
"apache-maven",
"--search-response-file",
str(FIXTURES / "maven-newest-too-new.json"),
"--prerelease-pattern",
"alpha",
"--prerelease-pattern",
"beta",
"--prerelease-pattern",
"rc",
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["version"], "3.9.8")

def test_filters_rc_and_milestone_releases_by_json_fields(self) -> None:
result = self.run_script(
"select-gradle",
"--now",
NOW,
"--versions-file",
str(FIXTURES / "gradle-prerelease-filtering.json"),
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["version"], "9.4.1")

def test_exact_48_hour_boundary_is_accepted(self) -> None:
result = self.run_script(
"select-maven",
"--now",
NOW,
"--group-id",
"org.apache.maven.plugins",
"--artifact-id",
"maven-surefire-plugin",
"--search-response-file",
str(FIXTURES / "surefire-boundary.json"),
"--prerelease-pattern",
"alpha",
"--prerelease-pattern",
"beta",
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["version"], "3.5.5")
self.assertEqual(outputs["published_at"], "2026-04-22T12:00:00Z")


def run_validate_lockfiles(
self,
*,
baseline: dict[str, str],
current: dict[str, str],
metadata: dict,
now: str = NOW,
) -> tuple[subprocess.CompletedProcess[str], Path]:
"""
Run validate-lockfiles with in-memory lockfile content.
baseline/current map relative paths to file text.
All coordinates must be covered by metadata — any uncovered coordinate
hits the (unreachable) search URL and is warned+skipped.
"""
tmp = Path(tempfile.mkdtemp())
self.addCleanup(shutil.rmtree, tmp, True)
baseline_dir = tmp / "before"
current_dir = tmp / "after"
metadata_file = tmp / "metadata.json"

for rel_path, content in baseline.items():
p = baseline_dir / rel_path
p.parent.mkdir(parents=True, exist_ok=True)
p.write_text(content, encoding="utf-8")

for rel_path, content in current.items():
p = current_dir / rel_path
p.parent.mkdir(parents=True, exist_ok=True)
p.write_text(content, encoding="utf-8")

metadata_file.write_text(json.dumps(metadata), encoding="utf-8")

result = self.run_script(
"validate-lockfiles",
"--baseline-dir", str(baseline_dir),
"--current-dir", str(current_dir),
"--metadata-file", str(metadata_file),
"--search-url", (tmp / "no-network").as_uri(),
"--now", now,
)
return result, current_dir

def test_validates_changed_lockfiles_when_all_updates_are_old_enough(self) -> None:
baseline_content = "# lockfile\ncom.example:lib-a:1.0.0=runtimeClasspath\ncom.example:lib-b:1.0.0=runtimeClasspath\n"
current_content = "# lockfile\ncom.example:lib-a:1.1.0=runtimeClasspath\ncom.example:lib-b:1.1.0=runtimeClasspath\n"
metadata = {
"com.example:lib-a:1.1.0": "2026-04-20T12:00:00Z",
"com.example:lib-b:1.1.0": "2026-04-20T11:00:00Z",
}

result, current_dir = self.run_validate_lockfiles(
baseline={"module/gradle.lockfile": baseline_content},
current={"module/gradle.lockfile": current_content},
metadata=metadata,
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["reverted_files"], "0")
self.assertEqual((current_dir / "module/gradle.lockfile").read_text(encoding="utf-8"), current_content)

def test_reverts_lockfile_when_any_changed_dependency_is_too_new(self) -> None:
baseline_content = "# lockfile\ncom.example:lib-a:1.0.0=runtimeClasspath\ncom.example:lib-b:1.0.0=runtimeClasspath\n"
current_content = "# lockfile\ncom.example:lib-a:1.1.0=runtimeClasspath\ncom.example:lib-b:2.0.0=runtimeClasspath\n"
metadata = {
"com.example:lib-a:1.1.0": "2026-04-20T12:00:00Z", # old enough
"com.example:lib-b:2.0.0": "2026-04-24T11:00:00Z", # too new
}

result, current_dir = self.run_validate_lockfiles(
baseline={"module/gradle.lockfile": baseline_content},
current={"module/gradle.lockfile": current_content},
metadata=metadata,
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["reverted_files"], "1")
self.assertEqual((current_dir / "module/gradle.lockfile").read_text(encoding="utf-8"), baseline_content)

def test_reverts_lockfile_when_one_of_multiple_coexisting_versions_is_too_new(self) -> None:
baseline_content = "# lockfile\ncom.typesafe:config:1.3.1=compileClasspath\ncom.typesafe:config:1.4.4=runtimeClasspath\n"
current_content = "# lockfile\ncom.typesafe:config:1.3.1=compileClasspath\ncom.typesafe:config:1.5.0=runtimeClasspath\n"
metadata = {
"com.typesafe:config:1.5.0": "2026-04-24T11:00:00Z", # too new
}

result, current_dir = self.run_validate_lockfiles(
baseline={"module/gradle.lockfile": baseline_content},
current={"module/gradle.lockfile": current_content},
metadata=metadata,
)

self.assertEqual(result.returncode, 0, result.stderr)
self.assertEqual((current_dir / "module/gradle.lockfile").read_text(encoding="utf-8"), baseline_content)

def test_removes_brand_new_lockfile_with_too_new_dependency(self) -> None:
current_content = "# lockfile\ncom.example:brand-new:1.0.0=runtimeClasspath\n"
metadata = {
"com.example:brand-new:1.0.0": "2026-04-24T11:00:00Z", # too new
}

result, current_dir = self.run_validate_lockfiles(
baseline={},
current={"module/gradle.lockfile": current_content},
metadata=metadata,
)

self.assertEqual(result.returncode, 0, result.stderr)
self.assertFalse((current_dir / "module/gradle.lockfile").exists())

def test_warns_and_skips_coordinate_when_metadata_lookup_fails(self) -> None:
# coordinate not in metadata → hits unreachable search URL → warns and skips (does not revert)
baseline_content = "# lockfile\ncom.example:lib:1.0.0=runtimeClasspath\n"
current_content = "# lockfile\ncom.example:lib:1.1.0=runtimeClasspath\n"

result, current_dir = self.run_validate_lockfiles(
baseline={"module/gradle.lockfile": baseline_content},
current={"module/gradle.lockfile": current_content},
metadata={},
)

self.assertEqual(result.returncode, 0, result.stderr)
outputs = self.parse_outputs(result.stdout)
self.assertEqual(outputs["reverted_files"], "0")
self.assertIn("::warning", result.stdout)
self.assertEqual((current_dir / "module/gradle.lockfile").read_text(encoding="utf-8"), current_content)


if __name__ == "__main__":
unittest.main()
Loading
Loading