Skip to content

πŸ’« Toolkit to help you get started with SDD or any other process!

28.4 KB
Raw Blame
"""Regression coverage for the repository-owned preset submission verifier."""

import hashlib
import json
import subprocess
import sys
import zipfile
from datetime import datetime, timezone
from pathlib import Path

import pytest
import yaml

ROOT = Path(__file__).resolve().parent.parent
VERIFIER = ROOT / ".github" / "scripts" / "validate_community_preset.py"
WORKFLOW = ROOT / ".github" / "workflows" / "add-community-preset.md"


@pytest.fixture
def submission(tmp_path):
    issue = {
        "preset_id": "sample",
        "preset_name": "Sample Preset",
        "version": "1.2.3",
        "description": "Sample usage",
        "author": "Contributor",
        "repository": "https://github.com/example/presets",
        "download_url": "https://github.com/example/presets/releases/download/sample-v1.2.3/sample.zip",
        "documentation": "https://github.com/example/presets/blob/main/sample/README.md",
        "license": "MIT",
        "speckit_version": ">=1.0.0",
        "required_extensions": "aide, canon",
        "templates_provided": "- spec-template.md",
        "commands_provided": "- speckit.plan.md",
        "scripts_count": "0",
        "tags": "sample, example",
    }
    paths = {name: tmp_path / name for name in (
        "issue.json", "archive.zip", "README.md", "catalog.json", "presets.md",
        "snapshot.json",
    )}
    paths["README.md"].write_text(
        f"specify preset add --from {issue['download_url']}\n", encoding="utf-8"
    )
    manifest = {
        "preset": {"id": "sample", "version": "1.2.3"},
        "requires": {"speckit_version": ">=1.0.0", "extensions": ["aide", "canon"]},
    }
    with zipfile.ZipFile(paths["archive.zip"], "w") as archive:
        archive.writestr("presets-release/sample/preset.yml", yaml.safe_dump(manifest))
        archive.writestr("presets-release/other/preset.yml", yaml.safe_dump({
            "preset": {"id": "other", "version": "9.9.9"},
            "requires": {"speckit_version": ">=0.1.0"},
        }))
    issue["actual_sha256"] = hashlib.sha256(paths["archive.zip"].read_bytes()).hexdigest()
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["catalog.json"].write_text(
        json.dumps({"presets": {}}), encoding="utf-8"
    )
    paths["presets.md"].write_text(
        "| Preset | Purpose | Provides | Requires | URL |\n"
        "|--------|---------|----------|----------|-----|\n",
        encoding="utf-8",
    )
    return issue, manifest, paths


def run_verifier(paths, phase="submission"):
    return subprocess.run(
        [
            sys.executable, str(VERIFIER), phase,
            "--issue", str(paths["issue.json"]),
            "--archive", str(paths["archive.zip"]),
            "--readme", str(paths["README.md"]),
            "--catalog", str(paths["catalog.json"]),
            "--docs", str(paths["presets.md"]),
            "--snapshot", str(paths["snapshot.json"]),
        ],
        capture_output=True, text=True, check=False,
    )


def write_archive(paths, manifest):
    with zipfile.ZipFile(paths["archive.zip"], "w") as archive:
        archive.writestr("release/sample/preset.yml", yaml.safe_dump(manifest))


def write_generated(issue, paths, *, created_at=None):
    timestamp = (
        json.loads(paths["snapshot.json"].read_text(encoding="utf-8"))["expected_timestamp"]
        if paths["snapshot.json"].exists()
        else "2026-01-01T00:00:00Z"
    )
    entry = {
        "id": issue["preset_id"], "name": issue["preset_name"],
        "version": issue["version"], "description": issue["description"],
        "author": issue["author"], "repository": issue["repository"],
        "download_url": issue["download_url"], "sha256": issue["actual_sha256"],
        "homepage": issue["repository"], "documentation": issue["documentation"],
        "license": issue["license"],
        "requires": {"speckit_version": issue["speckit_version"],
                     "extensions": ["aide", "canon"]},
        "provides": {"templates": 1, "commands": 1},
        "tags": ["sample", "example"],
        "created_at": created_at if created_at is not None else timestamp,
        "updated_at": timestamp,
    }
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": entry["updated_at"], "presets": {"sample": entry},
    }), encoding="utf-8")
    preset_name = issue["preset_name"].replace("\\", r"\\").replace("|", r"\|")
    description = issue["description"].replace("\\", r"\\").replace("|", r"\|")
    paths["presets.md"].write_text(
        "| Preset | Purpose | Provides | Requires | URL |\n"
        "|--------|---------|----------|----------|-----|\n"
        f"| {preset_name} | {description} | 1 template, 1 command | "
        "aide extension, canon extension | "
        "[presets](https://github.com/example/presets) |\n",
        encoding="utf-8",
    )
    return entry


def test_matching_monorepo_submission_and_generated_files_pass(submission):
    issue, _, paths = submission
    before = datetime.now(timezone.utc).strftime("%Y-%m-%dT00:00:00Z")
    first = run_verifier(paths)
    assert first.returncode == 0, first.stdout + first.stderr
    snapshot = json.loads(paths["snapshot.json"].read_text(encoding="utf-8"))
    after = datetime.now(timezone.utc).strftime("%Y-%m-%dT00:00:00Z")
    assert snapshot["expected_timestamp"] in (before, after)
    write_generated(issue, paths)
    second = run_verifier(paths, "generated")
    assert second.returncode == 0, second.stdout + second.stderr


def test_update_preserving_created_at_passes(submission):
    issue, _, paths = submission
    original = write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": original["updated_at"], "presets": {"sample": original},
    }), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    assert run_verifier(paths, "generated").returncode == 0


@pytest.mark.parametrize(("change", "message"), [
    ({"preset": {"id": "sample", "version": "1.2.4"}}, "version"),
    ({"requires": {"speckit_version": ">=2.0.0",
                   "extensions": ["aide", "canon"]}}, "speckit_version"),
    ({"requires": {"speckit_version": ">=1.0.0",
                   "extensions": ["aide"]}}, "extensions"),
])
def test_published_manifest_mismatch_is_submission_failure(submission, change, message):
    _, manifest, paths = submission
    manifest.update(change)
    write_archive(paths, manifest)
    result = run_verifier(paths)
    assert result.returncode == 1
    assert message in result.stdout
    assert not paths["snapshot.json"].exists()


def test_release_tag_mismatch_is_submission_failure(submission):
    issue, _, paths = submission
    issue["download_url"] = issue["download_url"].replace("v1.2.3", "v1.2.4")
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 1


def test_stale_from_url_fails_even_with_valid_dev_command(submission):
    issue, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        f"specify preset add --from {issue['download_url'].replace('v1.2.3', 'v1.2.2')}\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README" in result.stdout


@pytest.mark.parametrize("archive_url", [False, True])
def test_stale_from_url_with_submitted_scoped_tag_fails(submission, archive_url):
    issue, _, paths = submission
    if archive_url:
        issue["download_url"] = (
            "https://github.com/example/presets/archive/refs/tags/"
            "spec-kit-sample-v1.2.3.zip"
        )
    else:
        issue["download_url"] = issue["download_url"].replace(
            "sample-v1.2.3", "spec-kit-sample-v1.2.3"
        )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        f"specify preset add --from {issue['download_url'].replace('v1.2.3', 'v1.2.2')}\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1, result.stdout + result.stderr
    assert "README --from URL" in result.stdout


def test_dev_only_readme_is_accepted(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n", encoding="utf-8"
    )
    assert run_verifier(paths).returncode == 0


def test_dev_current_directory_path_is_accepted(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev .\n", encoding="utf-8"
    )
    assert run_verifier(paths).returncode == 0


def test_dev_option_without_path_is_rejected(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev --priority 20\n", encoding="utf-8"
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README" in result.stdout


def test_dev_without_path_does_not_consume_next_paragraph(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev\n"
        "Next paragraph describes the preset.\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README" in result.stdout


def test_quoted_from_url_with_sentence_punctuation_is_accepted(submission):
    issue, _, paths = submission
    paths["README.md"].write_text(
        f'Spec Kit install: `specify preset add --from "{issue["download_url"]}".`\n',
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


def test_id_install_and_unrelated_monorepo_release_are_accepted(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/releases/download/other-v2.0.0/other.zip\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


def test_unrelated_scoped_release_stays_accepted_with_submitted_scope(submission):
    issue, _, paths = submission
    issue["download_url"] = issue["download_url"].replace(
        "sample-v1.2.3", "spec-kit-sample-v1.2.3"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/releases/download/other-v2.0.0/other.zip\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


@pytest.mark.parametrize("archive_url", [False, True])
def test_unrelated_unscoped_monorepo_release_stays_accepted(submission, archive_url):
    issue, _, paths = submission
    if archive_url:
        issue["download_url"] = (
            "https://github.com/example/presets/archive/refs/tags/"
            "spec-kit-sample-v1.2.3.zip"
        )
        unrelated = (
            "https://github.com/example/presets/archive/refs/tags/v2.0.0.zip"
        )
    else:
        issue["download_url"] = issue["download_url"].replace(
            "sample-v1.2.3", "spec-kit-sample-v1.2.3"
        )
        unrelated = (
            "https://github.com/example/presets/releases/download/v2.0.0/other.zip"
        )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        f"specify preset add --from {unrelated}\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


def test_unrelated_unscoped_archive_stays_accepted_in_monorepo(submission):
    issue, _, paths = submission
    issue["download_url"] = (
        "https://github.com/example/presets/archive/refs/tags/v1.2.3.zip"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/archive/refs/tags/v2.0.0.zip\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


def test_stale_unscoped_archive_fails_for_single_preset(submission):
    issue, manifest, paths = submission
    write_archive(paths, manifest)
    issue["download_url"] = (
        "https://github.com/example/presets/archive/refs/tags/v1.2.3.zip"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/archive/refs/tags/v1.2.2.zip\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README --from URL" in result.stdout


def test_matching_unscoped_archive_passes_for_single_preset(submission):
    issue, manifest, paths = submission
    write_archive(paths, manifest)
    issue["download_url"] = (
        "https://github.com/example/presets/archive/refs/tags/v1.2.3.zip"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        f"specify preset add --from {issue['download_url']}\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0


def test_same_asset_on_unscoped_tag_is_reported_as_stale(submission):
    issue, _, paths = submission
    issue["download_url"] = issue["download_url"].replace(
        "sample-v1.2.3", "v1.2.3"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        f"specify preset add --from {issue['download_url'].replace('v1.2.3', 'v1.2.2')}\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README --from URL" in result.stdout


def test_versioned_asset_on_unscoped_tag_is_reported_as_stale(submission):
    issue, _, paths = submission
    issue["download_url"] = (
        "https://github.com/example/presets/releases/download/"
        "v1.2.3/sample-1.2.3.zip"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/releases/download/"
        "v1.2.2/sample-1.2.2.zip\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README --from URL" in result.stdout


def test_same_asset_on_bare_tag_stays_stale_for_scoped_submission(submission):
    issue, _, paths = submission
    issue["download_url"] = issue["download_url"].replace(
        "sample-v1.2.3", "spec-kit-sample-v1.2.3"
    )
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        "specify preset add --from "
        "https://github.com/example/presets/releases/download/v1.2.2/sample.zip\n",
        encoding="utf-8",
    )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "README --from URL" in result.stdout


def test_stale_scoped_release_in_another_repository_fails(submission):
    _, _, paths = submission
    paths["README.md"].write_text(
        "specify preset add --dev ./sample\n"
        "specify preset add --from "
        "https://github.com/elsewhere/presets/releases/download/sample-v1.2.2/sample.zip\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 1


def test_optional_manifest_extension_is_not_required(submission):
    issue, manifest, paths = submission
    manifest["requires"]["extensions"].append({
        "id": "optional", "version": ">=1.0.0", "required": False,
    })
    write_archive(paths, manifest)
    issue["actual_sha256"] = hashlib.sha256(paths["archive.zip"].read_bytes()).hexdigest()
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 0


def test_invalid_unrelated_monorepo_manifest_does_not_mask_match(submission):
    _, manifest, paths = submission
    with zipfile.ZipFile(paths["archive.zip"], "w") as archive:
        archive.writestr("release/sample/preset.yml", yaml.safe_dump(manifest))
        archive.writestr("release/other/preset.yml", "preset: [invalid\n")
    assert run_verifier(paths).returncode == 0


def test_archive_with_too_many_manifests_is_rejected_before_parsing(submission):
    _, _, paths = submission
    with zipfile.ZipFile(paths["archive.zip"], "w") as archive:
        for index in range(101):
            archive.writestr(f"release/{index}/preset.yml", "preset: [invalid\n")
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "more than 100 preset.yml files" in result.stdout
    assert "invalid manifests" not in result.stdout


def test_archive_with_excessive_total_manifest_size_is_rejected(submission):
    _, manifest, paths = submission
    padding = "#" * (1024 * 1024 - len(yaml.safe_dump(manifest)) - 2)
    with zipfile.ZipFile(
        paths["archive.zip"], "w", compression=zipfile.ZIP_DEFLATED
    ) as archive:
        for index in range(11):
            archive.writestr(
                f"release/{index}/preset.yml",
                f"{yaml.safe_dump(manifest)}\n{padding}",
            )
    result = run_verifier(paths)
    assert result.returncode == 1
    assert "10 MiB total limit" in result.stdout


def test_missing_archive_is_blocked_not_failed(submission):
    _, _, paths = submission
    paths["archive.zip"].unlink()
    result = run_verifier(paths)
    assert result.returncode == 2
    assert "BLOCKED" in result.stdout


def test_missing_generated_documentation_is_repairable(submission):
    issue, _, paths = submission
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths)
    paths["presets.md"].unlink()
    result = run_verifier(paths, "generated")
    assert result.returncode == 3
    assert "REPAIR" in result.stdout


def test_existing_entry_without_creation_date_blocks_update(submission):
    issue, _, paths = submission
    entry = write_generated(issue, paths)
    del entry["created_at"]
    paths["catalog.json"].write_text(
        json.dumps({"presets": {"sample": entry}}), encoding="utf-8"
    )
    result = run_verifier(paths)
    assert result.returncode == 2
    assert "created_at" in result.stdout


@pytest.mark.parametrize("timestamp_field", ["created_at", "updated_at"])
def test_generated_new_entry_rejects_stale_dates(submission, timestamp_field):
    issue, _, paths = submission
    assert run_verifier(paths).returncode == 0
    entry = write_generated(issue, paths)
    entry[timestamp_field] = "2000-01-01T00:00:00Z"
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": entry["updated_at"], "presets": {"sample": entry},
    }), encoding="utf-8")
    result = run_verifier(paths, "generated")
    assert result.returncode == 3, result.stdout + result.stderr
    assert timestamp_field in result.stdout


def test_generated_update_rejects_matching_stale_updated_dates(submission):
    issue, _, paths = submission
    entry = write_generated(issue, paths)
    assert run_verifier(paths).returncode == 0
    entry["updated_at"] = "2000-01-01T00:00:00Z"
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": entry["updated_at"], "presets": {"sample": entry},
    }), encoding="utf-8")
    result = run_verifier(paths, "generated")
    assert result.returncode == 3, result.stdout + result.stderr
    assert "updated_at" in result.stdout


def test_generated_update_rejects_stale_homepage(submission):
    issue, _, paths = submission
    entry = write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    entry["homepage"] = "https://example.com/old"
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": entry["updated_at"], "presets": {"sample": entry},
    }), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    entry = write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    entry["homepage"] = "https://example.com/old"
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": entry["updated_at"], "presets": {"sample": entry},
    }), encoding="utf-8")
    result = run_verifier(paths, "generated")
    assert result.returncode == 3
    assert "homepage" in result.stdout


def test_generated_documentation_accepts_escaped_pipe_in_preset_name(submission):
    issue, _, paths = submission
    issue["preset_name"] = "Data | Governance"
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths)
    result = run_verifier(paths, "generated")
    assert result.returncode == 0, result.stdout + result.stderr


def test_generated_documentation_accepts_backslash_before_pipe(submission):
    issue, _, paths = submission
    issue["preset_name"] = r"Data \| Governance"
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths)
    result = run_verifier(paths, "generated")
    assert result.returncode == 0, result.stdout + result.stderr


def test_generated_documentation_allows_duplicate_display_names(submission):
    issue, _, paths = submission
    other_row = (
        "| Sample Preset | Other usage | 1 command | β€” | "
        "[other](https://github.com/example/other) |"
    )
    paths["catalog.json"].write_text(json.dumps({
        "presets": {"other": {"name": issue["preset_name"]}},
    }), encoding="utf-8")
    paths["presets.md"].write_text(
        "| Preset | Purpose | Provides | Requires | URL |\n"
        "|--------|---------|----------|----------|-----|\n"
        f"{other_row}\n",
        encoding="utf-8",
    )
    assert run_verifier(paths).returncode == 0
    entry = write_generated(issue, paths)
    catalog = json.loads(paths["catalog.json"].read_text(encoding="utf-8"))
    catalog["presets"] = {
        "other": {"name": issue["preset_name"]},
        "sample": entry,
    }
    paths["catalog.json"].write_text(json.dumps(catalog), encoding="utf-8")
    paths["presets.md"].write_text(
        "| Preset | Purpose | Provides | Requires | URL |\n"
        "|--------|---------|----------|----------|-----|\n"
        f"{other_row}\n"
        "| Sample Preset | Sample usage | 1 template, 1 command | "
        "aide extension, canon extension | "
        "[presets](https://github.com/example/presets) |\n",
        encoding="utf-8",
    )
    result = run_verifier(paths, "generated")
    assert result.returncode == 0, result.stdout + result.stderr


def test_generated_documentation_accepts_replaced_renamed_row(submission):
    issue, _, paths = submission
    original = write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    paths["presets.md"].write_text(
        paths["presets.md"].read_text(encoding="utf-8").replace(
            "Sample usage", "Legacy documentation wording"
        ),
        encoding="utf-8",
    )
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": original["updated_at"], "presets": {"sample": original},
    }), encoding="utf-8")
    issue["preset_name"] = "Renamed Preset"
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    result = run_verifier(paths, "generated")
    assert result.returncode == 0, result.stdout + result.stderr


def test_generated_documentation_rejects_stale_row_after_rename(submission):
    issue, _, paths = submission
    original = write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    paths["presets.md"].write_text(
        paths["presets.md"].read_text(encoding="utf-8").replace(
            "Sample usage", "Legacy documentation wording"
        ),
        encoding="utf-8",
    )
    previous_row = paths["presets.md"].read_text(encoding="utf-8").splitlines()[2]
    paths["catalog.json"].write_text(json.dumps({
        "updated_at": original["updated_at"], "presets": {"sample": original},
    }), encoding="utf-8")
    issue["preset_name"] = "Renamed Preset"
    paths["issue.json"].write_text(json.dumps(issue), encoding="utf-8")
    assert run_verifier(paths).returncode == 0
    write_generated(issue, paths, created_at="2024-12-01T00:00:00Z")
    paths["presets.md"].write_text(
        paths["presets.md"].read_text(encoding="utf-8") + previous_row + "\n",
        encoding="utf-8",
    )
    result = run_verifier(paths, "generated")
    assert result.returncode == 3
    assert "previous documentation row" in result.stdout


@pytest.mark.parametrize(("damage", "message"), [
    ("catalog-json", "catalog"),
    ("catalog-order", "alphabetical"),
    ("catalog-metadata", "version"),
    ("homepage-missing", "homepage"),
    ("homepage-stale", "homepage"),
    ("catalog-timestamp", "top-level updated_at"),
    ("docs-order", "alphabetical"),
    ("docs-row", "documentation row"),
    ("created-at", "created_at"),
])
def test_generated_defects_are_fixable_not_submission_failures(submission, damage, message):
    issue, _, paths = submission
    if damage == "created-at":
        original = write_generated(issue, paths)
        paths["catalog.json"].write_text(
            json.dumps({"updated_at": original["updated_at"], "presets": {
                "sample": original,
            }}), encoding="utf-8"
        )
    assert run_verifier(paths).returncode == 0
    entry = write_generated(issue, paths)
    if damage == "catalog-json":
        paths["catalog.json"].write_text("{", encoding="utf-8")
    elif damage == "catalog-order":
        paths["catalog.json"].write_text(json.dumps({
            "updated_at": entry["updated_at"],
            "presets": {"sample": entry, "aaa": {"name": "AAA"}},
        }), encoding="utf-8")
    elif damage == "catalog-metadata":
        entry["version"] = "1.2.4"
        paths["catalog.json"].write_text(
            json.dumps({"updated_at": entry["updated_at"], "presets": {
                "sample": entry,
            }}), encoding="utf-8"
        )
    elif damage in ("homepage-missing", "homepage-stale"):
        if damage == "homepage-missing":
            del entry["homepage"]
        else:
            entry["homepage"] = "https://github.com/example/other"
        paths["catalog.json"].write_text(
            json.dumps({"updated_at": entry["updated_at"], "presets": {
                "sample": entry,
            }}), encoding="utf-8"
        )
    elif damage == "catalog-timestamp":
        paths["catalog.json"].write_text(
            json.dumps({"updated_at": "2020-01-01T00:00:00Z", "presets": {
                "sample": entry,
            }}), encoding="utf-8"
        )
    elif damage == "docs-order":
        paths["presets.md"].write_text(
            paths["presets.md"].read_text(encoding="utf-8")
            + "| AAA | x | 1 command | β€” | [aaa](https://github.com/aaa/aaa) |\n",
            encoding="utf-8",
        )
    elif damage == "docs-row":
        paths["presets.md"].write_text(
            paths["presets.md"].read_text(encoding="utf-8").replace(
                "Sample usage", "Wrong purpose"
            ), encoding="utf-8",
        )
    elif damage == "created-at":
        entry["created_at"] = "2000-01-01T00:00:00Z"
        paths["catalog.json"].write_text(
            json.dumps({"updated_at": entry["updated_at"], "presets": {
                "sample": entry,
            }}), encoding="utf-8"
        )
    result = run_verifier(paths, "generated")
    assert result.returncode == 3, result.stdout + result.stderr
    assert message in result.stdout


def test_workflow_gates_success_on_both_verifier_phases():
    source = WORKFLOW.read_text(encoding="utf-8")
    assert "python3 .github/scripts/validate_community_preset.py submission" in source
    assert "python3 .github/scripts/validate_community_preset.py generated" in source
    assert (source.index("validate_community_preset.py generated")
            < source.index("## Step 6")
            < source.index("add the `validation-passed`", source.index("## Step 6")))
    frontmatter = yaml.safe_load(source.split("---", 2)[1])
    assert [step["name"] for step in frontmatter["steps"]] == [
        "Set up Python for preset verification",
        "Install preset verifier dependency",
    ]
    compiled = yaml.safe_load(
        (ROOT / ".github/workflows/add-community-preset.lock.yml").read_text(
            encoding="utf-8"
        )
    )
    steps = compiled["jobs"]["agent"]["steps"]
    for setup in frontmatter["steps"]:
        assert setup in steps