pest/tests/Features/Tia/DefaultBranchResolution.php

<?php

declare(strict_types=1);

use Symfony\Component\Process\ExecutableFinder;
use Tests\Fixtures\Tia\Project;

afterEach(function (): void {
    Project::destroyAll();
});

test('a declared default branch beats autodetection', function (): void {
    $project = Project::make('develop', overlay: 'configured-default-branch');
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('a declared default branch that does not exist degrades to a full run', function (): void {
    $project = Project::make('master', overlay: 'unknown-default-branch');
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->uncached())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->exitCode)->toBe(0, $result->describe())
        ->and($project->branchKeys())->toBe(['master', 'feature-x']);
})->skipOnWindows();

test('a renamed default branch replays and writes under its new name', function (): void {
    $project = Project::make('master');
    $project->seed('master');

    $project->git()->rename('master', 'main');

    $result = $project->pest('--tia');
    $delta = $project->delta();

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe())
        ->and($project->branchKeys())->toBe(['master', 'main'])
        ->and($delta->baselineUntouched('master'))->toBeTrue($delta->summary())
        ->and($delta->writtenCount())->toBe(0, $delta->summary());
})->skipOnWindows();

test('the CI provider names the default branch where the checkout cannot', function (): void {
    $project = Project::make('master');
    $project->git()->unsetOriginHead();
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $project->write('.home/event.json', (string) json_encode([
        'repository' => ['default_branch' => 'master'],
    ]));

    $result = $project->pestWithEnvironment($project->path(), [
        'GITHUB_EVENT_PATH' => $project->path('.home/event.json'),
    ], '--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('GitLab names the default branch through its own variable', function (): void {
    $project = Project::make('master');
    $project->git()->unsetOriginHead();
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pestWithEnvironment($project->path(), [
        'CI_DEFAULT_BRANCH' => 'master',
    ], '--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('a lone recorded baseline names the default branch', function (): void {
    $project = Project::make('master');
    $project->git()->unsetOriginHead();
    $project->git()->config('init.defaultBranch', 'main');
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('a default branch nothing can name is refused rather than guessed', function (): void {
    $project = Project::make('master');
    $project->git()->unsetOriginHead();
    $project->git()->config('init.defaultBranch', 'main');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->output)->toContain('Tia mode could not determine the default branch.')
        ->and($result->output)->toContain('git remote set-head origin --auto')
        ->and($result->exitCode)->toBe(1, $result->describe())
        ->and($project->graphExists())->toBeFalse();
})->skipOnWindows();

test('an init.defaultBranch naming a branch that exists is still trusted', function (): void {
    $project = Project::make('master');
    $project->git()->unsetOriginHead();
    $project->git()->config('init.defaultBranch', 'master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->exitCode)->toBe(0, $result->describe())
        ->and($result->output)->not->toContain('could not determine the default branch')
        ->and($project->branchKeys())->toBe(['feature-x']);
})->skipOnWindows();

test('a repository with no remote is refused rather than silently re-run', function (): void {
    $project = Project::make('master');

    $project->git()->removeOrigin();

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->output)->toContain('Tia mode requires a repository with a remote.')
        ->and($result->exitCode)->toBe(1, $result->describe());
})->skipOnWindows();

test('a remote-less repository holding one baseline is not refused', function (): void {
    $project = Project::make('master');

    $project->git()->removeOrigin();
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('a declared default branch stands in for a missing remote', function (): void {
    $project = Project::make('master', overlay: 'configured-default-branch');

    $project->git()->removeOrigin();
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $result = $project->pest('--tia');

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($result->uncached())->toBe(0, $result->describe());
})->skipOnWindows();

test('tia still requires git', function (): void {
    $project = Project::withoutGit();

    $result = $project->pest('--tia');

    expect($result->output)->toContain('The feature "Tia mode" requires "git".')
        ->and($result->exitCode)->not->toBe(0);
})->skipOnWindows();

test('a plain run outside a repository creates no baseline', function (): void {
    $project = Project::withoutGit();

    $result = $project->pest();

    expect($result->exitCode)->toBe(0, $result->describe())
        ->and($result->tally())->toContain(Project::TOTAL_TESTS.' passed')
        ->and($project->graphExists())->toBeFalse()
        ->and($project->graphDir())->not->toBeDirectory();
})->skipOnWindows();

test('the default branch is resolved once per run, not once per test', function (): void {
    $project = Project::make('master');
    $project->seed('master');

    $project->git()->switchTo('feature-x', new: true);

    $git = (new ExecutableFinder)->find('git');

    expect($git)->not->toBeNull();

    $log = $project->path('git-calls.log');
    $project->write('shim/git', implode("\n", [
        '#!/bin/sh',
        'echo "$@" >> '.escapeshellarg($log),
        'exec '.escapeshellarg((string) $git).' "$@"',
        '',
    ]));
    chmod($project->path('shim/git'), 0755);

    $result = $project->pestWithEnvironment($project->path(), [
        'PATH' => $project->path('shim').':'.getenv('PATH'),
    ], '--tia');

    $calls = file_exists($log) ? explode("\n", trim((string) file_get_contents($log))) : [];
    $resolutions = array_filter($calls, fn (string $call): bool => str_contains($call, 'symbolic-ref')
        || str_contains($call, 'init.defaultBranch'));

    expect($result->replayed())->toBe(Project::TOTAL_TESTS, $result->describe())
        ->and($calls)->not->toBeEmpty('the git shim was never reached')
        ->and($resolutions)->toHaveCount(1, implode("\n", $calls));
})->skipOnWindows();