From dcb382177765b30c4a2e941d196cdc14c5e33f68 Mon Sep 17 00:00:00 2001 From: Daniel Klabbers Date: Fri, 13 Apr 2018 07:13:10 +0200 Subject: [PATCH] part one of adding tests, updating core --- .editorconfig | 2 +- phpunit.xml | 5 +- src/Install/Console/DataProviderInterface.php | 2 + src/Install/Console/DefaultsDataProvider.php | 12 ++ src/Install/Console/FileDataProvider.php | 13 +- src/Install/Console/InstallCommand.php | 3 +- src/Install/Console/UserDataProvider.php | 5 + .../DefaultInstallationCommandTest.php | 51 ++++++ tests/Test/Concerns/CreatesForum.php | 150 ++++++++++++++++++ tests/Test/Concerns/MakesApiRequests.php | 31 ++++ .../Concerns/RetrievesAuthorizedUsers.php | 37 +++++ tests/Test/TestCase.php | 8 +- tests/tmp/public/assets/.gitkeep | 0 tests/tmp/storage/.gitkeep | 0 14 files changed, 310 insertions(+), 9 deletions(-) create mode 100644 tests/Install/DefaultInstallationCommandTest.php create mode 100644 tests/Test/Concerns/CreatesForum.php create mode 100644 tests/Test/Concerns/MakesApiRequests.php create mode 100644 tests/Test/Concerns/RetrievesAuthorizedUsers.php create mode 100644 tests/tmp/public/assets/.gitkeep create mode 100644 tests/tmp/storage/.gitkeep diff --git a/.editorconfig b/.editorconfig index 87694ddab..658a43499 100644 --- a/.editorconfig +++ b/.editorconfig @@ -15,5 +15,5 @@ indent_size = 2 [*.{diff,md}] trim_trailing_whitespace = false -[*.php] +[*.{php,xml}] indent_size = 4 diff --git a/phpunit.xml b/phpunit.xml index c16f17554..6bdd4b7c7 100644 --- a/phpunit.xml +++ b/phpunit.xml @@ -11,9 +11,12 @@ syntaxCheck="false"> + + ./tests/Install + ./tests + ./tests/Install - diff --git a/src/Install/Console/DataProviderInterface.php b/src/Install/Console/DataProviderInterface.php index 11fc191c1..9976598e2 100644 --- a/src/Install/Console/DataProviderInterface.php +++ b/src/Install/Console/DataProviderInterface.php @@ -20,4 +20,6 @@ interface DataProviderInterface public function getAdminUser(); public function getSettings(); + + public function isDebugMode(): bool; } diff --git a/src/Install/Console/DefaultsDataProvider.php b/src/Install/Console/DefaultsDataProvider.php index c14d3aabd..70f300071 100644 --- a/src/Install/Console/DefaultsDataProvider.php +++ b/src/Install/Console/DefaultsDataProvider.php @@ -23,6 +23,8 @@ class DefaultsDataProvider implements DataProviderInterface 'port' => '3306', ]; + protected $debug = false; + protected $baseUrl = 'http://flarum.local'; protected $adminUser = [ @@ -96,4 +98,14 @@ class DefaultsDataProvider implements DataProviderInterface { $this->settings[$key] = $value; } + + public function isDebugMode(): bool + { + return $this->debug; + } + + public function setDebugMode(bool $debug = true) + { + $this->debug = $debug; + } } diff --git a/src/Install/Console/FileDataProvider.php b/src/Install/Console/FileDataProvider.php index 17bb9c5e9..0eb8886f0 100644 --- a/src/Install/Console/FileDataProvider.php +++ b/src/Install/Console/FileDataProvider.php @@ -18,6 +18,7 @@ use Symfony\Component\Yaml\Yaml; class FileDataProvider implements DataProviderInterface { protected $default; + protected $debug = false; protected $baseUrl = null; protected $databaseConfiguration = []; protected $adminUser = []; @@ -44,10 +45,11 @@ class FileDataProvider implements DataProviderInterface } // Define configuration variables + $this->debug = $configuration['debug'] ?? false; $this->baseUrl = isset($configuration['baseUrl']) ? rtrim($configuration['baseUrl'], '/') : null; - $this->databaseConfiguration = isset($configuration['databaseConfiguration']) ? $configuration['databaseConfiguration'] : []; - $this->adminUser = isset($configuration['adminUser']) ? $configuration['adminUser'] : []; - $this->settings = isset($configuration['settings']) ? $configuration['settings'] : []; + $this->databaseConfiguration = $configuration['databaseConfiguration'] ?? []; + $this->adminUser = $configuration['adminUser'] ?? []; + $this->settings = $configuration['settings'] ?? []; } else { throw new Exception('Configuration file does not exist.'); } @@ -72,4 +74,9 @@ class FileDataProvider implements DataProviderInterface { return $this->settings + $this->default->getSettings(); } + + public function isDebugMode(): bool + { + return $this->debug; + } } diff --git a/src/Install/Console/InstallCommand.php b/src/Install/Console/InstallCommand.php index 1ce1a2c0a..f3137454e 100644 --- a/src/Install/Console/InstallCommand.php +++ b/src/Install/Console/InstallCommand.php @@ -138,6 +138,7 @@ class InstallCommand extends AbstractCommand protected function install() { try { + $this->debug = $this->dataSource->isDebugMode(); $this->dbConfig = $this->dataSource->getDatabaseConfiguration(); $validation = $this->getValidator()->make( @@ -214,7 +215,7 @@ class InstallCommand extends AbstractCommand $dbConfig = $this->dbConfig; $config = [ - 'debug' => false, + 'debug' => $this->debug, 'database' => [ 'driver' => $dbConfig['driver'], 'host' => $dbConfig['host'], diff --git a/src/Install/Console/UserDataProvider.php b/src/Install/Console/UserDataProvider.php index 529e9d8e8..a84df2050 100644 --- a/src/Install/Console/UserDataProvider.php +++ b/src/Install/Console/UserDataProvider.php @@ -109,4 +109,9 @@ class UserDataProvider implements DataProviderInterface return $this->questionHelper->ask($this->input, $this->output, $question); } + + public function isDebugMode(): bool + { + return false; + } } diff --git a/tests/Install/DefaultInstallationCommandTest.php b/tests/Install/DefaultInstallationCommandTest.php new file mode 100644 index 000000000..c09234ee3 --- /dev/null +++ b/tests/Install/DefaultInstallationCommandTest.php @@ -0,0 +1,51 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Flarum\Tests\Install; + +use Flarum\Install\Console\InstallCommand; +use Flarum\Install\InstallServiceProvider; +use Flarum\Tests\Test\TestCase; +use Flarum\User\User; +use Symfony\Component\Console\Input\StringInput; +use Symfony\Component\Console\Output\StreamOutput; + +class DefaultsInstallationCommandTest extends TestCase +{ + protected $isInstalled = false; + + /** + * @test + */ + public function allows_forum_installation() + { + if (file_exists($this->app->basePath().DIRECTORY_SEPARATOR.'config.php')) { + unlink($this->app->basePath().DIRECTORY_SEPARATOR.'config.php'); + } + + $this->app->register(InstallServiceProvider::class); + /** @var InstallCommand $command */ + $command = $this->app->make(InstallCommand::class); + $command->setDataSource($this->configuration); + + $body = fopen('php://temp', 'wb+'); + $input = new StringInput(''); + $output = new StreamOutput($body); + + $command->run($input, $output); + + $this->assertFileExists($this->app->basePath().DIRECTORY_SEPARATOR.'config.php'); + + $admin = $this->configuration->getAdminUser(); + + $this->assertEquals(User::find(1)->username, $admin['username']); + } +} diff --git a/tests/Test/Concerns/CreatesForum.php b/tests/Test/Concerns/CreatesForum.php new file mode 100644 index 000000000..6be88436d --- /dev/null +++ b/tests/Test/Concerns/CreatesForum.php @@ -0,0 +1,150 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Flarum\Tests\Test\Concerns; + +use Flarum\Database\Migrator; +use Flarum\Foundation\Application; +use Flarum\Foundation\Site; +use Flarum\Http\Server; +use Flarum\Install\Console\DataProviderInterface; +use Flarum\Install\Console\DefaultsDataProvider; +use Illuminate\Database\ConnectionInterface; +use Illuminate\Database\Schema\Builder; + +trait CreatesForum +{ + /** + * @var Server + */ + protected $http; + + /** + * @var Site + */ + protected $site; + + /** + * @var Application + */ + protected $app; + + /** + * @var DataProviderInterface + */ + protected $configuration; + + /** + * Make the test set up Flarum as an installed app. + * + * @var bool + */ + protected $isInstalled = true; + + protected function createsSite() + { + $this->site = (new Site) + ->setBasePath(__DIR__.'/../../tmp') + ->setPublicPath(__DIR__.'/../../tmp/public'); + } + + protected function createsHttpForum() + { + $this->http = Server::fromSite( + $this->site + ); + + $this->app = $this->http->app; + } + + protected function refreshApplication() + { + $this->createsSite(); + + $data = new DefaultsDataProvider(); + + $data->setDebugMode(); + $data->setSetting('mail_driver', 'log'); + + $database = $data->getDatabaseConfiguration(); + $database['database'] = env('DB_DATABASE', 'flarum'); + $database['username'] = env('DB_USERNAME', 'root'); + $database['password'] = env('DB_PASSWORD', ''); + $data->setDatabaseConfiguration($database); + + $this->configuration = $data; + + $this->setsApplicationConfiguration($data); + + $this->seedsApplication(); + + $this->createsHttpForum(); + } + + protected function teardownApplication() + { + /** @var ConnectionInterface $connection */ + $connection = $this->app->make(ConnectionInterface::class); + $connection->rollBack(); + } + + protected function setsApplicationConfiguration(DataProviderInterface $data) + { + if ($this->isInstalled) { + $dbConfig = $data->getDatabaseConfiguration(); + $this->site->setConfig( + $config = [ + 'debug' => $data->isDebugMode(), + 'database' => [ + 'driver' => $dbConfig['driver'], + 'host' => $dbConfig['host'], + 'database' => $dbConfig['database'], + 'username' => $dbConfig['username'], + 'password' => $dbConfig['password'], + 'charset' => 'utf8mb4', + 'collation' => 'utf8mb4_unicode_ci', + 'prefix' => $dbConfig['prefix'], + 'port' => $dbConfig['port'], + 'strict' => false + ], + 'url' => $data->getBaseUrl(), + 'paths' => [ + 'api' => 'api', + 'admin' => 'admin', + ], + ] + ); + } + } + + protected function seedsApplication() + { + if ($this->isInstalled) { + $app = app(\Illuminate\Contracts\Foundation\Application::class); + + $app->bind(Builder::class, function ($container) { + return $container->make(ConnectionInterface::class)->getSchemaBuilder(); + }); + + /** @var Migrator $migrator */ + $migrator = $app->make(Migrator::class); + if (! $migrator->getRepository()->repositoryExists()) { + $migrator->getRepository()->createRepository(); + } + + $migrator->run(__DIR__.'/../../../migrations'); + + /** @var ConnectionInterface $connection */ + $connection = $app->make(\Illuminate\Database\ConnectionInterface::class); + $connection->beginTransaction(); + } + } +} diff --git a/tests/Test/Concerns/MakesApiRequests.php b/tests/Test/Concerns/MakesApiRequests.php new file mode 100644 index 000000000..270e501fb --- /dev/null +++ b/tests/Test/Concerns/MakesApiRequests.php @@ -0,0 +1,31 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Flarum\Tests\Test\Concerns; + +use Flarum\Api\ApiServiceProvider; +use Flarum\Api\Client; +use Flarum\User\Guest; +use Flarum\User\User; +use Psr\Http\Message\ResponseInterface; + +trait MakesApiRequests +{ + public function call(string $controller, User $actor = null, array $queryParams = [], array $body = []): ResponseInterface + { + $this->app->register(ApiServiceProvider::class); + $this->app->make('flarum.api.middleware'); + /** @var Client $api */ + $api = $this->app->make(Client::class); + + return $api->send($controller, $actor ?? new Guest, $queryParams, $body); + } +} diff --git a/tests/Test/Concerns/RetrievesAuthorizedUsers.php b/tests/Test/Concerns/RetrievesAuthorizedUsers.php new file mode 100644 index 000000000..eb085b46f --- /dev/null +++ b/tests/Test/Concerns/RetrievesAuthorizedUsers.php @@ -0,0 +1,37 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Flarum\Tests\Test\Concerns; + +use Flarum\User\User; + +trait RetrievesAuthorizedUsers +{ + protected $userAttributes = [ + 'username' => 'normal', + 'password' => 'too-obscure', + 'email' => 'normal@machine.local' + ]; + + public function getAdminUser() + { + return User::find(1); + } + + public function getNormalUser() + { + User::unguard(); + + return User::firstOrCreate([ + 'username' => $this->userAttributes['username'] + ], $this->userAttributes); + } +} diff --git a/tests/Test/TestCase.php b/tests/Test/TestCase.php index b9f2459e2..dc5944fd9 100644 --- a/tests/Test/TestCase.php +++ b/tests/Test/TestCase.php @@ -16,15 +16,17 @@ use PHPUnit\Framework\TestCase as Test; abstract class TestCase extends Test { + use Concerns\CreatesForum, + Concerns\MakesApiRequests; + public function setUp() { - Mockery::close(); - + $this->refreshApplication(); $this->init(); } protected function init() { - // To be overloaded by children - saves having to do setUp/mockery::close every time + // .. allows implementation by children without the need to call the parent. } } diff --git a/tests/tmp/public/assets/.gitkeep b/tests/tmp/public/assets/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/tests/tmp/storage/.gitkeep b/tests/tmp/storage/.gitkeep new file mode 100644 index 000000000..e69de29bb