id_configurator/tests/test_php.py

import json

from id_configurator.config import Configuration
from id_configurator.context import Context
from id_configurator.modules.php import PhpModule

CONFIG_WITH_REPO = {
    "uuid": "12345678-1234-5678-1234-567812345678",
    "organisation": "InterDiode",
    "configurations": {
        "php": {
            "repositories": [
                {"name": "demo", "url": "https://example.invalid/composer"}
            ]
        }
    },
}

CONFIG_WITH_TWO_REPOS = {
    "uuid": "12345678-1234-5678-1234-567812345678",
    "organisation": "InterDiode",
    "configurations": {
        "php": {
            "repositories": [
                {"name": "demo", "url": "https://example.invalid/composer"},
                {"name": "other", "url": "https://other.invalid/composer"},
            ]
        }
    },
}

EMPTY_CONFIG = {
    "uuid": "12345678-1234-5678-1234-567812345678",
    "organisation": "InterDiode",
}

CONFIG_WITH_CERTIFICATE_ONLY = {
    "uuid": "12345678-1234-5678-1234-567812345678",
    "organisation": "InterDiode",
    "configurations": {
        "certificates": [{"name": "interdiode-ca", "content": "-----BEGIN...-----"}]
    },
}


def make_config(data: dict) -> Configuration:
    return Configuration.model_validate(data)


def test_is_relevant_false_when_no_repositories(tmp_path) -> None:
    context = Context(config=make_config(EMPTY_CONFIG), dst=tmp_path / "dst", src=None)
    assert PhpModule().is_relevant(context) is False


def test_is_relevant_true_with_certificate_only(tmp_path) -> None:
    context = Context(
        config=make_config(CONFIG_WITH_CERTIFICATE_ONLY), dst=tmp_path / "dst", src=None
    )
    assert PhpModule().is_relevant(context) is True


def test_is_relevant_true_with_repository(tmp_path) -> None:
    context = Context(
        config=make_config(CONFIG_WITH_REPO), dst=tmp_path / "dst", src=None
    )
    assert PhpModule().is_relevant(context) is True


def test_apply_writes_global_composer_config(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(config=make_config(CONFIG_WITH_REPO), dst=dst, src=None)

    PhpModule().apply(context)

    config_path = dst / "root/.composer/config.json"
    content = json.loads(config_path.read_text(encoding="utf-8"))
    assert content == {
        "repositories": [
            {
                "name": "demo",
                "type": "composer",
                "url": "https://example.invalid/composer",
            },
            {"packagist.org": False},
        ]
    }


def test_apply_writes_multiple_repositories_in_order(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(config=make_config(CONFIG_WITH_TWO_REPOS), dst=dst, src=None)

    PhpModule().apply(context)

    config_path = dst / "root/.composer/config.json"
    content = json.loads(config_path.read_text(encoding="utf-8"))
    names = [repo["name"] for repo in content["repositories"] if "name" in repo]
    assert names == ["demo", "other"]
    assert {"packagist.org": False} in content["repositories"]


def test_apply_disables_secure_http_and_packagist_when_repo_not_https(
    tmp_path,
) -> None:
    data = {
        "uuid": "12345678-1234-5678-1234-567812345678",
        "organisation": "InterDiode",
        "configurations": {
            "php": {
                "repositories": [
                    {"name": "demo", "url": "https://example.invalid/composer"},
                    {"name": "insecure", "url": "http://other.invalid/composer"},
                ]
            }
        },
    }
    dst = tmp_path / "dst"
    context = Context(config=make_config(data), dst=dst, src=None)

    PhpModule().apply(context)

    config_path = dst / "root/.composer/config.json"
    content = json.loads(config_path.read_text(encoding="utf-8"))
    assert content["config"] == {"secure-http": False}
    assert {"packagist.org": False} in content["repositories"]


def test_apply_does_not_disable_secure_http_when_all_repos_https(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(config=make_config(CONFIG_WITH_REPO), dst=dst, src=None)

    PhpModule().apply(context)

    config_path = dst / "root/.composer/config.json"
    content = json.loads(config_path.read_text(encoding="utf-8"))
    assert "config" not in content


def test_apply_always_disables_packagist(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(config=make_config(CONFIG_WITH_REPO), dst=dst, src=None)

    PhpModule().apply(context)

    config_path = dst / "root/.composer/config.json"
    content = json.loads(config_path.read_text(encoding="utf-8"))
    assert {"packagist.org": False} in content["repositories"]


def test_apply_writes_composer_config_for_each_configured_user(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(
        config=make_config(CONFIG_WITH_REPO), dst=dst, src=None, users=["alice"]
    )

    PhpModule().apply(context)

    root_content = (dst / "root/.composer/config.json").read_bytes()
    alice_content = (dst / "home/alice/.composer/config.json").read_bytes()
    assert alice_content == root_content


def test_apply_without_certificates_does_not_write_openssl_ini(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(config=make_config(CONFIG_WITH_REPO), dst=dst, src=None)

    PhpModule().apply(context)

    assert not (dst / "usr/local/etc/php/conf.d/id-configurator-openssl.ini").exists()


def test_apply_sets_openssl_cafile_when_certificates_configured(tmp_path) -> None:
    dst = tmp_path / "dst"
    context = Context(
        config=make_config(CONFIG_WITH_CERTIFICATE_ONLY), dst=dst, src=None
    )

    PhpModule().apply(context)

    assert not (dst / "root/.composer/config.json").exists()
    ini_content = (
        dst / "usr/local/etc/php/conf.d/id-configurator-openssl.ini"
    ).read_text(encoding="utf-8")
    assert ini_content == "openssl.cafile=/etc/ssl/certs/ca-certificates.crt\n"