README

Mango Presenter Tester fork just for personal use with some tweaks.

Testing tool for Nette presenter with easy to use API.

Installation

The recommended way to install is via Composer:

composer require --dev forrest79/presenter-tester

It requires PHP version 8.1.

Integration & configuration

If you are using the power of Nette DI Container in your tests, you can use Presenter Tester in your current testing environment. All you need is to register PresenterTester service in .neon configuration for tests.

services:
	- Forrest79\PresenterTester\PresenterTester(baseUrl: "http://my-app.test")

You can also specify a list of listeners:

parameters:
	baseUrl: 'http://my-app.dev'

services:
	- Forrest79\PresenterTester\PresenterTester(
		baseUrl: %baseUrl%
		listeners: [
			MyListener()
		]
	)

Usage

Get PresenterTester service from DI container. When you get the service, you can start testing your presenters:

$testRequest = $presenterTester->createRequest('Admin:Article')
	->withParameters([
		'action' => 'edit',
		'id' => 1,
	]);
$testResult = $presenterTester->execute($testRequet);
$testResult->assertRenders('%A%Hello world article editation%A%');

As you can see, you first create a TestPresenterRequest using createRequest method on PresenterTester. You pass a presenter name (without an action) and later you configure the test request. You can set additional request parameters like action or your own application parameters. There are many other things you can configure on the request, like form values or headers.

After the test request is configured, you pass it to execute method, which performs presenter execution and returns TestPresenterResult, which wraps Nette\Application\IResponse with some additional data collected during execution.

The TestPresenterResult contains many useful assert functions like render check or form validity check. In our example there is assertRenders method, which asserts that presenter returns TextResponse and that the text contains a given pattern. You probably already know the pattern format from Tester\Assert::match() function.

Helpers

MemorySessionHandler

To bypass PHP session, you can use it for testing saving session just to memory. To do this, simply call this before running tests:

Forrest79\PresenterTester\Helpers\MemorySessionHandler::install();

Or use mocked Session.

Mocks

Some mocks are taken from https://github.com/mangoweb-backend/tester-http-mocks

Http\Request

To correct set SameSite cookie you need to redefine Http\Request for testing. You can use the original one from Nette:

services:
	http.request: Nette\Http\Request(
		url: Nette\Http\UrlScript(%baseUrl%)
		cookies: ['_nss': true] # Nette\Http\Helpers::STRICT_COOKIE_NAME
		remoteAddress: '255.254.253.252' # you can set also some other values, for example, REMOTE_ADDRESS
	)

Or you can use mocked Http\Request like this:

services:
	http.request: Forrest79\PresenterTester\Mocks\Http\Request(
		url: Nette\Http\UrlScript('http://my-app.dev')
		remoteAddress: '255.254.253.252' # you can set also some other values, for example, REMOTE_ADDRESS
	)

Http\Response

If you want to test cookies, that are sent, use mocked Http\Response:

services:
	http.response:
		factory: Forrest79\PresenterTester\Mocks\Http\Response
		alteration: true

Then get Forrest79\PresenterTester\Mocks\Http\Response service from DI container and read cookies by getCookies() method.

Http\Session

Fake testing session. When you use this, you don't need to install MemorySessionHandler.

services:
	session.session:
		factory: Forrest79\PresenterTester\Mocks\Http\Session

Mail\Mailer

Fake mailer. All send emails via Nette\Mail are saved to the memory, and you can check them in tests.

services:
	mail.mailer:
		factory: Forrest79\PresenterTester\Mocks\Mail\Mailer
		alteration: true

Then get Forrest79\PresenterTester\Mocks\Mail\Mailer service from DI container and read last message with getLastMessage() method, all messages with getMessages() method or check sent message count with count() method or use Countable interface.

TestPresenterRequest API

Beware that TestPresenterRequest is immutable object.

`withParameters(array $parameters)`

Set application request parameters.

`withForm(string $formName, array $post, array $files)`

Add form submission data to request. You have to specify a full component tree path to in $formName.

Presenter Tester supports forms with CSRF protection, but since it uses session, it is recommended to install mangoweb/tester-http-mocks package.

`withSignal(string $signal, array $componentParameters = [])`

With Presenter Tester, you can also easily test signal method.

`withAjax`

(Not only) signals often use AJAX, which you can enable using this method.

`withMethod(string $methodName)`

Change the HTTP method. The default is GET. You don't have to explicitly set a method for forms.

`withHeaders(array $headers)`

Pass additional HTTP headers.

`withIdentity(Nette\Security\IIdentity $identity)`

Change the identity of the User, which is executing given request. This is useful when login is required to perform the action. You can implement identity factory, which provides a default identity for each request.

`withPost(array $post)`

`withFiles(array $files)`

`withRawBody(string$rawBody)`

TestPresenterResult API

It is a result of test execution. It wraps Nette\Application\IResponse and adds few methods to check the response easily.

`assertRenders($match)`

Checks that response is TextResponse. Also, you can provide a $match parameter to check that response contains some text. You can either pass pattern or an array plain strings.

`assertNotRenders($matches)`

Checks that have given pattern or strings were not rendered.

`assertJson($expected)`

Check that response is JSON. You can optionally pass the expected payload.

`assertBadRequest($code)`

Checks that requests terminates with bad request exception (e.g., 404 not found).

`assertRedirects(string $presenterName, array $parameters)`

Check that request redirects to given presenter. You can also pass parameters to check. Extra parameters in redirect request are ignored.

`assertRedirectsUrl($url)`

`assertFormValid($formName)`

`assertFormHasErrors($formName, $formErrors)`

Also, there are methods like getResponse or getPresenter to access original data and perform some custom checks.

Listeners

You can hook to some events by implementing Forrest79\PresenterTester\PresenterTesterListener interface. Then you can, e.g., modify test request or execute some implicit result checks.

To register a listener, simply register it as a service in DI container (infrastructure container if you are using Mango Tester Infrastructure).

Identity factory

Using identity factory, you can implement a factory which creates a default identity. The factory is a simple PHP callback, which accepts PresenterTestRequest and returns Nette\Security\IIdentity.

forrest79 / presenter-tester

Maintainers

Details