Fix up database creation and handling code for servers; ref #2447

tests/Integration/Services/Databases/DeployServerDatabaseServiceTest.php

@@ -0,0 +1,168 @@
+<?php
+
+namespace Pterodactyl\Tests\Integration\Services\Databases;
+
+use Mockery;
+use Pterodactyl\Models\Node;
+use InvalidArgumentException;
+use Pterodactyl\Models\Database;
+use Pterodactyl\Models\DatabaseHost;
+use Symfony\Component\VarDumper\Cloner\Data;
+use Pterodactyl\Tests\Integration\IntegrationTestCase;
+use Pterodactyl\Services\Databases\DatabaseManagementService;
+use Pterodactyl\Services\Databases\DeployServerDatabaseService;
+use Pterodactyl\Exceptions\Service\Database\NoSuitableDatabaseHostException;
+
+class DeployServerDatabaseServiceTest extends IntegrationTestCase
+{
+    /** @var \Mockery\MockInterface */
+    private $managementService;
+
+    /**
+     * Setup tests.
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->managementService = Mockery::mock(DatabaseManagementService::class);
+        $this->swap(DatabaseManagementService::class, $this->managementService);
+    }
+
+    /**
+     * Ensure we reset the config to the expected value.
+     */
+    protected function tearDown(): void
+    {
+        config()->set('pterodactyl.client_features.databases.allow_random', true);
+
+        Database::query()->delete();
+        DatabaseHost::query()->delete();
+
+        parent::tearDown();
+    }
+
+    /**
+     * Test that an error is thrown if either the database name or the remote host are empty.
+     *
+     * @param array $data
+     * @dataProvider invalidDataProvider
+     */
+    public function testErrorIsThrownIfDatabaseNameIsEmpty($data)
+    {
+        $server = $this->createServerModel();
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessageMatches('/^Expected a non-empty value\. Got: /',);
+        $this->getService()->handle($server, $data);
+    }
+
+    /**
+     * Test that an error is thrown if there are no database hosts on the same node as the
+     * server and the allow_random config value is false.
+     */
+    public function testErrorIsThrownIfNoDatabaseHostsExistOnNode()
+    {
+        $server = $this->createServerModel();
+
+        $node = factory(Node::class)->create(['location_id' => $server->location->id]);
+        factory(DatabaseHost::class)->create(['node_id' => $node->id]);
+
+        config()->set('pterodactyl.client_features.databases.allow_random', false);
+
+        $this->expectException(NoSuitableDatabaseHostException::class);
+
+        $this->getService()->handle($server, [
+            'database' => 'something',
+            'remote' => '%',
+        ]);
+    }
+
+    /**
+     * Test that an error is thrown if no database hosts exist at all on the system.
+     */
+    public function testErrorIsThrownIfNoDatabaseHostsExistOnSystem()
+    {
+        $server = $this->createServerModel();
+
+        $this->expectException(NoSuitableDatabaseHostException::class);
+
+        $this->getService()->handle($server, [
+            'database' => 'something',
+            'remote' => '%',
+        ]);
+    }
+
+    /**
+     * Test that a database host on the same node as the server is preferred.
+     */
+    public function testDatabaseHostOnSameNodeIsPreferred()
+    {
+        $server = $this->createServerModel();
+
+        $node = factory(Node::class)->create(['location_id' => $server->location->id]);
+        factory(DatabaseHost::class)->create(['node_id' => $node->id]);
+        $host = factory(DatabaseHost::class)->create(['node_id' => $server->node_id]);
+
+        $this->managementService->expects('create')->with($server, [
+            'database_host_id' => $host->id,
+            'database' => "s{$server->id}_something",
+            'remote' => '%',
+        ])->andReturns(new Database);
+
+        $response = $this->getService()->handle($server, [
+            'database' => 'something',
+            'remote' => '%',
+        ]);
+
+        $this->assertInstanceOf(Database::class, $response);
+    }
+
+    /**
+     * Test that a database host not assigned to the same node as the server is used if
+     * there are no same-node hosts and the allow_random configuration value is set to
+     * true.
+     */
+    public function testDatabaseHostIsSelectedIfNoSuitableHostExistsOnSameNode()
+    {
+        $server = $this->createServerModel();
+
+        $node = factory(Node::class)->create(['location_id' => $server->location->id]);
+        $host = factory(DatabaseHost::class)->create(['node_id' => $node->id]);
+
+        $this->managementService->expects('create')->with($server, [
+            'database_host_id' => $host->id,
+            'database' => "s{$server->id}_something",
+            'remote' => '%',
+        ])->andReturns(new Database);
+
+        $response = $this->getService()->handle($server, [
+            'database' => 'something',
+            'remote' => '%',
+        ]);
+
+        $this->assertInstanceOf(Database::class, $response);
+    }
+
+    /**
+     * @return array
+     */
+    public function invalidDataProvider(): array
+    {
+        return [
+            [['remote' => '%']],
+            [['database' => null, 'remote' => '%']],
+            [['database' => '', 'remote' => '%']],
+            [['database' => '']],
+            [['database' => '', 'remote' => '']],
+        ];
+    }
+
+    /**
+     * @return \Pterodactyl\Services\Databases\DeployServerDatabaseService
+     */
+    private function getService()
+    {
+        return $this->app->make(DeployServerDatabaseService::class);
+    }
+}