README

此捆绑包与 kununu/data-fixtures 包集成，允许您在测试中加载固定数据。它还提供了一些使测试更简单的实用工具，例如将测试控制器更具有表现力的 RequestBuilder。如果您想看看这个捆绑包能为您做什么，请点击 这里。

安装

1. 将 kununu/testing-bundle 添加到您的项目中

请注意，此捆绑包不应在生产模式下使用！

composer require --dev kununu/testing-bundle

2. 启用捆绑包

在任何环境中启用捆绑包，请参阅 config/bundles.php。

<?php

return [
    ...
    Kununu\TestingBundle\KununuTestingBundle::class => ['dev' => true, 'test' => true],
];

配置

在 config/packages/test/ 内创建 kununu_testing.yaml 文件。捆绑包的配置选项高度依赖于固定数据类型。请查看 加载固定数据 部分，其中包含更多选项。

提示 如果您在多个环境中使用此捆绑包，例如 dev 和 test，并且配置选项完全相同，您可以通过以下方式导入 kununu_testing.yaml 以避免重复配置。

# config/packages/dev/kununu_testing.yaml
kununu_testing:
  cache:
    pools:
      app.cache.first:
        load_command_fixtures_classes_namespace:
          - 'Kununu\TestingBundle\Tests\App\Fixtures\CachePool\CachePoolFixture1'

# config/packages/test/kununu_testing.yaml
imports:
  - { resource: '../dev/kununu_testing.yaml' }

加载固定数据

此捆绑包与 kununu/data-fixtures 集成，允许您在测试中加载固定数据。目前，此捆绑包支持以下类型的固定数据

• Doctrine DBAL 连接固定数据
• 缓存池固定数据
• Elasticsearch 固定数据
• Symfony Http 客户端固定数据

Schema Copier

此捆绑包还有从数据库复制数据库模式的方法。

查看更多

• Schema Copier

发送请求

请求构建器

此捆绑包提供请求构建器，它使调用端点更具表现力。

// Creates and returns a Builder that you can use to do a GET request
public static function aGetRequest(): self;

// Creates and returns a Builder that you can use to do a POST request
public static function aPostRequest(): self;

// Creates and returns a Builder that you can use to do a DELETE request
public static function aDeleteRequest(): self;

// Creates and returns a Builder that you can use to do a PUT request
public static function aPutRequest(): self;

// Creates and returns a Builder that you can use to do a PATCH request
public static function aPatchRequest(): self;

// Set The Request parameters
public function withParameters(array $parameters): self;

// Change The request method
public function withMethod(string $method): self;

// Set the URI to fetch
public function withUri(string $uri): self;

// Set the content of the request as an array that internally is transformed to a json and provided as the raw body data
public function withContent(array $content): self;

// Set the Raw body data
public function withRawContent(string $content): self;

// Sets an HTTP_AUTHORIZATION header with the value of "Bearer $token"
public function withAuthorization(string $token): self;

// Sets an header. 
// In converts any header name to uppercase and prepends "HTTP_" if the header name does not contains it
public function withHeader(string $headerName, string $headerValue): self;

// Sets a server parameter (HTTP headers are referenced with an HTTP_ prefix as PHP does)
public function withServerParameter(string $parameterName, string $parameterValue): self;

WebTestCase

此捆绑包公开了一个可扩展的 WebTestCase，它公开了一个帮助您测试控制器而不必担心创建内核的方法。此类还允许您在测试中加载固定数据。

final protected function doRequest(RequestBuilder $builder): Symfony\Component\HttpFoundation\Response

内部，此方法通过以下方式调用 Symfony 客户端：

$client->request($builder->method, $builder->uri, $builder->parameters, $builder->files, $builder->server, $builder->content);

示例

让我们假设您有一个名为 company_create 的路由，它是受保护的（需要提供有效的访问令牌），并期望在请求体中提供一个 json，其中包含创建新公司所需的数据。

# routes.yaml
company_create:
  path:       /companies
  controller: App\Controller\CompaniesController::createAction
  methods:    [POST]

使用此捆绑包提供的概念，例如 加载固定数据、请求构建器 和 WebTestCase，我们的测试可能如下所示：

<?php

namespace App\Tests\Integration\Controller;

use App\Tests\Integration\Controller\DataFixtures\MySQL\CreateCompanyDataFixtures;
use Kununu\TestingBundle\Test\RequestBuilder;
use Kununu\TestingBundle\Test\WebTestCase;
use Symfony\Component\HttpFoundation\Response;

class CompaniesControllerTest extends WebTestCase
{
    public function testCreateCompany(): void
    {
        $this->loadDbFixtures('your_doctrine_connection_name', [CreateCompanyDataFixtures::class]);

        $data = [
            'name'        => 'kununu GmbH',
            'location'    => [
                'city'         => 'Wien',
                'country_code' => 'at',
            ],
        ];

        $response = $this->doRequest(
            RequestBuilder::aPostRequest()
                ->withUri('/companies')
                ->withContent($data)
                ->withAuthorization('eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjYyZDVkNzc5NmQxOTk')
                ->withServerParameter('REMOTE_ADDR', '127.0.0.1')
        );

        $this->assertNotNull($response->getContent());
        $this->assertEquals(Response::HTTP_CREATED, $response->getStatusCode());

        $json = $response->getContent();
        $this->assertJson($json);

        $company = json_decode($json, true);

        $this->assertSame($data['name'], $company['name']);
        $this->assertSame($data['location']['city'], $company['location']['city']);
        $this->assertSame($data['location']['country_code'], $company['location']['country_code']);
    }
}

贡献

如果您有兴趣贡献，请阅读我们的 贡献指南。

测试

此存储库利用 GitHub actions 在向分支提交时运行测试。

如果您想在本地计算机上运行集成测试，您将需要

• pdo_mysql 扩展
• MySQL 服务器
• Elasticsearch 集群

为了在本地环境中为您准备好一切，请运行 ./tests/setupLocalTests.sh 并按照指示操作。然后您就可以运行测试了： vendor/bin/phpunit。