kleinanzeigen-bot/tests/smoke/test_smoke_health.py

# SPDX-FileCopyrightText: © Jens Bergmann and contributors
# SPDX-License-Identifier: AGPL-3.0-or-later
# SPDX-ArtifactOfProjectHomePage: https://github.com/Second-Hand-Friends/kleinanzeigen-bot/
"""
Minimal smoke tests: post-deployment health checks for kleinanzeigen-bot.
These tests verify that the most essential components are operational.
"""

import json
import re
import subprocess  # noqa: S404
import sys
from pathlib import Path
from typing import Callable

import pytest
from ruyaml import YAML

from kleinanzeigen_bot.model.config_model import Config
from tests.conftest import SmokeKleinanzeigenBot


def run_cli_subcommand(args:list[str], cwd:str | None = None) -> subprocess.CompletedProcess[str]:
    """
    Run the kleinanzeigen-bot CLI as a subprocess with the given arguments.
    Returns the CompletedProcess object.
    """
    cli_module = "kleinanzeigen_bot.__main__"
    cmd = [sys.executable, "-m", cli_module] + args
    return subprocess.run(cmd, check = False, capture_output = True, text = True, cwd = cwd)  # noqa: S603


@pytest.mark.smoke
def test_app_starts(smoke_bot:SmokeKleinanzeigenBot) -> None:
    """Smoke: Bot can be instantiated and started without error."""
    assert smoke_bot is not None
    # Optionally call a minimal method if available
    assert hasattr(smoke_bot, "run") or hasattr(smoke_bot, "login")


@pytest.mark.smoke
@pytest.mark.parametrize("subcommand", [
    "--help",
    "help",
    "version",
    "diagnose",
])
def test_cli_subcommands_no_config(subcommand:str, tmp_path:Path) -> None:
    """
    Smoke: CLI subcommands that do not require a config file (--help, help, version, diagnose).
    """
    args = [subcommand]
    result = run_cli_subcommand(args, cwd = str(tmp_path))
    assert result.returncode == 0
    out = (result.stdout + "\n" + result.stderr).lower()
    if subcommand in {"--help", "help"}:
        assert "usage" in out or "help" in out, f"Expected help text in CLI output.\n{out}"
    elif subcommand == "version":
        assert re.match(r"^\s*\d{4}\+\w+", result.stdout.strip()), f"Output does not look like a version string: {result.stdout}"
    elif subcommand == "diagnose":
        assert "browser connection diagnostics" in out or "browser-verbindungsdiagnose" in out, f"Expected diagnostic output.\n{out}"


@pytest.mark.smoke
def test_cli_subcommands_create_config_creates_file(tmp_path:Path) -> None:
    """
    Smoke: CLI 'create-config' creates a config.yaml file in the current directory.
    """
    result = run_cli_subcommand(["create-config"], cwd = str(tmp_path))
    config_file = tmp_path / "config.yaml"
    assert result.returncode == 0
    assert config_file.exists(), "config.yaml was not created by create-config command"
    out = (result.stdout + "\n" + result.stderr).lower()
    assert "saving" in out, f"Expected saving message in CLI output.\n{out}"
    assert "config.yaml" in out, f"Expected config.yaml in CLI output.\n{out}"


@pytest.mark.smoke
def test_cli_subcommands_create_config_fails_if_exists(tmp_path:Path) -> None:
    """
    Smoke: CLI 'create-config' does not overwrite config.yaml if it already exists.
    """
    config_file = tmp_path / "config.yaml"
    config_file.write_text("# dummy config\n", encoding = "utf-8")
    result = run_cli_subcommand(["create-config"], cwd = str(tmp_path))
    assert result.returncode == 0
    assert config_file.exists(), "config.yaml was deleted or not present after second create-config run"
    out = (result.stdout + "\n" + result.stderr).lower()
    assert (
        "already exists" in out or "not overwritten" in out or "saving" in out
    ), f"Expected message about existing config in CLI output.\n{out}"


@pytest.mark.smoke
@pytest.mark.parametrize(("subcommand", "output_check"), [
    ("verify", "verify"),
    ("update-check", "update"),
    ("update-content-hash", "update-content-hash"),
    ("diagnose", "diagnose"),
])
@pytest.mark.parametrize(("config_ext", "serializer"), [
    ("yaml", None),
    ("yml", None),
    ("json", json.dumps),
])
def test_cli_subcommands_with_config_formats(
    subcommand:str,
    output_check:str,
    config_ext:str,
    serializer:Callable[[dict[str, object]], str] | None,
    tmp_path:Path,
    test_bot_config:Config,
) -> None:
    """
    Smoke: CLI subcommands that require a config file, tested with all supported formats.
    """
    config_path = tmp_path / f"config.{config_ext}"
    try:
        config_dict = test_bot_config.model_dump()
    except AttributeError:
        config_dict = test_bot_config.dict()
    if config_ext in {"yaml", "yml"}:
        yaml = YAML(typ = "unsafe", pure = True)
        with open(config_path, "w", encoding = "utf-8") as f:
            yaml.dump(config_dict, f)
    elif serializer is not None:
        config_path.write_text(serializer(config_dict), encoding = "utf-8")
    args = [subcommand, "--config", str(config_path)]
    result = run_cli_subcommand(args, cwd = str(tmp_path))
    assert result.returncode == 0
    out = (result.stdout + "\n" + result.stderr).lower()
    if subcommand == "verify":
        assert "no configuration errors found" in out, f"Expected 'no configuration errors found' in output for 'verify'.\n{out}"
    elif subcommand == "update-content-hash":
        assert "no active ads found" in out, f"Expected 'no active ads found' in output for 'update-content-hash'.\n{out}"
    elif subcommand == "update-check":
        assert result.returncode == 0
    elif subcommand == "diagnose":
        assert "browser connection diagnostics" in out or "browser-verbindungsdiagnose" in out, f"Expected diagnostic output for 'diagnose'.\n{out}"