class FieldNoteItemTest in Examples for Developers 8
Same name and namespace in other branches
- 3.x modules/field_permission_example/tests/src/Kernel/FieldNoteItemTest.php \Drupal\Tests\field_permission_example\Kernel\FieldNoteItemTest
Tests our sticky-note field type.
This class is based off the tests used in Drupal core for field plugins, since we need to use some of the same convenience methods for testing our custom field type. This base class also brings in the new PHPUnit-based kernel test system that replaces the older Simpletest- based classes.
@group field_permission_example @group examples
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\field\Kernel\FieldKernelTestBase
- class \Drupal\Tests\field_permission_example\Kernel\FieldNoteItemTest uses UserCreationTrait
- class \Drupal\Tests\field\Kernel\FieldKernelTestBase
Expanded class hierarchy of FieldNoteItemTest
See also
\Drupal\KernelTests\KernelTestBase
File
- field_permission_example/
tests/ src/ Kernel/ FieldNoteItemTest.php, line 24
Namespace
Drupal\Tests\field_permission_example\KernelView source
class FieldNoteItemTest extends FieldKernelTestBase {
use UserCreationTrait;
/**
* We add the additional modules we need loaded here.
*
* The test runner will merge the $modules lists from this class, the class
* it extends, and so on up the class hierarchy. So, it is not necessary to
* include modules in your list that a parent class has already declared.
*
* @var array
*/
public static $modules = [
'field_permission_example',
];
/**
* {@inheritdoc}
*
* This sets up the entity_test and user types to use our example
* field plugins.
*/
protected function setUp() {
parent::setUp();
$type_manager = $this->container
->get('entity_type.manager');
// Set up our entity_type and user type for our new field:
$type_manager
->getStorage('field_storage_config')
->create([
'field_name' => 'field_fieldnote',
'entity_type' => 'entity_test',
'type' => 'field_permission_example_fieldnote',
])
->save();
$type_manager
->getStorage('field_config')
->create([
'entity_type' => 'entity_test',
'field_name' => 'field_fieldnote',
'bundle' => 'entity_test',
])
->save();
// Create a form display for the default form mode, and
// add our field type.
$type_manager
->getStorage('entity_form_display')
->create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
'status' => TRUE,
])
->setComponent('field_fieldnote', [
'type' => 'field_permission_example_widget',
])
->save();
// Now do this for the user type.
$type_manager
->getStorage('field_storage_config')
->create([
'field_name' => 'user_fieldnote',
'entity_type' => 'user',
'type' => 'field_permission_example_fieldnote',
])
->save();
$type_manager
->getStorage('field_config')
->create([
'entity_type' => 'user',
'field_name' => 'user_fieldnote',
'bundle' => 'user',
])
->save();
// Fetch a form display for a user. This may already exist, so check as
// Core does.
// @see https://api.drupal.org/api/drupal/core%21includes%21entity.inc/function/entity_get_form_display/8
$entity_form_display = $type_manager
->getStorage('entity_form_display')
->load('user.user.default');
if (empty($entity_form_display)) {
$entity_form_display = $type_manager
->getStorage('entity_form_display')
->create([
'targetEntityType' => 'user',
'bundle' => 'user',
'mode' => 'default',
'status' => TRUE,
]);
}
// And add our fancy field to that display:
$entity_form_display
->setComponent('field_fieldnote', [
'type' => 'field_permission_example_widget',
])
->save();
}
/**
* Test entity fields of the field_permission_example_fieldnote field type.
*/
public function testFieldNoteItem() {
// Verify entity creation.
$type_manager = $this->container
->get('entity_type.manager');
$entity = $type_manager
->getStorage('entity_test')
->create([]);
$value = 'This is an epic entity';
$entity->field_fieldnote = $value;
$entity->name->value = $this
->randomMachineName();
$entity
->save();
// Verify entity has been created properly.
$id = $entity
->id();
$entity = $type_manager
->getStorage('entity_test')
->load($id);
$this
->assertTrue($entity->field_fieldnote instanceof FieldItemListInterface, 'Field implements interface.');
$this
->assertTrue($entity->field_fieldnote[0] instanceof FieldItemInterface, 'Field item implements interface.');
$this
->assertEqual($entity->field_fieldnote->value, $value);
$this
->assertEqual($entity->field_fieldnote[0]->value, $value);
// Verify changing the field's value.
$new_value = $this
->randomMachineName();
$entity->field_fieldnote->value = $new_value;
$this
->assertEqual($entity->field_fieldnote->value, $new_value);
// Read changed entity and assert changed values.
$entity
->save();
$entity = $type_manager
->getStorage('entity_test')
->load($id);
$this
->assertEqual($entity->field_fieldnote->value, $new_value);
// Test sample item generation.
$entity = $type_manager
->getStorage('entity_test')
->create([]);
$entity->field_fieldnote
->generateSampleItems();
$this
->entityValidateAndSave($entity);
}
/**
* Test multiple access scenarios for the fieldnote field.
*/
public function testFieldNoteAccess() {
// Let's set up some scenarios.
$scenarios = [
'admin_type' => [
'perms' => [
'administer the fieldnote field',
],
'can_view_any' => TRUE,
'can_edit_any' => TRUE,
'can_view_own' => TRUE,
'can_edit_own' => TRUE,
],
'low_access' => [
'perms' => [
'view test entity',
],
'can_view_any' => FALSE,
'can_edit_any' => FALSE,
'can_view_own' => FALSE,
'can_edit_own' => FALSE,
],
'view_any' => [
'perms' => [
'view test entity',
'view any fieldnote',
],
'can_view_any' => TRUE,
'can_edit_any' => FALSE,
'can_view_own' => FALSE,
'can_edit_own' => FALSE,
],
'edit_any' => [
'perms' => [
'view test entity',
'view any fieldnote',
'edit any fieldnote',
],
'can_view_any' => TRUE,
'can_edit_any' => TRUE,
'can_view_own' => FALSE,
'can_edit_own' => FALSE,
],
'view_own' => [
'perms' => [
'view test entity',
'view own fieldnote',
],
'can_view_any' => FALSE,
'can_edit_any' => FALSE,
'can_view_own' => TRUE,
'can_edit_own' => FALSE,
],
'edit_own' => [
'perms' => [
'view test entity',
'view own fieldnote',
'edit own fieldnote',
],
'can_view_any' => FALSE,
'can_edit_any' => FALSE,
'can_view_own' => TRUE,
'can_edit_own' => TRUE,
],
];
$value = 'This is an epic entity';
// We also need to test users as an entity to attach to. They work
// a little differently than most content entity types:
$arbitrary_user = $this
->createUser([], 'Some User');
$arbitrary_user->user_fieldnote = $value;
$arbitrary_user
->save();
$storage = $this->container
->get('entity_type.manager')
->getStorage('entity_test');
foreach ($scenarios as $name => $scenario) {
$test_user = $this
->createUser($scenario['perms'], $name);
$entity = $storage
->create([
'entity_test',
]);
$entity->field_fieldnote = $value;
$entity->name->value = $this
->randomMachineName();
$entity
->save();
foreach ([
'can_view_any',
'can_edit_any',
] as $op) {
$this
->doAccessAssertion($entity, 'field_fieldnote', $test_user, $name, $op, $scenario[$op]);
$this
->doAccessAssertion($arbitrary_user, 'user_fieldnote', $test_user, $name, $op, $scenario[$op]);
}
if ($scenario['can_view_own'] or $scenario['can_edit_own']) {
$entity->user_id = $test_user;
$entity
->save();
$test_user->user_fieldnote = $value;
$test_user
->save();
foreach ([
'can_view_own',
'can_edit_own',
] as $op) {
$this
->doAccessAssertion($entity, 'field_fieldnote', $test_user, $name, $op, $scenario[$op]);
$this
->doAccessAssertion($test_user, 'user_fieldnote', $test_user, $name, $op, $scenario[$op]);
}
}
}
}
/**
* Helper routine to run the assertions.
*/
protected function doAccessAssertion($entity, $field_name, $account, $name, $op, $expected) {
$expect_str = $expected ? "CAN" : "CANNOT";
$assert_str = "{$name} {$expect_str} do {$op} on field {$field_name}";
$operation = preg_match('/edit/', $op) ? "edit" : "view";
$result = $entity->{$field_name}
->access($operation, $account);
if ($expected) {
$this
->assertTrue($result, $assert_str);
}
else {
$this
->assertFalse($result, $assert_str);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
FieldKernelTestBase:: |
protected | property | Bag of created field storages and fields. | |
FieldKernelTestBase:: |
protected | function | Assert that a field has the expected values in an entity. | |
FieldKernelTestBase:: |
protected | function | Create a field and an associated field storage. | |
FieldKernelTestBase:: |
protected | function | Saves and reloads an entity. | |
FieldKernelTestBase:: |
protected | function | Validate and save entity. Fail if violations are found. | |
FieldKernelTestBase:: |
protected | function | Generate random values for a field_test field. | |
FieldNoteItemTest:: |
public static | property |
We add the additional modules we need loaded here. Overrides FieldKernelTestBase:: |
|
FieldNoteItemTest:: |
protected | function | Helper routine to run the assertions. | |
FieldNoteItemTest:: |
protected | function |
This sets up the entity_test and user types to use our example
field plugins. Overrides FieldKernelTestBase:: |
|
FieldNoteItemTest:: |
public | function | Test multiple access scenarios for the fieldnote field. | |
FieldNoteItemTest:: |
public | function | Test entity fields of the field_permission_example_fieldnote field type. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. |