laravel#152 Implement facades faking

src/Browser.php

@@ -18,6 +18,7 @@ class Browser
         Concerns\InteractsWithMouse,
         Concerns\MakesAssertions,
         Concerns\WaitsForElements,
+        Concerns\FakesFacades,
         Macroable {
             __call as macroCall;
         }

src/Concerns/FakesFacades.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Laravel\Dusk\Concerns;
+
+use Laravel\Dusk\Faking\FacadeFakeProxy;
+
+trait FakesFacades
+{
+    /**
+     * Fake a facade and return the fake proxy.
+     *
+     * @param  string   $facade
+     * @return \Laravel\Dusk\Faking\FacadeFakeProxy
+     */
+    public function fake(string $facade)
+    {
+        $this->visit('/_dusk/fake/'.urlencode($facade));
+
+        return new FacadeFakeProxy($this, $facade);
+    }
+}

src/DuskServiceProvider.php

@@ -4,7 +4,12 @@
 
 use Exception;
 use Illuminate\Support\Facades\Route;
+use Laravel\Dusk\Faking\FakingManager;
 use Illuminate\Support\ServiceProvider;
+use Laravel\Dusk\Http\Middleware\SaveFaking;
+use Laravel\Dusk\Http\Middleware\StartFaking;
+use Laravel\Dusk\Http\Controllers\FakingController;
+use Illuminate\Contracts\Http\Kernel as HttpKernel;
 
 class DuskServiceProvider extends ServiceProvider
 {
@@ -15,20 +20,8 @@ class DuskServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        Route::get('/_dusk/login/{userId}/{guard?}', [
-            'middleware' => 'web',
-            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@login',
-        ]);
-
-        Route::get('/_dusk/logout/{guard?}', [
-            'middleware' => 'web',
-            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@logout',
-        ]);
-
-        Route::get('/_dusk/user/{guard?}', [
-            'middleware' => 'web',
-            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@user',
-        ]);
+        $this->bootAuthRoutes();
+        $this->bootFakingRoutes();
     }
 
     /**
@@ -43,6 +36,10 @@ public function register()
             throw new Exception('It is unsafe to run Dusk in production.');
         }
 
+        $this->app->singleton('faking', function ($app) {
+            return new FakingManager($app);
+        });
+
         if ($this->app->runningInConsole()) {
             $this->commands([
                 Console\InstallCommand::class,
@@ -51,6 +48,52 @@ public function register()
                 Console\PageCommand::class,
                 Console\ComponentCommand::class,
             ]);
+        } else {
+            $kernel = $this->app->make(HttpKernel::class);
+            $kernel->pushMiddleware(StartFaking::class);
+            $kernel->pushMiddleware(SaveFaking::class);
         }
+
+    }
+
+    /**
+     * Boot auth routes.
+     *
+     * @return void
+     */
+    protected function bootAuthRoutes()
+    {
+        Route::get('/_dusk/login/{userId}/{guard?}', [
+            'middleware' => 'web',
+            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@login',
+        ]);
+
+        Route::get('/_dusk/logout/{guard?}', [
+            'middleware' => 'web',
+            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@logout',
+        ]);
+
+        Route::get('/_dusk/user/{guard?}', [
+            'middleware' => 'web',
+            'uses' => 'Laravel\Dusk\Http\Controllers\UserController@user',
+        ]);
+    }
+
+    /**
+     * Boot faking routes.
+     *
+     * @return void
+     */
+    protected function bootFakingRoutes()
+    {
+        Route::get('/_dusk/fake/{facade}', [
+            'middleware' => 'web',
+            'uses' => 'Laravel\Dusk\Http\Controllers\FakingController@fake',
+        ]);
+
+        Route::get('/_dusk/get-fake/{facade}', [
+            'middleware' => 'web',
+            'uses' => 'Laravel\Dusk\Http\Controllers\FakingController@getFake',
+        ]);
     }
 }

src/Facades/Faking.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Laravel\Dusk\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * @see \Laravel\Dusk\Faking\FakingManager
+ * @see \Laravel\Dusk\Faking\Driver
+ */
+class Faking extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'faking';
+    }
+}

src/Faking/Driver.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Laravel\Dusk\Faking;
+
+use Symfony\Component\HttpFoundation\Response;
+
+abstract class Driver
+{
+    /**
+     * The array of active facade fakes.
+     *
+     * @var array
+     */
+    protected $fakes = [];
+
+    /**
+     * Start faking facades.
+     *
+     * @return void
+     */
+    public function start()
+    {
+        $this->loadFakes();
+
+        foreach ($this->fakes as $facade => $fake) {
+            $facade::swap($fake);
+        }
+    }
+
+    /**
+     * Save facades state.
+     *
+     * @param  \Symfony\Component\HttpFoundation\Response   $response
+     * @return void
+     */
+    public function save(Response $response)
+    {
+        $this->storeFakes($response);
+    }
+
+    /**
+     * Replace facade instance with a fake.
+     *
+     * @param  string   $facade
+     * @return void
+     */
+    public function fake(string $facade)
+    {
+        if (!$this->has($facade)) {
+            $fake = $this->createFake($facade);
+            $facade::swap($fake);
+            $this->fakes[$facade] = $fake;
+        }
+    }
+
+    /**
+     * Determine if a facade is being faked.
+     *
+     * @param  string   $facade
+     * @return boolean
+     */
+    public function has(string $facade)
+    {
+        return isset($this->fakes[$facade]);
+    }
+
+    /**
+     * Serialize a facade fake.
+     *
+     * @param  string   $facade
+     * @return string
+     */
+    public function serialize(string $facade)
+    {
+        return serialize($this->fakes[$facade]);
+    }
+
+    /**
+     * Deserialize a facade fake.
+     *
+     * @param  string   $serializedFake
+     * @return mixed
+     */
+    public function unserialize(string $serializedFake)
+    {
+        return unserialize($serializedFake);
+    }
+
+    /**
+    * Create a facade fake.
+    *
+    * @param $facade   string
+    * @return mixed
+    */
+    protected function createFake(string $facade)
+    {
+        $facade::fake();
+
+        return $facade::getFacadeRoot();
+    }
+
+    /**
+     * Load fakes from storage.
+     *
+     * @return void
+     */
+    protected abstract function loadFakes();
+
+    /**
+     * Store fakes.
+     *
+     * @param  \Symfony\Component\HttpFoundation\Response   $response
+     * @return void
+     */
+    protected abstract function storeFakes(Response $response);
+}

src/Faking/Drivers/CookiesDriver.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace Laravel\Dusk\Faking\Drivers;
+
+use Cookie;
+use Laravel\Dusk\Faking\Driver;
+use Symfony\Component\HttpFoundation\Response;
+
+class CookiesDriver extends Driver
+{
+    /**
+     * Name of the cookie used to serialize fakes.
+     *
+     * @var string
+     */
+    const COOKIE_NAME = 'Dusk-Facade-Fakes';
+
+    /**
+     * Load fakes from storage.
+     *
+     * @return void
+     */
+    protected function loadFakes()
+    {
+        $serializedFakes = Cookie::get(self::COOKIE_NAME, '{}');
+        $serializedFakes = json_decode($serializedFakes, true);
+
+        foreach ($serializedFakes as $facade => $serializedFake) {
+            $this->fakes[$facade] = $this->unserialize($serializedFake);
+        }
+    }
+
+    /**
+     * Store fakes.
+     *
+     * @param  \Symfony\Component\HttpFoundation\Response   $response
+     * @return void
+     */
+    protected function storeFakes(Response $response)
+    {
+        $serializedFakes = [];
+        foreach (array_keys($this->fakes) as $facade) {
+            $serializedFakes[$facade] = $this->serialize($facade);
+        }
+
+        $response->headers->setCookie(
+            Cookie::forever(
+                static::COOKIE_NAME,
+                json_encode($serializedFakes),
+                '/'
+            )
+        );
+    }
+}