DrupalTest.php
Same filename in other branches
Namespace
Drupal\Tests\CoreFile
-
core/
tests/ Drupal/ Tests/ Core/ DrupalTest.php
View source
<?php
namespace Drupal\Tests\Core;
use Drupal\Core\DependencyInjection\ClassResolverInterface;
use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Entity\Query\QueryAggregateInterface;
use Drupal\Core\Entity\Query\QueryInterface;
use Drupal\Tests\UnitTestCase;
use Symfony\Component\HttpFoundation\RequestStack;
/**
* Tests the Drupal class.
*
* @coversDefaultClass \Drupal
* @group DrupalTest
*/
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() {
\Drupal::setContainer($this->container);
$this->assertSame($this->container, \Drupal::getContainer());
}
/**
* @covers ::getContainer
*/
public function testGetContainerException() {
$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() {
$this->setMockContainerService('test_service');
$this->assertNotNull(\Drupal::service('test_service'));
}
/**
* Tests the currentUser() method.
*
* @covers ::currentUser
*/
public function testCurrentUser() {
$this->setMockContainerService('current_user');
$this->assertNotNull(\Drupal::currentUser());
}
/**
* Tests the entityTypeManager() method.
*
* @covers ::entityTypeManager
*/
public function testEntityTypeManager() {
$this->setMockContainerService('entity_type.manager');
$this->assertNotNull(\Drupal::entityTypeManager());
}
/**
* Tests the database() method.
*
* @covers ::database
*/
public function testDatabase() {
$this->setMockContainerService('database');
$this->assertNotNull(\Drupal::database());
}
/**
* Tests the cache() method.
*
* @covers ::cache
*/
public function testCache() {
$this->setMockContainerService('cache.test');
$this->assertNotNull(\Drupal::cache('test'));
}
/**
* Tests the classResolver method.
*
* @covers ::classResolver
*/
public function testClassResolver() {
$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() {
$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() {
$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() {
$this->setMockContainerService('lock');
$this->assertNotNull(\Drupal::lock());
}
/**
* Tests the config() method.
*
* @covers ::config
*/
public function testConfig() {
$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() {
$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() {
$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() {
$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() {
$this->setMockContainerService('state');
$this->assertNotNull(\Drupal::state());
}
/**
* Tests the httpClient() method.
*
* @covers ::httpClient
*/
public function testHttpClient() {
$this->setMockContainerService('http_client');
$this->assertNotNull(\Drupal::httpClient());
}
/**
* Tests the entityQuery() method.
*
* @covers ::entityQuery
*/
public function testEntityQuery() {
$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() {
$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() {
$this->setMockContainerService('flood');
$this->assertNotNull(\Drupal::flood());
}
/**
* Tests the moduleHandler() method.
*
* @covers ::moduleHandler
*/
public function testModuleHandler() {
$this->setMockContainerService('module_handler');
$this->assertNotNull(\Drupal::moduleHandler());
}
/**
* Tests the typedDataManager() method.
*
* @covers ::typedDataManager
*/
public function testTypedDataManager() {
$this->setMockContainerService('typed_data_manager');
$this->assertNotNull(\Drupal::typedDataManager());
}
/**
* Tests the token() method.
*
* @covers ::token
*/
public function testToken() {
$this->setMockContainerService('token');
$this->assertNotNull(\Drupal::token());
}
/**
* Tests the urlGenerator() method.
*
* @covers ::urlGenerator
*/
public function testUrlGenerator() {
$this->setMockContainerService('url_generator');
$this->assertNotNull(\Drupal::urlGenerator());
}
/**
* Tests the linkGenerator() method.
*
* @covers ::linkGenerator
*/
public function testLinkGenerator() {
$this->setMockContainerService('link_generator');
$this->assertNotNull(\Drupal::linkGenerator());
}
/**
* Tests the translation() method.
*
* @covers ::translation
*/
public function testTranslation() {
$this->setMockContainerService('string_translation');
$this->assertNotNull(\Drupal::translation());
}
/**
* Tests the languageManager() method.
*
* @covers ::languageManager
*/
public function testLanguageManager() {
$this->setMockContainerService('language_manager');
$this->assertNotNull(\Drupal::languageManager());
}
/**
* Tests the csrfToken() method.
*
* @covers ::csrfToken
*/
public function testCsrfToken() {
$this->setMockContainerService('csrf_token');
$this->assertNotNull(\Drupal::csrfToken());
}
/**
* Tests the transliteration() method.
*
* @covers ::transliteration
*/
public function testTransliteration() {
$this->setMockContainerService('transliteration');
$this->assertNotNull(\Drupal::transliteration());
}
/**
* Tests the formBuilder() method.
*
* @covers ::formBuilder
*/
public function testFormBuilder() {
$this->setMockContainerService('form_builder');
$this->assertNotNull(\Drupal::formBuilder());
}
/**
* Tests the menuTree() method.
*
* @covers ::menuTree
*/
public function testMenuTree() {
$this->setMockContainerService('menu.link_tree');
$this->assertNotNull(\Drupal::menuTree());
}
/**
* Tests the pathValidator() method.
*
* @covers ::pathValidator
*/
public function testPathValidator() {
$this->setMockContainerService('path.validator');
$this->assertNotNull(\Drupal::pathValidator());
}
/**
* Tests the accessManager() method.
*
* @covers ::accessManager
*/
public function testAccessManager() {
$this->setMockContainerService('access_manager');
$this->assertNotNull(\Drupal::accessManager());
}
/**
* 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);
if (isset($return)) {
$expects->willReturn($return);
}
else {
$expects->willReturn(TRUE);
}
\Drupal::setContainer($this->container);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
DrupalTest | Tests the Drupal class. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.