class TestRunTest

Same name and namespace in other branches
  1. 10 core/tests/Drupal/KernelTests/Core/Test/TestRunTest.php \Drupal\KernelTests\Core\Test\TestRunTest

@coversDefaultClass \Drupal\Core\Test\TestRun @group Test

Hierarchy

Expanded class hierarchy of TestRunTest

File

core/tests/Drupal/KernelTests/Core/Test/TestRunTest.php, line 18

Namespace

Drupal\KernelTests\Core\Test
View source 
class TestRunTest extends KernelTestBase {
    
    /**
     * The database connection for testing.
     *
     * NOTE: this is the connection to the fixture database to allow testing the
     * storage class, NOT the database where actual tests results are stored.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * The test run results storage.
     *
     * @var \Drupal\Core\Test\TestRunResultsStorageInterface
     */
    protected $testRunResultsStorage;
    
    /**
     * {@inheritdoc}
     */
    public function setUp() : void {
        parent::setUp();
        $this->connection = Database::getConnection();
        $this->testRunResultsStorage = new SimpletestTestRunResultsStorage($this->connection);
        $this->testRunResultsStorage
            ->buildTestingResultsEnvironment(FALSE);
    }
    
    /**
     * @covers ::createNew
     * @covers ::get
     * @covers ::id
     * @covers ::insertLogEntry
     * @covers ::setDatabasePrefix
     * @covers ::getDatabasePrefix
     * @covers ::getTestClass
     */
    public function testCreateAndGet() : void {
        // Test ::createNew.
        $test_run = TestRun::createNew($this->testRunResultsStorage);
        $this->assertEquals(1, $test_run->id());
        $this->assertEquals(0, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $this->connection
            ->select('simpletest_test_id')
            ->countQuery()
            ->execute()
            ->fetchField());
        $test_run->setDatabasePrefix('oddity1234');
        $this->assertEquals('oddity1234', $test_run->getDatabasePrefix());
        $this->assertEquals('oddity1234', $this->connection
            ->select('simpletest_test_id', 's')
            ->fields('s', [
            'last_prefix',
        ])
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $test_run->insertLogEntry($this->getTestLogEntry('Test\\GroundControl')));
        $this->assertEquals('oddity1234', $test_run->getDatabasePrefix());
        $this->assertEquals('Test\\GroundControl', $test_run->getTestClass());
        $this->assertEquals(1, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $this->connection
            ->select('simpletest_test_id')
            ->countQuery()
            ->execute()
            ->fetchField());
        // Explicitly void the $test_run variable.
        $test_run = NULL;
        // Test ::get.
        $test_run = TestRun::get($this->testRunResultsStorage, 1);
        $this->assertEquals(1, $test_run->id());
        $this->assertEquals('oddity1234', $test_run->getDatabasePrefix());
        $this->assertEquals('Test\\GroundControl', $test_run->getTestClass());
    }
    
    /**
     * @covers ::createNew
     * @covers ::id
     * @covers ::insertLogEntry
     * @covers ::setDatabasePrefix
     */
    public function testCreateAndRemove() : void {
        $test_run_1 = TestRun::createNew($this->testRunResultsStorage);
        $test_run_1->setDatabasePrefix('oddity1234');
        $test_run_1->insertLogEntry($this->getTestLogEntry('Test\\GroundControl'));
        $this->assertEquals(1, $test_run_1->id());
        $this->assertEquals(1, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $this->connection
            ->select('simpletest_test_id')
            ->countQuery()
            ->execute()
            ->fetchField());
        $test_run_2 = TestRun::createNew($this->testRunResultsStorage);
        $test_run_2->setDatabasePrefix('oddity5678');
        $test_run_2->insertLogEntry($this->getTestLogEntry('Test\\PlanetEarth'));
        $this->assertEquals(2, $test_run_2->id());
        $this->assertEquals(2, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(2, $this->connection
            ->select('simpletest_test_id')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $test_run_1->removeResults());
        $this->assertEquals(1, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
        $this->assertEquals(1, $this->connection
            ->select('simpletest_test_id')
            ->countQuery()
            ->execute()
            ->fetchField());
    }
    
    /**
     * @covers ::createNew
     * @covers ::insertLogEntry
     * @covers ::setDatabasePrefix
     * @covers ::getLogEntriesByTestClass
     * @covers ::getDatabasePrefix
     * @covers ::getTestClass
     */
    public function testGetLogEntriesByTestClass() : void {
        $test_run = TestRun::createNew($this->testRunResultsStorage);
        $test_run->setDatabasePrefix('oddity1234');
        $this->assertEquals(1, $test_run->insertLogEntry($this->getTestLogEntry('Test\\PlanetEarth')));
        $this->assertEquals(2, $test_run->insertLogEntry($this->getTestLogEntry('Test\\GroundControl')));
        $this->assertEquals([
            0 => (object) [
                'message_id' => 2,
                'test_id' => 1,
                'test_class' => 'Test\\GroundControl',
                'status' => 'pass',
                'message' => 'Major Tom',
                'message_group' => 'other',
                'function' => 'Unknown',
                'line' => 0,
                'file' => 'Unknown',
            ],
            1 => (object) [
                'message_id' => 1,
                'test_id' => 1,
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'pass',
                'message' => 'Major Tom',
                'message_group' => 'other',
                'function' => 'Unknown',
                'line' => 0,
                'file' => 'Unknown',
            ],
        ], $test_run->getLogEntriesByTestClass());
        $this->assertEquals('oddity1234', $test_run->getDatabasePrefix());
        $this->assertEquals('Test\\GroundControl', $test_run->getTestClass());
    }
    
    /**
     * @covers ::createNew
     * @covers ::setDatabasePrefix
     * @covers ::processPhpErrorLogFile
     * @covers ::getLogEntriesByTestClass
     */
    public function testProcessPhpErrorLogFile() : void {
        $test_run = TestRun::createNew($this->testRunResultsStorage);
        $test_run->setDatabasePrefix('oddity1234');
        $test_run->processPhpErrorLogFile('core/tests/fixtures/test-error.log', 'Test\\PlanetEarth');
        $this->assertEquals([
            0 => (object) [
                'message_id' => '1',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "Argument 1 passed to Drupal\\FunctionalTests\\Bootstrap\\ErrorContainer::Drupal\\FunctionalTests\\Bootstrap\\{closure}() must be an instance of Drupal\\FunctionalTests\\Bootstrap\\ErrorContainer, int given, called",
                'message_group' => 'TypeError',
                'function' => 'Unknown',
                'line' => '18',
                'file' => '/var/www/core/tests/Drupal/FunctionalTests/Bootstrap/ErrorContainer.php on line 20 in /var/www/core/tests/Drupal/FunctionalTests/Bootstrap/ErrorContainer.php',
            ],
            1 => (object) [
                'message_id' => '2',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#1 /var/www/core/lib/Drupal/Core/DrupalKernel.php(1396): Drupal\\FunctionalTests\\Bootstrap\\ErrorContainer->get('http_kernel')\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            2 => (object) [
                'message_id' => '3',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#2 /var/www/core/lib/Drupal/Core/DrupalKernel.php(693): Drupal\\Core\\DrupalKernel->getHttpKernel()\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            3 => (object) [
                'message_id' => '4',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#3 /var/www/index.php(19): Drupal\\Core\\DrupalKernel->handle(Object(Symfony\\Component\\HttpFoundation\\Request))\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            4 => (object) [
                'message_id' => '5',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#4 {main}\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            5 => (object) [
                'message_id' => '6',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "Thrown exception during Container::get",
                'message_group' => 'Exception',
                'function' => 'Unknown',
                'line' => '17',
                'file' => '/var/www/core/tests/Drupal/FunctionalTests/Bootstrap/ExceptionContainer.php',
            ],
            6 => (object) [
                'message_id' => '7',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#1 /var/www/core/lib/Drupal/Core/DrupalKernel.php(693): Drupal\\Core\\DrupalKernel->getHttpKernel()\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            7 => (object) [
                'message_id' => '8',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#2 /var/www/index.php(19): Drupal\\Core\\DrupalKernel->handle(Object(Symfony\\Component\\HttpFoundation\\Request))\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
            8 => (object) [
                'message_id' => '9',
                'test_id' => '1',
                'test_class' => 'Test\\PlanetEarth',
                'status' => 'fail',
                'message' => "#3 {main}\n",
                'message_group' => 'Fatal error',
                'function' => 'Unknown',
                'line' => '0',
                'file' => 'Unknown',
            ],
        ], $test_run->getLogEntriesByTestClass());
    }
    
    /**
     * @covers ::insertLogEntry
     */
    public function testProcessPhpUnitResults() : void {
        $phpunit_error_xml = __DIR__ . '/../../../Tests/Core/Test/fixtures/phpunit_error.xml';
        $res = JUnitConverter::xmlToRows(1, $phpunit_error_xml);
        $runner = PhpUnitTestRunner::create(\Drupal::getContainer());
        $test_run = TestRun::createNew($this->testRunResultsStorage);
        $runner->processPhpUnitResults($test_run, $res);
        $this->assertEquals(4, $this->connection
            ->select('simpletest')
            ->countQuery()
            ->execute()
            ->fetchField());
    }
    
    /**
     * Returns a sample test run log entry.
     *
     * @param string $test_class
     *   The test class.
     *
     * @return string[]
     *   An array with the elements to be logged.
     */
    protected function getTestLogEntry(string $test_class) : array {
        return [
            'test_class' => $test_class,
            'status' => 'pass',
            'message' => 'Major Tom',
            'message_group' => 'other',
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$modules protected static property Modules to enable. 547
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestRunTest::$connection protected property The database connection for testing.
TestRunTest::$testRunResultsStorage protected property The test run results storage.
TestRunTest::getTestLogEntry protected function Returns a sample test run log entry.
TestRunTest::setUp public function Overrides KernelTestBase::setUp
TestRunTest::testCreateAndGet public function @covers ::createNew
@covers ::get
@covers ::id
@covers ::insertLogEntry
@covers ::setDatabasePrefix
@covers ::getDatabasePrefix
@covers ::getTestClass
TestRunTest::testCreateAndRemove public function @covers ::createNew
@covers ::id
@covers ::insertLogEntry
@covers ::setDatabasePrefix
TestRunTest::testGetLogEntriesByTestClass public function @covers ::createNew
@covers ::insertLogEntry
@covers ::setDatabasePrefix
@covers ::getLogEntriesByTestClass
@covers ::getDatabasePrefix
@covers ::getTestClass
TestRunTest::testProcessPhpErrorLogFile public function @covers ::createNew
@covers ::setDatabasePrefix
@covers ::processPhpErrorLogFile
@covers ::getLogEntriesByTestClass
TestRunTest::testProcessPhpUnitResults public function @covers ::insertLogEntry

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.