You are here

class ServerTest in Lightweight Directory Access Protocol (LDAP) 8.4

@coversDefaultClass \Drupal\ldap_servers\Entity\Server @group ldap

Hierarchy

Expanded class hierarchy of ServerTest

File

ldap_servers/tests/src/Kernel/ServerTest.php, line 15

Namespace

Drupal\Tests\ldap_servers\Kernel
View source
class ServerTest extends KernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'ldap_servers',
    'externalauth',
  ];

  /**
   * Server.
   *
   * @var \Drupal\ldap_servers\Entity\Server
   */
  protected $server;

  /**
   * {@inheritdoc}
   */
  public function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('ldap_server');
    $this->server = Server::create([
      'id' => 'example',
    ]);
  }

  /**
   * Test derive user name.
   */
  public function testDeriveUserName() : void {
    $entry = new Entry('cn=hpotter,ou=people,dc=example,dc=org');
    $entry
      ->setAttribute('samAccountName', [
      'hpotter',
    ]);
    $entry
      ->setAttribute('username', [
      'harry',
    ]);

    // Default case, only user_attr set.
    $this->server
      ->set('user_attr', 'samAccountName');
    self::assertEquals('hpotter', $this->server
      ->deriveUsernameFromLdapResponse($entry));
    $this->server
      ->set('account_name_attr', 'username');
    self::assertEquals('harry', $this->server
      ->deriveUsernameFromLdapResponse($entry));
  }

  /**
   * Test the Base DN.
   */
  public function testGetBasedn() : void {
    $this->server
      ->set('basedn', []);
    self::assertEquals([], $this->server
      ->getBaseDn());
    $this->server
      ->set('basedn', [
      'ou=people,dc=hogwarts,dc=edu',
      'ou=groups,dc=hogwarts,dc=edu',
    ]);
    self::assertEquals('ou=groups,dc=hogwarts,dc=edu', $this->server
      ->getBaseDn()[1]);
    self::assertCount(2, $this->server
      ->getBaseDn());
  }

  /**
   * Test getting username from LDAP entry.
   */
  public function testDeriveAttributesFromLdapResponse() : void {
    $this->server
      ->set('account_name_attr', '');
    $this->server
      ->set('user_attr', 'cn');
    $this->server
      ->set('mail_attr', 'mail');
    $this->server
      ->set('unique_persistent_attr', 'guid');
    $empty_entry = new Entry('undefined', []);
    self::assertEquals('', $this->server
      ->deriveUsernameFromLdapResponse($empty_entry));
    self::assertEquals('', $this->server
      ->deriveEmailFromLdapResponse($empty_entry));
    $userOpenLdap = new Entry('cn=hpotter,ou=people,dc=hogwarts,dc=edu', [
      'cn' => [
        0 => 'hpotter',
      ],
      'mail' => [
        0 => 'hpotter@hogwarts.edu',
        1 => 'hpotter@students.hogwarts.edu',
      ],
      'uid' => [
        0 => '1',
      ],
      'guid' => [
        0 => '101',
      ],
      'sn' => [
        0 => 'Potter',
      ],
      'givenname' => [
        0 => 'Harry',
      ],
      'house' => [
        0 => 'Gryffindor',
      ],
      'department' => [
        0 => '',
      ],
      'faculty' => [
        0 => 1,
      ],
      'staff' => [
        0 => 1,
      ],
      'student' => [
        0 => 1,
      ],
      'gpa' => [
        0 => '3.8',
      ],
      'probation' => [
        0 => 1,
      ],
      'password' => [
        0 => 'goodpwd',
      ],
    ]);
    self::assertEquals('hpotter', $this->server
      ->deriveUsernameFromLdapResponse($userOpenLdap));
    self::assertEquals('hpotter@hogwarts.edu', $this->server
      ->deriveEmailFromLdapResponse($userOpenLdap));
    $userOpenLdap
      ->removeAttribute('mail');
    $this->server
      ->set('mail_template', '[cn]@template.com');
    self::assertEquals('hpotter@template.com', $this->server
      ->deriveEmailFromLdapResponse($userOpenLdap));
    self::assertEquals('101', $this->server
      ->derivePuidFromLdapResponse($userOpenLdap));
    $this->server
      ->set('unique_persistent_attr_binary', TRUE);
    $userOpenLdap
      ->setAttribute('guid', [
      'Rr0by/+kSEKzVGoWnkpQ4Q==',
    ]);
    self::assertEquals('52723062792f2b6b53454b7a56476f576e6b705134513d3d', $this->server
      ->derivePuidFromLdapResponse($userOpenLdap));
  }

  /**
   * Test non-latin DN.
   */
  public function testNonLatinDn() : void {
    $this->server
      ->set('account_name_attr', '');
    $this->server
      ->set('user_attr', 'cn');
    $this->server
      ->set('mail_attr', 'mail');
    $this->server
      ->set('unique_persistent_attr', 'guid');
    $userOpenLdap = new Entry('cn=zażółćgęśląjaźń,ou=people,dc=hogwarts,dc=edu', [
      'cn' => [
        0 => 'zażółćgęśląjaźń',
      ],
    ]);
    self::assertEquals('zażółćgęśląjaźń', $this->server
      ->deriveUsernameFromLdapResponse($userOpenLdap));
  }

  /**
   * Test remaining getters.
   */
  public function testGetters() : void {
    $this->server
      ->set('address', 'example.com');
    self::assertEquals('example.com', $this->server
      ->getServerAddress());
    $this->server
      ->set('bind_method', 'user');
    self::assertEquals('user', $this->server
      ->getBindMethod());
    $this->server
      ->set('binddn', '1');
    self::assertEquals('1', $this->server
      ->getBindDn());
    $this->server
      ->set('bindpw', '2');
    self::assertEquals('2', $this->server
      ->getBindPassword());
    $this->server
      ->set('grp_derive_from_dn_attr', '3');
    self::assertEquals('3', $this->server
      ->getDerivedGroupFromDnAttribute());
    $this->server
      ->set('grp_derive_from_dn', TRUE);
    self::assertEquals(TRUE, $this->server
      ->isGroupDerivedFromDn());
    $this->server
      ->set('grp_memb_attr_match_user_attr', '5');
    self::assertEquals('5', $this->server
      ->getUserAttributeFromGroupMembershipEntryAttribute());
    $this->server
      ->set('grp_memb_attr', '6');
    self::assertEquals('6', $this->server
      ->getGroupMembershipAttribute());
    $this->server
      ->set('grp_nested', FALSE);
    self::assertEquals(FALSE, $this->server
      ->isGrouppNested());
    self::assertNull($this->server
      ->getGroupObjectClass());
    $this->server
      ->set('grp_object_cat', '7');
    self::assertEquals('7', $this->server
      ->getGroupObjectClass());
    $this->server
      ->set('grp_test_grp_dn_writeable', '8');
    self::assertEquals('8', $this->server
      ->getGroupTestGroupDnWriteable());
    $this->server
      ->set('grp_test_grp_dn', '9');
    self::assertEquals('9', $this->server
      ->getGroupTestGroupDn());
    $this->server
      ->set('grp_unused', TRUE);
    self::assertEquals(TRUE, $this->server
      ->isGroupUnused());
  }

}

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.
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
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.
ServerTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ServerTest::$server protected property Server.
ServerTest::setUp public function Overrides KernelTestBase::setUp
ServerTest::testDeriveAttributesFromLdapResponse public function Test getting username from LDAP entry.
ServerTest::testDeriveUserName public function Test derive user name.
ServerTest::testGetBasedn public function Test the Base DN.
ServerTest::testGetters public function Test remaining getters.
ServerTest::testNonLatinDn public function Test non-latin DN.
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.