main_test.php.twig

<?php
/**
 *
 * {{ EXTENSION.extension_display_name }}. An extension for the phpBB Forum Software package.
 *
 * @copyright (c) {{ "now"|date("Y") ~ (AUTHORS.0.author_name ? ', ' ~ AUTHORS.0.author_name) ~ (AUTHORS.0.author_homepage ? ', ' ~ AUTHORS.0.author_homepage) }}
 * @license GNU General Public License, version 2 (GPL-2.0)
 *
 */

namespace {{ EXTENSION.vendor_name }}\{{ EXTENSION.extension_name }}\tests\controller;

class main_test extends \phpbb_test_case
{
	/**
	 * Dataset for the test_handle() test
	 */
	public function handle_data()
	{
		return [
			[200, '@{{ EXTENSION.vendor_name|lower }}_{{ EXTENSION.extension_name|lower }}/{{ EXTENSION.extension_name|lower }}_body.html'],
		];
	}

	/**
	 * A simple test that creates the controller class, and
	 * checks that its handle() method is working as expected.
	 *
	 * Note the dataProvider is required in this docblock to
	 * define the data set method this test will be using (above).
	 *
	 * @dataProvider handle_data
	 */
	public function test_handle($status_code, $page_content)
	{
		// Mocks are dummy implementations that provide the API of components we depend on //
		/** @var \phpbb\template\template $template Mock the template class */
		$template = $this->getMockBuilder('\phpbb\template\template')
			->disableOriginalConstructor()
			->getMock();

		/** @var {{ LANGUAGE.class }}|\PHPUnit\Framework\MockObject\MockObject ${{ LANGUAGE.object }} Mock the {{ LANGUAGE.object }} class */
		${{ LANGUAGE.object }} = $this->getMockBuilder('{{ LANGUAGE.class }}')
			->disableOriginalConstructor()
			->getMock();

		// Set {{ LANGUAGE.object }}->lang() to return any arguments sent to it
		${{ LANGUAGE.object }}->expects(self::any())
			->method('lang')
			->will(self::returnArgument(0));

		/** @var \phpbb\controller\helper|\PHPUnit\Framework\MockObject\MockObject $controller_helper Mock the controller helper class */
		$controller_helper = $this->getMockBuilder('\phpbb\controller\helper')
			->disableOriginalConstructor()
			->getMock();

		// Set the expected output of the controller_helper->render() method
		$controller_helper->expects($this->once())
			->method('render')
			->willReturnCallback(function ($template_file, $page_title = '', $status_code = 200, $display_online_list = false) {
				return new \Symfony\Component\HttpFoundation\Response($template_file, $status_code);
			});

		// Instantiate the controller
		$controller = new \{{ EXTENSION.vendor_name }}\{{ EXTENSION.extension_name }}\controller\main_controller(
			new \phpbb\config\config([]),
			$controller_helper,
			$template,
			${{ LANGUAGE.object }}
		);

		$response = $controller->handle('test');
		$this->assertInstanceOf('\Symfony\Component\HttpFoundation\Response', $response);
		$this->assertEquals($status_code, $response->getStatusCode());
		$this->assertEquals($page_content, $response->getContent());
	}
}