Updated assertion traits logic

Author: TavoNiievez

src/Codeception/Module/Laravel/InteractsWithAuthentication.php

@@ -5,82 +5,70 @@
 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
      * <?php
      * // provide array of credentials
      * $I->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');
     }
 
     /**
      * Logout user.
      */
     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();
     }
 }

src/Codeception/Module/Laravel/InteractsWithConsole.php

@@ -4,29 +4,25 @@
 
 namespace Codeception\Module\Laravel;
 
-use Illuminate\Contracts\Console\Kernel;
 use Symfony\Component\Console\Output\OutputInterface;
 
 trait InteractsWithConsole
 {
     /**
      * Call an Artisan command.
      *
-     * ``` php
+     * ```php
      * <?php
      * $I->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());

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
      * <?php
      * $I->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
      * <?php
      * // In Laravel
      * App::bind('foo', function($app) {
@@ -46,7 +46,6 @@ public function getApplication()
      * // Will return an instance of FooBar, also works for singletons.
      * ```
      *
-     * @param string $class
      * @return mixed
      */
     public function grabService(string $class)
@@ -58,14 +57,12 @@ public function grabService(string $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
+     * ```php
      * <?php
      * $I->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
      * <?php
      * $I->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
      * <?php
      * $I->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
      * <?php
      * $I->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
      * <?php
      * $I->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;
     }