class TestSiteApplicationTest
Same name in this branch
- 11.x core/tests/Drupal/KernelTests/Scripts/TestSiteApplicationTest.php \Drupal\KernelTests\Scripts\TestSiteApplicationTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Scripts/TestSiteApplicationTest.php \Drupal\Tests\Scripts\TestSiteApplicationTest
- 8.9.x core/tests/Drupal/Tests/Scripts/TestSiteApplicationTest.php \Drupal\Tests\Scripts\TestSiteApplicationTest
- 10 core/tests/Drupal/Tests/Scripts/TestSiteApplicationTest.php \Drupal\Tests\Scripts\TestSiteApplicationTest
Tests core/scripts/test-site.php.
This test uses the Drupal\Core\Database\Database class which has a static. Therefore run in a separate process to avoid side effects.
@group Setup @group #slow @runTestsInSeparateProcesses @preserveGlobalState disabled
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Scripts\TestSiteApplicationTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of TestSiteApplicationTest
See also
\Drupal\TestSite\TestSiteApplication
\Drupal\TestSite\Commands\TestSiteInstallCommand
\Drupal\TestSite\Commands\TestSiteTearDownCommand
File
-
core/
tests/ Drupal/ Tests/ Scripts/ TestSiteApplicationTest.php, line 33
Namespace
Drupal\Tests\ScriptsView source
class TestSiteApplicationTest extends UnitTestCase {
/**
* The PHP executable path.
*
* @var string
*/
protected $php;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$php_executable_finder = new PhpExecutableFinder();
$this->php = $php_executable_finder->find();
}
/**
* @coversNothing
*/
public function testInstallWithNonExistingFile() : void {
$command_line = $this->php . ' core/scripts/test-site.php install --setup-file "this-class-does-not-exist" --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
$process->run();
$this->assertStringContainsString('The file this-class-does-not-exist does not exist.', $process->getErrorOutput());
}
/**
* @coversNothing
*/
public function testInstallWithFileWithNoClass() : void {
$command_line = $this->php . ' core/scripts/test-site.php install --setup-file core/tests/fixtures/empty_file.php.module --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
$process->run();
$this->assertStringContainsString('The file core/tests/fixtures/empty_file.php.module does not contain a class', $process->getErrorOutput());
}
/**
* @coversNothing
*/
public function testInstallWithNonSetupClass() : void {
$this->markTestIncomplete('Fix this test in https://www.drupal.org/project/drupal/issues/2962157.');
// Use __FILE__ to test absolute paths.
$command_line = $this->php . ' core/scripts/test-site.php install --setup-file "' . __FILE__ . '" --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root, [
'COLUMNS' => PHP_INT_MAX,
]);
$process->run();
$this->assertStringContainsString('The class Drupal\\Tests\\Scripts\\TestSiteApplicationTest contained in', $process->getErrorOutput());
$this->assertStringContainsString('needs to implement \\Drupal\\TestSite\\TestSetupInterface', $process->getErrorOutput());
}
/**
* @coversNothing
*/
public function testInstallScript() : void {
$simpletest_path = $this->root . DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . 'simpletest';
if (!is_writable($simpletest_path)) {
$this->markTestSkipped("Requires the directory {$simpletest_path} to exist and be writable");
}
// Install a site using the JSON output.
$command_line = $this->php . ' core/scripts/test-site.php install --json --setup-file core/tests/Drupal/TestSite/TestSiteInstallTestScript.php --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
$result = json_decode($process->getOutput(), TRUE);
$db_prefix = $result['db_prefix'];
$this->assertStringStartsWith('simpletest' . substr($db_prefix, 4) . ':', $result['user_agent']);
$http_client = new Client();
$request = (new Request('GET', getenv('SIMPLETEST_BASE_URL') . '/test-page'))->withHeader('User-Agent', trim($result['user_agent']));
$response = $http_client->send($request);
// Ensure the test_page_test module got installed.
$this->assertStringContainsString('Test page | Drupal', (string) $response->getBody());
// Ensure that there are files and database tables for the tear down command
// to clean up.
$key = $this->addTestDatabase($db_prefix);
$this->assertGreaterThan(0, count(Database::getConnection('default', $key)->schema()
->findTables('%')));
$test_database = new TestDatabase($db_prefix);
$test_file = $this->root . DIRECTORY_SEPARATOR . $test_database->getTestSitePath() . DIRECTORY_SEPARATOR . '.htkey';
$this->assertFileExists($test_file);
// Ensure the lock file exists.
$this->assertFileExists($this->getTestLockFile($db_prefix));
// Install another site so we can ensure the tear down command only removes
// one site at a time. Use the regular output.
$command_line = $this->php . ' core/scripts/test-site.php install --setup-file core/tests/Drupal/TestSite/TestSiteInstallTestScript.php --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertStringContainsString('Successfully installed a test site', $process->getOutput());
$this->assertSame(0, $process->getExitCode());
$regex = '/Database prefix\\s+([^\\s]*)/';
$this->assertMatchesRegularExpression($regex, $process->getOutput());
preg_match('/Database prefix\\s+([^\\s]*)/', $process->getOutput(), $matches);
$other_db_prefix = $matches[1];
$other_key = $this->addTestDatabase($other_db_prefix);
$this->assertGreaterThan(0, count(Database::getConnection('default', $other_key)->schema()
->findTables('%')));
// Ensure the lock file exists for the new install.
$this->assertFileExists($this->getTestLockFile($other_db_prefix));
// Now test the tear down process as well, but keep the lock.
$command_line = $this->php . ' core/scripts/test-site.php tear-down ' . $db_prefix . ' --keep-lock --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
$this->assertStringContainsString("Successfully uninstalled {$db_prefix} test site", $process->getOutput());
// Ensure that all the tables and files for this DB prefix are gone.
$this->assertCount(0, Database::getConnection('default', $key)->schema()
->findTables('%'));
$this->assertFileDoesNotExist($test_file);
// Ensure the other site's tables and files still exist.
$this->assertGreaterThan(0, count(Database::getConnection('default', $other_key)->schema()
->findTables('%')));
$test_database = new TestDatabase($other_db_prefix);
$test_file = $this->root . DIRECTORY_SEPARATOR . $test_database->getTestSitePath() . DIRECTORY_SEPARATOR . '.htkey';
$this->assertFileExists($test_file);
// Tear down the other site. Tear down should work if the test site is
// broken. Prove this by removing its settings.php.
$test_site_settings = $this->root . DIRECTORY_SEPARATOR . $test_database->getTestSitePath() . DIRECTORY_SEPARATOR . 'settings.php';
$this->assertTrue(unlink($test_site_settings));
$command_line = $this->php . ' core/scripts/test-site.php tear-down ' . $other_db_prefix . ' --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
$this->assertStringContainsString("Successfully uninstalled {$other_db_prefix} test site", $process->getOutput());
// Ensure that all the tables and files for this DB prefix are gone.
$this->assertCount(0, Database::getConnection('default', $other_key)->schema()
->findTables('%'));
$this->assertFileDoesNotExist($test_file);
// The lock for the first site should still exist but the second site's lock
// is released during tear down.
$this->assertFileExists($this->getTestLockFile($db_prefix));
$this->assertFileDoesNotExist($this->getTestLockFile($other_db_prefix));
}
/**
* @coversNothing
*/
public function testInstallInDifferentLanguage() : void {
$simpletest_path = $this->root . DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . 'simpletest';
if (!is_writable($simpletest_path)) {
$this->markTestSkipped("Requires the directory {$simpletest_path} to exist and be writable");
}
$command_line = $this->php . ' core/scripts/test-site.php install --json --langcode fr --setup-file core/tests/Drupal/TestSite/TestSiteMultilingualInstallTestScript.php --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
$process->setTimeout(500);
$process->run();
$this->assertEquals(0, $process->getExitCode());
$result = json_decode($process->getOutput(), TRUE);
$db_prefix = $result['db_prefix'];
$http_client = new Client();
$request = (new Request('GET', getenv('SIMPLETEST_BASE_URL') . '/test-page'))->withHeader('User-Agent', trim($result['user_agent']));
$response = $http_client->send($request);
// Ensure the test_page_test module got installed.
$this->assertStringContainsString('Test page | Drupal', (string) $response->getBody());
$this->assertStringContainsString('lang="fr"', (string) $response->getBody());
// Now test the tear down process as well.
$command_line = $this->php . ' core/scripts/test-site.php tear-down ' . $db_prefix . ' --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
// Ensure that all the tables for this DB prefix are gone.
$this->assertCount(0, Database::getConnection('default', $this->addTestDatabase($db_prefix))
->schema()
->findTables('%'));
}
/**
* @coversNothing
*/
public function testTearDownDbPrefixValidation() : void {
$command_line = $this->php . ' core/scripts/test-site.php tear-down not-a-valid-prefix';
$process = Process::fromShellCommandline($command_line, $this->root);
$process->setTimeout(500);
$process->run();
$this->assertSame(1, $process->getExitCode());
$this->assertStringContainsString('Invalid database prefix: not-a-valid-prefix', $process->getErrorOutput());
}
/**
* @coversNothing
*/
public function testUserLogin() : void {
$this->markTestIncomplete('Fix this test in https://www.drupal.org/project/drupal/issues/2962157.');
$simpletest_path = $this->root . DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR . 'simpletest';
if (!is_writable($simpletest_path)) {
$this->markTestSkipped("Requires the directory {$simpletest_path} to exist and be writable");
}
// Install a site using the JSON output.
$command_line = $this->php . ' core/scripts/test-site.php install --json --setup-file core/tests/Drupal/TestSite/TestSiteInstallTestScript.php --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
$result = json_decode($process->getOutput(), TRUE);
$db_prefix = $result['db_prefix'];
$site_path = $result['site_path'];
$this->assertSame('sites/simpletest/' . str_replace('test', '', $db_prefix), $site_path);
// Test the user login command with valid uid.
$command_line = $this->php . ' core/scripts/test-site.php user-login 1 --site-path ' . $site_path;
$process = Process::fromShellCommandline($command_line, $this->root);
$process->run();
$this->assertSame(0, $process->getExitCode());
$this->assertStringContainsString('/user/reset/1/', $process->getOutput());
$http_client = new Client();
$request = (new Request('GET', getenv('SIMPLETEST_BASE_URL') . trim($process->getOutput())))
->withHeader('User-Agent', trim($result['user_agent']));
$response = $http_client->send($request);
// Ensure the response sets a new session.
$this->assertTrue($response->getHeader('Set-Cookie'));
// Test the user login command with invalid uid.
$command_line = $this->php . ' core/scripts/test-site.php user-login invalid-uid --site-path ' . $site_path;
$process = Process::fromShellCommandline($command_line, $this->root);
$process->run();
$this->assertSame(1, $process->getExitCode());
$this->assertStringContainsString('The "uid" argument needs to be an integer, but it is "invalid-uid".', $process->getErrorOutput());
// Now tear down the test site.
$command_line = $this->php . ' core/scripts/test-site.php tear-down ' . $db_prefix . ' --db-url "' . getenv('SIMPLETEST_DB') . '"';
$process = Process::fromShellCommandline($command_line, $this->root);
// Set the timeout to a value that allows debugging.
$process->setTimeout(500);
$process->run();
$this->assertSame(0, $process->getExitCode());
$this->assertStringContainsString("Successfully uninstalled {$db_prefix} test site", $process->getOutput());
}
/**
* Adds the installed test site to the database connection info.
*
* @param string $db_prefix
* The prefix of the installed test site.
*
* @return string
* The database key of the added connection.
*/
protected function addTestDatabase($db_prefix) : string {
$database = Database::convertDbUrlToConnectionInfo(getenv('SIMPLETEST_DB'), $this->root);
$database['prefix'] = $db_prefix;
$target = __CLASS__ . $db_prefix;
Database::addConnectionInfo($target, 'default', $database);
return $target;
}
/**
* Gets the lock file path.
*
* @param string $db_prefix
* The prefix of the installed test site.
*
* @return string
* The lock file path.
*/
protected function getTestLockFile($db_prefix) : string {
$lock_id = str_replace('test', '', $db_prefix);
return FileSystem::getOsTemporaryDirectory() . '/test_' . $lock_id;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
TestSiteApplicationTest::$php | protected | property | The PHP executable path. | |
TestSiteApplicationTest::addTestDatabase | protected | function | Adds the installed test site to the database connection info. | |
TestSiteApplicationTest::getTestLockFile | protected | function | Gets the lock file path. | |
TestSiteApplicationTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
TestSiteApplicationTest::testInstallInDifferentLanguage | public | function | @coversNothing | |
TestSiteApplicationTest::testInstallScript | public | function | @coversNothing | |
TestSiteApplicationTest::testInstallWithFileWithNoClass | public | function | @coversNothing | |
TestSiteApplicationTest::testInstallWithNonExistingFile | public | function | @coversNothing | |
TestSiteApplicationTest::testInstallWithNonSetupClass | public | function | @coversNothing | |
TestSiteApplicationTest::testTearDownDbPrefixValidation | public | function | @coversNothing | |
TestSiteApplicationTest::testUserLogin | public | function | @coversNothing | |
UnitTestCase::$root | protected | property | The app root. | |
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.