php CLI上简单漂亮的打印覆盖检查器。从终端中phpunit的coverage-clover xml文件打印指标。可用于整合机智

Posted 2021-05-05

#!/usr/bin/env php
<?php
/**
 * Based on coverage-checker.php by Marco Pivetta <[e-mail]>
 * @link https://ocramius.github.io/blog/automated-code-coverage-check-for-github-pull-requests-with-travis/
 *
 *
 * ## API:
 * ```
 * php ./coverage-cli.php [path/to/clover.xml] [minimum coverage limit]
 * ```
 *
 * ## Example:
 * ```
 * php ./coverage-cli.php ./tmp/clover.xml 70
 * ```
 */

$inputFile  = $argv[1];
$percentage = min(100, max(0, (int) $argv[2]));

if (!file_exists($inputFile)) {
    throw new InvalidArgumentException('Invalid input file provided');
}

if (!$percentage) {
    throw new InvalidArgumentException('An integer checked percentage must be given as second parameter');
}

$xml             = new SimpleXMLElement(file_get_contents($inputFile));
$metrics         = $xml->xpath('//coverage/project/metrics');
$totalElements   = $metrics[0]['elements'];
$checkedElements = $metrics[0]['coveredelements'];

$coverage = round(($checkedElements / $totalElements) * 100, 2);

$stats = <<<COVERAGE_STATS
\e[0;37m
Files: ............................ %d
Classes: .......................... %d
Methods: .......................... %d
Elements: ......................... %d
Covered Elements: ................. %d

Total Coverage: ................... %.2f%%
Coverage Limit: ................... %.2f%%
\e[0m
COVERAGE_STATS;

$stats = sprintf(
    $stats,
    $metrics[0]['files'],
    $metrics[0]['classes'],
    $metrics[0]['methods'],
    $metrics[0]['elements'],
    $metrics[0]['coveredelements'],
    $coverage,
    $percentage
);


if ($coverage < $percentage) {
    fwrite(
        STDERR,
        $stats . PHP_EOL . PHP_EOL .
        sprintf(
            "\e[1mCode coverage is \e[1;31m%.2f%%\e[0m\e[1m, which is below the accepted %d%%\e[0m",
            $coverage,
            $percentage
        ) . PHP_EOL . PHP_EOL
    );
    exit(1);
}

fwrite(
    STDERR,
    $stats . PHP_EOL . PHP_EOL .
    sprintf(
        "\e[1mCode coverage is \e[1;32m%.2f%%\e[0m\e[1m - OK!\e[0m",
        $coverage
    ) . PHP_EOL . PHP_EOL
);