sousa-gecko/python/mozversioncontrol/test/conftest.py

# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

from __future__ import annotations

import os
import platform
import shutil
import subprocess
import tempfile
from pathlib import Path

import pytest


def setup_hg_default_path(working_dir):
    """Set up default hg path to remoterepo."""
    hgrc_path = Path(working_dir) / ".hg" / "hgrc"
    hgrc_path.parent.mkdir(parents=True, exist_ok=True)  # Ensure .hg directory exists
    with open(hgrc_path, "w") as f:
        f.write("[paths]\n")
        f.write("default = ../remoterepo\n")


# Execute the first element in each list of steps within a `repo` directory,
# then copy the whole directory to a `remoterepo`, and finally execute the
# second element on just `repo`.
SETUP = {
    "hg": [
        """
        echo "foo" > foo
        echo "bar" > bar
        hg init
        hg add *
        hg commit -m "Initial commit"
        hg phase --public .
        """,
        setup_hg_default_path,
    ],
    "git": [
        """
        echo "foo" > foo
        echo "bar" > bar
        git init -b master
        git config user.name "Testing McTesterson"
        git config user.email "test@example.org"
        git add *
        git commit -am "Initial commit"
        """,
        """
        git remote add upstream ../remoterepo
        git fetch upstream
        git branch -u upstream/master
        """,
    ],
    "jj": [
        """
        echo "foo" > foo
        echo "bar" > bar
        git init -b master
        git config user.name "Testing McTesterson"
        git config user.email "test@example.org"
        git add *
        git commit -am "Initial commit"
        jj git init --colocate
        jj config set --repo user.name "Testing McTesterson"
        jj config set --repo user.email "test@example.org"
        jj metaedit --update-author
        jj abandon
        """,
        """
        jj git remote add upstream ../remoterepo
        jj git fetch --remote upstream
        jj bookmark track master@upstream
        """,
    ],
    "src": [
        """
        echo "foo" > foo
        echo "bar" > bar
        mkdir config
        echo 1.0 > config/milestone.txt
        """,
        "",
    ],
}


class RepoTestFixture:
    def __init__(self, repo_dir: Path, vcs: str, steps: list[str]):
        self.dir = repo_dir
        self.vcs = vcs

        # This creates a step iterator. Each time execute_next_step()
        # is called the next set of instructions will be executed.
        self.steps = (shell(cmd, self.dir) for cmd in steps)

    def execute_next_step(self):
        next(self.steps)


def shell(cmd, working_dir):
    if callable(cmd):
        # If it's a callable, execute it with the working directory
        # Convert Path to string for consistency
        cmd(str(working_dir))
    else:
        # Otherwise, treat it as shell commands
        for step in cmd.split(os.linesep):
            if step.strip():  # Skip empty lines
                subprocess.check_call(step, shell=True, cwd=working_dir)


@pytest.fixture(params=["git", "hg", "jj", "src"])
def repo(request):
    if request.param == "jj":
        if os.getenv("MOZ_AUTOMATION") == "1":
            fetches_dir = os.environ.get("MOZ_FETCHES_DIR", "")
            jj_dir = Path(fetches_dir) / "jj"
            if jj_dir.is_dir():
                os.environ["PATH"] = os.pathsep.join([str(jj_dir), os.environ["PATH"]])
            if platform.system() == "Darwin":
                pytest.skip(
                    "jj tests disabled for MacOS CI due to incompatible git on workers"
                )
        if os.getenv("MOZ_AVOID_JJ_VCS") not in (None, "0", ""):
            pytest.skip("jj support disabled")
        try:
            subprocess.call(["jj", "--version"], stdout=subprocess.DEVNULL)
        except OSError:
            pytest.skip("jj unavailable")

        # Isolate jj tests from user's local config
        os.environ["JJ_CONFIG"] = ""

    if request.param == "hg":
        try:
            subprocess.call(
                ["hg", "--version"],
                stdout=subprocess.DEVNULL,
                stderr=subprocess.DEVNULL,
            )
        except OSError:
            if not os.environ.get("MOZ_AUTOMATION"):
                pytest.skip("hg unavailable")

    vcs = request.param
    # Use tempfile since pytest's tempdir is too long for jj on Windows
    td = tempfile.TemporaryDirectory(prefix=f"{vcs}-repo")
    tmpdir = Path(td.name)
    steps = list(SETUP[vcs])  # Create a copy of the list

    if hasattr(request.module, "STEPS"):
        if vcs == "src" and vcs not in request.module.STEPS:
            # Special-case SourceRepository: most tests do not handle this case,
            # so allow it to be skipped if STEPS is defined but not for src.
            # (Tests without STEPS will need to skip manually.)
            pytest.skip("not applicable for src repo")
        steps.extend(request.module.STEPS[vcs])

    repo_dir = (tmpdir / "repo").resolve()
    (tmpdir / "repo").mkdir()

    repo_test_fixture = RepoTestFixture(repo_dir, vcs, steps)

    repo_test_fixture.execute_next_step()

    shutil.copytree(str(repo_dir), str(tmpdir / "remoterepo"))

    if vcs in ("git", "jj"):
        subprocess.check_call(
            ["git", "config", "receive.denyCurrentBranch", "updateInstead"],
            cwd=str(tmpdir / "remoterepo"),
        )

    repo_test_fixture.execute_next_step()

    yield repo_test_fixture