Fix multiple controller unit test failures

Author: DaneEveritt

app/Http/Controllers/Server/SubuserController.php

@@ -128,7 +128,7 @@ public function view(Request $request): View
      */
     public function update(SubuserUpdateFormRequest $request, string $uuid, string $hash): RedirectResponse
     {
-        $this->subuserUpdateService->handle($request->attributes->get('subuser'), $request->input('permissions'));
+        $this->subuserUpdateService->handle($request->attributes->get('subuser'), $request->input('permissions', []));
         $this->alert->success(trans('server.users.user_updated'))->flash();
 
         return redirect()->route('server.subusers.view', ['uuid' => $uuid, 'subuser' => $hash]);
@@ -154,7 +154,6 @@ public function create(Request $request): View
      * Handles creating a new subuser.
      *
      * @param \Pterodactyl\Http\Requests\Server\Subuser\SubuserStoreFormRequest $request
-     * @param string                                                            $uuid
      * @return \Illuminate\Http\RedirectResponse
      *
      * @throws \Exception
@@ -164,15 +163,15 @@ public function create(Request $request): View
      * @throws \Pterodactyl\Exceptions\Service\Subuser\ServerSubuserExistsException
      * @throws \Pterodactyl\Exceptions\Service\Subuser\UserIsServerOwnerException
      */
-    public function store(SubuserStoreFormRequest $request, $uuid): RedirectResponse
+    public function store(SubuserStoreFormRequest $request): RedirectResponse
     {
         $server = $request->attributes->get('server');
 
-        $subuser = $this->subuserCreationService->handle($server, $request->input('email'), $request->input('permissions'));
+        $subuser = $this->subuserCreationService->handle($server, $request->input('email'), $request->input('permissions', []));
         $this->alert->success(trans('server.users.user_assigned'))->flash();
 
         return redirect()->route('server.subusers.view', [
-            'uuid' => $uuid,
+            'uuid' => $server->uuid,
             'id' => $subuser->id,
         ]);
     }

tests/Traits/Http/RequestMockHelpers.php

@@ -0,0 +1,73 @@
+<?php
+
+namespace Tests\Traits\Http;
+
+use Mockery as m;
+use Illuminate\Http\Request;
+use Pterodactyl\Models\User;
+use InvalidArgumentException;
+use Symfony\Component\HttpFoundation\ParameterBag;
+
+trait RequestMockHelpers
+{
+    /**
+     * @var string
+     */
+    private $requestMockClass = Request::class;
+
+    /**
+     * @var \Illuminate\Http\Request|\Mockery\Mock
+     */
+    protected $request;
+
+    /**
+     * Set the class to mock for requests.
+     *
+     * @param string $class
+     */
+    public function setRequestMockClass(string $class)
+    {
+        $this->requestMockClass = $class;
+
+        $this->buildRequestMock();
+    }
+
+    /**
+     * Set the active request object to be an instance of a mocked request.
+     */
+    protected function buildRequestMock()
+    {
+        $this->request = m::mock($this->requestMockClass);
+        if (! $this->request instanceof Request) {
+            throw new InvalidArgumentException('First argument passed to buildRequestMock must be an instance of \Illuminate\Http\Request when mocked.');
+        }
+
+        $this->request->attributes = new ParameterBag();
+    }
+
+    /**
+     * Set a request attribute on the mock object.
+     *
+     * @param string $attribute
+     * @param mixed  $value
+     */
+    protected function setRequestAttribute(string $attribute, $value)
+    {
+        $this->request->attributes->set($attribute, $value);
+    }
+
+    /**
+     * Sets the mocked request user. If a user model is not provided, a factory model
+     * will be created and returned.
+     *
+     * @param \Pterodactyl\Models\User|null $user
+     * @return \Pterodactyl\Models\User
+     */
+    protected function setRequestUser(User $user = null): User
+    {
+        $user = $user instanceof User ? $user : factory(User::class)->make();
+        $this->request->shouldReceive('user')->withNoArgs()->andReturn($user);
+
+        return $user;
+    }
+}

tests/Unit/Http/Controllers/ControllerTestCase.php

@@ -0,0 +1,86 @@
+<?php
+
+namespace Tests\Unit\Http\Controllers;
+
+use Mockery as m;
+use Tests\TestCase;
+use Tests\Traits\Http\RequestMockHelpers;
+use Tests\Assertions\ControllerAssertionsTrait;
+
+abstract class ControllerTestCase extends TestCase
+{
+    use ControllerAssertionsTrait, RequestMockHelpers;
+
+    /**
+     * @var \Pterodactyl\Http\Controllers\Controller|\Mockery\Mock
+     */
+    private $controller;
+
+    /**
+     * Setup tests.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->buildRequestMock();
+    }
+
+    /**
+     * Set an instance of the controller.
+     *
+     * @param \Pterodactyl\Http\Controllers\Controller|\Mockery\Mock $controller
+     */
+    public function setControllerInstance($controller)
+    {
+        $this->controller = $controller;
+    }
+
+    /**
+     * Return an instance of the controller.
+     *
+     * @return \Mockery\Mock|\Pterodactyl\Http\Controllers\Controller
+     */
+    public function getControllerInstance()
+    {
+        return $this->controller;
+    }
+
+    /**
+     * Helper function to mock injectJavascript requests.
+     *
+     * @param array|null $args
+     * @param bool       $subset
+     */
+    protected function mockInjectJavascript(array $args = null, bool $subset = false)
+    {
+        $controller = $this->getControllerInstance();
+
+        $controller->shouldReceive('setRequest')->with($this->request)->once()->andReturnSelf();
+        if (is_null($args)) {
+            $controller->shouldReceive('injectJavascript')->withAnyArgs()->once()->andReturnNull();
+        } else {
+            $with = $subset ? m::subset($args) : $args;
+
+            $controller->shouldReceive('injectJavascript')->with($with)->once()->andReturnNull();
+        }
+    }
+
+    /**
+     * Build and return a mocked controller instance to use for testing.
+     *
+     * @param string $class
+     * @param array  $args
+     * @return \Mockery\Mock|\Pterodactyl\Http\Controllers\Controller
+     */
+    protected function buildMockedController(string $class, array $args = [])
+    {
+        $controller = m::mock($class, $args)->makePartial();
+
+        if (is_null($this->getControllerInstance())) {
+            $this->setControllerInstance($controller);
+        }
+
+        return $this->getControllerInstance();
+    }
+}

tests/Unit/Http/Controllers/Server/ConsoleControllerTest.php

@@ -10,32 +10,18 @@
 namespace Tests\Unit\Http\Controllers\Server;
 
 use Mockery as m;
-use Tests\TestCase;
 use Pterodactyl\Models\Server;
-use Illuminate\Contracts\Session\Session;
 use Illuminate\Contracts\Config\Repository;
-use Tests\Assertions\ControllerAssertionsTrait;
+use Tests\Unit\Http\Controllers\ControllerTestCase;
 use Pterodactyl\Http\Controllers\Server\ConsoleController;
 
-class ConsoleControllerTest extends TestCase
+class ConsoleControllerTest extends ControllerTestCase
 {
-    use ControllerAssertionsTrait;
-
     /**
-     * @var \Illuminate\Contracts\Config\Repository
+     * @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
      */
     protected $config;
 
-    /**
-     * @var \Pterodactyl\Http\Controllers\Server\ConsoleController
-     */
-    protected $controller;
-
-    /**
-     * @var \Illuminate\Contracts\Session\Session
-     */
-    protected $session;
-
     /**
      * Setup tests.
      */
@@ -44,9 +30,6 @@ public function setUp()
         parent::setUp();
 
         $this->config = m::mock(Repository::class);
-        $this->session = m::mock(Session::class);
-
-        $this->controller = m::mock(ConsoleController::class, [$this->config, $this->session])->makePartial();
     }
 
     /**
@@ -56,16 +39,15 @@ public function setUp()
      */
     public function testAllControllers($function, $view)
     {
+        $controller = $this->getController();
         $server = factory(Server::class)->make();
+        $this->setRequestAttribute('server', $server);
+        $this->mockInjectJavascript();
 
-        if ($function === 'index') {
-            $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
-        }
         $this->config->shouldReceive('get')->with('pterodactyl.console.count')->once()->andReturn(100);
         $this->config->shouldReceive('get')->with('pterodactyl.console.frequency')->once()->andReturn(10);
-        $this->controller->shouldReceive('injectJavascript')->once()->andReturnNull();
 
-        $response = $this->controller->$function();
+        $response = $controller->$function($this->request);
         $this->assertIsViewResponse($response);
         $this->assertViewNameEquals($view, $response);
     }
@@ -82,4 +64,14 @@ public function controllerDataProvider()
             ['console', 'server.console'],
         ];
     }
+
+    /**
+     * Return a mocked instance of the controller to allow access to authorization functionality.
+     *
+     * @return \Pterodactyl\Http\Controllers\Server\ConsoleController|\Mockery\Mock
+     */
+    private function getController()
+    {
+        return $this->buildMockedController(ConsoleController::class, [$this->config]);
+    }
 }

tests/Unit/Http/Controllers/Server/Files/DownloadControllerTest.php

@@ -10,34 +10,22 @@
 namespace Tests\Unit\Http\Controllers\Server\Files;
 
 use Mockery as m;
-use Tests\TestCase;
 use phpmock\phpunit\PHPMock;
 use Pterodactyl\Models\Node;
 use Pterodactyl\Models\Server;
 use Illuminate\Cache\Repository;
-use Illuminate\Contracts\Session\Session;
-use Tests\Assertions\ControllerAssertionsTrait;
+use Tests\Unit\Http\Controllers\ControllerTestCase;
 use Pterodactyl\Http\Controllers\Server\Files\DownloadController;
 
-class DownloadControllerTest extends TestCase
+class DownloadControllerTest extends ControllerTestCase
 {
-    use ControllerAssertionsTrait, PHPMock;
+    use PHPMock;
 
     /**
-     * @var \Illuminate\Cache\Repository
+     * @var \Illuminate\Cache\Repository|\Mockery\Mock
      */
     protected $cache;
 
-    /**
-     * @var \Pterodactyl\Http\Controllers\Server\Files\DownloadController
-     */
-    protected $controller;
-
-    /**
-     * @var \Illuminate\Contracts\Session\Session
-     */
-    protected $session;
-
     /**
      * Setup tests.
      */
@@ -46,32 +34,40 @@ public function setUp()
         parent::setUp();
 
         $this->cache = m::mock(Repository::class);
-        $this->session = m::mock(Session::class);
-
-        $this->controller = m::mock(DownloadController::class, [$this->cache, $this->session])->makePartial();
     }
 
     /**
      * Test the download controller redirects correctly.
      */
     public function testIndexController()
     {
+        $controller = $this->getController();
         $server = factory(Server::class)->make();
-        $node = factory(Node::class)->make();
-        $server->node = $node;
+        $server->setRelation('node', factory(Node::class)->make());
 
-        $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
-        $this->controller->shouldReceive('authorize')->with('download-files', $server)->once()->andReturnNull();
+        $this->setRequestAttribute('server', $server);
+
+        $controller->shouldReceive('authorize')->with('download-files', $server)->once()->andReturnNull();
         $this->getFunctionMock('\\Pterodactyl\\Http\\Controllers\\Server\\Files', 'str_random')
             ->expects($this->once())->willReturn('randomString');
 
-        $this->cache->shouldReceive('tags')->with(['Server:Downloads'])->once()->andReturnSelf()
-            ->shouldReceive('put')->with('randomString', ['server' => $server->uuid, 'path' => '/my/file.txt'], 5)->once()->andReturnNull();
+        $this->cache->shouldReceive('tags')->with(['Server:Downloads'])->once()->andReturnSelf();
+        $this->cache->shouldReceive('put')->with('randomString', ['server' => $server->uuid, 'path' => '/my/file.txt'], 5)->once()->andReturnNull();
 
-        $response = $this->controller->index('1234', '/my/file.txt');
+        $response = $controller->index($this->request, $server->uuidShort, '/my/file.txt');
         $this->assertIsRedirectResponse($response);
         $this->assertRedirectUrlEquals(sprintf(
             '%s://%s:%s/v1/server/file/download/%s', $server->node->scheme, $server->node->fqdn, $server->node->daemonListen, 'randomString'
         ), $response);
     }
+
+    /**
+     * Return a mocked instance of the controller to allow access to authorization functionality.
+     *
+     * @return \Pterodactyl\Http\Controllers\Server\Files\DownloadController|\Mockery\Mock
+     */
+    private function getController()
+    {
+        return $this->buildMockedController(DownloadController::class, [$this->cache]);
+    }
 }