Commençons par Laravel, BDD et vous

Bienvenue dans une série sur le développement d'applications Laravel à l'aide des méthodes de développement piloté par le comportement (BDD). Le BDD full-stack peut sembler complexe et intimidant. Il existe autant de façons d’y parvenir que de développeurs.

Dans cette série, je vais vous guider dans la conception d'une application Laravel à partir de zéro à l'aide de Behat et PhpSpec.

Il existe de nombreuses ressources sur BDD en général, mais le matériel spécifique à Laravel est difficile à trouver. Ainsi, dans cette série, nous nous concentrerons davantage sur les aspects liés à Laravel plutôt que sur les éléments généraux que vous pouvez lire dans de nombreux autres endroits.

Décrire le comportement

Lors de la description des comportements (également connue sous le nom d'écriture d'histoires et de spécifications), nous utiliserons une approche de l'extérieur vers l'intérieur. Cela signifie que chaque fois que nous créons une nouvelle fonctionnalité, nous commençons par écrire une user story complète. Il s’agit généralement du point de vue du client ou d’une partie prenante.

Qu'attendons-nous qu'il se passe lorsque nous faisons cela ? 块引用>

À moins que nous ne refactorisons le code existant, nous ne sommes pas autorisés à écrire de code à moins que nous n'atteignions une étape rouge ayant échoué.

Parfois, il est nécessaire d’aborder de manière itérative une petite partie d’une histoire ou d’un long métrage (j’utilise les deux mots de manière interchangeable) sur laquelle nous travaillons. Cela signifie généralement écrire des spécifications en utilisant PhpSpec. Parfois, il faut plusieurs itérations au niveau de l'intégration ou de l'unité avant que l'histoire entière soit transmise (au niveau de l'acceptation). Tout cela semble compliqué, mais ce n’est pas le cas. Je crois fermement à l'apprentissage par la pratique, donc je pense que tout cela aura plus de sens une fois que nous aurons commencé à écrire du code.

Nous rédigerons des histoires et des spécifications à quatre niveaux différents :

1. Acceptation

La plupart du temps, notre suite de fonctionnalités servira de couche d'acceptation. La façon dont nous décrivons les fonctionnalités dans une suite de fonctionnalités sera très similaire à la façon dont nous rédigeons des histoires d'acceptation (à l'aide du framework de navigateur automatisé), il y aura donc beaucoup de duplications.

Tant que les histoires décrivent le comportement du point de vue du client, elles peuvent servir d'histoires d'acceptation. Nous utiliserons Symfony DomCrawler pour tester la sortie de l'application. Plus tard dans cette série, nous constaterons peut-être que nous devons tester avec un véritable navigateur capable également d'exécuter JavaScript. Les tests via le navigateur ajoutent de nouveaux problèmes, car nous devons nous assurer que l'environnement de test horaire est chargé pendant l'exécution de la suite.

2. Fonctionnalité

Dans notre suite de fonctionnalités, nous aurons accès aux applications Laravel, ce qui est très pratique. Premièrement, cela permet une différenciation facile des environnements. Deuxièmement, ne pas passer par le navigateur rend notre suite de tests plus rapide. Chaque fois que nous souhaitons implémenter une nouvelle fonctionnalité, nous utilisons Behat pour écrire une histoire dans notre suite de fonctionnalités.

3. Intégration

Notre suite d'intégration testera le comportement des parties essentielles de votre application qui ne nécessitent pas nécessairement un accès à Laravel. Les suites intégrées sont souvent un mélange d'histoires Behat et de spécifications PhpSpec.

4. Unité

Nos tests unitaires seront écrits en PhpSpec et testeront de petites unités indépendantes du cœur de l'application. Nos entités, objets de valeur, etc. auront tous des spécifications.

Cas

Dans cette série, à partir du prochain article, nous allons construire un système de suivi du temps. Nous allons d’abord décrire le comportement externe en écrivant un trait Behat. Le comportement interne de notre application sera décrit à l'aide de PhpSpec.

Ces deux outils réunis nous aideront à être satisfaits de la qualité de l'application que nous construisons. Nous rédigerons des fonctionnalités et des spécifications principalement à trois niveaux :

1. Fonctionnalité
2. Intégration
3. Unité

Dans notre suite de fonctionnalités, nous récupérerons la réponse HTTP de l'application en mode headless, ce qui signifie que nous ne passerons pas par le navigateur. Cela facilitera l'interaction avec Laravel et permettra à notre suite de fonctionnalités de servir également de couche d'acceptation.

Plus tard, si nous nous retrouvons avec une interface utilisateur plus complexe et que nous devrons peut-être également tester du JavaScript, nous pourrions ajouter une suite d'acceptation dédiée. La série est toujours en chantier, alors n'hésitez pas à déposer vos suggestions dans la section commentaires.

Nos paramètres

Veuillez noter que dans ce tutoriel, je suppose que vous disposez d'une nouvelle installation et d'un nouveau fonctionnement de Laravel (4.2). Il est préférable que vous utilisiez également Laravel Homestead, ce que j'ai utilisé lors de l'écriture de ce code.

Avant de commencer un vrai travail, assurons-nous que Behat et PhpSpec sont opérationnels. Tout d'abord, chaque fois que je démarre un nouveau projet Laravel, j'aime faire un petit nettoyage et supprimer les éléments dont je n'ai pas besoin :

git rm -r app/tests/ phpunit.xml CONTRIBUTING.md

Si vous supprimez ces fichiers, assurez-vous de mettre à jour vos composer.json fichiers en conséquence :

"autoload": {
    "classmap": [
        "app/commands",
        "app/controllers",
        "app/models",
        "app/database/migrations",
        "app/database/seeds"
    ]
},

Bien sûr :

$ composer dump-autoload

Nous sommes maintenant prêts à présenter les outils BDD dont nous avons besoin. Ajoutez simplement la section require-dev à votre require-dev 部分添加到您的 composer.json :

"require": {
    "laravel/framework": "4.2.*"
},
"require-dev": {
    "behat/behat": "~3.0",
    "phpspec/phpspec": "~2.0",
    "phpunit/phpunit": "~4.1"
},

“我们为什么要引入 PHPUnit？”你可能在想？在本系列中，我们不会编写优秀的 PHPUnit 测试用例，但断言与 Behat 一起是一个方便的工具。我们将在本文后面编写第一个功能时看到这一点。

请记住在修改 composer.json 后更新依赖项：

$ composer update --dev

我们即将完成安装和设置。 PhpSpec 开箱即用：

$ vendor/bin/phpspec run

0 specs
0 examples 
0ms

但是 Behat 需要使用 --init 选项快速运行才能设置所有内容：

$ vendor/bin/behat --init

+d features - place your *.feature files here
+d features/bootstrap - place your context classes here
+f features/bootstrap/FeatureContext.php - place your definitions, transformations and hooks here

$ vendor/bin/behat

No scenarios
No steps
0m0.14s (12.18Mb)

第一个命令创建了一个闪亮的新 FeatureContext 类，我们可以在其中编写功能所需的步骤定义：

<?php

use Behat\Behat\Context\SnippetAcceptingContext;
use Behat\Gherkin\Node\PyStringNode;
use Behat\Gherkin\Node\TableNode;

/**
 * Behat context class.
 */
class FeatureContext implements SnippetAcceptingContext
{
    /**
     * Initializes context.
     *
     * Every scenario gets its own context object.
     * You can also pass arbitrary arguments to the context constructor through behat.yml.
     */
    public function __construct()
    {
    }
}

编写我们的第一个功能

我们的第一个功能非常简单：我们只需确保新的 Laravel 安装以“您已到达”来迎接我们。在主页上。我还添加了一个相当愚蠢的 Given 步骤，假设我登录了 ，这仅用于显示在我们的功能中与 Laravel 交互是多么容易。

从技术上讲，我将这种类型的功能归类为功能测试，因为它与框架交互，但它也可以作为验收测试，因为我们不会看到通过浏览器测试运行类似测试有任何不同的结果工具。现在我们将坚持使用我们的功能测试套件。

继续创建一个 welcome.feature 文件并将其放入 features/functions:

# features/functional/welcome.feature

Feature: Welcoming developer
    As a Laravel developer
    In order to proberly begin a new project
    I need to be greeted upon arrival

    Scenario: Greeting developer on homepage
        Given I am logged in
        When I visit "/"
        Then I should see "You have arrived."

通过将功能特性放在 featured 目录中，我们以后可以更轻松地管理我们的套件。我们不希望不需要 Laravel 的集成类型功能必须等待缓慢的功能套件。

我喜欢让事情保持美观和干净，所以我相信我们应该为我们的功能套件提供一个专用的功能上下文，以便我们可以访问 Laravel。您可以继续复制现有的 FeatureContext 文件并将类名称更改为 LaravelFeatureContext。为此，我们还需要一个 behat.yml 配置文件。

在项目的根目录中创建一个并添加以下内容：

default:
    suites:
        functional:
            paths: [ %paths.base%/features/functional ]
            contexts: [ LaravelFeatureContext ]

我认为这里的 YAML 是非常不言自明的。我们的功能套件将在 functioning 目录中查找功能，并通过 LaravelFeatureContext 运行它们。

如果我们此时尝试运行 Behat，它会告诉我们实现必要的步骤定义。我们可以使用以下命令让 Behat 将空脚手架方法添加到 LaravelFeatureContext 中：

$ vendor/bin/behat --dry-run --append-snippets
$ vendor/bin/behat

Feature: Welcoming developer
    As a Laravel developer
    In order to proberly begin a new project
    I need to be greeted upon arival

  Scenario: Greeting developer on homepage # features/functional/welcome.feature:6
    Given I am logged in                   # LaravelFeatureContext::iAmLoggedIn()
      TODO: write pending definition
    When I visit "/"                       # LaravelFeatureContext::iVisit()
    Then I should see "You have arrived."  # LaravelFeatureContext::iShouldSee()

1 scenario (1 pending)
3 steps (1 pending, 2 skipped)
0m0.28s (12.53Mb)

现在，正如您从输出中看到的那样，我们已准备好开始实施第一个步骤：鉴于我已登录 。

Laravel 附带的 PHPUnit 测试用例允许我们执行诸如 $this->be($user) 之类的操作，它会登录给定用户。最终，我们希望能够像使用 PHPUnit 一样与 Laravel 交互，所以让我们继续编写“我们希望拥有”的步骤定义代码：

/**
 * @Given I am logged in
 */
public function iAmLoggedIn()
{
    $user = new User;

    $this->be($user);
}

这当然行不通，因为 Behat 不知道 Laravel 的具体内容，但我很快就会向您展示让 Behat 和 Laravel 很好地协同工作是多么容易。

如果您查看 Laravel 源代码并找到 Illuminate\Foundation\Testing\TestCase 类（默认测试用例扩展自该类），您会发现从 Laravel 4.2 开始，一切都已更改转移到一个特质。 ApplicationTrait 现在负责启动 Application 实例、设置 HTTP 客户端并为我们提供一些辅助方法，例如 be()。

这非常酷，主要是因为这意味着我们可以将其拉入我们的 Behat 上下文中，几乎不需要任何设置。我们还可以访问 AssertionsTrait，但这仍然与 PHPUnit 相关。

当我们引入特征时，我们需要做两件事。我们需要一个 setUp() 方法，如 Illuminate\Foundation\Testing\TestCase 类中的方法，并且需要一个 createApplication() 方法，如默认 Laravel 测试用例中的方法。其实我们直接复制这两个方法就可以了。

只有一件事需要注意：在 PHPUnit 中，方法 setUp() 会在每次测试之前自动调用。为了在 Behat 中实现相同的效果，我们可以使用 @BeforeScenario 注释。

将以下内容添加到您的 LaravelFeatureContext：

use Illuminate\Foundation\Testing\ApplicationTrait;

/**
 * Behat context class.
 */
class LaravelFeatureContext implements SnippetAcceptingContext
{
    /**
     * Responsible for providing a Laravel app instance.
     */
    use ApplicationTrait;

    /**
     * Initializes context.
     *
     * Every scenario gets its own context object.
     * You can also pass arbitrary arguments to the context constructor through behat.yml.
     */
    public function __construct()
    {
    }

    /**
     * @BeforeScenario
     */
    public function setUp()
    {
        if ( ! $this->app)
        {
            $this->refreshApplication();
        }
    }

    /**
     * Creates the application.
     *
     * @return \Symfony\Component\HttpKernel\HttpKernelInterface
     */
    public function createApplication()
    {
        $unitTesting = true;

        $testEnvironment = 'testing';

        return require __DIR__.'/../../bootstrap/start.php';
    }

非常简单，看看我们运行 Behat 时得到的结果：

$ vendor/bin/behat

Feature: Welcoming developer
    As a Laravel developer
    In order to proberly begin a new project
    I need to be greeted upon arival

  Scenario: Greeting developer on homepage # features/functional/welcome.feature:6
    Given I am logged in                   # LaravelFeatureContext::iAmLoggedIn()
    When I visit "/"                       # LaravelFeatureContext::iVisit()
      TODO: write pending definition
    Then I should see "You have arrived."  # LaravelFeatureContext::iShouldSee()

1 scenario (1 pending)
3 steps (1 passed, 1 pending, 1 skipped)
0m0.73s (17.92Mb)

绿色的第一步，这意味着我们的设置正在运行！

接下来，我们可以实现 当我访问 步骤。这个非常简单，我们可以简单地使用 ApplicationTrait 提供的 call() 方法。一行代码即可实现：

/**
 * @When I visit :uri
 */
public function iVisit($uri)
{
    $this->call('GET', $uri);
}

最后一步，然后我应该看到，需要更多一点，我们需要引入两个依赖项。我们需要 PHPUnit 来进行断言，并且需要 Symfony DomCrawler 来搜索“您已到达”。文本。

我们可以这样实现：

use PHPUnit_Framework_Assert as PHPUnit;
use Symfony\Component\DomCrawler\Crawler;

...

/**
 * @Then I should see :text
 */
public function iShouldSee($text)
{
    $crawler = new Crawler($this->client->getResponse()->getContent());

    PHPUnit::assertCount(1, $crawler->filterXpath("//text()[. = '{$text}']"));
}

这与您使用 PHPUnit 时编写的代码几乎相同。 filterXpath() 部分有点令人困惑，我们现在不用担心它，因为它有点超出了本文的范围。请相信我，它有效。

最后一次跑步是个好消息：

$ vendor/bin/behat
Feature: Welcoming developer
    As a Laravel developer
    In order to proberly begin a new project
    I need to be greeted upon arival

  Scenario: Greeting developer on homepage # features/functional/welcome.feature:6
    Given I am logged in                   # LaravelFeatureContext::iAmLoggedIn()
    When I visit "/"                       # LaravelFeatureContext::iVisit()
    Then I should see "You have arrived."  # LaravelFeatureContext::iShouldSee()

1 scenario (1 passed)
3 steps (3 passed)
0m0.82s (19.46Mb)

该功能正在按预期工作，并且开发人员在抵达时受到欢迎。

结论

完整的 LaravelFeatureContext 现在应该与此类似：

call('GET', $uri);
    }

    /**
     * @Then I should see :text
     */
    public function iShouldSee($text)
    {
        $crawler = new Crawler($this->client->getResponse()->getContent());

        PHPUnit::assertCount(1, $crawler->filterXpath("//text()[. = '{$text}']"));
    }
}

随着我们继续使用 BDD 开发新的 Laravel 应用程序，我们现在已经有了一个非常好的基础。我希望我已经向您证明了让 Laravel 和 Behat 很好地协同工作是多么容易。

我们在第一篇文章中讨论了许多不同的主题。不用担心，随着本系列的继续，我们将更深入地研究一切。如果您有任何问题或建议，请留言。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!