{"id":20173831,"url":"https://github.com/nebkam/fluent-test","last_synced_at":"2025-04-10T03:18:00.544Z","repository":{"id":57024538,"uuid":"119804200","full_name":"nebkam/fluent-test","owner":"nebkam","description":"A few helpers to ease functional API testing in Symfony","archived":false,"fork":false,"pushed_at":"2024-04-10T11:55:56.000Z","size":50,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-10T03:17:51.266Z","etag":null,"topics":["fluent-interface","php","symfony","testing"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nebkam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-02-01T08:10:27.000Z","updated_at":"2023-08-22T14:45:03.000Z","dependencies_parsed_at":"2024-11-14T01:38:11.567Z","dependency_job_id":"6a55f73c-d2d4-466f-bbbe-157a2a64aedd","html_url":"https://github.com/nebkam/fluent-test","commit_stats":{"total_commits":50,"total_committers":5,"mean_commits":10.0,"dds":0.48,"last_synced_commit":"491e61e92bc541873227a5787d623121379e719f"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkam%2Ffluent-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkam%2Ffluent-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkam%2Ffluent-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nebkam%2Ffluent-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nebkam","download_url":"https://codeload.github.com/nebkam/fluent-test/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248148247,"owners_count":21055548,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["fluent-interface","php","symfony","testing"],"created_at":"2024-11-14T01:38:05.327Z","updated_at":"2025-04-10T03:18:00.522Z","avatar_url":"https://github.com/nebkam.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Latest Stable Version](https://poser.pugx.org/nebkam/fluent-test/v)](//packagist.org/packages/nebkam/fluent-test)\n\n# Fluent Test Helper\nFew classes to make your Symfony tests more readable\n\n### Symfony 5 \u0026 6\n`composer require --dev nebkam/fluent-test`\n\n### Symfony 3 \u0026 4\n`composer require --dev nebkam/fluent-test:\"^2.0\"`\n\n## `RequestBuilder`\nSince `Symfony\\Bundle\\FrameworkBundle\\KernelBrowser::request` has 7 optional parameters, arbitrary ordered, this class follows a [builder pattern](https://en.wikipedia.org/wiki/Builder_pattern) to construct the request using semantic methods.\n\n### Usage\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, $server, $content);\n\n// After\n$response = RequestBuilder::create($client)\n  -\u003esetMethod($method)\n  -\u003esetUri($uri)\n  -\u003esetParameters($parameters)\n  -\u003esetFiles($files)\n  -\u003esetContent($content)\n  -\u003egetResponse();\n```\n### What about $server parameter?\nThere's no `RequestBuilder::setServer` method, since it seemed to general to be semantic.\nInstead, you can use more specific methods (Thanks, @KristijanKanalas):\n - `setHeader`\n - `setHttpHeader`\n - `setCredentials`\n\n(if you think of some other uses of server variables, feel free to write a semantic method for it in a PR)\n\n#### setHeader\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, [\n  'CONTENT_TYPE' =\u003e $value\n  ], $content);\n\n// After\n$response = RequestBuilder::create($client)\n  -\u003esetHeader('CONTENT_TYPE', $value)\n  ...\n```\n\n#### setHttpHeader\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, [\n  'HTTP_X-Custom-Header' =\u003e $value\n  ], $content);\n\n// After\n$response = RequestBuilder::create($client)\n  -\u003esetHttpHeader('X-Custom-Header', $value)\n  ...\n```\n\n#### setCredentials\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, [\n  'PHP_AUTH_USER' =\u003e $username,\n  'PHP_AUTH_PW' =\u003e $password\n  ], $content);\n\n//After\n$response = RequestBuilder::create($client)\n  -\u003esetCredentials($username, $password)\n  ...\n```\n\n### `setJsonContent`\nSend a JSON encoded payload with the request\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, $server, json_encode($content));\n\n// After\n$response = RequestBuilder::create($client)\n  -\u003esetJsonContent($content)\n  ...\n```\n\n### Dynamic URIs\n`setUri` accepts either a plain `string` or [sprintf](https://www.php.net/manual/en/function.sprintf.php) -compatible parameters (format and values)\n```php\n// This works\n$response = RequestBuilder::create($client)\n  -\u003esetUri('/users/'. $email .'/details')\n  ...\n\n// This is more readable\n$response = RequestBuilder::create($client)\n  -\u003esetUri('/users/%s/details', $email)\n  ...\n```\n\n## `ResponseWrapper`\nA [decorator](https://en.wikipedia.org/wiki/Decorator_pattern) for `Symfony\\Component\\HttpFoundation\\Response` that wraps the response and provides few semantic _issers_ to make asserts more readable\n\n### Usage\n```php\n// Before\n$client-\u003erequest($method, $uri, $parameters, $files, $server, $content);\n$response = $client-\u003egetResponse();\n$this-\u003eassertEquals(200,$response-\u003egetStatusCode())\n\n// After\n$response = RequestBuilder::create($client)\n  ...\n  -\u003egetResponse();\n$this-\u003eassertTrue($response-\u003eisOk());\n```\n\n### List of _issers_\n- `isBadRequest`\n- `isCreated`\n- `isEmpty`\n- `isForbidden`\n- `isNotFound`\n- `isOk`\n- `isUnauthorized`\n- `isUnprocessable`\n\n### `getJsonContent`\nGet a JSON decoded body from the response\n```php\n// Before\n$response = $client-\u003erequest($method, $uri, $parameters, $files, $server, $content);\n$data = json_decode($client-\u003egetResponse());\n\n// After\n$data = RequestBuilder::create($client)\n  ...\n  -\u003egetResponse()\n  -\u003egetJsonContent();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebkam%2Ffluent-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnebkam%2Ffluent-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnebkam%2Ffluent-test/lists"}