|
| 1 | +# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. |
| 2 | +"""Shared discovery helpers for the static validation tests. |
| 3 | +
|
| 4 | +Everything here is filesystem-only so the tests run fast and need no network or |
| 5 | +AWS credentials. Discovery walks the repository from its root (the parent of the |
| 6 | +``tests`` directory) and deliberately skips directories that hold scratch or |
| 7 | +vendored copies (for example ``.claude`` worktrees and ``.git``) so those never |
| 8 | +affect CI results. |
| 9 | +""" |
| 10 | +from __future__ import annotations |
| 11 | + |
| 12 | +import re |
| 13 | +import shutil |
| 14 | +from pathlib import Path |
| 15 | + |
| 16 | +import pytest |
| 17 | + |
| 18 | +REPO_ROOT = Path(__file__).resolve().parent.parent |
| 19 | + |
| 20 | + |
| 21 | +def require_tool(name: str, install_hint: str) -> str: |
| 22 | + """Return the path to a required executable, or FAIL the test if it is absent. |
| 23 | +
|
| 24 | + These checks are meant to run in CI where every required tool is installed. |
| 25 | + A missing tool always fails -- it is never skipped -- because a skipped |
| 26 | + check is indistinguishable from a passing one and is exactly how a bad |
| 27 | + sample slips through. There is deliberately no environment-variable escape |
| 28 | + hatch: run the checks with the tools installed, or they fail. |
| 29 | + """ |
| 30 | + path = shutil.which(name) |
| 31 | + if path: |
| 32 | + return path |
| 33 | + pytest.fail( |
| 34 | + f"required tool {name!r} is not installed. Install it with: {install_hint}", |
| 35 | + pytrace=False, |
| 36 | + ) |
| 37 | + |
| 38 | +# Directories anywhere in the tree whose contents are not part of the samples we |
| 39 | +# ship and should never be validated. |
| 40 | +_EXCLUDED_DIR_NAMES = {".git", ".claude", ".kiro", "node_modules", "__pycache__", "build"} |
| 41 | + |
| 42 | +# Matches the OpenJD ``specificationVersion`` header of a standalone template. |
| 43 | +# Anchored at column 0 (no leading whitespace) on purpose: a standalone OpenJD |
| 44 | +# template file has this as a top-level key, whereas a template *embedded* inside |
| 45 | +# another document (for example an environment template nested in a |
| 46 | +# CloudFormation resource) is indented. Only standalone template files are |
| 47 | +# validated with ``openjd check``. |
| 48 | +_SPEC_VERSION_RE = re.compile( |
| 49 | + r"""^specificationVersion\s*:\s*['"]?(?P<version>[A-Za-z0-9._-]+)""", |
| 50 | + re.MULTILINE, |
| 51 | +) |
| 52 | + |
| 53 | + |
| 54 | +def _is_excluded(path: Path) -> bool: |
| 55 | + return any(part in _EXCLUDED_DIR_NAMES for part in path.parts) |
| 56 | + |
| 57 | + |
| 58 | +def _iter_yaml_files() -> list[Path]: |
| 59 | + files = [] |
| 60 | + for pattern in ("*.yaml", "*.yml"): |
| 61 | + for path in REPO_ROOT.rglob(pattern): |
| 62 | + if not _is_excluded(path.relative_to(REPO_ROOT)): |
| 63 | + files.append(path) |
| 64 | + return sorted(set(files)) |
| 65 | + |
| 66 | + |
| 67 | +def spec_version(path: Path) -> str | None: |
| 68 | + """Return the OpenJD ``specificationVersion`` of a YAML file, or ``None``. |
| 69 | +
|
| 70 | + Reads only the head of the file; the header appears at the top of every |
| 71 | + OpenJD template. |
| 72 | + """ |
| 73 | + try: |
| 74 | + head = path.read_text(encoding="utf-8", errors="replace")[:4096] |
| 75 | + except OSError: |
| 76 | + return None |
| 77 | + match = _SPEC_VERSION_RE.search(head) |
| 78 | + return match.group("version") if match else None |
| 79 | + |
| 80 | + |
| 81 | +def find_openjd_templates() -> list[Path]: |
| 82 | + """All OpenJD job and environment templates in the repository.""" |
| 83 | + return [ |
| 84 | + p |
| 85 | + for p in _iter_yaml_files() |
| 86 | + if (v := spec_version(p)) is not None |
| 87 | + and (v.startswith("jobtemplate-") or v.startswith("environment-")) |
| 88 | + ] |
| 89 | + |
| 90 | + |
| 91 | +def find_job_templates() -> list[Path]: |
| 92 | + return [p for p in find_openjd_templates() if (spec_version(p) or "").startswith("jobtemplate-")] |
| 93 | + |
| 94 | + |
| 95 | +def find_environment_templates() -> list[Path]: |
| 96 | + return [p for p in find_openjd_templates() if (spec_version(p) or "").startswith("environment-")] |
| 97 | + |
| 98 | + |
| 99 | +def find_host_configuration_scripts() -> list[Path]: |
| 100 | + """Host configuration shell / PowerShell scripts.""" |
| 101 | + base = REPO_ROOT / "host_configuration_scripts" |
| 102 | + if not base.is_dir(): |
| 103 | + return [] |
| 104 | + scripts = [] |
| 105 | + for pattern in ("*.sh", "*.ps1"): |
| 106 | + for path in base.rglob(pattern): |
| 107 | + if not _is_excluded(path.relative_to(REPO_ROOT)): |
| 108 | + scripts.append(path) |
| 109 | + return sorted(set(scripts)) |
| 110 | + |
| 111 | + |
| 112 | +def find_cloudformation_templates() -> list[Path]: |
| 113 | + """CloudFormation templates (YAML files under ``cloudformation/``). |
| 114 | +
|
| 115 | + Excludes the OpenJD job templates that happen to live under that tree (for |
| 116 | + example the ``test-job.yaml`` samples) since those are validated by the |
| 117 | + OpenJD checks instead. |
| 118 | + """ |
| 119 | + base = REPO_ROOT / "cloudformation" |
| 120 | + if not base.is_dir(): |
| 121 | + return [] |
| 122 | + templates = [] |
| 123 | + for pattern in ("*.yaml", "*.yml"): |
| 124 | + for path in base.rglob(pattern): |
| 125 | + rel = path.relative_to(REPO_ROOT) |
| 126 | + if _is_excluded(rel) or spec_version(path) is not None: |
| 127 | + continue |
| 128 | + templates.append(path) |
| 129 | + return sorted(set(templates)) |
| 130 | + |
| 131 | + |
| 132 | +def find_conda_recipe_dirs() -> list[Path]: |
| 133 | + """Directories under ``conda_recipes/`` that contain a ``deadline-cloud.yaml``.""" |
| 134 | + base = REPO_ROOT / "conda_recipes" |
| 135 | + if not base.is_dir(): |
| 136 | + return [] |
| 137 | + dirs = [] |
| 138 | + for path in base.rglob("deadline-cloud.yaml"): |
| 139 | + rel = path.relative_to(REPO_ROOT) |
| 140 | + if not _is_excluded(rel): |
| 141 | + dirs.append(path.parent) |
| 142 | + return sorted(set(dirs)) |
| 143 | + |
| 144 | + |
| 145 | +def rel(path: Path) -> str: |
| 146 | + """Repo-relative string form of a path, for readable test ids.""" |
| 147 | + try: |
| 148 | + return str(path.relative_to(REPO_ROOT)) |
| 149 | + except ValueError: |
| 150 | + return str(path) |
0 commit comments