nebkam/fluent-test

一些辅助工具,简化在Symfony中进行功能API测试

4.2.0 2024-04-10 11:52 UTC

This package is auto-updated.

Last update: 2024-09-10 12:46:23 UTC


README

Latest Stable Version

Fluent Test Helper

一些类,使您的Symfony测试更具可读性

Symfony 5 & 6

composer require --dev nebkam/fluent-test

Symfony 3 & 4

composer require --dev nebkam/fluent-test:"^2.0"

RequestBuilder

由于Symfony\Bundle\FrameworkBundle\KernelBrowser::request有7个可选参数,顺序任意,此类遵循构建器模式,使用语义方法构建请求。

使用方法

// Before
$response = $client->request($method, $uri, $parameters, $files, $server, $content);

// After
$response = RequestBuilder::create($client)
  ->setMethod($method)
  ->setUri($uri)
  ->setParameters($parameters)
  ->setFiles($files)
  ->setContent($content)
  ->getResponse();

关于$server参数怎么办?

没有RequestBuilder::setServer方法,因为它看起来太过通用,不具语义。相反,您可以使用更具体的方法(感谢,@KristijanKanalas)

  • setHeader
  • setHttpHeader
  • setCredentials

(如果您认为服务器变量有其他用途,请随时在PR中编写语义方法)

setHeader

// Before
$response = $client->request($method, $uri, $parameters, $files, [
  'CONTENT_TYPE' => $value
  ], $content);

// After
$response = RequestBuilder::create($client)
  ->setHeader('CONTENT_TYPE', $value)
  ...

setHttpHeader

// Before
$response = $client->request($method, $uri, $parameters, $files, [
  'HTTP_X-Custom-Header' => $value
  ], $content);

// After
$response = RequestBuilder::create($client)
  ->setHttpHeader('X-Custom-Header', $value)
  ...

setCredentials

// Before
$response = $client->request($method, $uri, $parameters, $files, [
  'PHP_AUTH_USER' => $username,
  'PHP_AUTH_PW' => $password
  ], $content);

//After
$response = RequestBuilder::create($client)
  ->setCredentials($username, $password)
  ...

setJsonContent

在请求中发送JSON编码的有效负载

// Before
$response = $client->request($method, $uri, $parameters, $files, $server, json_encode($content));

// After
$response = RequestBuilder::create($client)
  ->setJsonContent($content)
  ...

动态URI

setUri接受一个普通字符串或sprintf兼容的参数(格式和值)

// This works
$response = RequestBuilder::create($client)
  ->setUri('/users/'. $email .'/details')
  ...

// This is more readable
$response = RequestBuilder::create($client)
  ->setUri('/users/%s/details', $email)
  ...

ResponseWrapper

一个装饰器,用于包装Symfony\Component\HttpFoundation\Response并提供一些语义的issers,使断言更具可读性

使用方法

// Before
$client->request($method, $uri, $parameters, $files, $server, $content);
$response = $client->getResponse();
$this->assertEquals(200,$response->getStatusCode())

// After
$response = RequestBuilder::create($client)
  ...
  ->getResponse();
$this->assertTrue($response->isOk());

issers列表

  • isBadRequest
  • isCreated
  • isEmpty
  • isForbidden
  • isNotFound
  • isOk
  • isUnauthorized
  • isUnprocessable

getJsonContent

从响应中获取JSON解码后的主体

// Before
$response = $client->request($method, $uri, $parameters, $files, $server, $content);
$data = json_decode($client->getResponse());

// After
$data = RequestBuilder::create($client)
  ...
  ->getResponse()
  ->getJsonContent();