class DrupalTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/DrupalTest.php \Drupal\Tests\Core\DrupalTest
- 8.9.x core/tests/Drupal/Tests/Core/DrupalTest.php \Drupal\Tests\Core\DrupalTest
- 10 core/tests/Drupal/Tests/Core/DrupalTest.php \Drupal\Tests\Core\DrupalTest
Tests the Drupal class.
@coversDefaultClass \Drupal @group DrupalTest
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\Core\DrupalTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of DrupalTest
1 string reference to 'DrupalTest'
- TestDiscoveryTest::infoParserProvider in core/
tests/ Drupal/ Tests/ Core/ Test/ TestDiscoveryTest.php
File
-
core/
tests/ Drupal/ Tests/ Core/ DrupalTest.php, line 22
Namespace
Drupal\Tests\CoreView source
class DrupalTest extends UnitTestCase {
/**
* The mock container.
*
* @var \Symfony\Component\DependencyInjection\ContainerBuilder|\PHPUnit\Framework\MockObject\MockObject
*/
protected $container;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->container = $this->getMockBuilder('Symfony\\Component\\DependencyInjection\\ContainerBuilder')
->onlyMethods([
'get',
])
->getMock();
}
/**
* Tests the get/setContainer() method.
*
* @covers ::getContainer
*/
public function testSetContainer() : void {
\Drupal::setContainer($this->container);
$this->assertSame($this->container, \Drupal::getContainer());
}
/**
* @covers ::getContainer
*/
public function testGetContainerException() : void {
$this->expectException(ContainerNotInitializedException::class);
$this->expectExceptionMessage('\\Drupal::$container is not initialized yet. \\Drupal::setContainer() must be called with a real container.');
\Drupal::getContainer();
}
/**
* Tests the service() method.
*
* @covers ::service
*/
public function testService() : void {
$this->setMockContainerService('test_service');
$this->assertNotNull(\Drupal::service('test_service'));
}
/**
* Tests the currentUser() method.
*
* @covers ::currentUser
*/
public function testCurrentUser() : void {
$this->setMockContainerService('current_user');
$this->assertNotNull(\Drupal::currentUser());
}
/**
* Tests the entityTypeManager() method.
*
* @covers ::entityTypeManager
*/
public function testEntityTypeManager() : void {
$this->setMockContainerService('entity_type.manager');
$this->assertNotNull(\Drupal::entityTypeManager());
}
/**
* Tests the database() method.
*
* @covers ::database
*/
public function testDatabase() : void {
$this->setMockContainerService('database');
$this->assertNotNull(\Drupal::database());
}
/**
* Tests the cache() method.
*
* @covers ::cache
*/
public function testCache() : void {
$this->setMockContainerService('cache.test');
$this->assertNotNull(\Drupal::cache('test'));
}
/**
* Tests the classResolver method.
*
* @covers ::classResolver
*/
public function testClassResolver() : void {
$class_resolver = $this->prophesize(ClassResolverInterface::class);
$this->setMockContainerService('class_resolver', $class_resolver->reveal());
$this->assertInstanceOf(ClassResolverInterface::class, \Drupal::classResolver());
}
/**
* Tests the classResolver method when called with a class.
*
* @covers ::classResolver
*/
public function testClassResolverWithClass() : void {
$class_resolver = $this->prophesize(ClassResolverInterface::class);
$class_resolver->getInstanceFromDefinition(static::class)
->willReturn($this);
$this->setMockContainerService('class_resolver', $class_resolver->reveal());
$this->assertSame($this, \Drupal::classResolver(static::class));
}
/**
* Tests the keyValueExpirable() method.
*
* @covers ::keyValueExpirable
*/
public function testKeyValueExpirable() : void {
$keyvalue = $this->getMockBuilder('Drupal\\Core\\KeyValueStore\\KeyValueExpirableFactory')
->disableOriginalConstructor()
->getMock();
$keyvalue->expects($this->once())
->method('get')
->with('test_collection')
->willReturn(TRUE);
$this->setMockContainerService('keyvalue.expirable', $keyvalue);
$this->assertNotNull(\Drupal::keyValueExpirable('test_collection'));
}
/**
* Tests the lock() method.
*
* @covers ::lock
*/
public function testLock() : void {
$this->setMockContainerService('lock');
$this->assertNotNull(\Drupal::lock());
}
/**
* Tests the config() method.
*
* @covers ::config
*/
public function testConfig() : void {
$config = $this->createMock('Drupal\\Core\\Config\\ConfigFactoryInterface');
$config->expects($this->once())
->method('get')
->with('test_config')
->willReturn(TRUE);
$this->setMockContainerService('config.factory', $config);
// Test \Drupal::config(), not $this->config().
$this->assertNotNull(\Drupal::config('test_config'));
}
/**
* Tests the queue() method.
*
* @covers ::queue
*/
public function testQueue() : void {
$queue = $this->getMockBuilder('Drupal\\Core\\Queue\\QueueFactory')
->disableOriginalConstructor()
->getMock();
$queue->expects($this->once())
->method('get')
->with('test_queue', TRUE)
->willReturn(TRUE);
$this->setMockContainerService('queue', $queue);
$this->assertNotNull(\Drupal::queue('test_queue', TRUE));
}
/**
* Tests the testRequestStack() method.
*
* @covers ::requestStack
*/
public function testRequestStack() : void {
$request_stack = new RequestStack();
$this->setMockContainerService('request_stack', $request_stack);
$this->assertSame($request_stack, \Drupal::requestStack());
}
/**
* Tests the keyValue() method.
*
* @covers ::keyValue
*/
public function testKeyValue() : void {
$keyvalue = $this->getMockBuilder('Drupal\\Core\\KeyValueStore\\KeyValueFactory')
->disableOriginalConstructor()
->getMock();
$keyvalue->expects($this->once())
->method('get')
->with('test_collection')
->willReturn(TRUE);
$this->setMockContainerService('keyvalue', $keyvalue);
$this->assertNotNull(\Drupal::keyValue('test_collection'));
}
/**
* Tests the state() method.
*
* @covers ::state
*/
public function testState() : void {
$this->setMockContainerService('state');
$this->assertNotNull(\Drupal::state());
}
/**
* Tests the httpClient() method.
*
* @covers ::httpClient
*/
public function testHttpClient() : void {
$this->setMockContainerService('http_client');
$this->assertNotNull(\Drupal::httpClient());
}
/**
* Tests the entityQuery() method.
*
* @covers ::entityQuery
*/
public function testEntityQuery() : void {
$query = $this->createMock(QueryInterface::class);
$storage = $this->createMock(EntityStorageInterface::class);
$storage->expects($this->once())
->method('getQuery')
->with('OR')
->willReturn($query);
$entity_type_manager = $this->createMock(EntityTypeManagerInterface::class);
$entity_type_manager->expects($this->once())
->method('getStorage')
->with('test_entity')
->willReturn($storage);
$this->setMockContainerService('entity_type.manager', $entity_type_manager);
$this->assertInstanceOf(QueryInterface::class, \Drupal::entityQuery('test_entity', 'OR'));
}
/**
* Tests the entityQueryAggregate() method.
*
* @covers ::entityQueryAggregate
*/
public function testEntityQueryAggregate() : void {
$query = $this->createMock(QueryAggregateInterface::class);
$storage = $this->createMock(EntityStorageInterface::class);
$storage->expects($this->once())
->method('getAggregateQuery')
->with('OR')
->willReturn($query);
$entity_type_manager = $this->createMock(EntityTypeManagerInterface::class);
$entity_type_manager->expects($this->once())
->method('getStorage')
->with('test_entity')
->willReturn($storage);
$this->setMockContainerService('entity_type.manager', $entity_type_manager);
$this->assertInstanceOf(QueryAggregateInterface::class, \Drupal::entityQueryAggregate('test_entity', 'OR'));
}
/**
* Tests the flood() method.
*
* @covers ::flood
*/
public function testFlood() : void {
$this->setMockContainerService('flood');
$this->assertNotNull(\Drupal::flood());
}
/**
* Tests the moduleHandler() method.
*
* @covers ::moduleHandler
*/
public function testModuleHandler() : void {
$this->setMockContainerService('module_handler');
$this->assertNotNull(\Drupal::moduleHandler());
}
/**
* Tests the typedDataManager() method.
*
* @covers ::typedDataManager
*/
public function testTypedDataManager() : void {
$this->setMockContainerService('typed_data_manager');
$this->assertNotNull(\Drupal::typedDataManager());
}
/**
* Tests the token() method.
*
* @covers ::token
*/
public function testToken() : void {
$this->setMockContainerService('token');
$this->assertNotNull(\Drupal::token());
}
/**
* Tests the urlGenerator() method.
*
* @covers ::urlGenerator
*/
public function testUrlGenerator() : void {
$this->setMockContainerService('url_generator');
$this->assertNotNull(\Drupal::urlGenerator());
}
/**
* Tests the linkGenerator() method.
*
* @covers ::linkGenerator
*/
public function testLinkGenerator() : void {
$this->setMockContainerService('link_generator');
$this->assertNotNull(\Drupal::linkGenerator());
}
/**
* Tests the translation() method.
*
* @covers ::translation
*/
public function testTranslation() : void {
$this->setMockContainerService('string_translation');
$this->assertNotNull(\Drupal::translation());
}
/**
* Tests the languageManager() method.
*
* @covers ::languageManager
*/
public function testLanguageManager() : void {
$this->setMockContainerService('language_manager');
$this->assertNotNull(\Drupal::languageManager());
}
/**
* Tests the csrfToken() method.
*
* @covers ::csrfToken
*/
public function testCsrfToken() : void {
$this->setMockContainerService('csrf_token');
$this->assertNotNull(\Drupal::csrfToken());
}
/**
* Tests the transliteration() method.
*
* @covers ::transliteration
*/
public function testTransliteration() : void {
$this->setMockContainerService('transliteration');
$this->assertNotNull(\Drupal::transliteration());
}
/**
* Tests the formBuilder() method.
*
* @covers ::formBuilder
*/
public function testFormBuilder() : void {
$this->setMockContainerService('form_builder');
$this->assertNotNull(\Drupal::formBuilder());
}
/**
* Tests the menuTree() method.
*
* @covers ::menuTree
*/
public function testMenuTree() : void {
$this->setMockContainerService('menu.link_tree');
$this->assertNotNull(\Drupal::menuTree());
}
/**
* Tests the pathValidator() method.
*
* @covers ::pathValidator
*/
public function testPathValidator() : void {
$this->setMockContainerService('path.validator');
$this->assertNotNull(\Drupal::pathValidator());
}
/**
* Tests the accessManager() method.
*
* @covers ::accessManager
*/
public function testAccessManager() : void {
$this->setMockContainerService('access_manager');
$this->assertNotNull(\Drupal::accessManager());
}
/**
* Tests the PHP constants have consistent values.
*/
public function testPhpConstants() : void {
// RECOMMENDED_PHP can be just MAJOR.MINOR so normalize it to allow using
// version_compare().
$normalizer = function (string $version) : string {
// The regex below is from \Composer\Semver\VersionParser::normalize().
preg_match('{^(\\d{1,5})(\\.\\d++)?(\\.\\d++)?$}i', $version, $matches);
return $matches[1] . (!empty($matches[2]) ? $matches[2] : '.9999999') . (!empty($matches[3]) ? $matches[3] : '.9999999');
};
$recommended_php = $normalizer(\Drupal::RECOMMENDED_PHP);
$this->assertTrue(version_compare($recommended_php, \Drupal::MINIMUM_PHP, '>='), "\\Drupal::RECOMMENDED_PHP should be greater or equal to \\Drupal::MINIMUM_PHP");
// As this test depends on the $normalizer function it is tested.
$this->assertSame('10.9999999.9999999', $normalizer('10'));
$this->assertSame('10.1.9999999', $normalizer('10.1'));
$this->assertSame('10.1.2', $normalizer('10.1.2'));
}
/**
* Sets up a mock expectation for the container get() method.
*
* @param string $service_name
* The service name to expect for the get() method.
* @param mixed $return
* The value to return from the mocked container get() method.
*/
protected function setMockContainerService($service_name, $return = NULL) {
$expects = $this->container
->expects($this->once())
->method('get')
->with($service_name)
->willReturn($return ?? new \stdClass());
\Drupal::setContainer($this->container);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DrupalTest::$container | protected | property | The mock container. | |
DrupalTest::setMockContainerService | protected | function | Sets up a mock expectation for the container get() method. | |
DrupalTest::setUp | protected | function | Overrides UnitTestCase::setUp | |
DrupalTest::testAccessManager | public | function | Tests the accessManager() method. | |
DrupalTest::testCache | public | function | Tests the cache() method. | |
DrupalTest::testClassResolver | public | function | Tests the classResolver method. | |
DrupalTest::testClassResolverWithClass | public | function | Tests the classResolver method when called with a class. | |
DrupalTest::testConfig | public | function | Tests the config() method. | |
DrupalTest::testCsrfToken | public | function | Tests the csrfToken() method. | |
DrupalTest::testCurrentUser | public | function | Tests the currentUser() method. | |
DrupalTest::testDatabase | public | function | Tests the database() method. | |
DrupalTest::testEntityQuery | public | function | Tests the entityQuery() method. | |
DrupalTest::testEntityQueryAggregate | public | function | Tests the entityQueryAggregate() method. | |
DrupalTest::testEntityTypeManager | public | function | Tests the entityTypeManager() method. | |
DrupalTest::testFlood | public | function | Tests the flood() method. | |
DrupalTest::testFormBuilder | public | function | Tests the formBuilder() method. | |
DrupalTest::testGetContainerException | public | function | @covers ::getContainer | |
DrupalTest::testHttpClient | public | function | Tests the httpClient() method. | |
DrupalTest::testKeyValue | public | function | Tests the keyValue() method. | |
DrupalTest::testKeyValueExpirable | public | function | Tests the keyValueExpirable() method. | |
DrupalTest::testLanguageManager | public | function | Tests the languageManager() method. | |
DrupalTest::testLinkGenerator | public | function | Tests the linkGenerator() method. | |
DrupalTest::testLock | public | function | Tests the lock() method. | |
DrupalTest::testMenuTree | public | function | Tests the menuTree() method. | |
DrupalTest::testModuleHandler | public | function | Tests the moduleHandler() method. | |
DrupalTest::testPathValidator | public | function | Tests the pathValidator() method. | |
DrupalTest::testPhpConstants | public | function | Tests the PHP constants have consistent values. | |
DrupalTest::testQueue | public | function | Tests the queue() method. | |
DrupalTest::testRequestStack | public | function | Tests the testRequestStack() method. | |
DrupalTest::testService | public | function | Tests the service() method. | |
DrupalTest::testSetContainer | public | function | Tests the get/setContainer() method. | |
DrupalTest::testState | public | function | Tests the state() method. | |
DrupalTest::testToken | public | function | Tests the token() method. | |
DrupalTest::testTranslation | public | function | Tests the translation() method. | |
DrupalTest::testTransliteration | public | function | Tests the transliteration() method. | |
DrupalTest::testTypedDataManager | public | function | Tests the typedDataManager() method. | |
DrupalTest::testUrlGenerator | public | function | Tests the urlGenerator() method. | |
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. | |
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.