Newer
Older
Angie Byron
committed
<?php
/**
* Contains \Drupal\system\Tests\Entity\EntityCrudHookTest.
namespace Drupal\system\Tests\Entity;
use Drupal\comment\Entity\Comment;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\comment\Tests\CommentTestTrait;
Angie Byron
committed
use Drupal\Core\Database\Database;
use Drupal\Core\Language\LanguageInterface;
use Drupal\block\Entity\Block;
use Drupal\node\Entity\NodeType;
use Drupal\taxonomy\Entity\Term;
Alex Pott
committed
use Drupal\node\Entity\Node;
Alex Pott
committed
use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\user\Entity\User;
use Drupal\file\Entity\File;
catch
committed
* Tests the invocation of hooks when creating, inserting, loading, updating or
* deleting an entity.
*
* Tested hooks are:
* - hook_entity_insert() and hook_ENTITY_TYPE_insert()
* - hook_entity_load() and hook_ENTITY_TYPE_load()
* - hook_entity_update() and hook_ENTITY_TYPE_update()
* - hook_entity_predelete() and hook_ENTITY_TYPE_predelete()
* - hook_entity_delete() and hook_ENTITY_TYPE_delete()
*
* These hooks are each tested for several entity types.
*
* @group Entity
Angie Byron
committed
*/
class EntityCrudHookTest extends EntityUnitTestBase {
Angie Byron
committed
use CommentTestTrait;
/**
* Modules to enable.
*
* @var array
*/
Angie Byron
committed
public static $modules = array('block', 'block_test', 'entity_crud_hook_test', 'file', 'taxonomy', 'node', 'comment');
Angie Byron
committed
protected $ids = array();
Alex Pott
committed
protected function setUp() {
Angie Byron
committed
parent::setUp();
$this->installSchema('user', array('users_data'));
$this->installSchema('file', array('file_usage'));
$this->installSchema('node', array('node_access'));
$this->installSchema('comment', array('comment_entity_statistics'));
$this->installConfig(['node', 'comment']);
Angie Byron
committed
}
Angie Byron
committed
/**
catch
committed
* Checks the order of CRUD hook execution messages.
Angie Byron
committed
*
catch
committed
* entity_crud_hook_test.module implements all core entity CRUD hooks and
* stores a message for each in $GLOBALS['entity_crud_hook_test'].
catch
committed
*
* @param $messages
* An array of plain-text messages in the order they should appear.
Angie Byron
committed
*/
catch
committed
protected function assertHookMessageOrder($messages) {
$positions = array();
foreach ($messages as $message) {
// Verify that each message is found and record its position.
$position = array_search($message, $GLOBALS['entity_crud_hook_test']);
catch
committed
if ($this->assertTrue($position !== FALSE, $message)) {
$positions[] = $position;
}
Angie Byron
committed
}
catch
committed
// Sort the positions and ensure they remain in the same order.
$sorted = $positions;
sort($sorted);
$this->assertTrue($sorted == $positions, 'The hook messages appear in the correct order.');
Angie Byron
committed
}
Angie Byron
committed
/**
* Tests hook invocations for CRUD operations on blocks.
*/
public function testBlockHooks() {
$entity = entity_create('block', array(
'id' => 'stark_test_html',
'plugin' => 'test_html',
'theme' => 'stark',
Angie Byron
committed
));
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_block_create called',
'entity_crud_hook_test_entity_create called for type block',
));
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$entity->save();
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_block_presave called',
'entity_crud_hook_test_entity_presave called for type block',
'entity_crud_hook_test_block_insert called',
'entity_crud_hook_test_entity_insert called for type block',
));
$GLOBALS['entity_crud_hook_test'] = array();
$entity = Block::load($entity->id());
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type block',
'entity_crud_hook_test_block_load called',
));
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$entity->label = 'New label';
$entity->save();
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_block_presave called',
'entity_crud_hook_test_entity_presave called for type block',
'entity_crud_hook_test_block_update called',
'entity_crud_hook_test_entity_update called for type block',
));
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$entity->delete();
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_block_predelete called',
'entity_crud_hook_test_entity_predelete called for type block',
'entity_crud_hook_test_block_delete called',
'entity_crud_hook_test_entity_delete called for type block',
));
}
Angie Byron
committed
/**
* Tests hook invocations for CRUD operations on comments.
Angie Byron
committed
*/
public function testCommentHooks() {
Angie Byron
committed
$account = $this->createUser();
NodeType::create([
'type' => 'article',
'name' => 'Article',
])->save();
$this->addDefaultCommentField('node', 'article', 'comment', CommentItemInterface::OPEN);
Angie Byron
committed
$node = entity_create('node', array(
Dries Buytaert
committed
'uid' => $account->id(),
Angie Byron
committed
'type' => 'article',
'title' => 'Test node',
'status' => 1,
'promote' => 0,
'sticky' => 0,
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
Angie Byron
committed
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
));
$node->save();
$nid = $node->id();
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$comment = Comment::create(array(
Angie Byron
committed
'cid' => NULL,
'pid' => 0,
'entity_id' => $nid,
'entity_type' => 'node',
'field_name' => 'comment',
Dries Buytaert
committed
'uid' => $account->id(),
Angie Byron
committed
'subject' => 'Test comment',
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
'status' => 1,
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
));
catch
committed
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_comment_create called',
'entity_crud_hook_test_entity_create called for type comment',
));
$GLOBALS['entity_crud_hook_test'] = array();
$comment->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_comment_presave called',
'entity_crud_hook_test_entity_presave called for type comment',
'entity_crud_hook_test_comment_insert called',
'entity_crud_hook_test_entity_insert called for type comment',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$comment = Comment::load($comment->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type comment',
'entity_crud_hook_test_comment_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$comment->setSubject('New subject');
$comment->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_comment_presave called',
'entity_crud_hook_test_entity_presave called for type comment',
'entity_crud_hook_test_comment_update called',
'entity_crud_hook_test_entity_update called for type comment',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$comment->delete();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_comment_predelete called',
'entity_crud_hook_test_entity_predelete called for type comment',
'entity_crud_hook_test_comment_delete called',
'entity_crud_hook_test_entity_delete called for type comment',
));
Angie Byron
committed
}
/**
* Tests hook invocations for CRUD operations on files.
Angie Byron
committed
*/
public function testFileHooks() {
$this->installEntitySchema('file');
Angie Byron
committed
$url = 'public://entity_crud_hook_test.file';
file_put_contents($url, 'Test test test');
$file = File::create([
Angie Byron
committed
'fid' => NULL,
'uid' => 1,
'filename' => 'entity_crud_hook_test.file',
'uri' => $url,
'filemime' => 'text/plain',
'filesize' => filesize($url),
'status' => 1,
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
]);
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_file_create called',
'entity_crud_hook_test_entity_create called for type file',
));
$GLOBALS['entity_crud_hook_test'] = array();
Dries Buytaert
committed
$file->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_file_presave called',
'entity_crud_hook_test_entity_presave called for type file',
'entity_crud_hook_test_file_insert called',
'entity_crud_hook_test_entity_insert called for type file',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$file = File::load($file->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type file',
'entity_crud_hook_test_file_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$file->setFilename('new.entity_crud_hook_test.file');
Dries Buytaert
committed
$file->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_file_presave called',
'entity_crud_hook_test_entity_presave called for type file',
'entity_crud_hook_test_file_update called',
'entity_crud_hook_test_entity_update called for type file',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Dries Buytaert
committed
$file->delete();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_file_predelete called',
'entity_crud_hook_test_entity_predelete called for type file',
'entity_crud_hook_test_file_delete called',
'entity_crud_hook_test_entity_delete called for type file',
));
Angie Byron
committed
}
/**
* Tests hook invocations for CRUD operations on nodes.
Angie Byron
committed
*/
public function testNodeHooks() {
Angie Byron
committed
$account = $this->createUser();
$node = entity_create('node', array(
Angie Byron
committed
'uid' => $account->id(),
Angie Byron
committed
'type' => 'article',
'title' => 'Test node',
'status' => 1,
'promote' => 0,
'sticky' => 0,
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
Angie Byron
committed
'created' => REQUEST_TIME,
'changed' => REQUEST_TIME,
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_node_create called',
'entity_crud_hook_test_entity_create called for type node',
));
$GLOBALS['entity_crud_hook_test'] = array();
$node->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_node_presave called',
'entity_crud_hook_test_entity_presave called for type node',
'entity_crud_hook_test_node_insert called',
'entity_crud_hook_test_entity_insert called for type node',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$node = Node::load($node->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type node',
'entity_crud_hook_test_node_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$node->title = 'New title';
$node->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_node_presave called',
'entity_crud_hook_test_entity_presave called for type node',
'entity_crud_hook_test_node_update called',
'entity_crud_hook_test_entity_update called for type node',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$node->delete();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_node_predelete called',
'entity_crud_hook_test_entity_predelete called for type node',
'entity_crud_hook_test_node_delete called',
'entity_crud_hook_test_entity_delete called for type node',
));
Angie Byron
committed
}
/**
* Tests hook invocations for CRUD operations on taxonomy terms.
Angie Byron
committed
*/
public function testTaxonomyTermHooks() {
$this->installEntitySchema('taxonomy_term');
Angie Byron
committed
$vocabulary = entity_create('taxonomy_vocabulary', array(
Angie Byron
committed
'name' => 'Test vocabulary',
'vid' => 'test',
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
Angie Byron
committed
'description' => NULL,
'module' => 'entity_crud_hook_test',
));
Alex Pott
committed
$vocabulary->save();
$GLOBALS['entity_crud_hook_test'] = array();
Angie Byron
committed
$term = entity_create('taxonomy_term', array(
'vid' => $vocabulary->id(),
Angie Byron
committed
'name' => 'Test term',
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
Angie Byron
committed
'description' => NULL,
'format' => 1,
));
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_term_create called',
'entity_crud_hook_test_entity_create called for type taxonomy_term',
));
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$term->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_term_presave called',
'entity_crud_hook_test_entity_presave called for type taxonomy_term',
'entity_crud_hook_test_taxonomy_term_insert called',
'entity_crud_hook_test_entity_insert called for type taxonomy_term',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$term = Term::load($term->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type taxonomy_term',
'entity_crud_hook_test_taxonomy_term_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$term->setName('New name');
Alex Pott
committed
$term->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_term_presave called',
'entity_crud_hook_test_entity_presave called for type taxonomy_term',
'entity_crud_hook_test_taxonomy_term_update called',
'entity_crud_hook_test_entity_update called for type taxonomy_term',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$term->delete();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_term_predelete called',
'entity_crud_hook_test_entity_predelete called for type taxonomy_term',
'entity_crud_hook_test_taxonomy_term_delete called',
'entity_crud_hook_test_entity_delete called for type taxonomy_term',
));
Angie Byron
committed
}
/**
* Tests hook invocations for CRUD operations on taxonomy vocabularies.
Angie Byron
committed
*/
public function testTaxonomyVocabularyHooks() {
$this->installEntitySchema('taxonomy_term');
Angie Byron
committed
$vocabulary = entity_create('taxonomy_vocabulary', array(
Angie Byron
committed
'name' => 'Test vocabulary',
'vid' => 'test',
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
Angie Byron
committed
'description' => NULL,
'module' => 'entity_crud_hook_test',
));
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_vocabulary_create called',
'entity_crud_hook_test_entity_create called for type taxonomy_vocabulary',
));
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$vocabulary->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_vocabulary_presave called',
'entity_crud_hook_test_entity_presave called for type taxonomy_vocabulary',
'entity_crud_hook_test_taxonomy_vocabulary_insert called',
'entity_crud_hook_test_entity_insert called for type taxonomy_vocabulary',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$vocabulary = Vocabulary::load($vocabulary->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type taxonomy_vocabulary',
'entity_crud_hook_test_taxonomy_vocabulary_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$vocabulary->set('name', 'New name');
Alex Pott
committed
$vocabulary->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_vocabulary_presave called',
'entity_crud_hook_test_entity_presave called for type taxonomy_vocabulary',
'entity_crud_hook_test_taxonomy_vocabulary_update called',
'entity_crud_hook_test_entity_update called for type taxonomy_vocabulary',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Alex Pott
committed
$vocabulary->delete();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_taxonomy_vocabulary_predelete called',
'entity_crud_hook_test_entity_predelete called for type taxonomy_vocabulary',
'entity_crud_hook_test_taxonomy_vocabulary_delete called',
'entity_crud_hook_test_entity_delete called for type taxonomy_vocabulary',
));
Angie Byron
committed
}
/**
* Tests hook invocations for CRUD operations on users.
Angie Byron
committed
*/
public function testUserHooks() {
$account = User::create([
Angie Byron
committed
'name' => 'Test user',
'mail' => 'test@example.com',
'created' => REQUEST_TIME,
'status' => 1,
'language' => 'en',
Angie Byron
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_user_create called',
'entity_crud_hook_test_entity_create called for type user',
));
$GLOBALS['entity_crud_hook_test'] = array();
$account->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_user_presave called',
'entity_crud_hook_test_entity_presave called for type user',
'entity_crud_hook_test_user_insert called',
'entity_crud_hook_test_entity_insert called for type user',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
User::load($account->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_entity_load called for type user',
'entity_crud_hook_test_user_load called',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
$account->name = 'New name';
$account->save();
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_user_presave called',
'entity_crud_hook_test_entity_presave called for type user',
'entity_crud_hook_test_user_update called',
'entity_crud_hook_test_entity_update called for type user',
));
Angie Byron
committed
$GLOBALS['entity_crud_hook_test'] = array();
Dries Buytaert
committed
user_delete($account->id());
Angie Byron
committed
catch
committed
$this->assertHookMessageOrder(array(
'entity_crud_hook_test_user_predelete called',
'entity_crud_hook_test_entity_predelete called for type user',
'entity_crud_hook_test_user_delete called',
'entity_crud_hook_test_entity_delete called for type user',
));
Angie Byron
committed
}
Angie Byron
committed
/**
* Tests rollback from failed entity save.
Angie Byron
committed
*/
function testEntityRollback() {
Angie Byron
committed
// Create a block.
try {
entity_create('entity_test', array('name' => 'fail_insert'))->save();
Angie Byron
committed
$this->fail('Expected exception has not been thrown.');
}
catch (\Exception $e) {
$this->pass('Expected exception has been thrown.');
}
if (Database::getConnection()->supportsTransactions()) {
// Check that the block does not exist in the database.
Alex Pott
committed
$ids = \Drupal::entityQuery('entity_test')->condition('name', 'fail_insert')->execute();
Angie Byron
committed
$this->assertTrue(empty($ids), 'Transactions supported, and entity not found in database.');
}
else {
// Check that the block exists in the database.
Alex Pott
committed
$ids = \Drupal::entityQuery('entity_test')->condition('name', 'fail_insert')->execute();
Angie Byron
committed
$this->assertFalse(empty($ids), 'Transactions not supported, and entity found in database.');
}
}