php - 使用 Composer 和 autoload.php 在 PHPUnit 中自动加载类

Question

我刚刚通过 Composer 安装了 Sebastian Bergmann 的 PHPUnit 3.7.19 版，并编写了一个我想进行单元测试的类。

我希望我的所有类都自动加载到每个单元测试中，而不必使用include或require在我的测试顶部，但事实证明这很困难！

这是我的目录结构的样子（尾部 / 斜杠表示目录，而不是文件）：

作曲家.json
作曲家锁
作曲家.phar
库/
- 返回.php
测试/
- 返回Test.php
小贩/
- 仓/
  - phpunit
- 作曲家/
- php单元/
- symfony/
- 自动加载.php

我的composer.json文件包括以下内容：

"require": {
    "phpunit/phpunit": "3.7.*",
    "phpunit/phpunit-selenium": ">=1.2"
}

我的返回.php类文件包括以下内容：

<?php
class Returning {
    public $var;
    function __construct(){
        $this->var = 1;
    }
}
?>

我的returnedTest.php测试文件包括以下内容：

<?php
class ReturningTest extends PHPUnit_Framework_TestCase
{
    protected $obj = null;

    protected function setUp()
    {
        $this->obj = new Returning;
    }

    public function testExample()
    {   
        $this->assertEquals(1, $this->obj->var);
    }

    protected function tearDown()
    {

    }
}
?>

但是，当我从命令行运行时./vendor/bin/phpunit tests，出现以下错误：

PHP 致命错误：在第 8 行的 /files/code/php/db/tests/returningTest.php 中找不到类“返回”

我注意到composer生成了一个autoload.php文件，vendor/autoload.php但不确定这是否与我的问题有关。

此外，在 Stack Overflow 上的其他一些答案中，人们提到了在 composer 中使用PSR-0namespace和PHP 中的命令，但我没有成功使用任何一个。

请帮忙！我只想在 PHPUnit 中自动加载我的类，这样我就可以使用它们来创建对象而不必担心includeor require。

更新：2013 年 8 月 14 日

我现在创建了一个名为PHPUnit Skeleton的开源项目，以帮助您轻松地为您的项目启动和运行 PHPUnit 测试。

score 80 · Accepted Answer

嗯，一开始。您需要告诉自动加载器在哪里可以找到类的 php 文件。这是通过遵循 PSR-0 标准来完成的。

最好的方法是使用命名空间。Acme/Tests/ReturningTest.php当你请求一个Acme\Tests\ReturningTest类时，自动加载器会搜索一个文件。那里有一些很棒的命名空间教程，只需搜索和阅读。请注意，命名空间不是PHP 用于自动加载的东西，而是可以用于自动加载的东西。

Composer 带有一个标准的 PSR-0 自动加载器（中的那个vendor/autoload.php）。在您的情况下，您想告诉自动加载器在目录中搜索文件lib。然后当你使用ReturningTest它时会寻找/lib/ReturningTest.php.

将此添加到您的composer.json：

{
    ...
    "autoload": {
        "psr-0": { "": "lib/" }
    }
}

文档中的更多信息。

现在自动加载器可以找到你需要的类，让 PHPunit 在运行测试之前知道有一个文件要执行：一个引导文件。您可以使用该--bootstrap选项指定引导文件所在的位置：

$ ./vendor/bin/phpunit tests --bootstrap vendor/autoload.php

但是，最好使用PHPunit 配置文件：

<!-- /phpunit.xml.dist -->
<?xml version="1.0" encoding="utf-8" ?>
<phpunit bootstrap="./vendor/autoload.php">

    <testsuites>
        <testsuite name="The project's test suite">
            <directory>./tests</directory>
        </testsuite>
    </testsuites>

</phpunit>

现在，您可以运行该命令，它会自动检测配置文件：

$ ./vendor/bin/phpunit

如果将配置文件放入另一个目录，则需要将该目录的路径放入带有-c选项的命令中。

score 45 · Accepted Answer

[ Update2 ] 另一种更简单的替代方法是使用（参考）autoload-dev中的指令。好处是您不需要为了自动加载不同的类而维护两个 bootstrap.php（一个用于 prod，一个用于 dev）。composer.json

{
  "autoload": {
    "psr-4": { "MyLibrary\\": "src/" }
  },
  "autoload-dev": {
    "psr-4": { "MyLibrary\\Tests\\": "tests/" }
  }
}

[更新] Wouter J 的回答更完整。但我的可以帮助想要在tests/文件夹中设置 PSR-0 自动加载的人。
Phpunit 使用这种模式扫描所有文件*Test.php。所以我们不需要自己自动加载它们。但是我们仍然希望自动加载其他支持类，tests/例如fixture/stub或一些父类。

一个简单的方法是查看 Composer 项目本身是如何设置 phpunit 测试的。其实很简单。请注意带有“引导程序”的行。

参考：https ://github.com/composer/composer/blob/master/phpunit.xml.dist

<?xml version="1.0" encoding="UTF-8"?>

<phpunit backupGlobals="false"
         backupStaticAttributes="false"
         colors="true"
         convertErrorsToExceptions="true"
         convertNoticesToExceptions="true"
         convertWarningsToExceptions="true"
         processIsolation="false"
         stopOnFailure="false"
         syntaxCheck="false"
         bootstrap="tests/bootstrap.php"
>
    <testsuites>
        <testsuite name="Composer Test Suite">
            <directory>./tests/Composer/</directory>
        </testsuite>
    </testsuites>

    <groups>
        <exclude>
            <group>slow</group>
        </exclude>
    </groups>

    <filter>
        <whitelist>
            <directory>./src/Composer/</directory>
            <exclude>
                <file>./src/Composer/Autoload/ClassLoader.php</file>
            </exclude>
        </whitelist>
    </filter>
</phpunit>

参考：https ://github.com/composer/composer/blob/master/tests/bootstrap.php

<?php

/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

error_reporting(E_ALL);

$loader = require __DIR__.'/../src/bootstrap.php';
$loader->add('Composer\Test', __DIR__);

上面的最后一行是在命名空间 Composer\Test 下自动加载 phpunit 测试类。

score 6 · Accepted Answer

这些答案都不是我想要的。是的 PHPUnit 加载测试文件，但不加载存根/固定装置。Chaun Ma 的回答并没有削减它，因为运行vendor/bin/phpunit已经包含自动加载，所以没有办法让自动加载器的实例在那时将更多路径推送到它的堆栈。

我最终在文档中找到了这个：

如果您需要在多个目录中搜索相同的前缀，您可以将它们指定为数组，如下所示：
{
    "autoload": {
        "psr-0": { "Monolog\\": ["src/", "lib/"] }
    }
}

score 5 · Accepted Answer

有一种非常简单的方法可以使用自动加载和引导来设置 phpunit。使用 phpunit 的选项在几秒钟内--generate-configuration创建您的phpunit.xml配置-：

vendor/bin/phpunit --generate-configuration

（或者只是phpunit --generate-configuration在你的 PATH 中设置了 phpunit）。此选项已从 phpunit5 及更高版本中可用。

此选项将提示您输入引导文件 ( vendor/autoload.php )、测试和源目录。如果您的项目使用 composer 默认设置（请参见下面的目录结构），则默认选项将是您所需要的。只需按三下 RETURN！

project-dir
   -- src
   -- tests
   -- vendor

你会得到一个默认的 phpunit.xml，这很好。您当然可以编辑以包括您需要的任何专业（例如colors="true"）：

<?xml version="1.0" encoding="UTF-8"?>
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.1/phpunit.xsd"
         bootstrap="vendor/autoload.php"
         executionOrder="depends,defects"
         forceCoversAnnotation="true"
         beStrictAboutCoversAnnotation="true"
         beStrictAboutOutputDuringTests="true"
         beStrictAboutTodoAnnotatedTests="true"
         verbose="true">
    <testsuites>
        <testsuite name="default">
            <directory suffix="Test.php">tests</directory>
        </testsuite>
    </testsuites>
    <filter>
        <whitelist processUncoveredFilesFromWhitelist="true">
            <directory suffix=".php">src</directory>
        </whitelist>
    </filter>
</phpunit>

score 1 · Accepted Answer

如果您使用的是PHPUnit 7，您可以使您的类从src/文件夹自动加载，如下所示：

确保您的composer.json文件类似于以下内容：

{
    "autoload": {
        "classmap": [
            "src/"
        ]
    },
    "require-dev": {
        "phpunit/phpunit": "^7"
    }
}

要在运行命令中应用更改：composer.json
```
composer install
```
最后，您可以在tests/文件夹中运行测试：
```
./vendor/bin/phpunit tests/
```

php - 使用 Composer 和 autoload.php 在 PHPUnit 中自动加载类

5 回答 5

Related

Reference