class SectionTokenTest in Workbench Access 8
Tests workbench_access integration with tokens.
@group workbench_access
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\workbench_access\Kernel\SectionTokenTest uses ContentTypeCreationTrait, NodeCreationTrait, UserCreationTrait, WorkbenchAccessTestTrait
Expanded class hierarchy of SectionTokenTest
File
- tests/
src/ Kernel/ SectionTokenTest.php, line 22
Namespace
Drupal\Tests\workbench_access\KernelView source
class SectionTokenTest extends KernelTestBase {
use ContentTypeCreationTrait;
use NodeCreationTrait;
use UserCreationTrait;
use WorkbenchAccessTestTrait;
/**
* Access menu.
*
* @var \Drupal\system\MenuInterface
*/
protected $menu;
/**
* Access vocabulary.
*
* @var \Drupal\taxonomy\VocabularyInterface
*/
protected $vocabulary;
/**
* Taxonomy scheme.
*
* @var \Drupal\workbench_access\Entity\AccessSchemeInterface
*/
protected $taxonomyScheme;
/**
* Menu scheme.
*
* @var \Drupal\workbench_access\Entity\AccessSchemeInterface
*/
protected $menuScheme;
/**
* User section storage.
*
* @var \Drupal\workbench_access\UserSectionStorage
*/
protected $userStorage;
/**
* {@inheritdoc}
*/
protected static $modules = [
'node',
'link',
'menu_link_content',
'menu_ui',
'text',
'system',
'user',
'workbench_access',
'field',
'filter',
'taxonomy',
'options',
];
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this
->installConfig([
'filter',
'node',
'workbench_access',
'system',
]);
$this
->installEntitySchema('taxonomy_term');
$this
->installEntitySchema('node');
$this
->installEntitySchema('user');
$this
->installEntitySchema('menu_link_content');
$this
->installEntitySchema('section_association');
$this
->installSchema('system', [
'key_value',
'sequences',
]);
$this->vocabulary = $this
->setUpVocabulary();
$node_type = $this
->setUpContentType();
// Set a field on the node type.
$this
->setUpTaxonomyFieldForEntityType('node', $node_type
->id(), $this->vocabulary
->id(), WorkbenchAccessManagerInterface::FIELD_NAME, 'Section', $cardinality = 3);
$this->taxonomyScheme = $this
->setupTaxonomyScheme($node_type, $this->vocabulary);
// Add a menu to the node type.
$this->menu = Menu::load('main');
$node_type
->setThirdPartySetting('menu_ui', 'available_menus', [
'main',
]);
$node_type
->save();
$this->menuScheme = $this
->setupMenuScheme([
$node_type
->id(),
], [
'main',
], 'menu_section');
$this->userStorage = \Drupal::service('workbench_access.user_section_storage');
}
/**
* Tests the user section tokens.
*/
public function testUserSectionTokens() {
$user = $this
->createUser();
$link = MenuLinkContent::create([
'title' => 'Test menu link',
'link' => [
[
'uri' => 'route:<front>',
],
],
'menu_name' => $this->menu
->id(),
]);
$link
->save();
$this->userStorage
->addUser($this->menuScheme, $user, [
$link
->getPluginId(),
]);
$tokens = [
'workbench-access-sections' => 'Test menu link',
];
$bubbleable_metadata = new BubbleableMetadata();
$this
->assertTokens('user', [
'user' => $user,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->menuScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
$term = Term::create([
'name' => 'Test term',
'vid' => $this->vocabulary
->id(),
]);
$term
->save();
$this->userStorage
->addUser($this->taxonomyScheme, $user, [
$term
->id(),
]);
$tokens = [
'workbench-access-sections' => 'Test term, Test menu link',
];
$this
->assertTokens('user', [
'user' => $user,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->taxonomyScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
$term = Term::create([
'name' => 'Test term 2',
'vid' => $this->vocabulary
->id(),
]);
$term
->save();
$this->userStorage
->addUser($this->taxonomyScheme, $user, [
$term
->id(),
]);
$tokens = [
'workbench-access-sections' => 'Test term, Test term 2, Test menu link',
];
$this
->assertTokens('user', [
'user' => $user,
], $tokens, $bubbleable_metadata);
$this
->setCurrentUser($user);
$this
->assertTokens('current-user', [], $tokens, $bubbleable_metadata);
}
/**
* Tests the node section tokens.
*/
public function testNodeSectionTokens() {
// Test a node that is not assigned to a section.
$node1 = $this
->createNode([
'type' => 'page',
'title' => 'foo',
]);
$tokens = [];
$bubbleable_metadata = new BubbleableMetadata();
$this
->assertTokens('node', [
'node' => $node1,
], $tokens, $bubbleable_metadata);
$term = Term::create([
'name' => 'Test term',
'vid' => $this->vocabulary
->id(),
]);
$term
->save();
// Create a node that is assigned to a term section.
$node2 = $this
->createNode([
'type' => 'page',
'title' => 'bar',
WorkbenchAccessManagerInterface::FIELD_NAME => $term
->id(),
]);
$tokens = [
'workbench-access-sections' => 'Test term',
];
$bubbleable_metadata = new BubbleableMetadata();
$this
->assertTokens('node', [
'node' => $node2,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->taxonomyScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
// Assign to multiple terms.
$term2 = Term::create([
'name' => 'Test term two',
'vid' => $this->vocabulary
->id(),
]);
$term2
->save();
// Create a node that is assigned to a term section.
$node3 = $this
->createNode([
'type' => 'page',
'title' => 'bar',
WorkbenchAccessManagerInterface::FIELD_NAME => [
$term
->id(),
$term2
->id(),
],
]);
$tokens = [
'workbench-access-sections' => 'Test term, Test term two',
];
$bubbleable_metadata = new BubbleableMetadata();
$this
->assertTokens('node', [
'node' => $node3,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->taxonomyScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
// Create a node that is assigned to a menu section.
$link = MenuLinkContent::create([
'title' => 'Test menu link',
'link' => [
[
'uri' => 'route:<front>',
],
],
'menu_name' => $this->menu
->id(),
]);
$link
->save();
// Create a node that is in a menu section.
$node4 = $this
->createNode([
'type' => 'page',
'title' => 'bar',
]);
_menu_ui_node_save($node4, [
'title' => 'Menu test',
'menu_name' => 'main',
'description' => 'view bar',
'parent' => $link
->getPluginId(),
]);
$tokens = [
'workbench-access-sections' => 'Menu test',
];
$bubbleable_metadata = new BubbleableMetadata();
$this
->assertTokens('node', [
'node' => $node4,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->menuScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
// Create a node that is assigned to both sections.
$node5 = $this
->createNode([
'type' => 'page',
'title' => 'bar',
'field_workbench_access' => $term
->id(),
]);
_menu_ui_node_save($node5, [
'title' => 'Test another menu link',
'menu_name' => 'main',
'description' => 'view bar',
'parent' => $link
->getPluginId(),
]);
$tokens = [
'workbench-access-sections' => 'Test term, Test another menu link',
];
$this
->assertTokens('node', [
'node' => $node5,
], $tokens, $bubbleable_metadata);
$this
->assertContains($this->taxonomyScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
$this
->assertContains($this->menuScheme
->getCacheTags()[0], $bubbleable_metadata
->getCacheTags());
}
/**
* Helper function to assert tokens.
*
* @param string $type
* The token type.
* @param array $data
* The input data.
* @param array $tokens
* The tokens.
* @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
* The cache metadata.
*
* @return array
* The array of replacements.
*/
protected function assertTokens($type, array $data, array $tokens, BubbleableMetadata $bubbleable_metadata) {
$input = array_reduce(array_keys($tokens), function ($carry, $token) use ($type) {
$carry[$token] = "[{$type}:{$token}]";
return $carry;
}, []);
$replacements = \Drupal::token()
->generate($type, $input, $data, [], $bubbleable_metadata);
foreach ($tokens as $name => $expected) {
$token = $input[$name];
$this
->assertEquals($replacements[$token], $expected);
}
return $replacements;
}
}
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. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. | 1 |
EntityReferenceTestTrait:: |
protected | function | Creates a field of an entity reference field storage on the specified bundle. | |
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. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. | |
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. | |
SectionTokenTest:: |
protected | property | Access menu. | |
SectionTokenTest:: |
protected | property | Menu scheme. | |
SectionTokenTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
SectionTokenTest:: |
protected | property | Taxonomy scheme. | |
SectionTokenTest:: |
protected | property | User section storage. | |
SectionTokenTest:: |
protected | property | Access vocabulary. | |
SectionTokenTest:: |
protected | function | Helper function to assert tokens. | |
SectionTokenTest:: |
protected | function |
Overrides KernelTestBase:: |
|
SectionTokenTest:: |
public | function | Tests the node section tokens. | |
SectionTokenTest:: |
public | function | Tests the user section tokens. | |
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. | |
WorkbenchAccessTestTrait:: |
protected | function | Assert that admin can create an access scheme. | |
WorkbenchAccessTestTrait:: |
protected | function | Assert that unprivileged users cannot access admin pages. | |
WorkbenchAccessTestTrait:: |
protected | function | Sets up a user with a given role and saves it. | |
WorkbenchAccessTestTrait:: |
public | function | Checks if we are using Drupal 8 or 9. | |
WorkbenchAccessTestTrait:: |
protected | function | Loads the given scheme. | |
WorkbenchAccessTestTrait:: |
protected | function | Sets the field type. | |
WorkbenchAccessTestTrait:: |
protected | function | Sets up a user with an editor role that has access to content. | |
WorkbenchAccessTestTrait:: |
public | function | Set up a content type with workbench access enabled. | |
WorkbenchAccessTestTrait:: |
public | function | Sets up a user with an editor role that has access to content. | |
WorkbenchAccessTestTrait:: |
public | function | Sets up a menu scheme for a given node type. | |
WorkbenchAccessTestTrait:: |
protected | function | Sets up a taxonomy field on a given entity type and bundle. | |
WorkbenchAccessTestTrait:: |
public | function | Sets up a taxonomy scheme for a given node type. | |
WorkbenchAccessTestTrait:: |
public | function | Create a test vocabulary. |