SimpleTest中的代码覆盖率

Question

使用类似于PHPUnit的SimpleTest时，有什么方法可以生成代码覆盖率报告。

我已经在他们的网站上阅读了SimpleTest的文档，但找不到明确的方法！ 我碰到这个网站说

我们可以将require_once (dirname(__FILE__).'/coverage.php')到预期的文件中，它应该生成报告，但是没有用！

如果有一个有关如何生成代码覆盖率的有用网站，请在此处共享。

非常感谢。

Answer 1

我也无法以官方支持的方式运行它，但是我可以通过检查他们的代码来一起破解这些东西。 这适用于SimpleTest v1.1.7，而不适用于其主代码。 在撰写本文时，v1.1.7是最新版本，并且与PHP 7的新版本兼容，即使它是旧版本也是如此。

首先，您必须确保已安装，配置和运行Xdebug 。 在我的系统上，必须同时配置CLI和Apache版本的php.ini文件，具体取决于我是尝试通过Apache还是直接从终端使用PHP。 Xdebug可以替代，但是大多数人使用Xdebug。

然后，您必须使PHP_CodeCoverage库可从您的代码访问。 我建议将其作为作曲家软件包添加到您的项目中。

现在，您只需要手动使用该库即可捕获代码覆盖并生成报告。 具体执行方式将取决于您如何运行测试。 就个人而言，我在终端上运行测试，并且我有一个引导文件，该文件会在脚本启动脚本之前运行。 在引导文件的末尾，我包括SimpleTest自动运行文件，因此它将自动在包含的任何测试类中运行测试，如下所示：

require_once __DIR__.'/vendor/simpletest/simpletest/autorun.php';

在引导程序文件中的某个位置，您将需要创建一个过滤器，将要报告的目录和文件列入白名单，创建一个coverage对象，并将该过滤器传递给构造函数，开始coverage，创建并注册一个将改变的关闭函数SimpleTest执行测试以确保它也停止覆盖并生成覆盖率报告的方式。 您的引导文件可能如下所示：

<?php
require __DIR__.'/vendor/autoload.php';
$filter = new \SebastianBergmann\CodeCoverage\Filter();
$filter->addDirectoryToWhitelist(__DIR__."/src/");
$coverage = new \SebastianBergmann\CodeCoverage\CodeCoverage(null, $filter);
$coverage->start('<name of test>');

function shutdownWithCoverage($coverage)
{
    $autorun = function_exists('\run_local_tests'); // provided by simpletest
    if ($autorun) {
        $result = \run_local_tests(); // this actually runs the tests
    }
    $coverage->stop();
    $writer = new \SebastianBergmann\CodeCoverage\Report\Html\Facade;
    $writer->process($coverage, __DIR__.'/tmp/code-coverage-report');
    if ($autorun) {
        // prevent tests from running twice:
        exit($result ? 0 : 1);
    }
}
register_shutdown_function('\shutdownWithCoverage', $coverage);
require_once __DIR__.'/vendor/simpletest/simpletest/autorun.php';

Answer 2

我花了一些时间才弄清楚，因为-坦率地说-此功能的文档还不是很完整。

一旦测试套件启动并运行，只需在实际运行它的行之前包括以下几行：

require_once ('simpletest/extensions/coverage/coverage.php');
require_once ('simpletest/extensions/coverage/coverage_reporter.php');

$coverage = new CodeCoverage();
$coverage->log = 'coverage/log.sqlite'; // This folder should exist
$coverage->includes = ['.*\.php$'];     // Modify these as you wish
$coverage->excludes = ['simpletest.*']; // Or it is even better to use a setting file
$coverage->maxDirectoryDepth = '1';
$coverage->resetLog();
$coverage->startCoverage();

然后运行测试，例如：

$test = new ProjectTests(); //It is an extension of the class TestSuite
$test->run(new HtmlReporter());

最终生成报告

$coverage->stopCoverage();
$coverage->writeUntouched();

$handler           = new CoverageDataHandler($coverage->log);
$report            = new CoverageReporter();
$report->reportDir = 'coverage/report'; // This folder should exist
$report->title     = 'Code Coverage Report';
$report->coverage  = $handler->read();
$report->untouched = $handler->readUntouchedFiles();
$report->summaryFile = $report->reportDir . '/index.html';

就是这样。 根据您的设置，您可能需要进行一些小的调整才能使其正常工作。 例如，如果您使用的是来自simpletest的autorun.php，则可能会有些棘手。