Tests for RemoteRequestController

app/Http/Controllers/Server/Files/RemoteRequestController.php

@@ -110,14 +110,11 @@ class RemoteRequestController extends Controller
                 ->getDirectory($requestDirectory);
         } catch (RequestException $exception) {
             $this->writer->warning($exception);
+            $response = $exception->getResponse();
 
-            if (! is_null($exception->getResponse())) {
+            return response()->json(['error' => trans('exceptions.daemon_connection_failed', [
-                return response()->json(
+                'code' => is_null($response) ? 'E_CONN_REFUSED' : $response->getStatusCode(),
-                    ['error' => $exception->getResponse()->getBody()], $exception->getResponse()->getStatusCode()
+            ])], 500);
-                );
-            } else {
-                return response()->json(['error' => trans('server.files.exceptions.list_directory')], 500);
-            }
         }
 
         return view('server.files.list', [
@@ -151,16 +148,12 @@ class RemoteRequestController extends Controller
 
             return response('', 204);
         } catch (RequestException $exception) {
-            $response = $exception->getResponse();
             $this->writer->warning($exception);
+            $response = $exception->getResponse();
 
-            if (! is_null($response)) {
-                return response()->json(['error' => $response->getBody()], $response->getStatusCode());
-            } else {
             return response()->json(['error' => trans('exceptions.daemon_connection_failed', [
                 'code' => is_null($response) ? 'E_CONN_REFUSED' : $response->getStatusCode(),
             ])], 500);
         }
     }
 }
-}

resources/lang/en/server.php

@@ -206,7 +206,6 @@ return [
         'exceptions' => [
             'invalid_mime' => 'This type of file cannot be edited via the Panel\'s built-in editor.',
             'max_size' => 'This file is too large to edit via the Panel\'s built-in editor.',
-            'list_directory' => 'An error was encountered while attempting to get the contents of this directory. Please try again.',
         ],
         'header' => 'File Manager',
         'header_sub' => 'Manage all of your files directly from the web.',

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

@@ -0,0 +1,189 @@
+<?php
+/*
+ * Pterodactyl - Panel
+ * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace Tests\Unit\Http\Controllers\Server\Files;
+
+use GuzzleHttp\Exception\RequestException;
+use Illuminate\Contracts\Config\Repository;
+use Illuminate\Contracts\Session\Session;
+use Illuminate\Http\Request;
+use Illuminate\Log\Writer;
+use Mockery as m;
+use Pterodactyl\Contracts\Repository\Daemon\FileRepositoryInterface;
+use Pterodactyl\Http\Controllers\Server\Files\RemoteRequestController;
+use Pterodactyl\Models\Server;
+use Tests\Assertions\ControllerAssertionsTrait;
+use Tests\TestCase;
+
+class RemoteRequestControllerTest extends TestCase
+{
+    use ControllerAssertionsTrait;
+
+    /**
+     * @var \Illuminate\Contracts\Config\Repository
+     */
+    protected $config;
+
+    /**
+     * @var \Pterodactyl\Http\Controllers\Server\Files\RemoteRequestController
+     */
+    protected $controller;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\Daemon\FileRepositoryInterface
+     */
+    protected $fileRepository;
+
+    /**
+     * @var \Illuminate\Http\Request
+     */
+    protected $request;
+
+    /**
+     * @var \Illuminate\Contracts\Session\Session
+     */
+    protected $session;
+
+    /**
+     * @var \Illuminate\Log\Writer
+     */
+    protected $writer;
+
+    /**
+     * Setup tests.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->config = m::mock(Repository::class);
+        $this->fileRepository = m::mock(FileRepositoryInterface::class);
+        $this->request = m::mock(Request::class);
+        $this->session = m::mock(Session::class);
+        $this->writer = m::mock(Writer::class);
+
+        $this->controller = m::mock(RemoteRequestController::class, [
+            $this->config,
+            $this->fileRepository,
+            $this->session,
+            $this->writer,
+        ])->makePartial();
+    }
+
+    /**
+     * Test the directory listing controller.
+     */
+    public function testDirectoryController()
+    {
+        $server = factory(Server::class)->make();
+
+        $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
+        $this->controller->shouldReceive('authorize')->with('list-files', $server)->once()->andReturnNull();
+        $this->request->shouldReceive('input')->with('directory', '/')->once()->andReturn('/');
+        $this->session->shouldReceive('get')->with('server_data.token')->once()->andReturn($server->daemonSecret);
+        $this->fileRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
+            ->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
+            ->shouldReceive('setAccessToken')->with($server->daemonSecret)->once()->andReturnSelf()
+            ->shouldReceive('getDirectory')->with('/')->once()->andReturn(['folders' => 1, 'files' => 2]);
+        $this->config->shouldReceive('get')->with('pterodactyl.files.editable')->once()->andReturn([]);
+
+        $response = $this->controller->directory($this->request);
+        $this->assertIsViewResponse($response);
+        $this->assertViewNameEquals('server.files.list', $response);
+        $this->assertViewHasKey('files', $response);
+        $this->assertViewHasKey('folders', $response);
+        $this->assertViewHasKey('editableMime', $response);
+        $this->assertViewHasKey('directory', $response);
+        $this->assertViewKeyEquals('files', 2, $response);
+        $this->assertViewKeyEquals('folders', 1, $response);
+        $this->assertViewKeyEquals('editableMime', [], $response);
+        $this->assertViewKeyEquals('directory.first', false, $response);
+        $this->assertViewKeyEquals('directory.header', '', $response);
+    }
+
+    /**
+     * Test that the controller properly handles an exception thrown by the daemon conneciton.
+     */
+    public function testExceptionThrownByDaemonConnectionIsHandledByDisplayController()
+    {
+        $server = factory(Server::class)->make();
+        $exception = m::mock(RequestException::class);
+
+        $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
+        $this->controller->shouldReceive('authorize')->with('list-files', $server)->once()->andReturnNull();
+        $this->request->shouldReceive('input')->with('directory', '/')->once()->andReturn('/');
+        $this->fileRepository->shouldReceive('setNode')->with($server->node_id)->once()->andThrow($exception);
+
+        $this->writer->shouldReceive('warning')->with($exception)->once()->andReturnNull();
+        $exception->shouldReceive('getResponse')->withNoArgs()->once()->andReturnNull();
+
+        $response = $this->controller->directory($this->request);
+        $this->assertIsJsonResponse($response);
+        $this->assertResponseJsonEquals(['error' => trans('exceptions.daemon_connection_failed', ['code' => 'E_CONN_REFUSED'])], $response);
+        $this->assertResponseCodeEquals(500, $response);
+    }
+
+    /**
+     * Test the store controller.
+     */
+    public function testStoreController()
+    {
+        $server = factory(Server::class)->make();
+
+        $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
+        $this->controller->shouldReceive('authorize')->with('save-files', $server)->once()->andReturnNull();
+        $this->session->shouldReceive('get')->with('server_data.token')->once()->andReturn($server->daemonSecret);
+        $this->request->shouldReceive('input')->with('file')->once()->andReturn('file.txt');
+        $this->request->shouldReceive('input')->with('contents')->once()->andReturn('file contents');
+        $this->fileRepository->shouldReceive('setNode')->with($server->node_id)->once()->andReturnSelf()
+            ->shouldReceive('setAccessServer')->with($server->uuid)->once()->andReturnSelf()
+            ->shouldReceive('setAccessToken')->with($server->daemonSecret)->once()->andReturnSelf()
+            ->shouldReceive('putContent')->with('file.txt', 'file contents')->once()->andReturnNull();
+
+        $response = $this->controller->store($this->request, '1234');
+        $this->assertIsResponse($response);
+        $this->assertResponseCodeEquals(204, $response);
+    }
+
+    /**
+     * Test that the controller properly handles an exception thrown by the daemon conneciton.
+     */
+    public function testExceptionThrownByDaemonConnectionIsHandledByStoreController()
+    {
+        $server = factory(Server::class)->make();
+        $exception = m::mock(RequestException::class);
+
+        $this->session->shouldReceive('get')->with('server_data.model')->once()->andReturn($server);
+        $this->controller->shouldReceive('authorize')->with('save-files', $server)->once()->andReturnNull();
+        $this->fileRepository->shouldReceive('setNode')->with($server->node_id)->once()->andThrow($exception);
+
+        $this->writer->shouldReceive('warning')->with($exception)->once()->andReturnNull();
+        $exception->shouldReceive('getResponse')->withNoArgs()->once()->andReturnNull();
+
+        $response = $this->controller->store($this->request, '1234');
+        $this->assertIsJsonResponse($response);
+        $this->assertResponseJsonEquals(['error' => trans('exceptions.daemon_connection_failed', ['code' => 'E_CONN_REFUSED'])], $response);
+        $this->assertResponseCodeEquals(500, $response);
+    }
+}