benconstable/phpspec-laravel

使用 PhpSpec 测试您的 Laravel 应用程序

v4.0.1 2018-07-12 12:05 UTC

README

phpspec 扩展,用于测试 Laravel 应用程序。

Build Status Latest Stable Version Total Downloads License

版本

根据您使用的 Laravel 和/或 PhpSpec 版本,请确保您使用此包的正确版本。使用下表选择正确的版本。

安装

使用 composer 安装此包

composer require --dev "benconstable/phpspec-laravel:~4.0"

然后将其添加到您的 phpspec.yml

extensions:
  PhpSpec\Laravel\Extension\LaravelExtension: ~

您可以在 example.phpspec.yml 中查看一组适用于 Laravel 项目的合理 PhpSpec 默认设置。

为什么使用此扩展?

此扩展在编写 PhpSpec 测试时为您提供已启动的 Laravel 环境。

它允许您利用 Laravel 提供的一些优秀功能,如类别名和辅助函数,而不会受到测试框架的限制。

此扩展 不是 Laravel 内置 PHPUnit 设置的替代品。如果您想进行集成和/或功能测试,请使用那个,BehatCodeception

配置

测试环境

默认情况下,该扩展在 testing 环境中启动 Laravel。您可以通过在 phpspec.yml 中设置来将其更改为生产环境(或您喜欢的任何环境)。

extensions:
  PhpSpec\Laravel\Extension\LaravelExtension:
    testing_environment: "production"

应用启动路径

默认情况下,该扩展将通过在 vendor/ 目录以上查找 bootstrap/app.php 来启动您的应用。这是 Laravel 提供的默认位置。

如果您使用的是非标准安装,如需手动指定启动文件的路径,可按如下方式操作

extensions:
  PhpSpec\Laravel\Extension\LaravelExtension:
    framework_path: "/non/standard/laravel/setup/app.php"

您可以使用绝对路径(使用前导斜杠),或相对于 vendor/ 目录的路径。

使用

无 Laravel 的测试

如果您没有使用任何特定于 Laravel 环境的代码,那么您无需进行任何不同操作。只需像平常一样编写您的 PhpSpec 测试即可!

带有 Laravel 的测试

如果您想利用 Laravel 的别名或使用一些其 辅助函数,请从 PhpSpec\Laravel\LaravelObjectBehavior 扩展您的规格。这将防止测试时出错。

例如,此类使用一个别名

<?php
namespace App;

use Inspiring;

class MyInspiring extends Inspiring
{
    public function quoteBackwards()
    {
        return strrev(parent::quote());
    }
}

如果没有从 PhpSpec\Laravel\LaravelObjectBehavior 扩展

<?php
namespace spec\App;

use PhpSpec\ObjectBehavior;

class MyInspiringSpec extends ObjectBehavior
{
    function it_inspires_backwards()
    {
        $this->quoteBackwards()->shouldBeString();
    }
}

您将得到 致命错误:找不到类 'Inspiring'...。但通过从 PhpSpec\Laravel\LaravelObjectBehavior 扩展

<?php
namespace spec\App;

use PhpSpec\Laravel\LaravelObjectBehavior;

class MyInspiringSpec extends LaravelObjectBehavior
{
    function it_inspires_backwards()
    {
        $this->quoteBackwards()->shouldBeString();
    }
}

您将得到 ✔ 反向激发

并且此类使用一个辅助函数

<?php
namespace App;

class MyEncryptor
{
    public function encrypt($arg)
    {
        return bcrypt($arg);
    }
}

如果没有从 PhpSpec\Laravel\LaravelObjectBehavior 扩展

<?php
namespace spec\App;

use PhpSpec\ObjectBehavior;

class MyEncryptor extends ObjectBehavior
{
    function it_encrypts_a_string()
    {
        $this->encrypt()->shouldBeString();
    }
}

您将得到 致命错误:在非对象上调用成员函数 make()...。但通过从 PhpSpec\Laravel\LaravelObjectBehavior 扩展

<?php
namespace spec\App;

use PhpSpec\Laravel\LaravelObjectBehavior;

class MyEncryptor extends LaravelObjectBehavior
{
    function it_encrypts_a_string()
    {
        $this->encrypt()->shouldBeString();
    }
}

您将得到 ✔ 加密字符串

访问 IoC 容器

如果需要在您的规格中访问 服务容器,请使用 app() 辅助函数!

了解更多关于 phpspec 和 Laravel 的信息

Laracasts 提供了一些关于 phpspec 和 Laravel 的优秀指南。"Laravel、phpspec 和重构" 是一个很好的起点;它展示了如何使用 phpspec 与 Laravel 一起工作,并涵盖了编写测试的基本知识(而且它是免费的!)

贡献

请参阅 CONTRIBUTING.md

许可

MIT © Ben Constable。更多信息请参阅 LICENSE

感谢

感谢...

  • @obrignoni 为使此扩展与 Laravel 5 一起工作所做的杰出贡献
  • @Sam-Burns 为使此扩展与 Phpspec v3 和 v4 一起工作所做的杰出贡献
  • 所有其他 贡献者 以及报告了项目中问题和错误的每个人