Example: gitlab-ci-scaffold — generate a complete CI project

"""GitLab CI scaffold — generates a full project layout from a fluid contract."""

from __future__ import annotations

import json
from typing import Any, List, Mapping

from fluid_sdk import (
    ContractHelper,
    CustomScaffold,
    PluginMetadata,
    write_file_action,
)


class GitLabCIScaffold(CustomScaffold):
    """Generates README.md, .gitlab-ci.yml, and per-env config files."""

    name = "gitlab-ci"

    @classmethod
    def get_plugin_info(cls) -> PluginMetadata:
        return PluginMetadata(
            name=cls.name,
            role=cls.role,
            display_name="GitLab CI Scaffold",
            description="Generates a complete GitLab CI scaffold from a fluid contract.",
            version="0.1.0",
            author="FLUID SDK Examples",
            tags=["ci", "gitlab", "scaffold"],
        )

    def plan(self, contract: Mapping[str, Any]) -> List[dict]:
        c = ContractHelper(contract)
        actions: List[dict] = []

        # 1. The project README.
        actions.append(
            write_file_action(
                path="README.md",
                content=self._render_readme(c).encode("utf-8"),
                description="Project README",
            ).to_dict()
        )

        # 2. The CI definition.
        actions.append(
            write_file_action(
                path=".gitlab-ci.yml",
                content=self._render_ci(c).encode("utf-8"),
                description="GitLab CI definition",
            ).to_dict()
        )

        # 3. One config file per environment.
        for env_name in c.environment_names():
            actions.append(
                write_file_action(
                    path=f"config/{env_name}.json",
                    content=self._render_env_config(c, env_name).encode("utf-8"),
                    description=f"Config for environment {env_name!r}",
                ).to_dict()
            )

        return actions

    # The three private renderers below are mechanical f-strings.
    # Click to expand if you want the full source.
    # ↓

# tests/test_scaffold.py (excerpts)

class TestGitLabCIScaffold(CustomScaffoldTestHarness):
    plugin_class = GitLabCIScaffold
    sample_contracts = [LOCAL_CONTRACT]

    # === Scenarios specific to this plugin (added by you) ===

    def test_emits_one_config_per_environment(self):
        plugin = self._instantiate()
        actions = plugin.plan(MULTI_ENV_CONTRACT)
        config_paths = [a["params"]["path"] for a in actions
                        if a["params"]["path"].startswith("config/")]
        assert config_paths == ["config/dev.json", "config/staging.json", "config/prod.json"]

    def test_no_environments_means_no_config_files(self):
        plugin = self._instantiate()
        actions = plugin.plan({"metadata": {"id": "x"}, "environments": {}})
        assert all("config/" not in a["params"]["path"] for a in actions)

    def test_ci_yaml_has_deploy_per_env(self):
        plugin = self._instantiate()
        actions = plugin.plan(MULTI_ENV_CONTRACT)
        ci = next(a for a in actions if a["params"]["path"] == ".gitlab-ci.yml")
        body = ci["params"]["content_b64"]  # base64-encoded bytes
        import base64
        decoded = base64.b64decode(body).decode()
        assert "deploy:dev:" in decoded
        assert "deploy:staging:" in decoded
        assert "deploy:prod:" in decoded