Merge branch 'feature/api-integration-testing' into develop

Author: DaneEveritt

.env.travis

@@ -5,10 +5,10 @@ APP_THEME=pterodactyl
 APP_TIMEZONE=UTC
 APP_URL=http://localhost/
 
-DB_HOST=127.0.0.1
-DB_DATABASE=travis
-DB_USERNAME=root
-DB_PASSWORD=""
+TESTING_DB_HOST=127.0.0.1
+TESTING_DB_DATABASE=travis
+TESTING_DB_USERNAME=root
+TESTING_DB_PASSWORD=""
 
 CACHE_DRIVER=array
 SESSION_DRIVER=array

.travis.yml

@@ -14,9 +14,9 @@ before_script:
   - echo 'opcache.enable_cli=1' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
   - cp .env.travis .env
   - travis_retry composer install --no-interaction --prefer-dist --no-suggest
-  - php artisan migrate --seed
 script:
-  - vendor/bin/phpunit --coverage-clover coverage.xml
+  - vendor/bin/phpunit --bootstrap vendor/autoload.php --coverage-clover coverage.xml tests/Unit
+  - vendor/bin/phpunit tests/Integration
 notifications:
   email: false
   webhooks:

app/Exceptions/Handler.php

@@ -17,6 +17,13 @@
 
 class Handler extends ExceptionHandler
 {
+    /**
+     * Laravel's validation parser formats custom rules using the class name
+     * resulting in some weird rule names. This string will be parsed out and
+     * replaced with 'p_' in the response code.
+     */
+    private const PTERODACTYL_RULE_STRING = 'pterodactyl\_rules\_';
+
     /**
      * A list of the exception types that should not be reported.
      *
@@ -156,7 +163,9 @@ public function invalidJson($request, ValidationException $exception)
             $response = [];
             foreach ($errors as $key => $error) {
                 $response[] = [
-                    'code' => array_get($codes, str_replace('.', '_', $field) . '.' . $key),
+                    'code' => str_replace(self::PTERODACTYL_RULE_STRING, 'p_', array_get(
+                        $codes, str_replace('.', '_', $field) . '.' . $key
+                    )),
                     'detail' => $error,
                     'source' => ['field' => $field],
                 ];

app/Services/Helpers/TemporaryPasswordService.php

@@ -9,19 +9,14 @@
 
 namespace Pterodactyl\Services\Helpers;
 
+use Ramsey\Uuid\Uuid;
 use Illuminate\Contracts\Hashing\Hasher;
 use Illuminate\Database\ConnectionInterface;
-use Illuminate\Contracts\Config\Repository as ConfigRepository;
 
 class TemporaryPasswordService
 {
     const HMAC_ALGO = 'sha256';
 
-    /**
-     * @var \Illuminate\Contracts\Config\Repository
-     */
-    protected $config;
-
     /**
      * @var \Illuminate\Database\ConnectionInterface
      */
@@ -35,16 +30,11 @@ class TemporaryPasswordService
     /**
      * TemporaryPasswordService constructor.
      *
-     * @param \Illuminate\Contracts\Config\Repository  $config
      * @param \Illuminate\Database\ConnectionInterface $connection
      * @param \Illuminate\Contracts\Hashing\Hasher     $hasher
      */
-    public function __construct(
-        ConfigRepository $config,
-        ConnectionInterface $connection,
-        Hasher $hasher
-    ) {
-        $this->config = $config;
+    public function __construct(ConnectionInterface $connection, Hasher $hasher)
+    {
         $this->connection = $connection;
         $this->hasher = $hasher;
     }
@@ -57,7 +47,7 @@ public function __construct(
      */
     public function handle($email)
     {
-        $token = hash_hmac(self::HMAC_ALGO, str_random(40), $this->config->get('app.key'));
+        $token = hash_hmac(self::HMAC_ALGO, Uuid::uuid4()->toString(), config('app.key'));
 
         $this->connection->table('password_resets')->insert([
             'email' => $email,

app/Transformers/Api/Application/BaseTransformer.php

@@ -5,10 +5,15 @@
 use Cake\Chronos\Chronos;
 use Pterodactyl\Models\ApiKey;
 use Illuminate\Container\Container;
+use Illuminate\Database\Eloquent\Model;
 use League\Fractal\TransformerAbstract;
 use Pterodactyl\Services\Acl\Api\AdminAcl;
+use Pterodactyl\Transformers\Api\Client\BaseClientTransformer;
 use Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException;
 
+/**
+ * @method array transform(Model $model)
+ */
 abstract class BaseTransformer extends TransformerAbstract
 {
     const RESPONSE_TIMEZONE = 'UTC';
@@ -88,7 +93,7 @@ protected function makeTransformer(string $abstract, array $parameters = [])
         $transformer = Container::getInstance()->makeWith($abstract, $parameters);
         $transformer->setKey($this->getKey());
 
-        if (! $transformer instanceof self) {
+        if (! $transformer instanceof self || $transformer instanceof BaseClientTransformer) {
             throw new InvalidTransformerLevelException('Calls to ' . __METHOD__ . ' must return a transformer that is an instance of ' . __CLASS__);
         }
 

app/Transformers/Api/Application/EggTransformer.php

@@ -46,10 +46,10 @@ public function transform(Egg $model)
             'description' => $model->description,
             'docker_image' => $model->docker_image,
             'config' => [
-                'files' => json_decode($model->config_files),
-                'startup' => json_decode($model->config_startup),
+                'files' => json_decode($model->config_files, true),
+                'startup' => json_decode($model->config_startup, true),
                 'stop' => $model->config_stop,
-                'logs' => json_decode($model->config_logs),
+                'logs' => json_decode($model->config_logs, true),
                 'extends' => $model->config_from,
             ],
             'startup' => $model->startup,

app/Transformers/Api/Application/LocationTransformer.php

@@ -32,14 +32,22 @@ public function getResourceName(): string
      */
     public function transform(Location $location): array
     {
-        return $location->toArray();
+        return [
+            'id' => $location->id,
+            'short' => $location->short,
+            'long' => $location->long,
+            $location->getUpdatedAtColumn() => $this->formatTimestamp($location->updated_at),
+            $location->getCreatedAtColumn() => $this->formatTimestamp($location->created_at),
+        ];
     }
 
     /**
      * Return the nodes associated with this location.
      *
      * @param \Pterodactyl\Models\Location $location
      * @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
+     *
+     * @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
      */
     public function includeServers(Location $location)
     {
@@ -57,6 +65,8 @@ public function includeServers(Location $location)
      *
      * @param \Pterodactyl\Models\Location $location
      * @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
+     *
+     * @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
      */
     public function includeNodes(Location $location)
     {

app/Transformers/Api/Application/NestTransformer.php

@@ -4,6 +4,7 @@
 
 use Pterodactyl\Models\Egg;
 use Pterodactyl\Models\Nest;
+use Pterodactyl\Models\Server;
 use Pterodactyl\Services\Acl\Api\AdminAcl;
 
 class NestTransformer extends BaseTransformer
@@ -49,6 +50,8 @@ public function transform(Nest $model)
      *
      * @param \Pterodactyl\Models\Nest $model
      * @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
+     *
+     * @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
      */
     public function includeEggs(Nest $model)
     {
@@ -60,4 +63,23 @@ public function includeEggs(Nest $model)
 
         return $this->collection($model->getRelation('eggs'), $this->makeTransformer(EggTransformer::class), Egg::RESOURCE_NAME);
     }
+
+    /**
+     * Include the servers relationship on the given Nest model.
+     *
+     * @param \Pterodactyl\Models\Nest $model
+     * @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
+     *
+     * @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
+     */
+    public function includeServers(Nest $model)
+    {
+        if (! $this->authorize(AdminAcl::RESOURCE_SERVERS)) {
+            return $this->null();
+        }
+
+        $model->loadMissing('servers');
+
+        return $this->collection($model->getRelation('servers'), $this->makeTransformer(ServerTransformer::class), Server::RESOURCE_NAME);
+    }
 }

app/Transformers/Api/Application/UserTransformer.php

@@ -53,6 +53,8 @@ public function transform(User $user): array
      *
      * @param \Pterodactyl\Models\User $user
      * @return \League\Fractal\Resource\Collection|\League\Fractal\Resource\NullResource
+     *
+     * @throws \Pterodactyl\Exceptions\Transformer\InvalidTransformerLevelException
      */
     public function includeServers(User $user)
     {

bootstrap/tests.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Contracts\Console\Kernel;
+use Symfony\Component\Console\Output\ConsoleOutput;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$app = require __DIR__ . '/app.php';
+
+/** @var \Pterodactyl\Console\Kernel $kernel */
+$kernel = $app->make(Kernel::class);
+
+/**
+ * Bootstrap the kernel and prepare application for testing.
+ */
+$kernel->bootstrap();
+
+$output = new ConsoleOutput;
+
+/**
+ * Perform database migrations and reseeding before continuing with
+ * running the tests.
+ */
+$output->writeln(PHP_EOL . '<comment>Refreshing database for Integration tests...</comment>');
+$kernel->call('migrate:fresh', ['--database' => 'testing']);
+
+$output->writeln('<comment>Seeding database for Integration tests...</comment>' . PHP_EOL);
+$kernel->call('db:seed', ['--database' => 'testing']);