From 5509f8739ee7770535ab16d0d0f1c84b290d3f7b Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:03:37 -0500 Subject: [PATCH 01/19] Updated connector logic --- LICENSE | 2 +- readme.md | 2 +- src/Codeception/Lib/Connector/Laravel.php | 151 ++++-------------- .../Laravel/ExceptionHandlerDecorator.php | 13 +- .../Laravel6/ExceptionHandlerDecorator.php | 12 -- .../Module/Laravel/ServicesTrait.php | 124 ++++++++++++++ 6 files changed, 158 insertions(+), 146 deletions(-) create mode 100644 src/Codeception/Module/Laravel/ServicesTrait.php diff --git a/LICENSE b/LICENSE index 61d8209..bc9ea8a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2011-2020 Michael Bodnarchuk and contributors +Copyright (c) 2011-2021 Michael Bodnarchuk and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/readme.md b/readme.md index 1ee0bcd..04fca81 100644 --- a/readme.md +++ b/readme.md @@ -20,7 +20,7 @@ composer require "codeception/module-laravel" --dev ## Documentation -See [the module documentation](https://codeception.com/docs/modules/Laravel5). +See [the module documentation](https://codeception.com/docs/modules/Laravel). [Changelog](https://github.com/Codeception/module-laravel/releases) diff --git a/src/Codeception/Lib/Connector/Laravel.php b/src/Codeception/Lib/Connector/Laravel.php index ae25dd7..d593403 100644 --- a/src/Codeception/Lib/Connector/Laravel.php +++ b/src/Codeception/Lib/Connector/Laravel.php @@ -4,14 +4,14 @@ namespace Codeception\Lib\Connector; -use Closure; use Codeception\Lib\Connector\Laravel\ExceptionHandlerDecorator as LaravelExceptionHandlerDecorator; use Codeception\Lib\Connector\Laravel6\ExceptionHandlerDecorator as Laravel6ExceptionHandlerDecorator; +use Codeception\Module\Laravel\ServicesTrait; use Codeception\Stub; use Exception; use Illuminate\Contracts\Debug\ExceptionHandler; use Illuminate\Contracts\Events\Dispatcher; -use Illuminate\Contracts\Http\Kernel; +use Illuminate\Contracts\Foundation\Application as AppContract; use Illuminate\Database\Eloquent\Model; use Illuminate\Foundation\Application; use Illuminate\Foundation\Bootstrap\RegisterProviders; @@ -20,15 +20,11 @@ use Symfony\Component\HttpFoundation\Request as SymfonyRequest; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\HttpKernelBrowser as Client; -use Symfony\Component\HttpKernel\Kernel as SymfonyKernel; -use function class_alias; - -if (SymfonyKernel::VERSION_ID < 40300) { - class_alias('Symfony\Component\HttpKernel\Client', 'Symfony\Component\HttpKernel\HttpKernelBrowser'); -} class Laravel extends Client { + use ServicesTrait; + /** * @var array */ @@ -40,12 +36,12 @@ class Laravel extends Client private $contextualBindings = []; /** - * @var array + * @var object[] */ private $instances = []; /** - * @var array + * @var callable[] */ private $applicationHandlers = []; @@ -111,11 +107,11 @@ public function __construct($module) $this->initialize(); - $components = parse_url($this->app['config']->get('app.url', 'http://localhost')); + $components = parse_url($this->getConfig()->get('app.url', 'http://localhost')); if (array_key_exists('url', $this->module->config)) { $components = parse_url($this->module->config['url']); } - $host = isset($components['host']) ? $components['host'] : 'localhost'; + $host = $components['host'] ?? 'localhost'; parent::__construct($this->app, ['HTTP_HOST' => $host]); @@ -127,7 +123,6 @@ public function __construct($module) * Execute a request. * * @param SymfonyRequest $request - * @return Response * @throws Exception */ protected function doRequest($request): Response @@ -144,22 +139,20 @@ protected function doRequest($request): Response $request = Request::createFromBase($request); $response = $this->kernel->handle($request); - $this->app->make(Kernel::class)->terminate($request, $response); + $this->getHttpKernel()->terminate($request, $response); return $response; } - /** - * @param SymfonyRequest|null $request - * @throws Exception - */ private function initialize(SymfonyRequest $request = null): void { // Store a reference to the database object // so the database connection can be reused during tests $this->oldDb = null; - if (isset($this->app['db']) && $this->app['db']->connection()) { - $this->oldDb = $this->app['db']; + + $db = $this->getDb(); + if ($db && $db->connection()) { + $this->oldDb = $db; } $this->app = $this->kernel = $this->loadApplication(); @@ -173,36 +166,27 @@ private function initialize(SymfonyRequest $request = null): void // Reset the old database after all the service providers are registered. if ($this->oldDb) { - $this->app['events']->listen('bootstrapped: ' . RegisterProviders::class, function () { + $this->getEvents()->listen('bootstrapped: ' . RegisterProviders::class, function () { $this->app->singleton('db', function () { return $this->oldDb; }); }); } - $this->app->make(Kernel::class)->bootstrap(); + $this->getHttpKernel()->bootstrap(); - // Record all triggered events by adding a wildcard event listener - // Since Laravel 5.4 wildcard event handlers receive the event name as the first argument, - // but for earlier Laravel versions the firing() method of the event dispatcher should be used - // to determine the event name. - if (method_exists($this->app['events'], 'firing')) { - $listener = function () { - $this->triggeredEvents[] = $this->normalizeEvent($this->app['events']->firing()); - }; - } else { - $listener = function ($event) { - $this->triggeredEvents[] = $this->normalizeEvent($event); - }; - } - $this->app['events']->listen('*', $listener); + $listener = function ($event) { + $this->triggeredEvents[] = $this->normalizeEvent($event); + }; + + $this->getEvents()->listen('*', $listener); // Replace the Laravel exception handler with our decorated exception handler, // so exceptions can be intercepted for the disable_exception_handling functionality. if (version_compare(Application::VERSION, '7.0.0', '<')) { - $decorator = new Laravel6ExceptionHandlerDecorator($this->app[ExceptionHandler::class]); + $decorator = new Laravel6ExceptionHandlerDecorator($this->getExceptionHandler()); } else { - $decorator = new LaravelExceptionHandlerDecorator($this->app[ExceptionHandler::class]); + $decorator = new LaravelExceptionHandlerDecorator($this->getExceptionHandler()); } $decorator->exceptionHandlingDisabled($this->exceptionHandlingDisabled); @@ -225,11 +209,10 @@ private function initialize(SymfonyRequest $request = null): void /** * Boot the Laravel application object. - * - * @return Application */ - private function loadApplication(): Application + private function loadApplication(): AppContract { + /** @var AppContract $app */ $app = require $this->module->config['bootstrap_file']; $app->loadEnvironmentFrom($this->module->config['environment_file']); $app->instance('request', new Request()); @@ -239,8 +222,6 @@ private function loadApplication(): Application /** * Replace the Laravel event dispatcher with a mock. - * - * @throws Exception */ private function mockEventDispatcher(): void { @@ -253,13 +234,7 @@ private function mockEventDispatcher(): void return []; }; - // In Laravel 5.4 the Illuminate\Contracts\Events\Dispatcher interface was changed, - // the 'fire' method was renamed to 'dispatch'. This code determines the correct method to mock. - $method = method_exists($this->app['events'], 'dispatch') ? 'dispatch' : 'fire'; - - $mock = Stub::makeEmpty(Dispatcher::class, [ - $method => $callback - ]); + $mock = Stub::makeEmpty(Dispatcher::class, ['dispatch' => $callback]); $this->app->instance('events', $mock); } @@ -372,7 +347,7 @@ private function applyApplicationHandlers(): void private function applyBindings(): void { foreach ($this->bindings as $abstract => $binding) { - list($concrete, $shared) = $binding; + [$concrete, $shared] = $binding; $this->app->bind($abstract, $concrete, $shared); } @@ -400,77 +375,9 @@ private function applyInstances(): void } } - //====================================================================== - // Public methods called by module - //====================================================================== - - /** - * Register a Laravel service container binding that should be applied - * after initializing the Laravel Application object. - * - * @param string $abstract - * @param Closure|string|null $concrete - * @param bool $shared - */ - public function haveBinding(string $abstract, $concrete, bool $shared = false): void - { - $this->bindings[$abstract] = [$concrete, $shared]; - } - - /** - * Register a Laravel service container contextual binding that should be applied - * after initializing the Laravel Application object. - * - * @param string $concrete - * @param string $abstract - * @param Closure|string $implementation - */ - public function haveContextualBinding(string $concrete, string $abstract, $implementation): void - { - if (! isset($this->contextualBindings[$concrete])) { - $this->contextualBindings[$concrete] = []; - } - - $this->contextualBindings[$concrete][$abstract] = $implementation; - } - - /** - * Register a Laravel service container instance binding that should be applied - * after initializing the Laravel Application object. - * - * @param string $abstract - * @param mixed $instance - */ - public function haveInstance(string $abstract, $instance): void - { - $this->instances[$abstract] = $instance; - } - - /** - * Register a handler than can be used to modify the Laravel application object after it is initialized. - * The Laravel application object will be passed as an argument to the handler. - * - * @param callable $handler - */ - public function haveApplicationHandler(callable $handler): void - { - $this->applicationHandlers[] = $handler; - } - - /** - * Clear the registered application handlers. - */ - public function clearApplicationHandlers(): void - { - $this->applicationHandlers = []; - } - /** * Make sure files are \Illuminate\Http\UploadedFile instances with the private $test property set to true. * Fixes issue https://github.com/Codeception/Codeception/pull/3417. - * - * @param array $files - * @return array */ protected function filterFiles(array $files): array { @@ -478,15 +385,19 @@ protected function filterFiles(array $files): array return $this->convertToTestFiles($files); } - private function convertToTestFiles(array $files): array + private function convertToTestFiles(array &$files): array { $filtered = []; foreach ($files as $key => $value) { if (is_array($value)) { $filtered[$key] = $this->convertToTestFiles($value); + + $files[$key] = $value; } else { $filtered[$key] = UploadedFile::createFromBase($value, true); + + unset($files[$key]); } } diff --git a/src/Codeception/Lib/Connector/Laravel/ExceptionHandlerDecorator.php b/src/Codeception/Lib/Connector/Laravel/ExceptionHandlerDecorator.php index 693c948..8d292f2 100644 --- a/src/Codeception/Lib/Connector/Laravel/ExceptionHandlerDecorator.php +++ b/src/Codeception/Lib/Connector/Laravel/ExceptionHandlerDecorator.php @@ -45,10 +45,7 @@ public function report(Throwable $e): void } /** - * Determine if the exception should be reported. - * - * @param Throwable $e - * @return bool + * Determine if the exception should be reported. */ public function shouldReport(Throwable $e): bool { @@ -59,8 +56,6 @@ public function shouldReport(Throwable $e): bool * Render an exception into an HTTP response. * * @param Request $request - * @param Throwable $e - * @return Response * @throws Throwable */ public function render($request, Throwable $e): Response @@ -79,9 +74,6 @@ public function render($request, Throwable $e): Response /** * Check if the response content is HTML output of the Symfony exception handler class. - * - * @param string $content - * @return bool */ private function isSymfonyExceptionHandlerOutput(string $content): bool { @@ -93,7 +85,6 @@ private function isSymfonyExceptionHandlerOutput(string $content): bool * Render an exception to the console. * * @param OutputInterface $output - * @param Throwable $e */ public function renderForConsole($output, Throwable $e): void { @@ -102,8 +93,6 @@ public function renderForConsole($output, Throwable $e): void /** * @param string|callable $method - * @param array $args - * @return mixed */ public function __call($method, array $args) { diff --git a/src/Codeception/Lib/Connector/Laravel6/ExceptionHandlerDecorator.php b/src/Codeception/Lib/Connector/Laravel6/ExceptionHandlerDecorator.php index 3bc1d64..3ad2991 100644 --- a/src/Codeception/Lib/Connector/Laravel6/ExceptionHandlerDecorator.php +++ b/src/Codeception/Lib/Connector/Laravel6/ExceptionHandlerDecorator.php @@ -36,7 +36,6 @@ public function exceptionHandlingDisabled(bool $exceptionHandlingDisabled): void /** * Report or log an exception. * - * @param Exception $e * @throws Exception */ public function report(Exception $e): void @@ -46,9 +45,6 @@ public function report(Exception $e): void /** * Determine if the exception should be reported. - * - * @param Exception $e - * @return bool */ public function shouldReport(Exception $e): bool { @@ -59,8 +55,6 @@ public function shouldReport(Exception $e): bool * Render an exception into an HTTP response. * * @param Request $request - * @param Exception $e - * @return Response * @throws Exception */ public function render($request, Exception $e): Response @@ -79,9 +73,6 @@ public function render($request, Exception $e): Response /** * Check if the response content is HTML output of the Symfony exception handler class. - * - * @param string $content - * @return bool */ private function isSymfonyExceptionHandlerOutput(string $content): bool { @@ -93,7 +84,6 @@ private function isSymfonyExceptionHandlerOutput(string $content): bool * Render an exception to the console. * * @param OutputInterface $output - * @param Exception $e */ public function renderForConsole($output, Exception $e): void { @@ -102,8 +92,6 @@ public function renderForConsole($output, Exception $e): void /** * @param string|callable $method - * @param array $args - * @return mixed */ public function __call($method, array $args) { diff --git a/src/Codeception/Module/Laravel/ServicesTrait.php b/src/Codeception/Module/Laravel/ServicesTrait.php new file mode 100644 index 0000000..56d9167 --- /dev/null +++ b/src/Codeception/Module/Laravel/ServicesTrait.php @@ -0,0 +1,124 @@ +app['auth'] ?? null; + } + + /** + * @return \Illuminate\Config\Repository + */ + public function getConfig(): ?Config + { + return $this->app['config'] ?? null; + } + + /** + * @return \Illuminate\Foundation\Console\Kernel + */ + public function getConsoleKernel(): ?ConsoleKernel + { + return $this->app[ConsoleKernel::class] ?? null; + } + + /** + * @return \Illuminate\Database\DatabaseManager + */ + public function getDb(): ?Db + { + return $this->app['db'] ?? null; + } + + /** + * @return \Illuminate\Events\Dispatcher + */ + public function getEvents(): ?Events + { + return $this->app['events'] ?? null; + } + + /** + * @return \Illuminate\Foundation\Exceptions\Handler + */ + public function getExceptionHandler(): ?ExceptionHandler + { + return $this->app[ExceptionHandler::class] ?? null; + } + + /** + * @return \Illuminate\Foundation\Http\Kernel + */ + public function getHttpKernel(): ?HttpKernel + { + return $this->app[HttpKernel::class] ?? null; + } + + /** + * @return \Illuminate\Routing\UrlGenerator + */ + public function getUrlGenerator(): ?Url + { + return $this->app['url'] ?? null; + } + + /** + * @return \Illuminate\Http\Request + */ + public function getRequestObject(): ?SymfonyRequest + { + return $this->app['request'] ?? null; + } + + /** + * @return \Illuminate\Routing\Router + */ + public function getRouter(): ?Router + { + return $this->app['router'] ?? null; + } + + /** + * @return \Illuminate\Routing\RouteCollectionInterface|\Illuminate\Routing\RouteCollection + */ + public function getRoutes() + { + return $this->app['routes'] ?? null; + } + + /** + * @return \Illuminate\Contracts\Session\Session|\Illuminate\Session\SessionManager + */ + public function getSession() + { + return $this->app['session'] ?? null; + } + + /** + * @return \Illuminate\View\Factory + */ + public function getView(): ?View + { + return $this->app['view'] ?? null; + } +} From 4191563c375ef2ded58427f6613c30379a72bfd2 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:07:17 -0500 Subject: [PATCH 02/19] reorder the public methods used by the module --- src/Codeception/Lib/Connector/Laravel.php | 184 ++++++++++++++-------- 1 file changed, 114 insertions(+), 70 deletions(-) diff --git a/src/Codeception/Lib/Connector/Laravel.php b/src/Codeception/Lib/Connector/Laravel.php index d593403..f8cfe82 100644 --- a/src/Codeception/Lib/Connector/Laravel.php +++ b/src/Codeception/Lib/Connector/Laravel.php @@ -4,6 +4,7 @@ namespace Codeception\Lib\Connector; +use Closure; use Codeception\Lib\Connector\Laravel\ExceptionHandlerDecorator as LaravelExceptionHandlerDecorator; use Codeception\Lib\Connector\Laravel6\ExceptionHandlerDecorator as Laravel6ExceptionHandlerDecorator; use Codeception\Module\Laravel\ServicesTrait; @@ -261,76 +262,6 @@ private function normalizeEvent($event): string return $segments[0]; } - //====================================================================== - // Public methods called by module - //====================================================================== - - /** - * Did an event trigger? - * - * @param $event - * @return bool - */ - public function eventTriggered($event): bool - { - $event = $this->normalizeEvent($event); - - foreach ($this->triggeredEvents as $triggeredEvent) { - if ($event == $triggeredEvent || is_subclass_of($event, $triggeredEvent)) { - return true; - } - } - - return false; - } - - /** - * Disable Laravel exception handling. - */ - public function disableExceptionHandling(): void - { - $this->exceptionHandlingDisabled = true; - $this->app[ExceptionHandler::class]->exceptionHandlingDisabled(true); - } - - /** - * Enable Laravel exception handling. - */ - public function enableExceptionHandling(): void - { - $this->exceptionHandlingDisabled = false; - $this->app[ExceptionHandler::class]->exceptionHandlingDisabled(false); - } - - /** - * Disable events. - * - * @throws Exception - */ - public function disableEvents(): void - { - $this->eventsDisabled = true; - $this->mockEventDispatcher(); - } - - /** - * Disable model events. - */ - public function disableModelEvents(): void - { - $this->modelEventsDisabled = true; - Model::unsetEventDispatcher(); - } - - /* - * Disable middleware. - */ - public function disableMiddleware(): void - { - $this->middlewareDisabled = true; - $this->app->instance('middleware.disable', true); - } - /** * Apply the registered application handlers. */ @@ -403,4 +334,117 @@ private function convertToTestFiles(array &$files): array return $filtered; } + + // Public methods called by module + + public function clearApplicationHandlers(): void + { + $this->applicationHandlers = []; + } + + public function disableEvents(): void + { + $this->eventsDisabled = true; + $this->mockEventDispatcher(); + } + + public function disableExceptionHandling(): void + { + $this->exceptionHandlingDisabled = true; + $this->getExceptionHandler()->exceptionHandlingDisabled(true); + } + + public function disableMiddleware($middleware = null): void + { + if (is_null($middleware)) { + $this->middlewareDisabled = true; + + $this->app->instance('middleware.disable', true); + return; + } + + foreach ((array) $middleware as $abstract) { + $this->app->instance($abstract, new class + { + public function handle($request, $next) + { + return $next($request); + } + }); + } + } + + public function disableModelEvents(): void + { + $this->modelEventsDisabled = true; + Model::unsetEventDispatcher(); + } + + public function enableExceptionHandling(): void + { + $this->exceptionHandlingDisabled = false; + $this->getExceptionHandler()->exceptionHandlingDisabled(false); + } + + public function enableMiddleware($middleware = null): void + { + if (is_null($middleware)) { + $this->middlewareDisabled = false; + + unset($this->app['middleware.disable']); + return; + } + + foreach ((array) $middleware as $abstract) { + unset($this->app[$abstract]); + } + } + + /** + * Did an event trigger? + * + * @param object|string $event + */ + public function eventTriggered($event): bool + { + $event = $this->normalizeEvent($event); + + foreach ($this->triggeredEvents as $triggeredEvent) { + if ($event == $triggeredEvent || is_subclass_of($event, $triggeredEvent)) { + return true; + } + } + + return false; + } + + public function haveApplicationHandler(callable $handler): void + { + $this->applicationHandlers[] = $handler; + } + + /** + * @param Closure|string|null $concrete + */ + public function haveBinding(string $abstract, $concrete, bool $shared = false): void + { + $this->bindings[$abstract] = [$concrete, $shared]; + } + + /** + * @param Closure|string $implementation + */ + public function haveContextualBinding(string $concrete, string $abstract, $implementation): void + { + if (! isset($this->contextualBindings[$concrete])) { + $this->contextualBindings[$concrete] = []; + } + + $this->contextualBindings[$concrete][$abstract] = $implementation; + } + + public function haveInstance(string $abstract, object $instance): void + { + $this->instances[$abstract] = $instance; + } } From 448d9854f8ef6c40e376170ef7e18edcbe6ac619 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:16:21 -0500 Subject: [PATCH 03/19] Split authentication methods --- src/Codeception/Module/Laravel.php | 81 +---------------- .../Laravel/InteractsWithAuthentication.php | 86 +++++++++++++++++++ 2 files changed, 89 insertions(+), 78 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithAuthentication.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 53ee103..ff9e4a6 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -7,18 +7,16 @@ use Closure; use Codeception\Configuration; use Codeception\Exception\ModuleConfigException; -use Codeception\Exception\ModuleException; use Codeception\Lib\Connector\Laravel as LaravelConnector; use Codeception\Lib\Framework; use Codeception\Lib\Interfaces\ActiveRecord; use Codeception\Lib\Interfaces\PartedModule; use Codeception\Lib\ModuleContainer; +use Codeception\Module\Laravel\InteractsWithAuthentication; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; use Exception; -use Illuminate\Contracts\Auth\Authenticatable; -use Illuminate\Contracts\Auth\Factory as AuthContract; use Illuminate\Contracts\Console\Kernel; use Illuminate\Contracts\Routing\UrlGenerator; use Illuminate\Contracts\Session\Session; @@ -132,6 +130,8 @@ */ class Laravel extends Framework implements ActiveRecord, PartedModule { + use InteractsWithAuthentication; + /** * @var Application */ @@ -791,81 +791,6 @@ public function seeFormErrorMessage(string $field, $errorMessage = null): void } } - /** - * Set the currently logged in user for the application. - * Takes either an object that implements the User interface or - * an array of credentials. - * - * ``` php - * amLoggedAs(['username' => 'jane@example.com', 'password' => 'password']); - * - * // provide User object - * $I->amLoggedAs( new User ); - * - * // can be verified with $I->seeAuthentication(); - * ``` - * @param Authenticatable|array $user - * @param string|null $guardName The guard name - */ - public function amLoggedAs($user, ?string $guardName = null): void - { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - $guard = $auth->guard($guardName); - - if ($user instanceof Authenticatable) { - $guard->login($user); - return; - } - - $this->assertTrue($guard->attempt($user), 'Failed to login with credentials ' . json_encode($user)); - } - - /** - * Logout user. - */ - public function logout(): void - { - $this->app['auth']->logout(); - } - - /** - * Checks that a user is authenticated. - * You can specify the guard that should be use as second parameter. - * - * @param string|null $guard - */ - public function seeAuthentication($guard = null): void - { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - $auth = $auth->guard($guard); - - $this->assertTrue($auth->check(), 'There is no authenticated user'); - } - - /** - * Check that user is not authenticated. - * You can specify the guard that should be use as second parameter. - * - * @param string|null $guard - */ - public function dontSeeAuthentication(?string $guard = null): void - { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - if (is_string($guard)) { - $auth = $auth->guard($guard); - } - - $this->assertNotTrue($auth->check(), 'There is an user authenticated'); - } - /** * Return an instance of a class from the Laravel service container. * (https://laravel.com/docs/master/container) diff --git a/src/Codeception/Module/Laravel/InteractsWithAuthentication.php b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php new file mode 100644 index 0000000..56ade6b --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php @@ -0,0 +1,86 @@ +amLoggedAs(['username' => 'jane@example.com', 'password' => 'password']); + * + * // provide User object + * $I->amLoggedAs( new User ); + * + * // can be verified with $I->seeAuthentication(); + * ``` + * @param Authenticatable|array $user + * @param string|null $guardName The guard name + */ + public function amLoggedAs($user, ?string $guardName = null): void + { + /** @var AuthContract $auth */ + $auth = $this->app['auth']; + + $guard = $auth->guard($guardName); + + if ($user instanceof Authenticatable) { + $guard->login($user); + return; + } + + $this->assertTrue($guard->attempt($user), 'Failed to login with credentials ' . json_encode($user)); + } + + /** + * Check that user is not authenticated. + * You can specify the guard that should be use as second parameter. + * + * @param string|null $guard + */ + public function dontSeeAuthentication(?string $guard = null): void + { + /** @var AuthContract $auth */ + $auth = $this->app['auth']; + + if (is_string($guard)) { + $auth = $auth->guard($guard); + } + + $this->assertNotTrue($auth->check(), 'There is an user authenticated'); + } + + /** + * Checks that a user is authenticated. + * You can specify the guard that should be use as second parameter. + * + * @param string|null $guard + */ + public function seeAuthentication($guard = null): void + { + /** @var AuthContract $auth */ + $auth = $this->app['auth']; + + $auth = $auth->guard($guard); + + $this->assertTrue($auth->check(), 'There is no authenticated user'); + } + + /** + * Logout user. + */ + public function logout(): void + { + $this->app['auth']->logout(); + } +} From a5020fa44d9a1324d4cb82238cc983302f241529 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:17:50 -0500 Subject: [PATCH 04/19] Split console methods --- src/Codeception/Module/Laravel.php | 32 +-------------- .../Module/Laravel/InteractsWithConsole.php | 39 +++++++++++++++++++ 2 files changed, 41 insertions(+), 30 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithConsole.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index ff9e4a6..532bfef 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -13,11 +13,11 @@ use Codeception\Lib\Interfaces\PartedModule; use Codeception\Lib\ModuleContainer; use Codeception\Module\Laravel\InteractsWithAuthentication; +use Codeception\Module\Laravel\InteractsWithConsole; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; use Exception; -use Illuminate\Contracts\Console\Kernel; use Illuminate\Contracts\Routing\UrlGenerator; use Illuminate\Contracts\Session\Session; use Illuminate\Contracts\View\Factory as ViewContract; @@ -35,7 +35,6 @@ use ReflectionClass; use ReflectionException; use RuntimeException; -use Symfony\Component\Console\Output\OutputInterface; use function is_array; /** @@ -131,6 +130,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule { use InteractsWithAuthentication; + use InteractsWithConsole; /** * @var Application @@ -426,34 +426,6 @@ public function dontSeeEventTriggered($expected): void } } - /** - * Call an Artisan command. - * - * ``` php - * callArtisan('command:name'); - * $I->callArtisan('command:name', ['parameter' => 'value']); - * ``` - * Use 3rd parameter to pass in custom `OutputInterface` - * - * @param string $command - * @param array $parameters - * @param OutputInterface|null $output - * @return string|void - */ - public function callArtisan(string $command, $parameters = [], OutputInterface $output = null) - { - $console = $this->app->make(Kernel::class); - if (!$output) { - $console->call($command, $parameters); - $output = trim($console->output()); - $this->debug($output); - return $output; - } - - $console->call($command, $parameters, $output); - } - /** * Opens web page using route name and parameters. * diff --git a/src/Codeception/Module/Laravel/InteractsWithConsole.php b/src/Codeception/Module/Laravel/InteractsWithConsole.php new file mode 100644 index 0000000..6174d27 --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithConsole.php @@ -0,0 +1,39 @@ +callArtisan('command:name'); + * $I->callArtisan('command:name', ['parameter' => 'value']); + * ``` + * Use 3rd parameter to pass in custom `OutputInterface` + * + * @param string $command + * @param array $parameters + * @param OutputInterface|null $output + * @return string|void + */ + public function callArtisan(string $command, $parameters = [], OutputInterface $output = null) + { + $console = $this->app->make(Kernel::class); + if (!$output) { + $console->call($command, $parameters); + $output = trim($console->output()); + $this->debug($output); + return $output; + } + + $console->call($command, $parameters, $output); + } +} From 53c511950588b3e0fa5d5a12cc3f950a0a530268 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:25:11 -0500 Subject: [PATCH 05/19] Split container methods --- src/Codeception/Module/Laravel.php | 152 +---------------- .../Module/Laravel/InteractsWithContainer.php | 157 ++++++++++++++++++ 2 files changed, 159 insertions(+), 150 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithContainer.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 532bfef..0039a38 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -4,7 +4,6 @@ namespace Codeception\Module; -use Closure; use Codeception\Configuration; use Codeception\Exception\ModuleConfigException; use Codeception\Lib\Connector\Laravel as LaravelConnector; @@ -14,6 +13,7 @@ use Codeception\Lib\ModuleContainer; use Codeception\Module\Laravel\InteractsWithAuthentication; use Codeception\Module\Laravel\InteractsWithConsole; +use Codeception\Module\Laravel\InteractsWithContainer; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -131,6 +131,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule { use InteractsWithAuthentication; use InteractsWithConsole; + use InteractsWithContainer; /** * @var Application @@ -292,24 +293,6 @@ protected function revertErrorHandler(): void set_error_handler([$handler, 'errorHandler']); } - /** - * Provides access the Laravel application object. - * - * @return \Illuminate\Contracts\Foundation\Application - */ - public function getApplication() - { - return $this->app; - } - - /** - * @param \Illuminate\Contracts\Foundation\Application $app - */ - public function setApplication($app): void - { - $this->app = $app; - } - /** * Enable Laravel exception handling. * @@ -763,32 +746,6 @@ public function seeFormErrorMessage(string $field, $errorMessage = null): void } } - /** - * Return an instance of a class from the Laravel service container. - * (https://laravel.com/docs/master/container) - * - * ``` php - * grabService('foo'); - * - * // Will return an instance of FooBar, also works for singletons. - * ``` - * - * @param string $class - * @return mixed - */ - public function grabService(string $class) - { - return $this->app[$class]; - } - - /** * Inserts record into the database. * If you pass the name of a database table as the first argument, this method returns an integer ID. @@ -1231,109 +1188,4 @@ private function buildQuery(string $table, $attributes = []) return $query; } - /** - * Add a binding to the Laravel service container. - * (https://laravel.com/docs/master/container) - * - * ``` php - * haveBinding('My\Interface', 'My\Implementation'); - * ``` - * - * @param string $abstract - * @param Closure|string|null $concrete - * @param bool $shared - */ - public function haveBinding(string $abstract, $concrete = null, bool $shared = false): void - { - $this->client->haveBinding($abstract, $concrete, $shared); - } - - /** - * Add a singleton binding to the Laravel service container. - * (https://laravel.com/docs/master/container) - * - * ``` php - * haveSingleton('App\MyInterface', 'App\MySingleton'); - * ``` - * - * @param string $abstract - * @param Closure|string|null $concrete - */ - public function haveSingleton(string $abstract, $concrete): void - { - $this->client->haveBinding($abstract, $concrete, true); - } - - /** - * Add a contextual binding to the Laravel service container. - * (https://laravel.com/docs/master/container) - * - * ``` php - * haveContextualBinding('My\Class', '$variable', 'value'); - * - * // This is similar to the following in your Laravel application - * $app->when('My\Class') - * ->needs('$variable') - * ->give('value'); - * ``` - * - * @param string $concrete - * @param string $abstract - * @param Closure|string $implementation - */ - public function haveContextualBinding(string $concrete, string $abstract, $implementation): void - { - $this->client->haveContextualBinding($concrete, $abstract, $implementation); - } - - /** - * Add an instance binding to the Laravel service container. - * (https://laravel.com/docs/master/container) - * - * ``` php - * haveInstance('App\MyClass', new App\MyClass()); - * ``` - * - * @param string $abstract - * @param mixed $instance - */ - public function haveInstance(string $abstract, $instance): void - { - $this->client->haveInstance($abstract, $instance); - } - - /** - * Register a handler than can be used to modify the Laravel application object after it is initialized. - * The Laravel application object will be passed as an argument to the handler. - * - * ``` php - * haveApplicationHandler(function($app) { - * $app->make('config')->set(['test_value' => '10']); - * }); - * ``` - * - * @param callable $handler - */ - public function haveApplicationHandler(callable $handler): void - { - $this->client->haveApplicationHandler($handler); - } - - /** - * Clear the registered application handlers. - * - * ``` php - * clearApplicationHandlers(); - * ``` - */ - public function clearApplicationHandlers(): void - { - $this->client->clearApplicationHandlers(); - } } diff --git a/src/Codeception/Module/Laravel/InteractsWithContainer.php b/src/Codeception/Module/Laravel/InteractsWithContainer.php new file mode 100644 index 0000000..d60bc18 --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithContainer.php @@ -0,0 +1,157 @@ +clearApplicationHandlers(); + * ``` + */ + public function clearApplicationHandlers(): void + { + $this->client->clearApplicationHandlers(); + } + + /** + * Provides access the Laravel application object. + * + * @return \Illuminate\Contracts\Foundation\Application + */ + public function getApplication() + { + return $this->app; + } + + /** + * Return an instance of a class from the Laravel service container. + * (https://laravel.com/docs/master/container) + * + * ``` php + * grabService('foo'); + * + * // Will return an instance of FooBar, also works for singletons. + * ``` + * + * @param string $class + * @return mixed + */ + public function grabService(string $class) + { + return $this->app[$class]; + } + + /** + * Register a handler than can be used to modify the Laravel application object after it is initialized. + * The Laravel application object will be passed as an argument to the handler. + * + * ``` php + * haveApplicationHandler(function($app) { + * $app->make('config')->set(['test_value' => '10']); + * }); + * ``` + * + * @param callable $handler + */ + public function haveApplicationHandler(callable $handler): void + { + $this->client->haveApplicationHandler($handler); + } + + /** + * Add a binding to the Laravel service container. + * (https://laravel.com/docs/master/container) + * + * ``` php + * haveBinding('My\Interface', 'My\Implementation'); + * ``` + * + * @param string $abstract + * @param Closure|string|null $concrete + * @param bool $shared + */ + public function haveBinding(string $abstract, $concrete = null, bool $shared = false): void + { + $this->client->haveBinding($abstract, $concrete, $shared); + } + + /** + * Add a contextual binding to the Laravel service container. + * (https://laravel.com/docs/master/container) + * + * ``` php + * haveContextualBinding('My\Class', '$variable', 'value'); + * + * // This is similar to the following in your Laravel application + * $app->when('My\Class') + * ->needs('$variable') + * ->give('value'); + * ``` + * + * @param string $concrete + * @param string $abstract + * @param Closure|string $implementation + */ + public function haveContextualBinding(string $concrete, string $abstract, $implementation): void + { + $this->client->haveContextualBinding($concrete, $abstract, $implementation); + } + + /** + * Add an instance binding to the Laravel service container. + * (https://laravel.com/docs/master/container) + * + * ``` php + * haveInstance('App\MyClass', new App\MyClass()); + * ``` + * + * @param string $abstract + * @param mixed $instance + */ + public function haveInstance(string $abstract, $instance): void + { + $this->client->haveInstance($abstract, $instance); + } + + /** + * Add a singleton binding to the Laravel service container. + * (https://laravel.com/docs/master/container) + * + * ``` php + * haveSingleton('App\MyInterface', 'App\MySingleton'); + * ``` + * + * @param string $abstract + * @param Closure|string|null $concrete + */ + public function haveSingleton(string $abstract, $concrete): void + { + $this->client->haveBinding($abstract, $concrete, true); + } + + /** + * @param \Illuminate\Contracts\Foundation\Application $app + */ + public function setApplication($app): void + { + $this->app = $app; + } +} From 4faa00ff20e3996ed99687fa0880fd26854f2888 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:34:03 -0500 Subject: [PATCH 06/19] Split eloquent methods --- src/Codeception/Module/Laravel.php | 402 +---------------- .../Module/Laravel/InteractsWithEloquent.php | 411 ++++++++++++++++++ 2 files changed, 413 insertions(+), 400 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithEloquent.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 0039a38..cdc5d01 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -14,6 +14,7 @@ use Codeception\Module\Laravel\InteractsWithAuthentication; use Codeception\Module\Laravel\InteractsWithConsole; use Codeception\Module\Laravel\InteractsWithContainer; +use Codeception\Module\Laravel\InteractsWithEloquent; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -24,17 +25,13 @@ use Illuminate\Database\Connection; use Illuminate\Database\DatabaseManager; use Illuminate\Database\Eloquent\Factory; -use Illuminate\Database\Eloquent\FactoryBuilder; -use Illuminate\Database\Eloquent\Model as EloquentModel; use Illuminate\Foundation\Application; use Illuminate\Http\Request; use Illuminate\Routing\Route; use Illuminate\Routing\Router; -use Illuminate\Support\Collection; use Illuminate\Support\ViewErrorBag; use ReflectionClass; use ReflectionException; -use RuntimeException; use function is_array; /** @@ -132,6 +129,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithAuthentication; use InteractsWithConsole; use InteractsWithContainer; + use InteractsWithEloquent; /** * @var Application @@ -746,373 +744,6 @@ public function seeFormErrorMessage(string $field, $errorMessage = null): void } } - /** - * Inserts record into the database. - * If you pass the name of a database table as the first argument, this method returns an integer ID. - * You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model. - * - * ```php - * haveRecord('users', ['name' => 'Davert']); // returns integer - * $user = $I->haveRecord('App\Models\User', ['name' => 'Davert']); // returns Eloquent model - * ``` - * - * @param string $table - * @param array $attributes - * @return EloquentModel|int - * @throws RuntimeException - * @part orm - */ - public function haveRecord($table, $attributes = []) - { - if (class_exists($table)) { - $model = new $table; - - if (! $model instanceof EloquentModel) { - throw new RuntimeException("Class $table is not an Eloquent model"); - } - - $model->fill($attributes)->save(); - - return $model; - } - - try { - /** @var DatabaseManager $dbManager */ - $dbManager = $this->app['db']; - return $dbManager->table($table)->insertGetId($attributes); - } catch (Exception $e) { - $this->fail("Could not insert record into table '$table':\n\n" . $e->getMessage()); - } - } - - /** - * Checks that record exists in database. - * You can pass the name of a database table or the class name of an Eloquent model as the first argument. - * - * ``` php - * seeRecord('users', ['name' => 'davert']); - * $I->seeRecord('App\Models\User', ['name' => 'davert']); - * ``` - * - * @param string $table - * @param array $attributes - * @part orm - */ - public function seeRecord($table, $attributes = []): void - { - if (class_exists($table)) { - if (! $foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { - $this->fail("Could not find $table with " . json_encode($attributes)); - } - } elseif (! $foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { - $this->fail("Could not find matching record in table '$table'"); - } - - $this->assertTrue($foundMatchingRecord); - } - - /** - * Checks that record does not exist in database. - * You can pass the name of a database table or the class name of an Eloquent model as the first argument. - * - * ```php - * dontSeeRecord('users', ['name' => 'davert']); - * $I->dontSeeRecord('App\Models\User', ['name' => 'davert']); - * ``` - * - * @param string $table - * @param array $attributes - * @part orm - */ - public function dontSeeRecord($table, $attributes = []): void - { - if (class_exists($table)) { - if ($foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { - $this->fail("Unexpectedly found matching $table with " . json_encode($attributes)); - } - } elseif ($foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { - $this->fail("Unexpectedly found matching record in table '$table'"); - } - - $this->assertFalse($foundMatchingRecord); - } - - /** - * Retrieves record from database - * If you pass the name of a database table as the first argument, this method returns an array. - * You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model. - * - * ``` php - * grabRecord('users', ['name' => 'davert']); // returns array - * $record = $I->grabRecord('App\Models\User', ['name' => 'davert']); // returns Eloquent model - * ``` - * - * @param string $table - * @param array $attributes - * @return array|EloquentModel - * @part orm - */ - public function grabRecord($table, $attributes = []) - { - if (class_exists($table)) { - if (! $model = $this->findModel($table, $attributes)) { - $this->fail("Could not find $table with " . json_encode($attributes)); - } - - return $model; - } - - if (! $record = $this->findRecord($table, $attributes)) { - $this->fail("Could not find matching record in table '$table'"); - } - - return $record; - } - - /** - * Checks that number of given records were found in database. - * You can pass the name of a database table or the class name of an Eloquent model as the first argument. - * - * ``` php - * seeNumRecords(1, 'users', ['name' => 'davert']); - * $I->seeNumRecords(1, 'App\Models\User', ['name' => 'davert']); - * ``` - * - * @param int $expectedNum - * @param string $table - * @param array $attributes - * @part orm - */ - public function seeNumRecords(int $expectedNum, string $table, array $attributes = []): void - { - if (class_exists($table)) { - $currentNum = $this->countModels($table, $attributes); - $this->assertEquals( - $expectedNum, - $currentNum, - "The number of found {$table} ({$currentNum}) does not match expected number {$expectedNum} with " . json_encode($attributes) - ); - } else { - $currentNum = $this->countRecords($table, $attributes); - $this->assertEquals( - $expectedNum, - $currentNum, - "The number of found records in table {$table} ({$currentNum}) does not match expected number $expectedNum with " . json_encode($attributes) - ); - } - } - - /** - * Retrieves number of records from database - * You can pass the name of a database table or the class name of an Eloquent model as the first argument. - * - * ``` php - * grabNumRecords('users', ['name' => 'davert']); - * $I->grabNumRecords('App\Models\User', ['name' => 'davert']); - * ``` - * - * @param string $table - * @param array $attributes - * @return int - * @part orm - */ - public function grabNumRecords(string $table, array $attributes = []): int - { - return class_exists($table) ? $this->countModels($table, $attributes) : $this->countRecords($table, $attributes); - } - - /** - * @param string $modelClass - * @param array $attributes - * - * @return EloquentModel - */ - protected function findModel(string $modelClass, array $attributes = []) - { - $query = $this->buildQuery($modelClass, $attributes); - - return $query->first(); - } - - protected function findRecord(string $table, array $attributes = []): array - { - $query = $this->buildQuery($table, $attributes); - return (array) $query->first(); - } - - protected function countModels(string $modelClass, $attributes = []): int - { - $query = $this->buildQuery($modelClass, $attributes); - return $query->count(); - } - - protected function countRecords(string $table, array $attributes = []): int - { - $query = $this->buildQuery($table, $attributes); - return $query->count(); - } - - /** - * @param string $modelClass - * - * @return EloquentModel - * @throws RuntimeException - */ - protected function getQueryBuilderFromModel(string $modelClass) - { - $model = new $modelClass; - - if (!$model instanceof EloquentModel) { - throw new RuntimeException("Class $modelClass is not an Eloquent model"); - } - - return $model->newQuery(); - } - - /** - * @param string $table - * - * @return EloquentModel - */ - protected function getQueryBuilderFromTable(string $table) - { - return $this->app['db']->table($table); - } - - /** - * Use Laravel model factory to create a model. - * - * ``` php - * have('App\Models\User'); - * $I->have('App\Models\User', ['name' => 'John Doe']); - * $I->have('App\Models\User', [], 'admin'); - * ``` - * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param array $attributes - * @param string $name - * @return mixed - * @part orm - */ - public function have(string $model, array $attributes = [], string $name = 'default') - { - try { - $model = $this->modelFactory($model, $name)->create($attributes); - - // In Laravel 6 the model factory returns a collection instead of a single object - if ($model instanceof Collection) { - $model = $model[0]; - } - - return $model; - } catch (Exception $e) { - $this->fail('Could not create model: \n\n' . get_class($e) . '\n\n' . $e->getMessage()); - } - } - - /** - * Use Laravel model factory to create multiple models. - * - * ``` php - * haveMultiple('App\Models\User', 10); - * $I->haveMultiple('App\Models\User', 10, ['name' => 'John Doe']); - * $I->haveMultiple('App\Models\User', 10, [], 'admin'); - * ``` - * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param int $times - * @param array $attributes - * @param string $name - * @return mixed - * @part orm - */ - public function haveMultiple(string $model, int $times, array $attributes = [], string $name = 'default') - { - try { - return $this->modelFactory($model, $name, $times)->create($attributes); - } catch (Exception $e) { - $this->fail("Could not create model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); - } - } - - /** - * Use Laravel model factory to make a model instance. - * - * ``` php - * make('App\Models\User'); - * $I->make('App\Models\User', ['name' => 'John Doe']); - * $I->make('App\Models\User', [], 'admin'); - * ``` - * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param array $attributes - * @param string $name - * @return mixed - * @part orm - */ - public function make(string $model, array $attributes = [], string $name = 'default') - { - try { - return $this->modelFactory($model, $name)->make($attributes); - } catch (Exception $e) { - $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); - } - } - - /** - * Use Laravel model factory to make multiple model instances. - * - * ``` php - * makeMultiple('App\Models\User', 10); - * $I->makeMultiple('App\Models\User', 10, ['name' => 'John Doe']); - * $I->makeMultiple('App\Models\User', 10, [], 'admin'); - * ``` - * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param int $times - * @param array $attributes - * @param string $name - * @return mixed - * @part orm - */ - public function makeMultiple(string $model, int $times, array $attributes = [], string $name = 'default') - { - try { - return $this->modelFactory($model, $name, $times)->make($attributes); - } catch (Exception $e) { - $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); - } - } - - /** - * @param string $model - * @param string $name - * @param int $times - * @return FactoryBuilder|\Illuminate\Database\Eloquent\Factories\Factory - */ - protected function modelFactory(string $model, string $name, $times = 1) - { - if (version_compare(Application::VERSION, '7.0.0', '<')) { - return factory($model, $name, $times); - } - - return $model::factory()->count($times); - } - /** * Returns a list of recognized domain names. * This elements of this list are regular expressions. @@ -1159,33 +790,4 @@ private function getDomainRegex(Route $route) return $compiledRoute->getHostRegex(); } - - /** - * Build Eloquent query with attributes - * - * @param string $table - * @param array $attributes - * @return EloquentModel - * @part orm - */ - private function buildQuery(string $table, $attributes = []) - { - if (class_exists($table)) { - $query = $this->getQueryBuilderFromModel($table); - } else { - $query = $this->getQueryBuilderFromTable($table); - } - - foreach ($attributes as $key => $value) { - if (is_array($value)) { - call_user_func_array(array($query, 'where'), $value); - } elseif (is_null($value)) { - $query->whereNull($key); - } else { - $query->where($key, $value); - } - } - return $query; - } - } diff --git a/src/Codeception/Module/Laravel/InteractsWithEloquent.php b/src/Codeception/Module/Laravel/InteractsWithEloquent.php new file mode 100644 index 0000000..555c2fd --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithEloquent.php @@ -0,0 +1,411 @@ +dontSeeRecord('users', ['name' => 'davert']); + * $I->dontSeeRecord('App\Models\User', ['name' => 'davert']); + * ``` + * + * @param string $table + * @param array $attributes + * @part orm + */ + public function dontSeeRecord($table, $attributes = []): void + { + if (class_exists($table)) { + if ($foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { + $this->fail("Unexpectedly found matching $table with " . json_encode($attributes)); + } + } elseif ($foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { + $this->fail("Unexpectedly found matching record in table '$table'"); + } + + $this->assertFalse($foundMatchingRecord); + } + + /** + * Retrieves number of records from database + * You can pass the name of a database table or the class name of an Eloquent model as the first argument. + * + * ``` php + * grabNumRecords('users', ['name' => 'davert']); + * $I->grabNumRecords('App\Models\User', ['name' => 'davert']); + * ``` + * + * @param string $table + * @param array $attributes + * @return int + * @part orm + */ + public function grabNumRecords(string $table, array $attributes = []): int + { + return class_exists($table) ? $this->countModels($table, $attributes) : $this->countRecords($table, $attributes); + } + + /** + * Retrieves record from database + * If you pass the name of a database table as the first argument, this method returns an array. + * You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model. + * + * ``` php + * grabRecord('users', ['name' => 'davert']); // returns array + * $record = $I->grabRecord('App\Models\User', ['name' => 'davert']); // returns Eloquent model + * ``` + * + * @param string $table + * @param array $attributes + * @return array|EloquentModel + * @part orm + */ + public function grabRecord($table, $attributes = []) + { + if (class_exists($table)) { + if (! $model = $this->findModel($table, $attributes)) { + $this->fail("Could not find $table with " . json_encode($attributes)); + } + + return $model; + } + + if (! $record = $this->findRecord($table, $attributes)) { + $this->fail("Could not find matching record in table '$table'"); + } + + return $record; + } + + /** + * Use Laravel model factory to create a model. + * + * ``` php + * have('App\Models\User'); + * $I->have('App\Models\User', ['name' => 'John Doe']); + * $I->have('App\Models\User', [], 'admin'); + * ``` + * + * @see https://laravel.com/docs/6.x/database-testing#using-factories + * @param string $model + * @param array $attributes + * @param string $name + * @return mixed + * @part orm + */ + public function have(string $model, array $attributes = [], string $name = 'default') + { + try { + $model = $this->modelFactory($model, $name)->create($attributes); + + // In Laravel 6 the model factory returns a collection instead of a single object + if ($model instanceof Collection) { + $model = $model[0]; + } + + return $model; + } catch (Exception $e) { + $this->fail('Could not create model: \n\n' . get_class($e) . '\n\n' . $e->getMessage()); + } + } + + /** + * Use Laravel model factory to create multiple models. + * + * ``` php + * haveMultiple('App\Models\User', 10); + * $I->haveMultiple('App\Models\User', 10, ['name' => 'John Doe']); + * $I->haveMultiple('App\Models\User', 10, [], 'admin'); + * ``` + * + * @see https://laravel.com/docs/6.x/database-testing#using-factories + * @param string $model + * @param int $times + * @param array $attributes + * @param string $name + * @return mixed + * @part orm + */ + public function haveMultiple(string $model, int $times, array $attributes = [], string $name = 'default') + { + try { + return $this->modelFactory($model, $name, $times)->create($attributes); + } catch (Exception $e) { + $this->fail("Could not create model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } + } + + /** + * Inserts record into the database. + * If you pass the name of a database table as the first argument, this method returns an integer ID. + * You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model. + * + * ```php + * haveRecord('users', ['name' => 'Davert']); // returns integer + * $user = $I->haveRecord('App\Models\User', ['name' => 'Davert']); // returns Eloquent model + * ``` + * + * @param string $table + * @param array $attributes + * @return EloquentModel|int + * @throws RuntimeException + * @part orm + */ + public function haveRecord($table, $attributes = []) + { + if (class_exists($table)) { + $model = new $table; + + if (! $model instanceof EloquentModel) { + throw new RuntimeException("Class $table is not an Eloquent model"); + } + + $model->fill($attributes)->save(); + + return $model; + } + + try { + /** @var DatabaseManager $dbManager */ + $dbManager = $this->app['db']; + return $dbManager->table($table)->insertGetId($attributes); + } catch (Exception $e) { + $this->fail("Could not insert record into table '$table':\n\n" . $e->getMessage()); + } + } + + /** + * Use Laravel model factory to make a model instance. + * + * ``` php + * make('App\Models\User'); + * $I->make('App\Models\User', ['name' => 'John Doe']); + * $I->make('App\Models\User', [], 'admin'); + * ``` + * + * @see https://laravel.com/docs/6.x/database-testing#using-factories + * @param string $model + * @param array $attributes + * @param string $name + * @return mixed + * @part orm + */ + public function make(string $model, array $attributes = [], string $name = 'default') + { + try { + return $this->modelFactory($model, $name)->make($attributes); + } catch (Exception $e) { + $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } + } + + /** + * Use Laravel model factory to make multiple model instances. + * + * ``` php + * makeMultiple('App\Models\User', 10); + * $I->makeMultiple('App\Models\User', 10, ['name' => 'John Doe']); + * $I->makeMultiple('App\Models\User', 10, [], 'admin'); + * ``` + * + * @see https://laravel.com/docs/6.x/database-testing#using-factories + * @param string $model + * @param int $times + * @param array $attributes + * @param string $name + * @return mixed + * @part orm + */ + public function makeMultiple(string $model, int $times, array $attributes = [], string $name = 'default') + { + try { + return $this->modelFactory($model, $name, $times)->make($attributes); + } catch (Exception $e) { + $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } + } + + /** + * Checks that number of given records were found in database. + * You can pass the name of a database table or the class name of an Eloquent model as the first argument. + * + * ``` php + * seeNumRecords(1, 'users', ['name' => 'davert']); + * $I->seeNumRecords(1, 'App\Models\User', ['name' => 'davert']); + * ``` + * + * @param int $expectedNum + * @param string $table + * @param array $attributes + * @part orm + */ + public function seeNumRecords(int $expectedNum, string $table, array $attributes = []): void + { + if (class_exists($table)) { + $currentNum = $this->countModels($table, $attributes); + $this->assertEquals( + $expectedNum, + $currentNum, + "The number of found {$table} ({$currentNum}) does not match expected number {$expectedNum} with " . json_encode($attributes) + ); + } else { + $currentNum = $this->countRecords($table, $attributes); + $this->assertEquals( + $expectedNum, + $currentNum, + "The number of found records in table {$table} ({$currentNum}) does not match expected number $expectedNum with " . json_encode($attributes) + ); + } + } + + /** + * Checks that record exists in database. + * You can pass the name of a database table or the class name of an Eloquent model as the first argument. + * + * ``` php + * seeRecord('users', ['name' => 'davert']); + * $I->seeRecord('App\Models\User', ['name' => 'davert']); + * ``` + * + * @param string $table + * @param array $attributes + * @part orm + */ + public function seeRecord($table, $attributes = []): void + { + if (class_exists($table)) { + if (! $foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { + $this->fail("Could not find $table with " . json_encode($attributes)); + } + } elseif (! $foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { + $this->fail("Could not find matching record in table '$table'"); + } + + $this->assertTrue($foundMatchingRecord); + } + + protected function countModels(string $modelClass, array $attributes = []): int + { + $query = $this->buildQuery($modelClass, $attributes); + return $query->count(); + } + + protected function countRecords(string $table, array $attributes = []): int + { + $query = $this->buildQuery($table, $attributes); + return $query->count(); + } + + /** + * @param string $modelClass + * @param array $attributes + * + * @return EloquentModel + */ + protected function findModel(string $modelClass, array $attributes = []) + { + $query = $this->buildQuery($modelClass, $attributes); + + return $query->first(); + } + + protected function findRecord(string $table, array $attributes = []): array + { + $query = $this->buildQuery($table, $attributes); + return (array) $query->first(); + } + + /** + * @param string $model + * @param string $name + * @param int $times + * @return FactoryBuilder|\Illuminate\Database\Eloquent\Factories\Factory + */ + protected function modelFactory(string $model, string $name, $times = 1) + { + if (version_compare(Application::VERSION, '7.0.0', '<')) { + return factory($model, $name, $times); + } + + return $model::factory()->count($times); + } + + /** + * Build Eloquent query with attributes + * + * @param string $table + * @param array $attributes + * @return EloquentModel + * @part orm + */ + private function buildQuery(string $table, $attributes = []) + { + if (class_exists($table)) { + $query = $this->getQueryBuilderFromModel($table); + } else { + $query = $this->getQueryBuilderFromTable($table); + } + + foreach ($attributes as $key => $value) { + if (is_array($value)) { + call_user_func_array(array($query, 'where'), $value); + } elseif (is_null($value)) { + $query->whereNull($key); + } else { + $query->where($key, $value); + } + } + return $query; + } + + /** + * @param string $modelClass + * + * @return EloquentModel + * @throws RuntimeException + */ + protected function getQueryBuilderFromModel(string $modelClass) + { + $model = new $modelClass; + + if (!$model instanceof EloquentModel) { + throw new RuntimeException("Class $modelClass is not an Eloquent model"); + } + + return $model->newQuery(); + } + + /** + * @param string $table + * + * @return EloquentModel + */ + protected function getQueryBuilderFromTable(string $table) + { + return $this->app['db']->table($table); + } +} From 8d15d55aeabc144b4ff2ad05e7b8636547fea5fd Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:36:49 -0500 Subject: [PATCH 07/19] Split events methods --- src/Codeception/Module/Laravel.php | 79 +---------------- .../Module/Laravel/InteractsWithEvents.php | 85 +++++++++++++++++++ 2 files changed, 87 insertions(+), 77 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithEvents.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index cdc5d01..81aa335 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -15,6 +15,7 @@ use Codeception\Module\Laravel\InteractsWithConsole; use Codeception\Module\Laravel\InteractsWithContainer; use Codeception\Module\Laravel\InteractsWithEloquent; +use Codeception\Module\Laravel\InteractsWithEvents; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -130,6 +131,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithConsole; use InteractsWithContainer; use InteractsWithEloquent; + use InteractsWithEvents; /** * @var Application @@ -330,83 +332,6 @@ public function disableMiddleware() $this->client->disableMiddleware(); } - /** - * Disable events for the next requests. - * This method does not disable model events. - * To disable model events you have to use the disableModelEvents() method. - * - * ```php - * disableEvents(); - * ``` - */ - public function disableEvents(): void - { - $this->client->disableEvents(); - } - - /** - * Disable model events for the next requests. - * - * ```php - * disableModelEvents(); - * ``` - */ - public function disableModelEvents(): void - { - $this->client->disableModelEvents(); - } - - /** - * Make sure events fired during the test. - * - * ```php - * seeEventTriggered('App\MyEvent'); - * $I->seeEventTriggered(new App\Events\MyEvent()); - * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); - * ``` - * @param string|object|string[] $expected - */ - public function seeEventTriggered($expected): void - { - $expected = is_array($expected) ? $expected : [$expected]; - - foreach ($expected as $expectedEvent) { - if (! $this->client->eventTriggered($expectedEvent)) { - $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; - - $this->fail("The '$expectedEvent' event did not trigger"); - } - } - } - - /** - * Make sure events did not fire during the test. - * - * ``` php - * dontSeeEventTriggered('App\MyEvent'); - * $I->dontSeeEventTriggered(new App\Events\MyEvent()); - * $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); - * ``` - * @param string|object|string[] $expected - */ - public function dontSeeEventTriggered($expected): void - { - $expected = is_array($expected) ? $expected : [$expected]; - - foreach ($expected as $expectedEvent) { - $triggered = $this->client->eventTriggered($expectedEvent); - if ($triggered) { - $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; - - $this->fail("The '$expectedEvent' event triggered"); - } - } - } - /** * Opens web page using route name and parameters. * diff --git a/src/Codeception/Module/Laravel/InteractsWithEvents.php b/src/Codeception/Module/Laravel/InteractsWithEvents.php new file mode 100644 index 0000000..2d982b4 --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithEvents.php @@ -0,0 +1,85 @@ +disableEvents(); + * ``` + */ + public function disableEvents(): void + { + $this->client->disableEvents(); + } + + /** + * Disable model events for the next requests. + * + * ```php + * disableModelEvents(); + * ``` + */ + public function disableModelEvents(): void + { + $this->client->disableModelEvents(); + } + + /** + * Make sure events did not fire during the test. + * + * ``` php + * dontSeeEventTriggered('App\MyEvent'); + * $I->dontSeeEventTriggered(new App\Events\MyEvent()); + * $I->dontSeeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); + * ``` + * @param string|object|string[] $expected + */ + public function dontSeeEventTriggered($expected): void + { + $expected = is_array($expected) ? $expected : [$expected]; + + foreach ($expected as $expectedEvent) { + $triggered = $this->client->eventTriggered($expectedEvent); + if ($triggered) { + $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; + + $this->fail("The '$expectedEvent' event triggered"); + } + } + } + + /** + * Make sure events fired during the test. + * + * ```php + * seeEventTriggered('App\MyEvent'); + * $I->seeEventTriggered(new App\Events\MyEvent()); + * $I->seeEventTriggered(['App\MyEvent', 'App\MyOtherEvent']); + * ``` + * @param string|object|string[] $expected + */ + public function seeEventTriggered($expected): void + { + $expected = is_array($expected) ? $expected : [$expected]; + + foreach ($expected as $expectedEvent) { + if (! $this->client->eventTriggered($expectedEvent)) { + $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; + + $this->fail("The '$expectedEvent' event did not trigger"); + } + } + } +} From 837e1091c6b7e17b3ac7cc2d640fe9c15ca5a3a4 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 00:40:56 -0500 Subject: [PATCH 08/19] Split exception handling methods --- src/Codeception/Module/Laravel.php | 28 ++------------- .../InteractsWithExceptionHandling.php | 34 +++++++++++++++++++ 2 files changed, 36 insertions(+), 26 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 81aa335..3b9d440 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -16,6 +16,7 @@ use Codeception\Module\Laravel\InteractsWithContainer; use Codeception\Module\Laravel\InteractsWithEloquent; use Codeception\Module\Laravel\InteractsWithEvents; +use Codeception\Module\Laravel\InteractsWithExceptionHandling; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -132,6 +133,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithContainer; use InteractsWithEloquent; use InteractsWithEvents; + use InteractsWithExceptionHandling; /** * @var Application @@ -293,32 +295,6 @@ protected function revertErrorHandler(): void set_error_handler([$handler, 'errorHandler']); } - /** - * Enable Laravel exception handling. - * - * ```php - * enableExceptionHandling(); - * ``` - */ - public function enableExceptionHandling() - { - $this->client->enableExceptionHandling(); - } - - /** - * Disable Laravel exception handling. - * - * ```php - * disableExceptionHandling(); - * ``` - */ - public function disableExceptionHandling() - { - $this->client->disableExceptionHandling(); - } - /** * Disable middleware for the next requests. * diff --git a/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php b/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php new file mode 100644 index 0000000..984b626 --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php @@ -0,0 +1,34 @@ +disableExceptionHandling(); + * ``` + */ + public function disableExceptionHandling() + { + $this->client->disableExceptionHandling(); + } + + /** + * Enable Laravel exception handling. + * + * ```php + * enableExceptionHandling(); + * ``` + */ + public function enableExceptionHandling() + { + $this->client->enableExceptionHandling(); + } +} From 7f508b03d674421f8e2091d7534a5bc4f984a0c7 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:06:37 -0500 Subject: [PATCH 09/19] Split routing methods --- src/Codeception/Module/Laravel.php | 176 +---------------- .../Module/Laravel/InteractsWithRouting.php | 185 ++++++++++++++++++ 2 files changed, 187 insertions(+), 174 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithRouting.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 3b9d440..f93b6d8 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -17,22 +17,19 @@ use Codeception\Module\Laravel\InteractsWithEloquent; use Codeception\Module\Laravel\InteractsWithEvents; use Codeception\Module\Laravel\InteractsWithExceptionHandling; +use Codeception\Module\Laravel\InteractsWithRouting; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; use Exception; -use Illuminate\Contracts\Routing\UrlGenerator; use Illuminate\Contracts\Session\Session; use Illuminate\Contracts\View\Factory as ViewContract; use Illuminate\Database\Connection; use Illuminate\Database\DatabaseManager; use Illuminate\Database\Eloquent\Factory; use Illuminate\Foundation\Application; -use Illuminate\Http\Request; use Illuminate\Routing\Route; -use Illuminate\Routing\Router; use Illuminate\Support\ViewErrorBag; -use ReflectionClass; use ReflectionException; use function is_array; @@ -134,6 +131,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithEloquent; use InteractsWithEvents; use InteractsWithExceptionHandling; + use InteractsWithRouting; /** * @var Application @@ -308,176 +306,6 @@ public function disableMiddleware() $this->client->disableMiddleware(); } - /** - * Opens web page using route name and parameters. - * - * ```php - * amOnRoute('posts.create'); - * ``` - * - * @param string $routeName - * @param mixed $params - */ - public function amOnRoute(string $routeName, $params = []): void - { - $route = $this->getRouteByName($routeName); - - $absolute = !is_null($route->domain()); - /** @var UrlGenerator $urlGenerator */ - $urlGenerator = $this->app['url']; - $url = $urlGenerator->route($routeName, $params, $absolute); - $this->amOnPage($url); - } - - /** - * Checks that current url matches route - * - * ``` php - * seeCurrentRouteIs('posts.index'); - * ``` - * @param string $routeName - */ - public function seeCurrentRouteIs(string $routeName): void - { - $this->getRouteByName($routeName); // Fails if route does not exists - - /** @var Request $request */ - $request = $this->app->request; - $currentRoute = $request->route(); - $currentRouteName = $currentRoute ? $currentRoute->getName() : ''; - - if ($currentRouteName != $routeName) { - $message = empty($currentRouteName) - ? "Current route has no name" - : "Current route is \"$currentRouteName\""; - $this->fail($message); - } - } - - /** - * Opens web page by action name - * - * ``` php - * amOnAction('PostsController@index'); - * - * // Laravel 8+: - * $I->amOnAction(PostsController::class . '@index'); - * ``` - * - * @param string $action - * @param mixed $parameters - */ - public function amOnAction(string $action, $parameters = []): void - { - $route = $this->getRouteByAction($action); - $absolute = !is_null($route->domain()); - /** @var UrlGenerator $urlGenerator */ - $urlGenerator = $this->app['url']; - $url = $urlGenerator->action($action, $parameters, $absolute); - - $this->amOnPage($url); - } - - /** - * Checks that current url matches action - * - * ``` php - * seeCurrentActionIs('PostsController@index'); - * - * // Laravel 8+: - * $I->seeCurrentActionIs(PostsController::class . '@index'); - * ``` - * - * @param string $action - */ - public function seeCurrentActionIs(string $action): void - { - $this->getRouteByAction($action); // Fails if route does not exists - /** @var Request $request */ - $request = $this->app->request; - $currentRoute = $request->route(); - $currentAction = $currentRoute ? $currentRoute->getActionName() : ''; - $currentAction = ltrim( - str_replace( (string)$this->getRootControllerNamespace(), '', $currentAction), - '\\' - ); - - if ($currentAction != $action) { - $this->fail("Current action is \"$currentAction\""); - } - } - - /** - * @param string $routeName - * @return mixed - */ - protected function getRouteByName(string $routeName) - { - /** @var Router $router */ - $router = $this->app['router']; - $routes = $router->getRoutes(); - if (!$route = $routes->getByName($routeName)) { - $this->fail("Route with name '$routeName' does not exist"); - } - - return $route; - } - - /** - * @param string $action - * @return Route - */ - protected function getRouteByAction(string $action): Route - { - $namespacedAction = $this->actionWithNamespace($action); - - if (!$route = $this->app['routes']->getByAction($namespacedAction)) { - $this->fail("Action '$action' does not exist"); - } - - return $route; - } - - /** - * Normalize an action to full namespaced action. - * - * @param string $action - * @return string - */ - protected function actionWithNamespace(string $action): string - { - $rootNamespace = $this->getRootControllerNamespace(); - - if ($rootNamespace && !(strpos($action, '\\') === 0)) { - return $rootNamespace . '\\' . $action; - } - - return trim($action, '\\'); - } - - /** - * Get the root controller namespace for the application. - * - * @return string|null - * @throws ReflectionException - */ - protected function getRootControllerNamespace(): ?string - { - $urlGenerator = $this->app['url']; - $reflection = new ReflectionClass($urlGenerator); - - $property = $reflection->getProperty('rootNamespace'); - $property->setAccessible(true); - - return $property->getValue($urlGenerator); - } - /** * Assert that a session variable exists. * diff --git a/src/Codeception/Module/Laravel/InteractsWithRouting.php b/src/Codeception/Module/Laravel/InteractsWithRouting.php new file mode 100644 index 0000000..06d05cc --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithRouting.php @@ -0,0 +1,185 @@ +amOnAction('PostsController@index'); + * + * // Laravel 8+: + * $I->amOnAction(PostsController::class . '@index'); + * ``` + * + * @param string $action + * @param mixed $parameters + */ + public function amOnAction(string $action, $parameters = []): void + { + $route = $this->getRouteByAction($action); + $absolute = !is_null($route->domain()); + /** @var UrlGenerator $urlGenerator */ + $urlGenerator = $this->app['url']; + $url = $urlGenerator->action($action, $parameters, $absolute); + + $this->amOnPage($url); + } + + /** + * Opens web page using route name and parameters. + * + * ```php + * amOnRoute('posts.create'); + * ``` + * + * @param string $routeName + * @param mixed $params + */ + public function amOnRoute(string $routeName, $params = []): void + { + $route = $this->getRouteByName($routeName); + + $absolute = !is_null($route->domain()); + /** @var UrlGenerator $urlGenerator */ + $urlGenerator = $this->app['url']; + $url = $urlGenerator->route($routeName, $params, $absolute); + $this->amOnPage($url); + } + + /** + * Checks that current url matches action + * + * ``` php + * seeCurrentActionIs('PostsController@index'); + * + * // Laravel 8+: + * $I->seeCurrentActionIs(PostsController::class . '@index'); + * ``` + * + * @param string $action + */ + public function seeCurrentActionIs(string $action): void + { + $this->getRouteByAction($action); // Fails if route does not exists + /** @var Request $request */ + $request = $this->app->request; + $currentRoute = $request->route(); + $currentAction = $currentRoute ? $currentRoute->getActionName() : ''; + $currentAction = ltrim( + str_replace( (string)$this->getRootControllerNamespace(), '', $currentAction), + '\\' + ); + + if ($currentAction != $action) { + $this->fail("Current action is \"$currentAction\""); + } + } + + /** + * Checks that current url matches route + * + * ``` php + * seeCurrentRouteIs('posts.index'); + * ``` + * @param string $routeName + */ + public function seeCurrentRouteIs(string $routeName): void + { + $this->getRouteByName($routeName); // Fails if route does not exists + + /** @var Request $request */ + $request = $this->app->request; + $currentRoute = $request->route(); + $currentRouteName = $currentRoute ? $currentRoute->getName() : ''; + + if ($currentRouteName != $routeName) { + $message = empty($currentRouteName) + ? "Current route has no name" + : "Current route is \"$currentRouteName\""; + $this->fail($message); + } + } + + /** + * Get the root controller namespace for the application. + * + * @return string|null + * @throws ReflectionException + */ + protected function getRootControllerNamespace(): ?string + { + $urlGenerator = $this->app['url']; + $reflection = new ReflectionClass($urlGenerator); + + $property = $reflection->getProperty('rootNamespace'); + $property->setAccessible(true); + + return $property->getValue($urlGenerator); + } + + /** + * @param string $action + * @return Route + */ + protected function getRouteByAction(string $action): Route + { + $namespacedAction = $this->actionWithNamespace($action); + + if (!$route = $this->app['routes']->getByAction($namespacedAction)) { + $this->fail("Action '$action' does not exist"); + } + + return $route; + } + + /** + * @param string $routeName + * @return mixed + */ + protected function getRouteByName(string $routeName) + { + /** @var Router $router */ + $router = $this->app['router']; + $routes = $router->getRoutes(); + if (!$route = $routes->getByName($routeName)) { + $this->fail("Route with name '$routeName' does not exist"); + } + + return $route; + } + + /** + * Normalize an action to full namespaced action. + * + * @param string $action + * @return string + */ + protected function actionWithNamespace(string $action): string + { + $rootNamespace = $this->getRootControllerNamespace(); + + if ($rootNamespace && !(strpos($action, '\\') === 0)) { + return $rootNamespace . '\\' . $action; + } + + return trim($action, '\\'); + } +} From 57416079c0585dedc70f2102b2f55bba607e37c9 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:09:45 -0500 Subject: [PATCH 10/19] Split session methods --- src/Codeception/Module/Laravel.php | 55 +--------------- .../Module/Laravel/InteractsWithSession.php | 63 +++++++++++++++++++ 2 files changed, 65 insertions(+), 53 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithSession.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index f93b6d8..7079474 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -18,6 +18,7 @@ use Codeception\Module\Laravel\InteractsWithEvents; use Codeception\Module\Laravel\InteractsWithExceptionHandling; use Codeception\Module\Laravel\InteractsWithRouting; +use Codeception\Module\Laravel\InteractsWithSession; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -132,6 +133,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithEvents; use InteractsWithExceptionHandling; use InteractsWithRouting; + use InteractsWithSession; /** * @var Application @@ -306,59 +308,6 @@ public function disableMiddleware() $this->client->disableMiddleware(); } - /** - * Assert that a session variable exists. - * - * ``` php - * seeInSession('key'); - * $I->seeInSession('key', 'value'); - * ``` - * - * @param string|array $key - * @param mixed|null $value - */ - public function seeInSession($key, $value = null): void - { - if (is_array($key)) { - $this->seeSessionHasValues($key); - return; - } - - /** @var Session $session */ - $session = $this->app['session']; - - if (!$session->has($key)) { - $this->fail("No session variable with key '$key'"); - } - - if (! is_null($value)) { - $this->assertEquals($value, $session->get($key)); - } - } - - /** - * Assert that the session has a given list of values. - * - * ``` php - * seeSessionHasValues(['key1', 'key2']); - * $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']); - * ``` - * - * @param array $bindings - */ - public function seeSessionHasValues(array $bindings): void - { - foreach ($bindings as $key => $value) { - if (is_int($key)) { - $this->seeInSession($value); - } else { - $this->seeInSession($key, $value); - } - } - } - /** * Assert that form errors are bound to the View. * diff --git a/src/Codeception/Module/Laravel/InteractsWithSession.php b/src/Codeception/Module/Laravel/InteractsWithSession.php new file mode 100644 index 0000000..391060b --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithSession.php @@ -0,0 +1,63 @@ +seeInSession('key'); + * $I->seeInSession('key', 'value'); + * ``` + * + * @param string|array $key + * @param mixed|null $value + */ + public function seeInSession($key, $value = null): void + { + if (is_array($key)) { + $this->seeSessionHasValues($key); + return; + } + + /** @var Session $session */ + $session = $this->app['session']; + + if (!$session->has($key)) { + $this->fail("No session variable with key '$key'"); + } + + if (! is_null($value)) { + $this->assertEquals($value, $session->get($key)); + } + } + + /** + * Assert that the session has a given list of values. + * + * ``` php + * seeSessionHasValues(['key1', 'key2']); + * $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']); + * ``` + * + * @param array $bindings + */ + public function seeSessionHasValues(array $bindings): void + { + foreach ($bindings as $key => $value) { + if (is_int($key)) { + $this->seeInSession($value); + } else { + $this->seeInSession($key, $value); + } + } + } +} From 7da87c1a9b5a9cd80532b746938241456cfef55c Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:11:55 -0500 Subject: [PATCH 11/19] Split views methods --- src/Codeception/Module/Laravel.php | 120 +---------------- .../Module/Laravel/InteractsWithViews.php | 125 ++++++++++++++++++ 2 files changed, 127 insertions(+), 118 deletions(-) create mode 100644 src/Codeception/Module/Laravel/InteractsWithViews.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 7079474..a5362ba 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -19,20 +19,17 @@ use Codeception\Module\Laravel\InteractsWithExceptionHandling; use Codeception\Module\Laravel\InteractsWithRouting; use Codeception\Module\Laravel\InteractsWithSession; +use Codeception\Module\Laravel\InteractsWithViews; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; use Exception; -use Illuminate\Contracts\Session\Session; -use Illuminate\Contracts\View\Factory as ViewContract; use Illuminate\Database\Connection; use Illuminate\Database\DatabaseManager; use Illuminate\Database\Eloquent\Factory; use Illuminate\Foundation\Application; use Illuminate\Routing\Route; -use Illuminate\Support\ViewErrorBag; use ReflectionException; -use function is_array; /** * @@ -134,6 +131,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithExceptionHandling; use InteractsWithRouting; use InteractsWithSession; + use InteractsWithViews; /** * @var Application @@ -308,120 +306,6 @@ public function disableMiddleware() $this->client->disableMiddleware(); } - /** - * Assert that form errors are bound to the View. - * - * ``` php - * seeFormHasErrors(); - * ``` - */ - public function seeFormHasErrors(): void - { - /** @var ViewContract $view */ - $view = $this->app->make('view'); - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); - - $this->assertGreaterThan( - 0, - $viewErrorBag->count(), - 'Expecting that the form has errors, but there were none!' - ); - } - - /** - * Assert that there are no form errors bound to the View. - * - * ``` php - * dontSeeFormErrors(); - * ``` - */ - public function dontSeeFormErrors(): void - { - /** @var ViewContract $view */ - $view = $this->app->make('view'); - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); - - $this->assertEquals( - 0, - $viewErrorBag->count(), - 'Expecting that the form does not have errors, but there were!' - ); - } - - /** - * Verifies that multiple fields on a form have errors. - * - * This method will validate that the expected error message - * is contained in the actual error message, that is, - * you can specify either the entire error message or just a part of it: - * - * ``` php - * seeFormErrorMessages([ - * 'address' => 'The address is too long', - * 'telephone' => 'too short' // the full error message is 'The telephone is too short' - * ]); - * ``` - * - * If you don't want to specify the error message for some fields, - * you can pass `null` as value instead of the message string. - * If that is the case, it will be validated that - * that field has at least one error of any type: - * - * ``` php - * seeFormErrorMessages([ - * 'telephone' => 'too short', - * 'address' => null - * ]); - * ``` - * - * @param array $expectedErrors - */ - public function seeFormErrorMessages(array $expectedErrors): void - { - foreach ($expectedErrors as $field => $message) { - $this->seeFormErrorMessage($field, $message); - } - } - - /** - * Assert that a specific form error message is set in the view. - * - * If you want to assert that there is a form error message for a specific key - * but don't care about the actual error message you can omit `$expectedErrorMessage`. - * - * If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key - * contains `$expectedErrorMessage`. - * - * ``` php - * seeFormErrorMessage('username'); - * $I->seeFormErrorMessage('username', 'Invalid Username'); - * ``` - * @param string $field - * @param string|null $errorMessage - */ - public function seeFormErrorMessage(string $field, $errorMessage = null): void - { - /** @var ViewContract $view */ - $view = $this->app['view']; - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); - - if (!($viewErrorBag->has($field))) { - $this->fail("No form error message for key '$field'\n"); - } - - if (! is_null($errorMessage)) { - $this->assertStringContainsString($errorMessage, $viewErrorBag->first($field)); - } - } - /** * Returns a list of recognized domain names. * This elements of this list are regular expressions. diff --git a/src/Codeception/Module/Laravel/InteractsWithViews.php b/src/Codeception/Module/Laravel/InteractsWithViews.php new file mode 100644 index 0000000..62ca507 --- /dev/null +++ b/src/Codeception/Module/Laravel/InteractsWithViews.php @@ -0,0 +1,125 @@ +dontSeeFormErrors(); + * ``` + */ + public function dontSeeFormErrors(): void + { + /** @var ViewContract $view */ + $view = $this->app->make('view'); + /** @var ViewErrorBag $viewErrorBag */ + $viewErrorBag = $view->shared('errors'); + + $this->assertEquals( + 0, + $viewErrorBag->count(), + 'Expecting that the form does not have errors, but there were!' + ); + } + + /** + * Assert that a specific form error message is set in the view. + * + * If you want to assert that there is a form error message for a specific key + * but don't care about the actual error message you can omit `$expectedErrorMessage`. + * + * If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key + * contains `$expectedErrorMessage`. + * + * ``` php + * seeFormErrorMessage('username'); + * $I->seeFormErrorMessage('username', 'Invalid Username'); + * ``` + * @param string $field + * @param string|null $errorMessage + */ + public function seeFormErrorMessage(string $field, $errorMessage = null): void + { + /** @var ViewContract $view */ + $view = $this->app['view']; + /** @var ViewErrorBag $viewErrorBag */ + $viewErrorBag = $view->shared('errors'); + + if (!($viewErrorBag->has($field))) { + $this->fail("No form error message for key '$field'\n"); + } + + if (! is_null($errorMessage)) { + $this->assertStringContainsString($errorMessage, $viewErrorBag->first($field)); + } + } + + /** + * Verifies that multiple fields on a form have errors. + * + * This method will validate that the expected error message + * is contained in the actual error message, that is, + * you can specify either the entire error message or just a part of it: + * + * ``` php + * seeFormErrorMessages([ + * 'address' => 'The address is too long', + * 'telephone' => 'too short' // the full error message is 'The telephone is too short' + * ]); + * ``` + * + * If you don't want to specify the error message for some fields, + * you can pass `null` as value instead of the message string. + * If that is the case, it will be validated that + * that field has at least one error of any type: + * + * ``` php + * seeFormErrorMessages([ + * 'telephone' => 'too short', + * 'address' => null + * ]); + * ``` + * + * @param array $expectedErrors + */ + public function seeFormErrorMessages(array $expectedErrors): void + { + foreach ($expectedErrors as $field => $message) { + $this->seeFormErrorMessage($field, $message); + } + } + + /** + * Assert that form errors are bound to the View. + * + * ``` php + * seeFormHasErrors(); + * ``` + */ + public function seeFormHasErrors(): void + { + /** @var ViewContract $view */ + $view = $this->app->make('view'); + /** @var ViewErrorBag $viewErrorBag */ + $viewErrorBag = $view->shared('errors'); + + $this->assertGreaterThan( + 0, + $viewErrorBag->count(), + 'Expecting that the form has errors, but there were none!' + ); + } +} From 0ab06fc6fe9d86ad5a1d8772bdbdf33f55b3d126 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:16:23 -0500 Subject: [PATCH 12/19] Split request methods --- src/Codeception/Module/Laravel.php | 15 ++----------- .../Module/Laravel/MakesHttpRequests.php | 21 +++++++++++++++++++ 2 files changed, 23 insertions(+), 13 deletions(-) create mode 100644 src/Codeception/Module/Laravel/MakesHttpRequests.php diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index a5362ba..0b29286 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -20,6 +20,7 @@ use Codeception\Module\Laravel\InteractsWithRouting; use Codeception\Module\Laravel\InteractsWithSession; use Codeception\Module\Laravel\InteractsWithViews; +use Codeception\Module\Laravel\MakesHttpRequests; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; @@ -132,6 +133,7 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithRouting; use InteractsWithSession; use InteractsWithViews; + use MakesHttpRequests; /** * @var Application @@ -293,19 +295,6 @@ protected function revertErrorHandler(): void set_error_handler([$handler, 'errorHandler']); } - /** - * Disable middleware for the next requests. - * - * ```php - * disableMiddleware(); - * ``` - */ - public function disableMiddleware() - { - $this->client->disableMiddleware(); - } - /** * Returns a list of recognized domain names. * This elements of this list are regular expressions. diff --git a/src/Codeception/Module/Laravel/MakesHttpRequests.php b/src/Codeception/Module/Laravel/MakesHttpRequests.php new file mode 100644 index 0000000..3df330d --- /dev/null +++ b/src/Codeception/Module/Laravel/MakesHttpRequests.php @@ -0,0 +1,21 @@ +disableMiddleware(); + * ``` + */ + public function disableMiddleware() + { + $this->client->disableMiddleware(); + } +} From 3b3df7bf2763f6df4baa24085832458308ca133f Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:22:49 -0500 Subject: [PATCH 13/19] Updated module class logic --- src/Codeception/Module/Laravel.php | 60 ++++++++++++++++-------------- 1 file changed, 33 insertions(+), 27 deletions(-) diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 0b29286..8efce0b 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -4,7 +4,7 @@ namespace Codeception\Module; -use Codeception\Configuration; +use Codeception\Configuration as CodeceptConfig; use Codeception\Exception\ModuleConfigException; use Codeception\Lib\Connector\Laravel as LaravelConnector; use Codeception\Lib\Framework; @@ -21,16 +21,17 @@ use Codeception\Module\Laravel\InteractsWithSession; use Codeception\Module\Laravel\InteractsWithViews; use Codeception\Module\Laravel\MakesHttpRequests; +use Codeception\Module\Laravel\ServicesTrait; use Codeception\Subscriber\ErrorHandler; use Codeception\TestInterface; use Codeception\Util\ReflectionHelper; -use Exception; use Illuminate\Database\Connection; use Illuminate\Database\DatabaseManager; -use Illuminate\Database\Eloquent\Factory; use Illuminate\Foundation\Application; use Illuminate\Routing\Route; use ReflectionException; +use Symfony\Component\Routing\CompiledRoute as SymfonyCompiledRoute; +use Throwable; /** * @@ -134,18 +135,24 @@ class Laravel extends Framework implements ActiveRecord, PartedModule use InteractsWithSession; use InteractsWithViews; use MakesHttpRequests; + use ServicesTrait; /** * @var Application */ public $app; + /** + * @var LaravelConnector + */ + public $client; + /** * @var array */ public $config = []; - public function __construct(ModuleContainer $container, ?array $config = null) + public function __construct(ModuleContainer $moduleContainer, ?array $config = null) { $this->config = array_merge( [ @@ -167,15 +174,18 @@ public function __construct(ModuleContainer $container, ?array $config = null) (array)$config ); - $projectDir = explode($this->config['packages'], Configuration::projectDir())[0]; + $projectDir = explode($this->config['packages'], CodeceptConfig::projectDir())[0]; $projectDir .= $this->config['root']; $this->config['project_dir'] = $projectDir; $this->config['bootstrap_file'] = $projectDir . $this->config['bootstrap']; - parent::__construct($container); + parent::__construct($moduleContainer); } + /** + * @return string[] + */ public function _parts(): array { return ['orm']; @@ -194,8 +204,7 @@ public function _initialize() /** * Before hook. * - * @param TestInterface $test - * @throws Exception + * @throws Throwable */ public function _before(TestInterface $test) { @@ -207,7 +216,7 @@ public function _before(TestInterface $test) } if ($this->applicationUsesDatabase() && $this->config['cleanup']) { - $this->app['db']->beginTransaction(); + $this->getDb()->beginTransaction(); $this->debugSection('Database', 'Transaction started'); } @@ -219,13 +228,12 @@ public function _before(TestInterface $test) /** * After hook. * - * @param TestInterface $test - * @throws Exception + * @throws Throwable */ public function _after(TestInterface $test) { if ($this->applicationUsesDatabase()) { - $db = $this->app['db']; + $db = $this->getDb(); if ($db instanceof DatabaseManager) { if ($this->config['cleanup']) { @@ -245,18 +253,16 @@ public function _after(TestInterface $test) // Remove references to Faker in factories to prevent memory leak unset($this->app[\Faker\Generator::class]); - unset($this->app[Factory::class]); + unset($this->app[\Illuminate\Database\Eloquent\Factory::class]); } } /** * Does the application use the database? - * - * @return bool */ private function applicationUsesDatabase(): bool { - return ! empty($this->app['config']['database.default']); + return ! empty($this->getConfig()['database.default']); } /** @@ -264,14 +270,14 @@ private function applicationUsesDatabase(): bool * * @throws ModuleConfigException */ - protected function checkBootstrapFileExists(): void + private function checkBootstrapFileExists(): void { $bootstrapFile = $this->config['bootstrap_file']; if (!file_exists($bootstrapFile)) { throw new ModuleConfigException( $this, - "Laravel bootstrap file not found in $bootstrapFile.\n" + "Laravel bootstrap file not found in {$bootstrapFile}.\n" . "Please provide a valid path by using the 'bootstrap' config param. " ); } @@ -280,7 +286,7 @@ protected function checkBootstrapFileExists(): void /** * Register Laravel autoloaders. */ - protected function registerAutoloaders(): void + private function registerAutoloaders(): void { require $this->config['project_dir'] . $this->config['vendor_dir'] . DIRECTORY_SEPARATOR . 'autoload.php'; } @@ -289,24 +295,25 @@ protected function registerAutoloaders(): void * Revert back to the Codeception error handler, * because Laravel registers it's own error handler. */ - protected function revertErrorHandler(): void + private function revertErrorHandler(): void { - $handler = new ErrorHandler(); - set_error_handler([$handler, 'errorHandler']); + $errorHandler = new ErrorHandler(); + set_error_handler([$errorHandler, 'errorHandler']); } /** * Returns a list of recognized domain names. * This elements of this list are regular expressions. * - * @return array * @throws ReflectionException + * @return string[] */ protected function getInternalDomains(): array { $internalDomains = [$this->getApplicationDomainRegex()]; - foreach ($this->app['routes'] as $route) { + /** @var Route $route */ + foreach ($this->getRoutes() as $route) { if (!is_null($route->domain())) { $internalDomains[] = $this->getDomainRegex($route); } @@ -330,13 +337,12 @@ private function getApplicationDomainRegex(): string /** * Get the regex for matching the domain part of this route. * - * @param Route $route - * @return string * @throws ReflectionException */ - private function getDomainRegex(Route $route) + private function getDomainRegex(Route $route): string { ReflectionHelper::invokePrivateMethod($route, 'compileRoute'); + /** @var SymfonyCompiledRoute $compiledRoute */ $compiledRoute = ReflectionHelper::readPrivateProperty($route, 'compiled'); return $compiledRoute->getHostRegex(); From ae45e2cd0c2d741eeb7c1dc4e3e4beede007e0c7 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:24:39 -0500 Subject: [PATCH 14/19] reorder some protected and private methods --- src/Codeception/Module/Laravel.php | 79 +++++++++++++++--------------- 1 file changed, 39 insertions(+), 40 deletions(-) diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index 8efce0b..b2a80e0 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -257,6 +257,27 @@ public function _after(TestInterface $test) } } + /** + * Returns a list of recognized domain names. + * This elements of this list are regular expressions. + * + * @throws ReflectionException + * @return string[] + */ + protected function getInternalDomains(): array + { + $internalDomains = [$this->getApplicationDomainRegex()]; + + /** @var Route $route */ + foreach ($this->getRoutes() as $route) { + if (!is_null($route->domain())) { + $internalDomains[] = $this->getDomainRegex($route); + } + } + + return array_unique($internalDomains); + } + /** * Does the application use the database? */ @@ -284,46 +305,6 @@ private function checkBootstrapFileExists(): void } /** - * Register Laravel autoloaders. - */ - private function registerAutoloaders(): void - { - require $this->config['project_dir'] . $this->config['vendor_dir'] . DIRECTORY_SEPARATOR . 'autoload.php'; - } - - /** - * Revert back to the Codeception error handler, - * because Laravel registers it's own error handler. - */ - private function revertErrorHandler(): void - { - $errorHandler = new ErrorHandler(); - set_error_handler([$errorHandler, 'errorHandler']); - } - - /** - * Returns a list of recognized domain names. - * This elements of this list are regular expressions. - * - * @throws ReflectionException - * @return string[] - */ - protected function getInternalDomains(): array - { - $internalDomains = [$this->getApplicationDomainRegex()]; - - /** @var Route $route */ - foreach ($this->getRoutes() as $route) { - if (!is_null($route->domain())) { - $internalDomains[] = $this->getDomainRegex($route); - } - } - - return array_unique($internalDomains); - } - - /** - * @return string * @throws ReflectionException */ private function getApplicationDomainRegex(): string @@ -347,4 +328,22 @@ private function getDomainRegex(Route $route): string return $compiledRoute->getHostRegex(); } + + /** + * Register Laravel autoloaders. + */ + private function registerAutoloaders(): void + { + require $this->config['project_dir'] . $this->config['vendor_dir'] . DIRECTORY_SEPARATOR . 'autoload.php'; + } + + /** + * Revert back to the Codeception error handler, + * because Laravel registers it's own error handler. + */ + private function revertErrorHandler(): void + { + $errorHandler = new ErrorHandler(); + set_error_handler([$errorHandler, 'errorHandler']); + } } From 72022e879c029267216eb3c1344b7dfe674a82de Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:44:43 -0500 Subject: [PATCH 15/19] Updated assertion traits logic --- .../Laravel/InteractsWithAuthentication.php | 62 +++--- .../Module/Laravel/InteractsWithConsole.php | 10 +- .../Module/Laravel/InteractsWithContainer.php | 43 ++-- .../Module/Laravel/InteractsWithEloquent.php | 204 ++++++++---------- .../Module/Laravel/InteractsWithEvents.php | 6 +- .../InteractsWithExceptionHandling.php | 4 +- .../Module/Laravel/InteractsWithRouting.php | 84 +++----- .../Module/Laravel/InteractsWithSession.php | 15 +- .../Module/Laravel/InteractsWithViews.php | 41 ++-- .../Module/Laravel/MakesHttpRequests.php | 6 +- 10 files changed, 192 insertions(+), 283 deletions(-) diff --git a/src/Codeception/Module/Laravel/InteractsWithAuthentication.php b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php index 56ade6b..63200cb 100644 --- a/src/Codeception/Module/Laravel/InteractsWithAuthentication.php +++ b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php @@ -5,75 +5,55 @@ namespace Codeception\Module\Laravel; use Illuminate\Contracts\Auth\Authenticatable; -use Illuminate\Contracts\Auth\Factory as AuthContract; trait InteractsWithAuthentication { /** * Set the currently logged in user for the application. - * Takes either an object that implements the User interface or - * an array of credentials. + * Unlike 'amActingAs', this method does update the session, fire the login events + * and remember the user as it assigns the corresponding Cookie. * - * ``` php + * ```php * amLoggedAs(['username' => 'jane@example.com', 'password' => 'password']); * - * // provide User object + * // provide User object that implements the User interface * $I->amLoggedAs( new User ); * * // can be verified with $I->seeAuthentication(); * ``` * @param Authenticatable|array $user - * @param string|null $guardName The guard name + * @param string|null $guardName */ - public function amLoggedAs($user, ?string $guardName = null): void + public function amLoggedAs($user, string $guardName = null): void { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - $guard = $auth->guard($guardName); - if ($user instanceof Authenticatable) { - $guard->login($user); + $this->getAuth()->login($user); return; } - $this->assertTrue($guard->attempt($user), 'Failed to login with credentials ' . json_encode($user)); + $guard = $this->getAuth()->guard($guardName); + $this->assertTrue( + $guard->attempt($user) + , 'Failed to login with credentials ' . json_encode($user) + ); } /** * Check that user is not authenticated. - * You can specify the guard that should be use as second parameter. - * - * @param string|null $guard */ - public function dontSeeAuthentication(?string $guard = null): void + public function dontSeeAuthentication(string $guardName = null): void { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - if (is_string($guard)) { - $auth = $auth->guard($guard); - } - - $this->assertNotTrue($auth->check(), 'There is an user authenticated'); + $this->assertFalse($this->isAuthenticated($guardName), 'The user is authenticated'); } /** * Checks that a user is authenticated. - * You can specify the guard that should be use as second parameter. - * - * @param string|null $guard */ - public function seeAuthentication($guard = null): void + public function seeAuthentication(string $guardName = null): void { - /** @var AuthContract $auth */ - $auth = $this->app['auth']; - - $auth = $auth->guard($guard); - - $this->assertTrue($auth->check(), 'There is no authenticated user'); + $this->assertTrue($this->isAuthenticated($guardName), 'The user is not authenticated'); } /** @@ -81,6 +61,14 @@ public function seeAuthentication($guard = null): void */ public function logout(): void { - $this->app['auth']->logout(); + $this->getAuth()->logout(); + } + + /** + * Return true if the user is authenticated, false otherwise. + */ + protected function isAuthenticated(?string $guardName): bool + { + return $this->getAuth()->guard($guardName)->check(); } } diff --git a/src/Codeception/Module/Laravel/InteractsWithConsole.php b/src/Codeception/Module/Laravel/InteractsWithConsole.php index 6174d27..338fa13 100644 --- a/src/Codeception/Module/Laravel/InteractsWithConsole.php +++ b/src/Codeception/Module/Laravel/InteractsWithConsole.php @@ -4,7 +4,6 @@ namespace Codeception\Module\Laravel; -use Illuminate\Contracts\Console\Kernel; use Symfony\Component\Console\Output\OutputInterface; trait InteractsWithConsole @@ -12,21 +11,18 @@ trait InteractsWithConsole /** * Call an Artisan command. * - * ``` php + * ```php * callArtisan('command:name'); * $I->callArtisan('command:name', ['parameter' => 'value']); * ``` * Use 3rd parameter to pass in custom `OutputInterface` * - * @param string $command - * @param array $parameters - * @param OutputInterface|null $output * @return string|void */ - public function callArtisan(string $command, $parameters = [], OutputInterface $output = null) + public function callArtisan(string $command, array $parameters = [], OutputInterface $output = null) { - $console = $this->app->make(Kernel::class); + $console = $this->getConsoleKernel(); if (!$output) { $console->call($command, $parameters); $output = trim($console->output()); diff --git a/src/Codeception/Module/Laravel/InteractsWithContainer.php b/src/Codeception/Module/Laravel/InteractsWithContainer.php index d60bc18..aa2589a 100644 --- a/src/Codeception/Module/Laravel/InteractsWithContainer.php +++ b/src/Codeception/Module/Laravel/InteractsWithContainer.php @@ -4,12 +4,14 @@ namespace Codeception\Module\Laravel; +use Illuminate\Contracts\Foundation\Application; + trait InteractsWithContainer { /** * Clear the registered application handlers. * - * ``` php + * ```php * clearApplicationHandlers(); * ``` @@ -21,19 +23,17 @@ public function clearApplicationHandlers(): void /** * Provides access the Laravel application object. - * - * @return \Illuminate\Contracts\Foundation\Application */ - public function getApplication() + public function getApplication(): Application { return $this->app; } /** * Return an instance of a class from the Laravel service container. - * (https://laravel.com/docs/master/container) + * (https://laravel.com/docs/7.x/container) * - * ``` php + * ```php * haveApplicationHandler(function($app) { * $app->make('config')->set(['test_value' => '10']); * }); * ``` - * - * @param callable $handler */ public function haveApplicationHandler(callable $handler): void { @@ -74,9 +71,9 @@ public function haveApplicationHandler(callable $handler): void /** * Add a binding to the Laravel service container. - * (https://laravel.com/docs/master/container) + * (https://laravel.com/docs/7.x/container) * - * ``` php + * ```php * haveBinding('My\Interface', 'My\Implementation'); * ``` @@ -92,9 +89,9 @@ public function haveBinding(string $abstract, $concrete = null, bool $shared = f /** * Add a contextual binding to the Laravel service container. - * (https://laravel.com/docs/master/container) + * (https://laravel.com/docs/7.x/container) * - * ``` php + * ```php * haveContextualBinding('My\Class', '$variable', 'value'); * @@ -115,26 +112,23 @@ public function haveContextualBinding(string $concrete, string $abstract, $imple /** * Add an instance binding to the Laravel service container. - * (https://laravel.com/docs/master/container) + * (https://laravel.com/docs/7.x/container) * - * ``` php + * ```php * haveInstance('App\MyClass', new App\MyClass()); * ``` - * - * @param string $abstract - * @param mixed $instance */ - public function haveInstance(string $abstract, $instance): void + public function haveInstance(string $abstract, object $instance): void { $this->client->haveInstance($abstract, $instance); } /** * Add a singleton binding to the Laravel service container. - * (https://laravel.com/docs/master/container) + * (https://laravel.com/docs/7.x/container) * - * ``` php + * ```php * haveSingleton('App\MyInterface', 'App\MySingleton'); * ``` @@ -147,10 +141,7 @@ public function haveSingleton(string $abstract, $concrete): void $this->client->haveBinding($abstract, $concrete, true); } - /** - * @param \Illuminate\Contracts\Foundation\Application $app - */ - public function setApplication($app): void + public function setApplication(Application $app): void { $this->app = $app; } diff --git a/src/Codeception/Module/Laravel/InteractsWithEloquent.php b/src/Codeception/Module/Laravel/InteractsWithEloquent.php index 555c2fd..efb21e4 100644 --- a/src/Codeception/Module/Laravel/InteractsWithEloquent.php +++ b/src/Codeception/Module/Laravel/InteractsWithEloquent.php @@ -4,38 +4,48 @@ namespace Codeception\Module\Laravel; -use Illuminate\Database\DatabaseManager; +use Illuminate\Database\Eloquent\Builder as EloquentBuilder; +use Illuminate\Database\Eloquent\Collection as EloquentCollection; +use Illuminate\Database\Eloquent\Factories\Factory as EloquentFactory; use Illuminate\Database\Eloquent\FactoryBuilder; use Illuminate\Database\Eloquent\Model as EloquentModel; +use Illuminate\Database\Query\Builder; +use Illuminate\Database\Query\Builder as QueryBuilder; use Illuminate\Foundation\Application; +use Illuminate\Support\Arr; use Illuminate\Support\Collection; use RuntimeException; +use Throwable; trait InteractsWithEloquent { - /** * Checks that record does not exist in database. * You can pass the name of a database table or the class name of an Eloquent model as the first argument. * * ```php * dontSeeRecord('users', ['name' => 'davert']); - * $I->dontSeeRecord('App\Models\User', ['name' => 'davert']); + * $I->dontSeeRecord($user); + * $I->dontSeeRecord('users', ['name' => 'Davert']); + * $I->dontSeeRecord('App\Models\User', ['name' => 'Davert']); * ``` * - * @param string $table + * @param string|class-string|object $table * @param array $attributes * @part orm */ public function dontSeeRecord($table, $attributes = []): void { + if ($table instanceof EloquentModel) { + $this->dontSeeRecord($table->getTable(), [$table->getKeyName() => $table->getKey()]); + } + if (class_exists($table)) { if ($foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { - $this->fail("Unexpectedly found matching $table with " . json_encode($attributes)); + $this->fail("Unexpectedly found matching {$table} with " . json_encode($attributes)); } } elseif ($foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { - $this->fail("Unexpectedly found matching record in table '$table'"); + $this->fail("Unexpectedly found matching record in table '{$table}'"); } $this->assertFalse($foundMatchingRecord); @@ -45,15 +55,12 @@ public function dontSeeRecord($table, $attributes = []): void * Retrieves number of records from database * You can pass the name of a database table or the class name of an Eloquent model as the first argument. * - * ``` php + * ```php * grabNumRecords('users', ['name' => 'davert']); - * $I->grabNumRecords('App\Models\User', ['name' => 'davert']); + * $I->grabNumRecords('users', ['name' => 'Davert']); + * $I->grabNumRecords('App\Models\User', ['name' => 'Davert']); * ``` * - * @param string $table - * @param array $attributes - * @return int * @part orm */ public function grabNumRecords(string $table, array $attributes = []): int @@ -66,10 +73,10 @@ public function grabNumRecords(string $table, array $attributes = []): int * If you pass the name of a database table as the first argument, this method returns an array. * You can also pass the class name of an Eloquent model, in that case this method returns an Eloquent model. * - * ``` php + * ```php * grabRecord('users', ['name' => 'davert']); // returns array - * $record = $I->grabRecord('App\Models\User', ['name' => 'davert']); // returns Eloquent model + * $record = $I->grabRecord('users', ['name' => 'Davert']); // returns array + * $record = $I->grabRecord('App\Models\User', ['name' => 'Davert']); // returns Eloquent model * ``` * * @param string $table @@ -80,15 +87,15 @@ public function grabNumRecords(string $table, array $attributes = []): int public function grabRecord($table, $attributes = []) { if (class_exists($table)) { - if (! $model = $this->findModel($table, $attributes)) { - $this->fail("Could not find $table with " . json_encode($attributes)); + if (!$model = $this->findModel($table, $attributes)) { + $this->fail("Could not find {$table} with " . json_encode($attributes)); } return $model; } - if (! $record = $this->findRecord($table, $attributes)) { - $this->fail("Could not find matching record in table '$table'"); + if (!$record = $this->findRecord($table, $attributes)) { + $this->fail("Could not find matching record in table '{$table}'"); } return $record; @@ -97,17 +104,15 @@ public function grabRecord($table, $attributes = []) /** * Use Laravel model factory to create a model. * - * ``` php + * ```php * have('App\Models\User'); * $I->have('App\Models\User', ['name' => 'John Doe']); * $I->have('App\Models\User', [], 'admin'); * ``` * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param array $attributes - * @param string $name + * @see https://laravel.com/docs/7.x/database-testing#using-factories + * * @return mixed * @part orm */ @@ -122,35 +127,32 @@ public function have(string $model, array $attributes = [], string $name = 'defa } return $model; - } catch (Exception $e) { - $this->fail('Could not create model: \n\n' . get_class($e) . '\n\n' . $e->getMessage()); + } catch (Throwable $t) { + $this->fail('Could not create model: \n\n' . get_class($t) . '\n\n' . $t->getMessage()); } } /** * Use Laravel model factory to create multiple models. * - * ``` php + * ```php * haveMultiple('App\Models\User', 10); * $I->haveMultiple('App\Models\User', 10, ['name' => 'John Doe']); * $I->haveMultiple('App\Models\User', 10, [], 'admin'); * ``` * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param int $times - * @param array $attributes - * @param string $name - * @return mixed + * @see https://laravel.com/docs/7.x/database-testing#using-factories + * + * @return EloquentModel|EloquentCollection * @part orm */ public function haveMultiple(string $model, int $times, array $attributes = [], string $name = 'default') { try { return $this->modelFactory($model, $name, $times)->create($attributes); - } catch (Exception $e) { - $this->fail("Could not create model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } catch (Throwable $t) { + $this->fail("Could not create model: \n\n" . get_class($t) . "\n\n" . $t->getMessage()); } } @@ -166,7 +168,7 @@ public function haveMultiple(string $model, int $times, array $attributes = [], * ``` * * @param string $table - * @param array $attributes + * @param array $attributes * @return EloquentModel|int * @throws RuntimeException * @part orm @@ -176,8 +178,8 @@ public function haveRecord($table, $attributes = []) if (class_exists($table)) { $model = new $table; - if (! $model instanceof EloquentModel) { - throw new RuntimeException("Class $table is not an Eloquent model"); + if (!$model instanceof EloquentModel) { + throw new RuntimeException("Class {$table} is not an Eloquent model"); } $model->fill($attributes)->save(); @@ -186,64 +188,58 @@ public function haveRecord($table, $attributes = []) } try { - /** @var DatabaseManager $dbManager */ - $dbManager = $this->app['db']; - return $dbManager->table($table)->insertGetId($attributes); - } catch (Exception $e) { - $this->fail("Could not insert record into table '$table':\n\n" . $e->getMessage()); + $table = $this->getDb()->table($table); + return $table->insertGetId($attributes); + } catch (Throwable $t) { + $this->fail("Could not insert record into table '$table':\n\n" . $t->getMessage()); } } /** * Use Laravel model factory to make a model instance. * - * ``` php + * ```php * make('App\Models\User'); * $I->make('App\Models\User', ['name' => 'John Doe']); * $I->make('App\Models\User', [], 'admin'); * ``` * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param array $attributes - * @param string $name - * @return mixed + * @see https://laravel.com/docs/7.x/database-testing#using-factories + * + * @return EloquentCollection|EloquentModel * @part orm */ public function make(string $model, array $attributes = [], string $name = 'default') { try { return $this->modelFactory($model, $name)->make($attributes); - } catch (Exception $e) { - $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } catch (Throwable $t) { + $this->fail("Could not make model: \n\n" . get_class($t) . "\n\n" . $t->getMessage()); } } /** * Use Laravel model factory to make multiple model instances. * - * ``` php + * ```php * makeMultiple('App\Models\User', 10); * $I->makeMultiple('App\Models\User', 10, ['name' => 'John Doe']); * $I->makeMultiple('App\Models\User', 10, [], 'admin'); * ``` * - * @see https://laravel.com/docs/6.x/database-testing#using-factories - * @param string $model - * @param int $times - * @param array $attributes - * @param string $name - * @return mixed + * @see https://laravel.com/docs/7.x/database-testing#using-factories + * + * @return EloquentCollection|EloquentModel * @part orm */ public function makeMultiple(string $model, int $times, array $attributes = [], string $name = 'default') { try { return $this->modelFactory($model, $name, $times)->make($attributes); - } catch (Exception $e) { - $this->fail("Could not make model: \n\n" . get_class($e) . "\n\n" . $e->getMessage()); + } catch (Throwable $t) { + $this->fail("Could not make model: \n\n" . get_class($t) . "\n\n" . $t->getMessage()); } } @@ -251,29 +247,26 @@ public function makeMultiple(string $model, int $times, array $attributes = [], * Checks that number of given records were found in database. * You can pass the name of a database table or the class name of an Eloquent model as the first argument. * - * ``` php + * ```php * seeNumRecords(1, 'users', ['name' => 'davert']); - * $I->seeNumRecords(1, 'App\Models\User', ['name' => 'davert']); + * $I->seeNumRecords(1, 'users', ['name' => 'Davert']); + * $I->seeNumRecords(1, 'App\Models\User', ['name' => 'Davert']); * ``` * - * @param int $expectedNum - * @param string $table - * @param array $attributes * @part orm */ public function seeNumRecords(int $expectedNum, string $table, array $attributes = []): void { if (class_exists($table)) { $currentNum = $this->countModels($table, $attributes); - $this->assertEquals( + $this->assertSame( $expectedNum, $currentNum, "The number of found {$table} ({$currentNum}) does not match expected number {$expectedNum} with " . json_encode($attributes) ); } else { $currentNum = $this->countRecords($table, $attributes); - $this->assertEquals( + $this->assertSame( $expectedNum, $currentNum, "The number of found records in table {$table} ({$currentNum}) does not match expected number $expectedNum with " . json_encode($attributes) @@ -285,24 +278,29 @@ public function seeNumRecords(int $expectedNum, string $table, array $attributes * Checks that record exists in database. * You can pass the name of a database table or the class name of an Eloquent model as the first argument. * - * ``` php + * ```php * seeRecord('users', ['name' => 'davert']); - * $I->seeRecord('App\Models\User', ['name' => 'davert']); + * $I->seeRecord($user); + * $I->seeRecord('users', ['name' => 'Davert']); + * $I->seeRecord('App\Models\User', ['name' => 'Davert']); * ``` * - * @param string $table + * @param string|class-string|object $table * @param array $attributes * @part orm */ public function seeRecord($table, $attributes = []): void { + if ($table instanceof EloquentModel) { + $this->seeRecord($table->getTable(), [$table->getKeyName() => $table->getKey()]); + } + if (class_exists($table)) { - if (! $foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { - $this->fail("Could not find $table with " . json_encode($attributes)); + if (!$foundMatchingRecord = (bool)$this->findModel($table, $attributes)) { + $this->fail("Could not find {$table} with " . json_encode($attributes)); } - } elseif (! $foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { - $this->fail("Could not find matching record in table '$table'"); + } elseif (!$foundMatchingRecord = (bool)$this->findRecord($table, $attributes)) { + $this->fail("Could not find matching record in table '{$table}'"); } $this->assertTrue($foundMatchingRecord); @@ -320,32 +318,22 @@ protected function countRecords(string $table, array $attributes = []): int return $query->count(); } - /** - * @param string $modelClass - * @param array $attributes - * - * @return EloquentModel - */ - protected function findModel(string $modelClass, array $attributes = []) + protected function findModel(string $modelClass, array $attributes): ?EloquentModel { $query = $this->buildQuery($modelClass, $attributes); - return $query->first(); } - protected function findRecord(string $table, array $attributes = []): array + protected function findRecord(string $table, array $attributes): array { $query = $this->buildQuery($table, $attributes); - return (array) $query->first(); + return (array)$query->first(); } /** - * @param string $model - * @param string $name - * @param int $times - * @return FactoryBuilder|\Illuminate\Database\Eloquent\Factories\Factory + * @return FactoryBuilder|EloquentFactory */ - protected function modelFactory(string $model, string $name, $times = 1) + protected function modelFactory(string $model, string $name, int $times = 1) { if (version_compare(Application::VERSION, '7.0.0', '<')) { return factory($model, $name, $times); @@ -357,18 +345,11 @@ protected function modelFactory(string $model, string $name, $times = 1) /** * Build Eloquent query with attributes * - * @param string $table - * @param array $attributes - * @return EloquentModel - * @part orm + * @return EloquentBuilder|QueryBuilder */ - private function buildQuery(string $table, $attributes = []) + private function buildQuery(string $table, array $attributes = []) { - if (class_exists($table)) { - $query = $this->getQueryBuilderFromModel($table); - } else { - $query = $this->getQueryBuilderFromTable($table); - } + $query = class_exists($table) ? $this->getQueryBuilderFromModel($table) : $this->getQueryBuilderFromTable($table); foreach ($attributes as $key => $value) { if (is_array($value)) { @@ -382,30 +363,19 @@ private function buildQuery(string $table, $attributes = []) return $query; } - /** - * @param string $modelClass - * - * @return EloquentModel - * @throws RuntimeException - */ - protected function getQueryBuilderFromModel(string $modelClass) + private function getQueryBuilderFromModel(string $modelClass): EloquentBuilder { $model = new $modelClass; if (!$model instanceof EloquentModel) { - throw new RuntimeException("Class $modelClass is not an Eloquent model"); + throw new RuntimeException("Class {$modelClass} is not an Eloquent model"); } return $model->newQuery(); } - /** - * @param string $table - * - * @return EloquentModel - */ - protected function getQueryBuilderFromTable(string $table) + private function getQueryBuilderFromTable(string $table): Builder { - return $this->app['db']->table($table); + return $this->getDb()->table($table); } } diff --git a/src/Codeception/Module/Laravel/InteractsWithEvents.php b/src/Codeception/Module/Laravel/InteractsWithEvents.php index 2d982b4..e9060c6 100644 --- a/src/Codeception/Module/Laravel/InteractsWithEvents.php +++ b/src/Codeception/Module/Laravel/InteractsWithEvents.php @@ -37,7 +37,7 @@ public function disableModelEvents(): void /** * Make sure events did not fire during the test. * - * ``` php + * ```php * dontSeeEventTriggered('App\MyEvent'); * $I->dontSeeEventTriggered(new App\Events\MyEvent()); @@ -54,7 +54,7 @@ public function dontSeeEventTriggered($expected): void if ($triggered) { $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; - $this->fail("The '$expectedEvent' event triggered"); + $this->fail("The '{$expectedEvent}' event triggered"); } } } @@ -78,7 +78,7 @@ public function seeEventTriggered($expected): void if (! $this->client->eventTriggered($expectedEvent)) { $expectedEvent = is_object($expectedEvent) ? get_class($expectedEvent) : $expectedEvent; - $this->fail("The '$expectedEvent' event did not trigger"); + $this->fail("The '{$expectedEvent}' event did not trigger"); } } } diff --git a/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php b/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php index 984b626..4e4f398 100644 --- a/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php +++ b/src/Codeception/Module/Laravel/InteractsWithExceptionHandling.php @@ -14,7 +14,7 @@ trait InteractsWithExceptionHandling * $I->disableExceptionHandling(); * ``` */ - public function disableExceptionHandling() + public function disableExceptionHandling(): void { $this->client->disableExceptionHandling(); } @@ -27,7 +27,7 @@ public function disableExceptionHandling() * $I->enableExceptionHandling(); * ``` */ - public function enableExceptionHandling() + public function enableExceptionHandling(): void { $this->client->enableExceptionHandling(); } diff --git a/src/Codeception/Module/Laravel/InteractsWithRouting.php b/src/Codeception/Module/Laravel/InteractsWithRouting.php index 06d05cc..f07c6a5 100644 --- a/src/Codeception/Module/Laravel/InteractsWithRouting.php +++ b/src/Codeception/Module/Laravel/InteractsWithRouting.php @@ -4,10 +4,7 @@ namespace Codeception\Module\Laravel; -use Illuminate\Contracts\Routing\UrlGenerator; -use Illuminate\Http\Request; use Illuminate\Routing\Route; -use Illuminate\Routing\Router; use ReflectionClass; use ReflectionException; @@ -16,7 +13,7 @@ trait InteractsWithRouting /** * Opens web page by action name * - * ``` php + * ```php * amOnAction('PostsController@index'); @@ -32,9 +29,8 @@ public function amOnAction(string $action, $parameters = []): void { $route = $this->getRouteByAction($action); $absolute = !is_null($route->domain()); - /** @var UrlGenerator $urlGenerator */ - $urlGenerator = $this->app['url']; - $url = $urlGenerator->action($action, $parameters, $absolute); + + $url = $this->getUrlGenerator()->action($action, $parameters, $absolute); $this->amOnPage($url); } @@ -55,16 +51,15 @@ public function amOnRoute(string $routeName, $params = []): void $route = $this->getRouteByName($routeName); $absolute = !is_null($route->domain()); - /** @var UrlGenerator $urlGenerator */ - $urlGenerator = $this->app['url']; - $url = $urlGenerator->route($routeName, $params, $absolute); + + $url = $this->getUrlGenerator()->route($routeName, $params, $absolute); $this->amOnPage($url); } /** * Checks that current url matches action * - * ``` php + * ```php * seeCurrentActionIs('PostsController@index'); @@ -72,111 +67,92 @@ public function amOnRoute(string $routeName, $params = []): void * // Laravel 8+: * $I->seeCurrentActionIs(PostsController::class . '@index'); * ``` - * - * @param string $action */ public function seeCurrentActionIs(string $action): void { - $this->getRouteByAction($action); // Fails if route does not exists - /** @var Request $request */ - $request = $this->app->request; + $this->getRouteByAction($action); + + $request = $this->getRequestObject(); $currentRoute = $request->route(); $currentAction = $currentRoute ? $currentRoute->getActionName() : ''; $currentAction = ltrim( - str_replace( (string)$this->getRootControllerNamespace(), '', $currentAction), + str_replace((string)$this->getAppRootControllerNamespace(), '', $currentAction), '\\' ); if ($currentAction != $action) { - $this->fail("Current action is \"$currentAction\""); + $this->fail("Current action is '{$currentAction}'"); } } /** * Checks that current url matches route * - * ``` php + * ```php * seeCurrentRouteIs('posts.index'); * ``` - * @param string $routeName */ public function seeCurrentRouteIs(string $routeName): void { - $this->getRouteByName($routeName); // Fails if route does not exists + $this->getRouteByName($routeName); - /** @var Request $request */ - $request = $this->app->request; + $request = $this->getRequestObject(); $currentRoute = $request->route(); $currentRouteName = $currentRoute ? $currentRoute->getName() : ''; if ($currentRouteName != $routeName) { $message = empty($currentRouteName) ? "Current route has no name" - : "Current route is \"$currentRouteName\""; + : "Current route is '{$currentRouteName}'"; $this->fail($message); } } /** - * Get the root controller namespace for the application. - * - * @return string|null * @throws ReflectionException */ - protected function getRootControllerNamespace(): ?string + protected function getAppRootControllerNamespace(): ?string { - $urlGenerator = $this->app['url']; - $reflection = new ReflectionClass($urlGenerator); + $urlGenerator = $this->getUrlGenerator(); + $reflectionClass = new ReflectionClass($urlGenerator); - $property = $reflection->getProperty('rootNamespace'); + $property = $reflectionClass->getProperty('rootNamespace'); $property->setAccessible(true); return $property->getValue($urlGenerator); } /** - * @param string $action - * @return Route + * Get route by Action. + * Fails if route does not exists. */ protected function getRouteByAction(string $action): Route { - $namespacedAction = $this->actionWithNamespace($action); + $namespacedAction = $this->normalizeActionToFullNamespacedAction($action); - if (!$route = $this->app['routes']->getByAction($namespacedAction)) { - $this->fail("Action '$action' does not exist"); + if (!$route = $this->getRoutes()->getByAction($namespacedAction)) { + $this->fail("Action '{$action}' does not exist"); } return $route; } - /** - * @param string $routeName - * @return mixed - */ - protected function getRouteByName(string $routeName) + protected function getRouteByName(string $routeName): Route { - /** @var Router $router */ - $router = $this->app['router']; - $routes = $router->getRoutes(); + $routes = $this->getRouter()->getRoutes(); if (!$route = $routes->getByName($routeName)) { - $this->fail("Route with name '$routeName' does not exist"); + $this->fail("Route with name '{$routeName}' does not exist"); } return $route; } - /** - * Normalize an action to full namespaced action. - * - * @param string $action - * @return string - */ - protected function actionWithNamespace(string $action): string + protected function normalizeActionToFullNamespacedAction(string $action): string { - $rootNamespace = $this->getRootControllerNamespace(); + $rootNamespace = $this->getAppRootControllerNamespace(); - if ($rootNamespace && !(strpos($action, '\\') === 0)) { + if ($rootNamespace && strpos($action, '\\') !== 0) { return $rootNamespace . '\\' . $action; } diff --git a/src/Codeception/Module/Laravel/InteractsWithSession.php b/src/Codeception/Module/Laravel/InteractsWithSession.php index 391060b..a33b2dc 100644 --- a/src/Codeception/Module/Laravel/InteractsWithSession.php +++ b/src/Codeception/Module/Laravel/InteractsWithSession.php @@ -4,14 +4,12 @@ namespace Codeception\Module\Laravel; -use Illuminate\Contracts\Session\Session; - trait InteractsWithSession { /** * Assert that a session variable exists. * - * ``` php + * ```php * seeInSession('key'); * $I->seeInSession('key', 'value'); @@ -27,28 +25,25 @@ public function seeInSession($key, $value = null): void return; } - /** @var Session $session */ - $session = $this->app['session']; + $session = $this->getSession(); if (!$session->has($key)) { - $this->fail("No session variable with key '$key'"); + $this->fail("No session variable with key '{$key}'"); } if (! is_null($value)) { - $this->assertEquals($value, $session->get($key)); + $this->assertSame($value, $session->get($key)); } } /** * Assert that the session has a given list of values. * - * ``` php + * ```php * seeSessionHasValues(['key1', 'key2']); * $I->seeSessionHasValues(['key1' => 'value1', 'key2' => 'value2']); * ``` - * - * @param array $bindings */ public function seeSessionHasValues(array $bindings): void { diff --git a/src/Codeception/Module/Laravel/InteractsWithViews.php b/src/Codeception/Module/Laravel/InteractsWithViews.php index 62ca507..fb0d58c 100644 --- a/src/Codeception/Module/Laravel/InteractsWithViews.php +++ b/src/Codeception/Module/Laravel/InteractsWithViews.php @@ -4,7 +4,6 @@ namespace Codeception\Module\Laravel; -use Illuminate\Contracts\View\Factory as ViewContract; use Illuminate\Support\ViewErrorBag; trait InteractsWithViews @@ -12,19 +11,16 @@ trait InteractsWithViews /** * Assert that there are no form errors bound to the View. * - * ``` php + * ```php * dontSeeFormErrors(); * ``` */ public function dontSeeFormErrors(): void { - /** @var ViewContract $view */ - $view = $this->app->make('view'); - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); + $viewErrorBag = $this->getViewErrorBag(); - $this->assertEquals( + $this->assertSame( 0, $viewErrorBag->count(), 'Expecting that the form does not have errors, but there were!' @@ -40,23 +36,18 @@ public function dontSeeFormErrors(): void * If you do pass `$expectedErrorMessage`, this method checks if the actual error message for a key * contains `$expectedErrorMessage`. * - * ``` php + * ```php * seeFormErrorMessage('username'); * $I->seeFormErrorMessage('username', 'Invalid Username'); * ``` - * @param string $field - * @param string|null $errorMessage */ - public function seeFormErrorMessage(string $field, $errorMessage = null): void + public function seeFormErrorMessage(string $field, string $errorMessage = null): void { - /** @var ViewContract $view */ - $view = $this->app['view']; - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); + $viewErrorBag = $this->getViewErrorBag(); if (!($viewErrorBag->has($field))) { - $this->fail("No form error message for key '$field'\n"); + $this->fail("No form error message for key '{$field}'\n"); } if (! is_null($errorMessage)) { @@ -71,7 +62,7 @@ public function seeFormErrorMessage(string $field, $errorMessage = null): void * is contained in the actual error message, that is, * you can specify either the entire error message or just a part of it: * - * ``` php + * ```php * seeFormErrorMessages([ * 'address' => 'The address is too long', @@ -84,15 +75,13 @@ public function seeFormErrorMessage(string $field, $errorMessage = null): void * If that is the case, it will be validated that * that field has at least one error of any type: * - * ``` php + * ```php * seeFormErrorMessages([ * 'telephone' => 'too short', * 'address' => null * ]); * ``` - * - * @param array $expectedErrors */ public function seeFormErrorMessages(array $expectedErrors): void { @@ -104,17 +93,14 @@ public function seeFormErrorMessages(array $expectedErrors): void /** * Assert that form errors are bound to the View. * - * ``` php + * ```php * seeFormHasErrors(); * ``` */ public function seeFormHasErrors(): void { - /** @var ViewContract $view */ - $view = $this->app->make('view'); - /** @var ViewErrorBag $viewErrorBag */ - $viewErrorBag = $view->shared('errors'); + $viewErrorBag = $this->getViewErrorBag(); $this->assertGreaterThan( 0, @@ -122,4 +108,9 @@ public function seeFormHasErrors(): void 'Expecting that the form has errors, but there were none!' ); } + + protected function getViewErrorBag(): ViewErrorBag + { + return $this->getView()->shared('errors'); + } } diff --git a/src/Codeception/Module/Laravel/MakesHttpRequests.php b/src/Codeception/Module/Laravel/MakesHttpRequests.php index 3df330d..81362a8 100644 --- a/src/Codeception/Module/Laravel/MakesHttpRequests.php +++ b/src/Codeception/Module/Laravel/MakesHttpRequests.php @@ -13,9 +13,11 @@ trait MakesHttpRequests * disableMiddleware(); * ``` + * + * @param string|array|null $middleware */ - public function disableMiddleware() + public function disableMiddleware($middleware = null): void { - $this->client->disableMiddleware(); + $this->client->disableMiddleware($middleware); } } From d9cfe82703b5298d8f3bb4e1c82c37c0a262c70b Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:48:42 -0500 Subject: [PATCH 16/19] Added new authentication assertions --- .../Laravel/InteractsWithAuthentication.php | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) diff --git a/src/Codeception/Module/Laravel/InteractsWithAuthentication.php b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php index 63200cb..419792b 100644 --- a/src/Codeception/Module/Laravel/InteractsWithAuthentication.php +++ b/src/Codeception/Module/Laravel/InteractsWithAuthentication.php @@ -4,6 +4,7 @@ namespace Codeception\Module\Laravel; +use Illuminate\Auth\GuardHelpers; use Illuminate\Contracts\Auth\Authenticatable; trait InteractsWithAuthentication @@ -40,6 +41,60 @@ public function amLoggedAs($user, string $guardName = null): void ); } + /** + * Set the given user object to the current or specified Guard. + */ + public function amActingAs(Authenticatable $user, string $guardName = null): void + { + if (isset($user->wasRecentlyCreated) && $user->wasRecentlyCreated) { + $user->wasRecentlyCreated = false; + } + + $this->getAuth()->guard($guardName)->setUser($user); + + $this->getAuth()->shouldUse($guardName); + } + + /** + * Assert that the user is authenticated as the given user. + */ + public function assertAuthenticatedAs(Authenticatable $user, string $guardName = null): void + { + $expected = $this->getAuth()->guard($guardName)->user(); + + $this->assertNotNull($expected, 'The current user is not authenticated.'); + + $this->assertInstanceOf( + get_class($expected), $user, + 'The currently authenticated user is not who was expected' + ); + + $this->assertSame( + $expected->getAuthIdentifier(), $user->getAuthIdentifier(), + 'The currently authenticated user is not who was expected' + ); + } + + /** + * Assert that the given credentials are valid. + */ + public function assertCredentials(array $credentials, string $guardName = null): void + { + $this->assertTrue( + $this->hasCredentials($credentials, $guardName), 'The given credentials are invalid.' + ); + } + + /** + * Assert that the given credentials are invalid. + */ + public function assertInvalidCredentials(array $credentials, string $guardName = null): void + { + $this->assertFalse( + $this->hasCredentials($credentials, $guardName), 'The given credentials are valid.' + ); + } + /** * Check that user is not authenticated. */ @@ -64,6 +119,20 @@ public function logout(): void $this->getAuth()->logout(); } + /** + * Return true if the credentials are valid, false otherwise. + */ + protected function hasCredentials(array $credentials, string $guardName = null): bool + { + /** @var GuardHelpers $guard */ + $guard = $this->getAuth()->guard($guardName); + $provider = $guard->getProvider(); + + $user = $provider->retrieveByCredentials($credentials); + + return $user && $provider->validateCredentials($user, $credentials); + } + /** * Return true if the user is authenticated, false otherwise. */ From 8771ed7f4d3e730397403daae65531821bdc5e1f Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:50:24 -0500 Subject: [PATCH 17/19] Added seedDatabase function --- .../Module/Laravel/InteractsWithEloquent.php | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/Codeception/Module/Laravel/InteractsWithEloquent.php b/src/Codeception/Module/Laravel/InteractsWithEloquent.php index efb21e4..df4c788 100644 --- a/src/Codeception/Module/Laravel/InteractsWithEloquent.php +++ b/src/Codeception/Module/Laravel/InteractsWithEloquent.php @@ -243,6 +243,18 @@ public function makeMultiple(string $model, int $times, array $attributes = [], } } + /** + * Seed a given database connection. + * + * @param class-string|class-string[] $seeders + */ + public function seedDatabase($seeders = 'Database\\Seeders\\DatabaseSeeder'): void + { + foreach (Arr::wrap($seeders) as $seeder) { + $this->callArtisan('db:seed', ['--class' => $seeder, '--no-interaction' => true]); + } + } + /** * Checks that number of given records were found in database. * You can pass the name of a database table or the class name of an Eloquent model as the first argument. From f9a6c5fe4bb3366f226354e1a30d9fb40209f348 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:52:51 -0500 Subject: [PATCH 18/19] Added enableMiddleware function --- .../Module/Laravel/MakesHttpRequests.php | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/Codeception/Module/Laravel/MakesHttpRequests.php b/src/Codeception/Module/Laravel/MakesHttpRequests.php index 81362a8..7fa04f5 100644 --- a/src/Codeception/Module/Laravel/MakesHttpRequests.php +++ b/src/Codeception/Module/Laravel/MakesHttpRequests.php @@ -20,4 +20,19 @@ public function disableMiddleware($middleware = null): void { $this->client->disableMiddleware($middleware); } + + /** + * Enable the given middleware for the test. + * + * ```php + * enableMiddleware(); + * ``` + * + * @param string|array|null $middleware + */ + public function enableMiddleware($middleware = null): void + { + $this->client->enableMiddleware($middleware); + } } From 330464529006fa4c61f305f28a21d8a06d9f5519 Mon Sep 17 00:00:00 2001 From: Tavo Nieves J Date: Mon, 6 Sep 2021 01:54:55 -0500 Subject: [PATCH 19/19] minor doc update --- src/Codeception/Module/Laravel.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Codeception/Module/Laravel.php b/src/Codeception/Module/Laravel.php index b2a80e0..a62d833 100644 --- a/src/Codeception/Module/Laravel.php +++ b/src/Codeception/Module/Laravel.php @@ -98,6 +98,7 @@ * * haveRecord * * make * * makeMultiple + * * seedDatabase * * seeNumRecords * * seeRecord *