flight-core/tests/EngineTest.php

<?php

use flight\Engine;
use flight\net\Response;

/**
 * Flight: An extensible micro-framework.
 *
 * @copyright   Copyright (c) 2012, Mike Cao <mike@mikecao.com>
 * @license     MIT, http://flightphp.com/license
 */


class EngineTest extends PHPUnit\Framework\TestCase
{
	public function setUp(): void {
		$_SERVER = [];
	}

	public function tearDown(): void {
		$_SERVER = [];
	}
	public function testInitBeforeStart() {
		$engine = new class extends Engine {
			public function getInitializedVar() {
				return $this->initialized;
			}
		};
		$this->assertTrue($engine->getInitializedVar());
		$engine->start();

		// this is necessary cause it doesn't actually send the response correctly
		ob_end_clean();

		$this->assertFalse($engine->router()->case_sensitive);
		$this->assertTrue($engine->response()->content_length);
	}

	public function testHandleErrorNoErrorNumber() {
		$engine = new Engine();
		$result = $engine->handleError(0, '', '', 0);
		$this->assertFalse($result);
	}

	public function testHandleErrorWithException() {
		$engine = new Engine();
		$this->expectException(Exception::class);
		$this->expectExceptionCode(5);
		$this->expectExceptionMessage('thrown error message');
		$engine->handleError(5, 'thrown error message', '', 0);
	}

	public function testHandleException() {
		$engine = new Engine();
		$regex_message = preg_quote('<h1>500 Internal Server Error</h1><h3>thrown exception message (20)</h3>');
		$this->expectOutputRegex('~'.$regex_message.'~');
		$engine->handleException(new Exception('thrown exception message', 20));
	}

	public function testMapExistingMethod() {
		$engine = new Engine();
		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Cannot override an existing framework method.');
		$engine->map('_start', function() {});
	}

	public function testRegisterExistingMethod() {
		$engine = new Engine();
		$this->expectException(Exception::class);
		$this->expectExceptionMessage('Cannot override an existing framework method.');
		$engine->register('_error', 'stdClass');
	}

	public function testSetArrayOfValues() {
		$engine = new Engine();
		$engine->set([ 'key1' => 'value1', 'key2' => 'value2']);
		$this->assertEquals('value1', $engine->get('key1'));
		$this->assertEquals('value2', $engine->get('key2'));
	}

	public function testStartWithRoute() {
		$_SERVER['REQUEST_METHOD'] = 'GET';
		$_SERVER['REQUEST_URI'] = '/someRoute';

		$engine = new class extends Engine {
			public function getInitializedVar() {
				return $this->initialized;
			}
		};
		$engine->route('/someRoute', function() { echo 'i ran'; }, true);
		$this->expectOutputString('i ran');
		$engine->start();
	}

	// n0nag0n - I don't know why this does what it does, but it's existing framework functionality 1/1/24
	public function testStartWithRouteButReturnedValueThrows404() {
		$_SERVER['REQUEST_METHOD'] = 'GET';
		$_SERVER['REQUEST_URI'] = '/someRoute';

		$engine = new class extends Engine {
			public function getInitializedVar() {
				return $this->initialized;
			}
		};
		$engine->route('/someRoute', function() { echo 'i ran'; return true; }, true);
		$this->expectOutputString('<h1>404 Not Found</h1><h3>The page you have requested could not be found.</h3>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ');
		$engine->start();
	}

	public function testStopWithCode() {
		$engine = new class extends Engine {
			public function getLoader() {
				return $this->loader;
			}
		};
		// doing this so we can overwrite some parts of the response
		$engine->getLoader()->register('response', function() {
			return new class extends \flight\net\Response {
				public function __construct() {}
				public function setRealHeader(string $header_string, bool $replace = true, int $response_code = 0): Response
				{
					return $this;
				}
			};
		});
		// need to add another one of these because _stop() stops and gets clean, but $response->send() does too.....
		ob_start();
		$engine->response()->write('I am a teapot');
		$this->expectOutputString('I am a teapot');
		$engine->stop(500);
		$this->assertEquals(500, $engine->response()->status());
	}

	public function testPostRoute() {
		$engine = new Engine();
		$engine->post('/someRoute', function() { echo 'i ran'; }, true);
		$routes = $engine->router()->getRoutes();
		$this->assertEquals('POST', $routes[0]->methods[0]);
		$this->assertEquals('/someRoute', $routes[0]->pattern);
	}

	public function testPutRoute() {
		$engine = new Engine();
		$engine->put('/someRoute', function() { echo 'i ran'; }, true);
		$routes = $engine->router()->getRoutes();
		$this->assertEquals('PUT', $routes[0]->methods[0]);
		$this->assertEquals('/someRoute', $routes[0]->pattern);
	}

	public function testPatchRoute() {
		$engine = new Engine();
		$engine->patch('/someRoute', function() { echo 'i ran'; }, true);
		$routes = $engine->router()->getRoutes();
		$this->assertEquals('PATCH', $routes[0]->methods[0]);
		$this->assertEquals('/someRoute', $routes[0]->pattern);
	}

	public function testDeleteRoute() {
		$engine = new Engine();
		$engine->delete('/someRoute', function() { echo 'i ran'; }, true);
		$routes = $engine->router()->getRoutes();
		$this->assertEquals('DELETE', $routes[0]->methods[0]);
		$this->assertEquals('/someRoute', $routes[0]->pattern);
	}

	public function testHalt() {
		$engine = new class extends Engine {
			public function getLoader() {
				return $this->loader;
			}
		};
		// doing this so we can overwrite some parts of the response
		$engine->getLoader()->register('response', function() {
			return new class extends \flight\net\Response {
				public function __construct() {}
				public function setRealHeader(string $header_string, bool $replace = true, int $response_code = 0): Response
				{
					return $this;
				}
			};
		});
		$this->expectOutputString('skip---exit');
		$engine->halt(500, 'skip---exit');
		$this->assertEquals(500, $engine->response()->status());
	}
}