You are here

Home » API reference » Feeds 8.3 » UserRoleTest.php

class UserRoleTest in Feeds 8.3

Same name in this branch
  1. 8.3 tests/src/Unit/Feeds/Target/UserRoleTest.php \Drupal\Tests\feeds\Unit\Feeds\Target\UserRoleTest
  2. 8.3 tests/src/Kernel/Feeds/Target/UserRoleTest.php \Drupal\Tests\feeds\Kernel\Feeds\Target\UserRoleTest

@coversDefaultClass \Drupal\feeds\Feeds\Target\UserRole @group feeds

Hierarchy

Expanded class hierarchy of UserRoleTest

File

tests/src/Kernel/Feeds/Target/UserRoleTest.php, line 13

Namespace

Drupal\Tests\feeds\Kernel\Feeds\Target
View source 
class UserRoleTest extends FeedsKernelTestBase {

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'field',
    'user',
    'feeds',
    'feeds_test_alter_source',
  ];

  /**
   * The feed type.
   *
   * @var \Drupal\feeds\FeedTypeInterface
   */
  protected $feedType;

  /**
   * The user storage.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userStorage;

  /**
   * The role storage.
   *
   * @var \Drupal\user\RoleStorageInterface
   */
  protected $roleStorage;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');

    // Create feed type.
    $this->feedType = $this
      ->createFeedTypeForCsv([
      'name' => 'name',
      'mail' => 'mail',
      'role_ids' => 'role_ids',
      'role_labels' => 'role_labels',
    ], [
      'id' => 'user_import',
      'processor' => 'entity:user',
      'processor_configuration' => [
        'update_existing' => ProcessorInterface::UPDATE_EXISTING,
        'authorize' => FALSE,
      ],
      'mappings' => [
        [
          'target' => 'name',
          'map' => [
            'value' => 'name',
          ],
        ],
        [
          'target' => 'mail',
          'map' => [
            'value' => 'mail',
          ],
          'unique' => [
            'value' => TRUE,
          ],
        ],
      ],
    ]);
    $this->userStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('user');
    $this->roleStorage = $this->container
      ->get('entity_type.manager')
      ->getStorage('user_role');
  }

  /**
   * Asserts that the given user has the given role.
   *
   * @param \Drupal\user\UserInterface $account
   *   The account to check for the role.
   * @param string $rid
   *   The expected role ID that the user should have.
   * @param string $message
   *   (optional) Assertion message.
   */
  protected function assertHasRole(UserInterface $account, $rid, $message = '') {
    $this
      ->assertTrue($account
      ->hasRole($rid), $message);
  }

  /**
   * Asserts that the given user NOT has the given role.
   *
   * @param \Drupal\user\UserInterface $account
   *   The account to check for the role.
   * @param string $rid
   *   The expected role ID that the user should NOT have.
   * @param string $message
   *   (optional) Assertion message.
   */
  protected function assertNotHasRole(UserInterface $account, $rid, $message = '') {
    $this
      ->assertFalse($account
      ->hasRole($rid), $message);
  }

  /**
   * Asserts the expected number of roles an user has.
   *
   * This excludes the authenticated user role.
   *
   * @param int $expected_number_of_roles
   *   The expected number of roles.
   * @param \Drupal\user\UserInterface $account
   *   The account to check for the role count.
   * @param string $message
   *   (optional) Assertion message.
   */
  protected function assertRoleCount($expected_number_of_roles, UserInterface $account, $message = '') {
    $this
      ->assertEquals($expected_number_of_roles, count($account
      ->getRoles(TRUE)), $message);
  }

  /**
   * Tests mapping to role without automatically creating new roles.
   */
  public function testWithoutRoleCreation() {

    // Create the manager role.
    $this
      ->createRole([], 'manager');

    // Add mapping to role.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_ids',
      ],
    ]);
    $this->feedType
      ->save();

    // Import.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia did not get any roles.
    $account = user_load_by_name('Morticia');
    $this
      ->assertNotHasRole($account, 'editor', 'Morticia does not have the editor role.');
    $this
      ->assertRoleCount(0, $account, 'Morticia has no special roles.');

    // Assert that Fester got the manager role and one role in total.
    $account = user_load_by_name('Fester');
    $this
      ->assertHasRole($account, 'manager', 'Fester has the manager role.');
    $this
      ->assertRoleCount(1, $account, 'Fester has one role.');

    // Assert that Gomez got the manager role but not the tester role, since
    // that role doesn't exist on the system.
    $account = user_load_by_name('Gomez');
    $this
      ->assertHasRole($account, 'manager', 'Gomez has the manager role.');
    $this
      ->assertNotHasRole($account, 'tester', 'Gomez does not have the tester role.');
    $this
      ->assertRoleCount(1, $account, 'Gomez has one role.');

    // Assert that Pugsley has no roles.
    $account = user_load_by_name('Pugsley');
    $this
      ->assertRoleCount(0, $account, 'Pugsley has no special roles.');

    // Assert that only one role exists:
    // - manager.
    $roles = $this->roleStorage
      ->loadMultiple();
    $this
      ->assertEquals(1, count($roles), 'Only one role exists.');
  }

  /**
   * Tests mapping to role with automatically creating new roles.
   */
  public function testWithRoleCreation() {

    // Create the manager role.
    $this
      ->createRole([], 'manager');

    // Add mapping to role.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_ids',
      ],
      'settings' => [
        'autocreate' => TRUE,
      ],
    ]);
    $this->feedType
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia got the editor role and one role in total.
    $account = user_load_by_name('Morticia');
    $this
      ->assertHasRole($account, 'editor', 'Morticia has the editor role.');
    $this
      ->assertRoleCount(1, $account, 'Morticia has one role.');

    // Assert that Fester got the manager role and one role in total.
    $account = user_load_by_name('Fester');
    $this
      ->assertHasRole($account, 'manager', 'Fester has the manager role.');
    $this
      ->assertRoleCount(1, $account, 'Fester has one role.');

    // Assert that Gomez got the manager, the editor role and two roles in
    // total.
    $account = user_load_by_name('Gomez');
    $this
      ->assertHasRole($account, 'manager', 'Gomez has the manager role.');
    $this
      ->assertHasRole($account, 'tester', 'Gomez has the tester role.');
    $this
      ->assertRoleCount(2, $account, 'Gomez has two roles.');

    // Assert that Pugsley has no roles.
    $account = user_load_by_name('Pugsley');
    $this
      ->assertRoleCount(0, $account, 'Pugsley has no special roles.');

    // Assert that three roles exist:
    // - manager;
    // - editor;
    // - tester.
    $roles = $this->roleStorage
      ->loadMultiple();
    $this
      ->assertEquals(3, count($roles), 'Three roles exist.');

    // Assert that the roles all got the expected label.
    $this
      ->assertEquals('editor', $roles['editor']
      ->label());
    $this
      ->assertEquals('tester', $roles['tester']
      ->label());
  }

  /**
   * Tests automatically creating new roles based on label.
   */
  public function testRoleCreationUsingLabel() {

    // Add mapping to role.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_labels',
      ],
      'settings' => [
        'reference_by' => 'label',
        'autocreate' => TRUE,
      ],
    ]);
    $this->feedType
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia got the Article Editor role.
    $account = user_load_by_name('Morticia');
    $this
      ->assertHasRole($account, 'article_editor', 'Morticia got the Article Editor role.');
    $this
      ->assertRoleCount(1, $account, 'Morticia has one role.');

    // Assert that Gomez got the manager and tester roles.
    $account = user_load_by_name('Gomez');
    $this
      ->assertHasRole($account, 'account_manager', 'Gomez has the manager role.');
    $this
      ->assertHasRole($account, 'software_tester', 'Gomez has the tester role.');
    $this
      ->assertRoleCount(2, $account, 'Gomez has two roles.');

    // Assert that the roles all got the expected label.
    $roles = $this->roleStorage
      ->loadMultiple();
    $this
      ->assertEquals(3, count($roles), 'Three roles exist.');
    $this
      ->assertEquals('Article Editor', $roles['article_editor']
      ->label());
    $this
      ->assertEquals('Account Manager', $roles['account_manager']
      ->label());
    $this
      ->assertEquals('Software Tester', $roles['software_tester']
      ->label());
  }

  /**
   * Tests mapping to role by role label.
   */
  public function testImportByRoleLabels() {

    // Create the manager and tester roles.
    $this
      ->createRole([], 'account_manager', 'Account Manager');
    $this
      ->createRole([], 'software_tester', 'Software Tester');

    // Add mapping to role.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_labels',
      ],
      'settings' => [
        'reference_by' => 'label',
      ],
    ]);
    $this->feedType
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia did not get any roles.
    $account = user_load_by_name('Morticia');
    $this
      ->assertNotHasRole($account, 'editor', 'Morticia does not have the editor role.');
    $this
      ->assertRoleCount(0, $account, 'Morticia has no special roles.');

    // Assert that Fester got the manager role and one roles in total.
    $account = user_load_by_name('Fester');
    $this
      ->assertHasRole($account, 'account_manager', 'Fester has the manager role.');
    $this
      ->assertRoleCount(1, $account, 'Fester has one role.');

    // Assert that Gomez got the manager and tester roles.
    $account = user_load_by_name('Gomez');
    $this
      ->assertHasRole($account, 'account_manager', 'Gomez has the manager role.');
    $this
      ->assertHasRole($account, 'software_tester', 'Gomez has the tester role.');
    $this
      ->assertRoleCount(2, $account, 'Gomez has two roles.');

    // Assert that Pugsley has no roles.
    $account = user_load_by_name('Pugsley');
    $this
      ->assertRoleCount(0, $account, 'Pugsley has no special roles.');

    // Assert that two roles exist:
    // - manager;
    // - tester.
    $roles = $this->roleStorage
      ->loadMultiple();
    $this
      ->assertEquals(2, count($roles), 'Two roles exist.');
  }

  /**
   * Tests mapping to role using only allowed roles.
   */
  public function testWithAllowedRoles() {

    // Create the manager and editor roles.
    $this
      ->createRole([], 'manager');
    $this
      ->createRole([], 'editor');

    // Add mapping to role. The manager role may not be assigned to the user by
    // the feed.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_ids',
      ],
      'settings' => [
        'allowed_roles' => [
          'manager' => FALSE,
          'editor' => 'editor',
        ],
        'autocreate' => TRUE,
      ],
    ]);
    $this->feedType
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia got the editor role and one role in total.
    $account = user_load_by_name('Morticia');
    $this
      ->assertHasRole($account, 'editor', 'Morticia has the editor role.');
    $this
      ->assertRoleCount(1, $account, 'Morticia has one role.');

    // Assert that Fester did not got the manager role, because that role was
    // not an allowed value.
    $account = user_load_by_name('Fester');
    $this
      ->assertNotHasRole($account, 'manager', 'Fester does not have the manager role.');
    $this
      ->assertRoleCount(0, $account, 'Fester has no special roles.');

    // Assert that Gomez only got the tester role and not the manager role.
    $account = user_load_by_name('Gomez');
    $this
      ->assertNotHasRole($account, 'manager', 'Gomez does not have the manager role.');
    $this
      ->assertHasRole($account, 'tester', 'Gomez has the tester role.');
    $this
      ->assertRoleCount(1, $account, 'Gomez has one role.');
  }

  /**
   * Tests that roles can be revoked and that only allowed roles are revoked.
   */
  public function testRevokeRoles() {

    // Create the manager, editor and tester roles.
    $this
      ->createRole([], 'manager');
    $this
      ->createRole([], 'editor');
    $this
      ->createRole([], 'tester');

    // Add mapping to role. The manager role may not be revoked, but the editor
    // role may.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_ids',
      ],
      'settings' => [
        'allowed_roles' => [
          'manager' => FALSE,
          'editor' => 'editor',
          'tester' => 'tester',
        ],
        'revoke_roles' => TRUE,
      ],
    ]);
    $this->feedType
      ->save();

    // Create account for Morticia with roles "manager" and "editor". In the
    // source only "editor" is specified. Morticia should keep both roles.
    $this->userStorage
      ->create([
      'name' => 'Morticia',
      'mail' => 'morticia@example.com',
      'pass' => 'mort',
      'status' => 1,
      'roles' => [
        'manager',
        'editor',
      ],
    ])
      ->save();

    // Create account for Pugsley with roles "manager", "editor" and "tester".
    // Pugsley has no roles in the source so should only keep the "manager"
    // role.
    $this->userStorage
      ->create([
      'name' => 'Pugsley',
      'mail' => 'pugsley@example.com',
      'pass' => 'pugs',
      'status' => 1,
      'roles' => [
        'manager',
        'editor',
        'tester',
      ],
    ])
      ->save();

    // Create account for Gomez and give it the "editor" role. Gomez has roles
    // "tester" and "manager" in the source, so it should lose the "editor" role
    // and gain the "tester" role.
    $this->userStorage
      ->create([
      'name' => 'Gomez',
      'mail' => 'gomez@example.com',
      'pass' => 'gome',
      'status' => 1,
      'roles' => [
        'editor',
      ],
    ])
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Morticia kept the manager and editor roles.
    $account = user_load_by_name('Morticia');
    $this
      ->assertHasRole($account, 'manager', 'Morticia still has the manager role.');
    $this
      ->assertHasRole($account, 'editor', 'Morticia has the editor role.');
    $this
      ->assertRoleCount(2, $account, 'Morticia has two roles.');

    // Assert that Pugsley only kept the manager role.
    $account = user_load_by_name('Pugsley');
    $this
      ->assertHasRole($account, 'manager', 'Pugsley still has the manager role.');
    $this
      ->assertNotHasRole($account, 'editor', 'Pugsley no longer has the editor role.');
    $this
      ->assertNotHasRole($account, 'tester', 'Pugsley no longer has the tester role.');
    $this
      ->assertRoleCount(1, $account, 'Pugsley has one role.');

    // Assert that Gomez lost the editor role, and gained the tester role.
    $account = user_load_by_name('Gomez');
    $this
      ->assertNotHasRole($account, 'editor', 'Gomez no longer has the editor role.');
    $this
      ->assertHasRole($account, 'tester', 'Gomez has the tester role.');
    $this
      ->assertRoleCount(1, $account, 'Gomez has one role.');
  }

  /**
   * Tests if no roles are revoked if the option "Revoke roles" is disabled.
   */
  public function testNoRevokeRoles() {

    // Create the manager and editor roles.
    $this
      ->createRole([], 'manager');
    $this
      ->createRole([], 'editor');

    // Add mapping to role. Set option to not revoke roles.
    $this->feedType
      ->addMapping([
      'target' => 'roles',
      'map' => [
        'target_id' => 'role_ids',
      ],
      'settings' => [
        'allowed_roles' => [
          'manager' => FALSE,
          'editor' => 'editor',
        ],
        'revoke_roles' => FALSE,
      ],
    ]);
    $this->feedType
      ->save();

    // Create account for Pugsley with roles "manager" and "editor". Pugsley has
    // no roles in the source file, but roles should not be revoked, so Pugsley
    // should keep all roles.
    $this->userStorage
      ->create([
      'name' => 'Pugsley',
      'mail' => 'pugsley@example.com',
      'pass' => 'pugs',
      'status' => 1,
      'roles' => [
        'manager',
        'editor',
      ],
    ])
      ->save();

    // Import CSV file.
    $feed = $this
      ->createFeed($this->feedType
      ->id(), [
      'source' => $this
        ->resourcesPath() . '/csv/users_roles.csv',
    ]);
    $feed
      ->import();

    // Assert that Pugsley kept all roles.
    $account = user_load_by_name('Pugsley');
    $this
      ->assertHasRole($account, 'manager', 'Pugsley still has the manager role.');
    $this
      ->assertHasRole($account, 'editor', 'Pugsley still has the editor role.');
    $this
      ->assertRoleCount(2, $account, 'Pugsley has two roles.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
FeedCreationTrait::createFeed protected function Creates a feed with default settings.
FeedCreationTrait::createFeedType protected function Creates a feed type with default settings.
FeedCreationTrait::createFeedTypeForCsv protected function Creates a feed type for the CSV parser.
FeedCreationTrait::getDefaultMappings protected function Returns default mappings for tests. 1
FeedCreationTrait::reloadFeed protected function Reloads a feed entity.
FeedsCommonTrait::$nodeType protected property The node type to test with.
FeedsCommonTrait::absolute protected function Returns the absolute path to the Drupal root.
FeedsCommonTrait::absolutePath protected function Returns the absolute directory path of the Feeds module.
FeedsCommonTrait::assertNodeCount protected function Asserts that the given number of nodes exist.
FeedsCommonTrait::createFieldWithStorage protected function Creates a field and an associated field storage.
FeedsCommonTrait::createNodeWithFeedsItem protected function Creates a new node with a feeds item field.
FeedsCommonTrait::printMessages protected function Prints messages useful for debugging.
FeedsCommonTrait::reloadEntity protected function Reloads an entity.
FeedsCommonTrait::resourcesPath protected function Returns the absolute directory path of the resources folder.
FeedsCommonTrait::resourcesUrl protected function Returns the url to the Feeds resources directory.
FeedsCommonTrait::runCompleteQueue protected function Runs all items from one queue.
FeedsCommonTrait::setUpNodeType protected function Creates a default node type called 'article'.
FeedsKernelTestBase::installTaxonomyModuleWithVocabulary protected function Installs the taxonomy module and adds a vocabulary.
FeedsKernelTestBase::setUpBodyField protected function Installs body field (not needed for every kernel test).
FeedsKernelTestBase::setUpFileFields protected function Installs a file and image fields (not needed for every kernel test).
FeedsKernelTestBase::setUpTermReferenceField protected function Installs a taxonomy term reference field.
FeedsReflectionTrait::callProtectedMethod protected function Calls a protected method on the given object.
FeedsReflectionTrait::getMethod protected function Gets a ReflectionMethod for a class method.
FeedsReflectionTrait::getProtectedClosure protected function Returns a dynamically created closure for the object's method.
FeedsReflectionTrait::setProtectedProperty protected function Sets a protected property.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess 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::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser
UserRoleTest::$feedType protected property The feed type.
UserRoleTest::$modules public static property Modules to enable. Overrides FeedsKernelTestBase::$modules
UserRoleTest::$roleStorage protected property The role storage.
UserRoleTest::$userStorage protected property The user storage.
UserRoleTest::assertHasRole protected function Asserts that the given user has the given role.
UserRoleTest::assertNotHasRole protected function Asserts that the given user NOT has the given role.
UserRoleTest::assertRoleCount protected function Asserts the expected number of roles an user has.
UserRoleTest::setUp protected function Overrides FeedsKernelTestBase::setUp
UserRoleTest::testImportByRoleLabels public function Tests mapping to role by role label.
UserRoleTest::testNoRevokeRoles public function Tests if no roles are revoked if the option "Revoke roles" is disabled.
UserRoleTest::testRevokeRoles public function Tests that roles can be revoked and that only allowed roles are revoked.
UserRoleTest::testRoleCreationUsingLabel public function Tests automatically creating new roles based on label.
UserRoleTest::testWithAllowedRoles public function Tests mapping to role using only allowed roles.
UserRoleTest::testWithoutRoleCreation public function Tests mapping to role without automatically creating new roles.
UserRoleTest::testWithRoleCreation public function Tests mapping to role with automatically creating new roles.