|
| 1 | +#!/usr/bin/env python3 |
| 2 | + |
| 3 | +from __future__ import annotations |
| 4 | + |
| 5 | +import argparse |
| 6 | +import json |
| 7 | +import os |
| 8 | +import re |
| 9 | +import sys |
| 10 | +from pathlib import Path |
| 11 | + |
| 12 | +SUPPORTED_MINORS = ["8.3", "8.4", "8.5"] |
| 13 | +DEFAULT_PHP_VERSION = "8.3" |
| 14 | + |
| 15 | + |
| 16 | +def version_to_tuple(version: str) -> tuple[int, int]: |
| 17 | + major, minor = version.split(".") |
| 18 | + return int(major), int(minor) |
| 19 | + |
| 20 | + |
| 21 | +def normalize_minor(version: str) -> str | None: |
| 22 | + match = re.match(r"^\s*v?(8)\.(\d+)(?:\.\d+)?(?:\.\*)?\s*$", version) |
| 23 | + |
| 24 | + if match is None: |
| 25 | + return None |
| 26 | + |
| 27 | + return f"{match.group(1)}.{match.group(2)}" |
| 28 | + |
| 29 | + |
| 30 | +def next_supported_minor(version: str) -> str | None: |
| 31 | + if version not in SUPPORTED_MINORS: |
| 32 | + return None |
| 33 | + |
| 34 | + index = SUPPORTED_MINORS.index(version) + 1 |
| 35 | + |
| 36 | + if index >= len(SUPPORTED_MINORS): |
| 37 | + major, minor = version_to_tuple(version) |
| 38 | + return f"{major}.{minor + 1}" |
| 39 | + |
| 40 | + return SUPPORTED_MINORS[index] |
| 41 | + |
| 42 | + |
| 43 | +def infer_clause_lower_bound(clause: str) -> str | None: |
| 44 | + tokens = re.findall(r"(\^|~|>=|>|<=|<|==|=)?\s*v?(8\.\d+(?:\.\d+)?(?:\.\*)?)", clause) |
| 45 | + lower_bounds: list[str] = [] |
| 46 | + |
| 47 | + for operator, version in tokens: |
| 48 | + normalized = normalize_minor(version) |
| 49 | + |
| 50 | + if normalized is None: |
| 51 | + continue |
| 52 | + |
| 53 | + if operator in ("", "=", "==", "^", "~", ">="): |
| 54 | + lower_bounds.append(normalized) |
| 55 | + continue |
| 56 | + |
| 57 | + if operator == ">": |
| 58 | + next_minor = next_supported_minor(normalized) |
| 59 | + |
| 60 | + if next_minor is not None: |
| 61 | + lower_bounds.append(next_minor) |
| 62 | + |
| 63 | + if not lower_bounds: |
| 64 | + return None |
| 65 | + |
| 66 | + return max(lower_bounds, key=version_to_tuple) |
| 67 | + |
| 68 | + |
| 69 | +def infer_minimum_supported_minor(requirement: str) -> str | None: |
| 70 | + clauses = [clause.strip() for clause in requirement.split("||")] |
| 71 | + lower_bounds = [ |
| 72 | + clause_lower_bound |
| 73 | + for clause in clauses |
| 74 | + if (clause_lower_bound := infer_clause_lower_bound(clause)) is not None |
| 75 | + ] |
| 76 | + |
| 77 | + if not lower_bounds: |
| 78 | + return None |
| 79 | + |
| 80 | + return min(lower_bounds, key=version_to_tuple) |
| 81 | + |
| 82 | + |
| 83 | +def resolve_from_lock(composer_lock: Path) -> tuple[str | None, str | None]: |
| 84 | + if not composer_lock.exists(): |
| 85 | + return None, None |
| 86 | + |
| 87 | + try: |
| 88 | + payload = json.loads(composer_lock.read_text()) |
| 89 | + except json.JSONDecodeError: |
| 90 | + return None, "composer.lock exists but could not be parsed" |
| 91 | + |
| 92 | + platform_overrides = payload.get("platform-overrides") or {} |
| 93 | + platform_php = platform_overrides.get("php") |
| 94 | + |
| 95 | + if isinstance(platform_php, str): |
| 96 | + resolved = normalize_minor(platform_php) |
| 97 | + |
| 98 | + if resolved is not None: |
| 99 | + return resolved, "composer.lock platform-overrides.php" |
| 100 | + |
| 101 | + return None, "composer.lock platform-overrides.php is not a supported PHP version" |
| 102 | + |
| 103 | + return None, None |
| 104 | + |
| 105 | + |
| 106 | +def resolve_from_json(composer_json: Path) -> tuple[str | None, str | None]: |
| 107 | + if not composer_json.exists(): |
| 108 | + return None, "composer.json does not exist" |
| 109 | + |
| 110 | + try: |
| 111 | + payload = json.loads(composer_json.read_text()) |
| 112 | + except json.JSONDecodeError: |
| 113 | + return None, "composer.json could not be parsed" |
| 114 | + |
| 115 | + config_platform_php = (((payload.get("config") or {}).get("platform") or {}).get("php")) |
| 116 | + |
| 117 | + if isinstance(config_platform_php, str): |
| 118 | + resolved = normalize_minor(config_platform_php) |
| 119 | + |
| 120 | + if resolved is not None: |
| 121 | + return resolved, "composer.json config.platform.php" |
| 122 | + |
| 123 | + return None, "composer.json config.platform.php is not a supported PHP version" |
| 124 | + |
| 125 | + require_php = ((payload.get("require") or {}).get("php")) |
| 126 | + |
| 127 | + if isinstance(require_php, str): |
| 128 | + resolved = infer_minimum_supported_minor(require_php) |
| 129 | + |
| 130 | + if resolved is not None: |
| 131 | + return resolved, "composer.json require.php" |
| 132 | + |
| 133 | + return None, "composer.json require.php could not be resolved safely" |
| 134 | + |
| 135 | + return None, None |
| 136 | + |
| 137 | + |
| 138 | +def resolve_php_version(composer_json: Path, composer_lock: Path) -> tuple[str, str, str | None]: |
| 139 | + resolved, source = resolve_from_lock(composer_lock) |
| 140 | + |
| 141 | + if resolved is None: |
| 142 | + resolved, source = resolve_from_json(composer_json) |
| 143 | + |
| 144 | + if resolved is None: |
| 145 | + return DEFAULT_PHP_VERSION, "fallback", "No reliable PHP version source was found. Falling back to 8.3." |
| 146 | + |
| 147 | + if resolved not in SUPPORTED_MINORS: |
| 148 | + return DEFAULT_PHP_VERSION, "fallback", ( |
| 149 | + f"Resolved PHP version {resolved} from {source} is outside the supported CI policy. Falling back to 8.3." |
| 150 | + ) |
| 151 | + |
| 152 | + return resolved, source or "fallback", None |
| 153 | + |
| 154 | + |
| 155 | +def write_output(name: str, value: str) -> None: |
| 156 | + github_output = os.environ.get("GITHUB_OUTPUT") |
| 157 | + |
| 158 | + if github_output: |
| 159 | + with open(github_output, "a", encoding="utf-8") as handle: |
| 160 | + handle.write(f"{name}={value}\n") |
| 161 | + |
| 162 | + |
| 163 | +def main() -> int: |
| 164 | + parser = argparse.ArgumentParser(description="Resolve the PHP version used by Fast Forward workflows.") |
| 165 | + parser.add_argument("--composer-json", default="composer.json") |
| 166 | + parser.add_argument("--composer-lock", default="composer.lock") |
| 167 | + args = parser.parse_args() |
| 168 | + |
| 169 | + resolved_version, source, warning = resolve_php_version( |
| 170 | + Path(args.composer_json), |
| 171 | + Path(args.composer_lock), |
| 172 | + ) |
| 173 | + |
| 174 | + matrix_versions = [version for version in SUPPORTED_MINORS if version_to_tuple(version) >= version_to_tuple(resolved_version)] |
| 175 | + matrix = json.dumps({"php-version": matrix_versions}, separators=(",", ":")) |
| 176 | + |
| 177 | + print(f"Resolved PHP version source: {source}") |
| 178 | + print(f"Resolved PHP version: {resolved_version}") |
| 179 | + print(f"Resolved PHP test matrix: {matrix_versions}") |
| 180 | + |
| 181 | + if warning: |
| 182 | + print(f"Warning: {warning}") |
| 183 | + |
| 184 | + write_output("php-version", resolved_version) |
| 185 | + write_output("php-version-source", source) |
| 186 | + write_output("test-matrix", matrix) |
| 187 | + write_output("warning", warning or "") |
| 188 | + |
| 189 | + return 0 |
| 190 | + |
| 191 | + |
| 192 | +if __name__ == "__main__": |
| 193 | + sys.exit(main()) |
0 commit comments