Skip to content

feat(http)!: add query parameter to route testing utilities #1583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brendt merged 2 commits into from
Oct 2, 2025
Merged

feat(http)!: add query parameter to route testing utilities #1583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16598e4
feat(http): add `query` parameter to route testing utilities
innocenzi Oct 1, 2025
6b9a4ae
test: update `TestResponseHelper` calls in tests
innocenzi Oct 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions src/Tempest/Framework/Testing/Http/HttpRouterTester.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
use Tempest\Http\Request;
use Tempest\Router\RouteConfig;
use Tempest\Router\Router;
use Tempest\Validation\Validator;
use Tempest\Support\Uri;

use function Tempest\map;

Expand All @@ -25,108 +25,108 @@ public function __construct(
private Container $container,
) {}

public function get(string $uri, array $headers = []): TestResponseHelper
public function get(string $uri, array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::GET,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: [],
headers: $headers,
),
);
}

public function head(string $uri, array $headers = []): TestResponseHelper
public function head(string $uri, array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::HEAD,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: [],
headers: $headers,
),
);
}

public function post(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function post(string $uri, array $body = [], array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::POST,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: $body,
headers: $headers,
),
);
}

public function put(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function put(string $uri, array $body = [], array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::PUT,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: $body,
headers: $headers,
),
);
}

public function delete(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function delete(string $uri, array $body = [], array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::DELETE,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: $body,
headers: $headers,
),
);
}

public function connect(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function connect(string $uri, array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::CONNECT,
uri: $uri,
body: $body,
uri: Uri\merge_query($uri, ...$query),
body: [],
headers: $headers,
),
);
}

public function options(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function options(string $uri, array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::OPTIONS,
uri: $uri,
body: $body,
uri: Uri\merge_query($uri, ...$query),
body: [],
headers: $headers,
),
);
}

public function trace(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function trace(string $uri, array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::TRACE,
uri: $uri,
body: $body,
uri: Uri\merge_query($uri, ...$query),
body: [],
headers: $headers,
),
);
}

public function patch(string $uri, array $body = [], array $headers = []): TestResponseHelper
public function patch(string $uri, array $body = [], array $query = [], array $headers = []): TestResponseHelper
{
return $this->sendRequest(
new GenericRequest(
method: Method::PATCH,
uri: $uri,
uri: Uri\merge_query($uri, ...$query),
body: $body,
headers: $headers,
),
Expand All @@ -142,6 +142,7 @@ public function sendRequest(Request $request): TestResponseHelper

return new TestResponseHelper(
response: $router->dispatch(map($request)->with(RequestToPsrRequestMapper::class)->do()),
request: $request,
container: $this->container,
);
}
Expand Down
3 changes: 2 additions & 1 deletion src/Tempest/Framework/Testing/Http/TestResponseHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Tempest\Container\Container;
use Tempest\Cryptography\Encryption\Encrypter;
use Tempest\Http\Cookie\Cookie;
use Tempest\Http\Request;
use Tempest\Http\Response;
use Tempest\Http\Responses\Invalid;
use Tempest\Http\Session\Session;
Expand All @@ -22,13 +23,13 @@
use Tempest\View\View;
use Tempest\View\ViewRenderer;

use function Tempest\get;
use function Tempest\Support\arr;

final class TestResponseHelper
{
public function __construct(
private(set) Response $response,
private(set) Request $request,
private(set) ?Container $container = null,
) {}

Expand Down
14 changes: 14 additions & 0 deletions tests/Integration/Testing/Http/HttpRouterTesterIntegrationTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,18 @@ public function test_patch_requests_failure(): void
->patch('/this-route-does-not-exist')
->assertOk();
}

public function test_query(): void
{
$this->assertSame($this->http->get('/test?foo=baz', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->get('/test?jon=doe', query: ['foo' => 'bar'])->request->uri, '/test?jon=doe&foo=bar');
$this->assertSame($this->http->get('/test?jon=doe', query: ['foo' => ['bar' => 'baz']])->request->uri, '/test?jon=doe&foo%5Bbar%5D=baz');

$this->assertSame($this->http->get('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->post('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->put('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->delete('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->patch('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
$this->assertSame($this->http->head('/test', query: ['foo' => 'bar'])->request->uri, '/test?foo=bar');
}
}
27 changes: 21 additions & 6 deletions tests/Integration/Testing/Http/TestResponseHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;
use Tempest\Framework\Testing\Http\TestResponseHelper;
use Tempest\Http\GenericRequest;
use Tempest\Http\GenericResponse;
use Tempest\Http\Method;
use Tempest\Http\Status;

/**
Expand All @@ -19,7 +21,7 @@ final class TestResponseHelperTest extends TestCase
public function test_get_response(): void
{
$response = new GenericResponse(status: Status::OK);
$helper = new TestResponseHelper($response);
$helper = new TestResponseHelper($response, new GenericRequest(Method::GET, '/'));

$this->assertSame($response, $helper->response);
}
Expand All @@ -31,6 +33,7 @@ public function test_assert_has_header(): void
status: Status::OK,
headers: ['Location' => '/new-location'],
),
new GenericRequest(Method::GET, '/'),
);

$helper->assertHasHeader('Location');
Expand All @@ -39,9 +42,8 @@ public function test_assert_has_header(): void
public function test_assert_has_header_failure(): void
{
$helper = new TestResponseHelper(
new GenericResponse(
status: Status::OK,
),
new GenericResponse(status: Status::OK),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -56,6 +58,7 @@ public function test_assert_header_value_equals(): void
status: Status::OK,
headers: ['Content-Type' => ['application/json']],
),
new GenericRequest(Method::GET, '/'),
);

$helper->assertHeaderContains('Content-Type', 'application/json');
Expand All @@ -65,6 +68,7 @@ public function test_assert_header_value_equals_failure(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -81,6 +85,7 @@ public function test_assert_redirect(): void
'Location' => ['/other-location'],
],
),
new GenericRequest(Method::GET, '/'),
);

$helper->assertRedirect();
Expand All @@ -90,6 +95,7 @@ public function test_assert_redirect_without_location_header(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::FOUND),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -104,6 +110,7 @@ public function test_assert_redirect_without_3xx_status_code(): void
status: Status::OK,
headers: ['Location' => '/other-location'],
),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -118,6 +125,7 @@ public function test_assert_redirect_to(): void
status: Status::FOUND,
headers: ['Location' => ['/other-location']],
),
new GenericRequest(Method::GET, '/'),
);

$helper->assertRedirect('/other-location');
Expand All @@ -127,6 +135,7 @@ public function test_assert_ok(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK),
new GenericRequest(Method::GET, '/'),
);

$helper->assertOk();
Expand All @@ -136,6 +145,7 @@ public function test_assert_ok_fails_with_not_okay_response(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::INTERNAL_SERVER_ERROR),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -147,6 +157,7 @@ public function test_assert_not_found(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::NOT_FOUND),
new GenericRequest(Method::GET, '/'),
);

$helper->assertNotFound();
Expand All @@ -156,6 +167,7 @@ public function test_assert_not_found_fails_with_okay_response(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK),
new GenericRequest(Method::GET, '/'),
);

$this->expectException(AssertionFailedError::class);
Expand All @@ -166,15 +178,15 @@ public function test_assert_not_found_fails_with_okay_response(): void
#[DataProvider('provide_assert_status_cases')]
public function test_assert_status(Status $expectedStatus, GenericResponse $response): void
{
$helper = new TestResponseHelper($response);
$helper = new TestResponseHelper($response, new GenericRequest(Method::GET, '/'));

$helper->assertStatus($expectedStatus);
}

#[DataProvider('provide_assert_status_fails_when_status_does_not_match_cases')]
public function test_assert_status_fails_when_status_does_not_match(Status $expectedStatus, GenericResponse $response): void
{
$helper = new TestResponseHelper($response);
$helper = new TestResponseHelper($response, new GenericRequest(Method::GET, '/'));

$this->expectException(AssertionFailedError::class);

Expand All @@ -185,6 +197,7 @@ public function test_assert_json_has_keys(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK, body: ['title' => 'Timeline Taxi', 'author' => ['name' => 'John']]),
new GenericRequest(Method::GET, '/'),
);

$helper->assertJsonHasKeys('title', 'author.name');
Expand All @@ -194,6 +207,7 @@ public function test_assert_json_contains(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK, body: ['title' => 'Timeline Taxi', 'author' => ['name' => 'John']]),
new GenericRequest(Method::GET, '/'),
);

$helper->assertJsonContains(['title' => 'Timeline Taxi']);
Expand All @@ -205,6 +219,7 @@ public function test_assert_json(): void
{
$helper = new TestResponseHelper(
new GenericResponse(status: Status::OK, body: ['title' => 'Timeline Taxi', 'author' => ['name' => 'John']]),
new GenericRequest(Method::GET, '/'),
);

$helper->assertJson(['title' => 'Timeline Taxi', 'author' => ['name' => 'John']]);
Expand Down