Merge pull request #10 from UnicornGlobal/console-concern

Console and Container Concerns

README.md

@@ -31,6 +31,8 @@ There are some traits you can use in your test case (including original ones in
 * `AlbertCht\Lumen\Testing\Concerns\RefreshDatabase`
 * `AlbertCht\Lumen\Testing\Concerns\WithFaker`
 * `AlbertCht\Lumen\Testing\Concerns\InteractsWithRedis`
+* `AlbertCht\Lumen\Testing\Concerns\InteractsWithConsole`
+* `AlbertCht\Lumen\Testing\Concerns\InteractsWithContainer`
 * `Laravel\Lumen\Testing\DatabaseMigrations`
 * `Laravel\Lumen\Testing\DatabaseTransactions`
 * `Laravel\Lumen\Testing\WithoutMiddleware`

src/Concerns/InteractsWithAuthentication.php

@@ -99,6 +99,18 @@ public function assertInvalidCredentials(array $credentials, $guard = null)
         return $this;
     }
 
+    /**
+     * Set the currently logged in user for the application.
+     *
+     * @param  \Illuminate\Contracts\Auth\Authenticatable  $user
+     * @param  string|null  $driver
+     * @return void
+     */
+    public function be($user, $driver = null)
+    {
+        $this->app['auth']->guard($driver)->setUser($user);
+    }
+
     /**
      * Return true if the credentials are valid, false otherwise.
      *

src/Concerns/InteractsWithConsole.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace AlbertCht\Lumen\Testing\Concerns;
+
+use Illuminate\Contracts\Console\Kernel;
+
+trait InteractsWithConsole
+{
+    /**
+     * Call artisan command and return code.
+     *
+     * @param  string  $command
+     * @param  array  $parameters
+     * @return int
+     */
+    public function artisan($command, $parameters = [])
+    {
+        return $this->app[Kernel::class]->call($command, $parameters);
+    }
+
+    /**
+     * Disable mocking the console output.
+     *
+     * @return $this
+     */
+    protected function withoutMockingConsoleOutput()
+    {
+        $this->mockConsoleOutput = false;
+        $this->app->offsetUnset(OutputStyle::class);
+        return $this;
+    }
+}

src/Concerns/InteractsWithContainer.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace AlbertCht\Lumen\Testing\Concerns;
+
+trait InteractsWithContainer
+{
+    /**
+     * Register an instance of an object in the container.
+     *
+     * @param  string  $abstract
+     * @param  object  $instance
+     * @return object
+     */
+    protected function swap($abstract, $instance)
+    {
+        return $this->instance($abstract, $instance);
+    }
+    /**
+     * Register an instance of an object in the container.
+     *
+     * @param  string  $abstract
+     * @param  object  $instance
+     * @return object
+     */
+    protected function instance($abstract, $instance)
+    {
+        $this->app->instance($abstract, $instance);
+        return $instance;
+    }
+}

src/Concerns/MocksApplicationServices.php

@@ -72,6 +72,29 @@ protected function getFiredEvents(array $events)
         return $this->getDispatched($events, $this->firedEvents);
     }
 
+    /**
+     * Specify a list of jobs that should be dispatched for the given operation.
+     *
+     * These jobs will be mocked, so that handlers will not actually be executed.
+     *
+     * @param  array|string  $jobs
+     * @return $this
+     */
+    protected function expectsJobs($jobs)
+    {
+        $jobs = is_array($jobs) ? $jobs : func_get_args();
+        $this->withoutJobs();
+        $this->beforeApplicationDestroyed(function () use ($jobs) {
+            $dispatched = $this->getDispatchedJobs($jobs);
+            if ($jobsNotDispatched = array_diff($jobs, $dispatched)) {
+                throw new Exception(
+                    'These expected jobs were not dispatched: ['.implode(', ', $jobsNotDispatched).']'
+                );
+            }
+        });
+        return $this;
+    }
+
     /**
      * Specify a list of jobs that should not be dispatched for the given operation.
      *
@@ -96,6 +119,23 @@ protected function doesntExpectJobs($jobs)
         return $this;
     }
 
+    /**
+     * Mock the job dispatcher so all jobs are silenced and collected.
+     *
+     * @return $this
+     */
+    protected function withoutJobs()
+    {
+        $mock = Mockery::mock('Illuminate\Contracts\Bus\Dispatcher');
+        $mock->shouldReceive('dispatch')->andReturnUsing(function ($dispatched) {
+            $this->dispatchedJobs[] = $dispatched;
+        });
+        $this->app->instance(
+            'Illuminate\Contracts\Bus\Dispatcher', $mock
+        );
+        return $this;
+    }
+
     /**
      * Filter the given jobs against the dispatched jobs.
      *

src/TestCase.php

@@ -9,9 +9,11 @@
 abstract class TestCase extends LumenTestCase
 {
     use Concerns\MakesHttpRequests,
+        Concerns\InteractsWithAuthentication,
+        Concerns\InteractsWithConsole,
+        Concerns\InteractsWithContainer,
         Concerns\InteractsWithDatabase,
         Concerns\InteractsWithExceptionHandling,
-        Concerns\InteractsWithAuthentication,
         Concerns\MocksApplicationServices;
 
     protected static $appPath;
@@ -64,4 +66,4 @@ protected function getAppPath()
 
         return static::$appPath;
     }
-}
+}