View source
<?php
if (function_exists('ldap_servers_module_load_include')) {
ldap_servers_module_load_include('php', 'ldap_test', 'LdapTestCase.class');
}
else {
module_load_include('php', 'ldap_test', 'LdapTestCase.class');
}
class LdapServersTestCase extends LdapTestCase {
public static function getInfo() {
return [
'name' => 'LDAP Servers Tests',
'description' => 'Test ldap servers. Servers module is primarily a storage
tool for ldap server configuration, so most of testing is just form and db testing.
there are some api like functions that are also tested.',
'group' => 'LDAP Servers',
];
}
public function __construct($test_id = NULL) {
parent::__construct($test_id);
}
public $module_name = 'ldap_servers';
protected $ldap_test_data;
public function setUp() {
parent::setUp([
'ldap_test',
]);
variable_set('ldap_simpletest', 2);
}
public function tearDown() {
parent::tearDown();
variable_del('ldap_help_watchdog_detail');
variable_del('ldap_simpletest');
}
public function testApiFunctions() {
$group = 'ldap_servers: functions';
foreach ([
'openldap1',
'activedirectory1',
] as $sid) {
$ldap_type = $sid == 'openldap1' ? 'Open Ldap' : 'Active Directory';
$this
->prepTestData('hogwarts', [
$sid,
]);
$group = "ldap_servers: functions: {$ldap_type}";
$test_data = variable_get('ldap_test_server__' . $sid, []);
ldap_servers_module_load_include('php', 'ldap_test', 'LdapServerTest.class');
$ldap_server = LdapServerTest::getLdapServerObjects($sid, NULL, TRUE);
$user_csv_entry = $test_data['csv']['users']['101'];
$user_dn = $user_csv_entry['dn'];
$user_cn = $user_csv_entry['cn'];
$user_ldap_entry = $test_data['ldap'][$user_dn];
$username = $ldap_server
->userUsernameFromLdapEntry($user_ldap_entry);
$this
->assertTrue($username == $user_csv_entry['cn'], 'LdapServer::userUsernameFromLdapEntry works when LdapServer::user_attr attribute used', $group);
$bogus_ldap_entry = [];
$username = $ldap_server
->userUsernameFromLdapEntry($bogus_ldap_entry);
$this
->assertTrue($username === FALSE, 'LdapServer::userUsernameFromLdapEntry fails correctly', $group);
$username = $ldap_server
->userUsernameFromDn($user_dn);
$this
->assertTrue($username == $user_cn, 'LdapServer::userUsernameFromDn works when LdapServer::user_attr attribute used', $group);
$username = $ldap_server
->userUsernameFromDn('bogus dn');
$this
->assertTrue($username === FALSE, 'LdapServer::userUsernameFromDn fails correctly', $group);
$desired = [];
$desired[0] = [
0 => 'cn=gryffindor,ou=groups,dc=hogwarts,dc=edu',
1 => 'cn=students,ou=groups,dc=hogwarts,dc=edu',
2 => 'cn=honors students,ou=groups,dc=hogwarts,dc=edu',
];
$desired[1] = array_merge($desired[0], [
'cn=users,ou=groups,dc=hogwarts,dc=edu',
]);
foreach ([
0,
1,
] as $nested) {
$nested_display = $nested ? 'nested' : 'not nested';
$desired_count = $nested ? 4 : 3;
$ldap_module_user_entry = [
'attr' => $user_ldap_entry,
'dn' => $user_dn,
];
$groups_desired = $desired[$nested];
$suffix = ",desired={$desired_count}, nested=" . (bool) $nested;
$groups = $ldap_server
->groupMembershipsFromUser($ldap_module_user_entry, 'group_dns', $nested);
$count = count($groups);
$diff1 = array_diff($groups_desired, $groups);
$diff2 = array_diff($groups, $groups_desired);
$pass = count($diff1) == 0 && count($diff2) == 0 && $count == $desired_count;
$this
->assertTrue($pass, "LdapServer::groupMembershipsFromUser nested={$nested}", $group . $suffix);
if (!$pass) {
debug('groupMembershipsFromUser');
debug($groups);
debug($diff1);
debug($diff2);
debug($groups_desired);
}
$groups = $ldap_server
->groupUserMembershipsFromUserAttr($ldap_module_user_entry, $nested);
$count = is_array($groups) ? count($groups) : $count;
$pass = $count === FALSE;
if ($sid == 'openldap1') {
$pass = $groups === FALSE;
}
else {
$pass = count($diff1) == 0 && count($diff2) == 0 && $count == $desired_count;
}
$this
->assertTrue($pass, "LdapServer::groupUserMembershipsFromUserAttr {$nested_display}, {$ldap_type}, is false because not configured", $group . $suffix);
if (!$pass) {
debug('groupUserMembershipsFromUserAttr');
debug($groups);
debug($diff1);
debug($diff2);
}
$groups = $ldap_server
->groupUserMembershipsFromEntry($ldap_module_user_entry, $nested);
$count = count($groups);
$diff1 = array_diff($groups_desired, $groups);
$diff2 = array_diff($groups, $groups_desired);
$pass = count($diff1) == 0 && count($diff2) == 0 && $count == $desired_count;
$this
->assertTrue($pass, "LdapServer::groupUserMembershipsFromEntry {$nested_display} works", $group . $suffix);
if (!$pass) {
debug('groupUserMembershipsFromEntry');
debug($groups);
debug($diff1);
debug($diff2);
debug($groups_desired);
}
}
}
}
public function testInstall() {
return;
$group = 'ldap_servers: install and uninstall';
$install_tables = [
'ldap_servers',
];
$modules = [
$this->module_name,
];
$ldap_module_uninstall_sequence = [
'ldap_authentication',
'ldap_test',
'ldap_user',
'ldap_group',
'ldap_servers',
];
module_disable($ldap_module_uninstall_sequence);
drupal_uninstall_modules($ldap_module_uninstall_sequence);
module_enable($modules, TRUE);
foreach ($install_tables as $table) {
$this
->assertTrue(db_table_exists($table), $table . ' table creates', $group);
}
$var_created = $this
->assertTrue(TRUE, 'ldap_servers_encryption variable initialized', $group);
$var_created = $this
->assertTrue(variable_get('ldap_servers_encrypt_key', drupal_get_hash_salt()), 'ldap_servers_encrypt_key variable initialized', $group);
module_disable($modules, TRUE);
drupal_uninstall_modules($modules, TRUE);
foreach ($install_tables as $table) {
$this
->assertFalse(db_table_exists($table), $table . ' table removed', $group);
}
$var_created = $this
->assertFalse(variable_get('ldap_servers_encryption', FALSE), 'ldap_servers_encryption variable removed', $group);
$var_created = $this
->assertFalse(variable_get('ldap_servers_encrypt_key', FALSE), 'ldap_servers_encrypt_key variable removed', $group);
$ldap_entry = [
'dn' => 'cn=hpotter,ou=people,dc=hogwarts,dc=edu',
'mail' => [
0 => 'hpotter@hogwarts.edu',
'count' => 1,
],
'sAMAccountName' => [
0 => 'hpotter',
'count' => 1,
],
'house' => [
0 => 'Gryffindor',
1 => 'Privet Drive',
'count' => 2,
],
'guid' => [
0 => 'sdafsdfsdf',
'count' => 1,
],
'count' => 3,
];
$this->ldapTestId = 'ldap_server.tokens';
$dn = ldap_servers_token_replace($ldap_entry, '[dn]');
$this
->assertTrue($dn == $ldap_entry['dn'], t('[dn] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$house0 = ldap_servers_token_replace($ldap_entry, '[house:0]');
$this
->assertTrue($house0 == $ldap_entry['house'][0], t("[house:0] token worked ({$house0}) on ldap_servers_token_replace()."), $this->ldapTestId);
$mixed = ldap_servers_token_replace($ldap_entry, 'thisold[house:0]');
$this
->assertTrue($mixed == 'thisold' . $ldap_entry['house'][0], t("thisold[house:0] token worked ({$mixed}) on ldap_servers_token_replace()."), $this->ldapTestId);
$compound = ldap_servers_token_replace($ldap_entry, '[samaccountname:0][house:0]');
$this
->assertTrue($compound == $ldap_entry['sAMAccountName'][0] . $ldap_entry['house'][0], t("[samaccountname:0][house:0] compound token worked ({$mixed}) on ldap_servers_token_replace()."), $this->ldapTestId);
$literalvalue = ldap_servers_token_replace($ldap_entry, 'literalvalue');
$this
->assertTrue($literalvalue == 'literalvalue', t("'literalvalue' token worked ({$literalvalue}) on ldap_servers_token_replace()."), $this->ldapTestId);
$house0 = ldap_servers_token_replace($ldap_entry, '[house]');
$this
->assertTrue($house0 == $ldap_entry['house'][0], t("[house] token worked ({$house0}) on ldap_servers_token_replace()."), $this->ldapTestId);
$house1 = ldap_servers_token_replace($ldap_entry, '[house:last]');
$this
->assertTrue($house1 == $ldap_entry['house'][1], t('[house:last] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$sAMAccountName = ldap_servers_token_replace($ldap_entry, '[samaccountname:0]');
$this
->assertTrue($sAMAccountName == $ldap_entry['sAMAccountName'][0], t('[samaccountname:0] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$sAMAccountNameMixedCase = ldap_servers_token_replace($ldap_entry, '[sAMAccountName:0]');
$this
->assertTrue($sAMAccountNameMixedCase == $ldap_entry['sAMAccountName'][0], t('[sAMAccountName:0] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$sAMAccountName2 = ldap_servers_token_replace($ldap_entry, '[samaccountname]');
$this
->assertTrue($sAMAccountName2 == $ldap_entry['sAMAccountName'][0], t('[samaccountname] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$sAMAccountName3 = ldap_servers_token_replace($ldap_entry, '[sAMAccountName]');
$this
->assertTrue($sAMAccountName2 == $ldap_entry['sAMAccountName'][0], t('[sAMAccountName] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$base64encode = ldap_servers_token_replace($ldap_entry, '[guid;base64_encode]');
$this
->assertTrue($base64encode == base64_encode($ldap_entry['guid'][0]), t('[guid;base64_encode] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$bin2hex = ldap_servers_token_replace($ldap_entry, '[guid;bin2hex]');
$this
->assertTrue($bin2hex == bin2hex($ldap_entry['guid'][0]), t('[guid;bin2hex] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$msguid = ldap_servers_token_replace($ldap_entry, '[guid;msguid]');
$this
->assertTrue($msguid == ldap_servers_msguid($ldap_entry['guid'][0]), t('[guid;msguid] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
$binary = ldap_servers_token_replace($ldap_entry, '[guid;binary]');
$this
->assertTrue($binary == ldap_servers_binary($ldap_entry['guid'][0]), t('[guid;binary] token worked on ldap_servers_token_replace().'), $this->ldapTestId);
module_enable($modules, TRUE);
}
public function testUIForms() {
foreach ([
1,
] as $ctools_enabled) {
$this->ldapTestId = "testUIForms.ctools.{$ctools_enabled}";
if ($ctools_enabled) {
module_enable([
'ctools',
]);
}
$ldap_simpletest_initial = variable_get('ldap_simpletest', 2);
variable_del('ldap_simpletest');
$this->privileged_user = $this
->drupalCreateUser([
'administer site configuration',
]);
$this
->drupalLogin($this->privileged_user);
$sid = 'server1';
$server_data = [];
$server_data[$sid] = [
'sid' => [
$sid,
$sid,
],
'name' => [
"Server {$sid}",
"My Server {$sid}",
],
'status' => [
1,
1,
],
'ldap_type' => [
'openldap',
'ad',
],
'address' => [
"{$sid}.ldap.fake",
"{$sid}.ldap.fake",
],
'port' => [
389,
7000,
],
'tls' => [
TRUE,
FALSE,
],
'bind_method' => [
1,
3,
],
'binddn' => [
'cn=service-account,ou=people,dc=hogwarts,dc=edu',
'',
],
'bindpw' => [
'sdfsdafsdfasdf',
'sdfsdafsdfasdf',
],
'user_attr' => [
'sAMAccountName',
'blah',
],
'account_name_attr' => [
'sAMAccountName',
'blah',
],
'mail_attr' => [
'mail',
'',
],
'mail_template' => [
'',
'[email]',
],
'unique_persistent_attr' => [
'dn',
'uniqueregistryid',
],
'unique_persistent_attr_binary' => [
1,
1,
1,
1,
],
'user_dn_expression' => [
'cn=%cn,%basedn',
'cn=%username,%basedn',
],
'ldap_to_drupal_user' => [
'code',
'different code',
],
'testing_drupal_username' => [
'hpotter',
'hpotter',
],
'testing_drupal_user_dn' => [
'cn=hpotter,ou=people,dc=hogwarts,dc=edu',
'cn=hpotter,ou=people,dc=hogwarts,dc=edu',
],
'grp_unused' => [
FALSE,
FALSE,
],
'grp_object_cat' => [
'group',
'group',
],
'grp_nested' => [
FALSE,
FALSE,
],
'grp_user_memb_attr_exists' => [
1,
1,
],
'grp_user_memb_attr' => [
'memberof',
'memberof',
],
'grp_memb_attr' => [
'member',
'member',
],
'grp_memb_attr_match_user_attr' => [
'dn',
'dn',
],
'grp_derive_from_dn' => [
1,
1,
],
'grp_derive_from_dn_attr' => [
'ou',
'ou',
],
'grp_test_grp_dn' => [
'cn=students,ou=groups,dc=hogwarts,dc=edu',
'cn=students,ou=groups,dc=hogwarts,dc=edu',
],
'grp_test_grp_dn_writeable' => [
'cn=students,ou=groups,dc=hogwarts,dc=edu',
'cn=students,ou=groups,dc=hogwarts,dc=edu',
],
];
$lcase_transformed = [
'user_attr',
'account_name_attr',
'mail_attr',
'unique_persistent_attr',
'grp_user_memb_attr',
'grp_memb_attr_match_user_attr',
'grp_derive_from_dn_attr',
];
if (!module_exists('php')) {
unset($server_data[$sid]['ldap_to_drupal_user']);
}
$this
->drupalGet('admin/config/people/ldap/servers/add');
$edit = [];
foreach ($server_data['server1'] as $input_name => $input_values) {
$edit[$input_name] = $input_values[0];
}
$this
->drupalPost('admin/config/people/ldap/servers/add', $edit, t('Add'));
$field_to_prop_map = LdapServer::field_to_properties_map();
$field_to_prop_map['bindpw'] = 'bindpw';
$ldap_servers = ldap_servers_get_servers(NULL, 'all', FALSE, TRUE);
$this
->assertTrue(count(array_keys($ldap_servers)) == 1, 'Add form for ldap server added server.', $this->ldapTestId . ' Add Server');
$this
->assertText('LDAP Server Server server1 added', 'Add form confirmation message', $this->ldapTestId . ' Add Server');
$mismatches = $this
->compareFormToProperties($ldap_servers['server1'], $server_data['server1'], 0, $field_to_prop_map, $lcase_transformed);
if (count($mismatches)) {
debug('mismatches between ldap server properties and form submitted values');
debug($mismatches);
debug($ldap_servers);
debug($server_data['server1']);
}
$this
->assertTrue(count($mismatches) == 0, 'Add form for ldap server properties match values submitted.', $this->ldapTestId . ' Add Server');
$this
->drupalGet('admin/config/people/ldap/servers/edit/server1');
$edit = [];
foreach ($server_data['server1'] as $input_name => $input_values) {
if ($input_values[1] !== NULL) {
$edit[$input_name] = $input_values[1];
}
}
unset($edit['sid']);
$this
->drupalPost('admin/config/people/ldap/servers/edit/server1', $edit, t('Update'));
$ldap_servers = ldap_servers_get_servers(NULL, 'all', FALSE, TRUE);
$this
->assertTrue(count(array_keys($ldap_servers)) == 1, 'Update form for ldap server didnt delete or add another server.', $this->ldapTestId . '.Update Server');
$mismatches = $this
->compareFormToProperties($ldap_servers['server1'], $server_data['server1'], 1, $field_to_prop_map, $lcase_transformed);
if (count($mismatches)) {
debug('mismatches between ldap server properties and form submitted values');
debug($mismatches);
}
$this
->assertTrue(count($mismatches) == 0, 'Update form for ldap server properties match values submitted.', $this->ldapTestId . '.Update Server');
$this
->drupalGet('admin/config/people/ldap/servers/delete/server1');
$this
->drupalPost('admin/config/people/ldap/servers/delete/server1', [], t('Delete'));
$ldap_servers = ldap_servers_get_servers(NULL, 'all', FALSE, TRUE);
$this
->assertTrue(count(array_keys($ldap_servers)) == 0, 'Delete form for ldap server deleted server.', $this->ldapTestId . '.Delete Server');
variable_set('ldap_simpletest', $ldap_simpletest_initial);
}
}
public function serverConfCount() {
$records = db_query('SELECT * FROM {ldap_servers}')
->fetchAllAssoc('sid');
return count(array_keys($records));
}
public function compareFormToProperties($object, $data, $item_id, $map, $lcase_transformed) {
$mismatches = [];
foreach ($data as $field_id => $values) {
$field_id = drupal_strtolower($field_id);
if (!isset($map[$field_id])) {
continue;
}
$property = $map[$field_id];
if (!property_exists($object, $property) && !property_exists($object, drupal_strtolower($property))) {
continue;
}
$property_value = $object->{$property};
$field_value = isset($values[$item_id + 2]) ? $values[$item_id + 2] : $values[$item_id];
if ($field_id == 'bindpw') {
continue;
}
if ($field_id == 'basedn') {
$pass = count($property_value) == 2;
if (!$pass) {
debug($property_value);
}
}
else {
if (in_array($field_id, $lcase_transformed) && is_scalar($field_value)) {
$field_value = drupal_strtolower($field_value);
}
$property_value_show = is_scalar($property_value) ? $property_value : serialize($property_value);
$field_value_show = is_scalar($field_value) ? $field_value : serialize($field_value);
if (is_array($property_value) && is_array($field_value)) {
$pass = count(array_diff($property_value, $field_value)) == 0;
}
elseif (is_scalar($property_value) && is_scalar($field_value)) {
$pass = $property_value == $field_value;
}
else {
$pass = FALSE;
}
}
if (!$pass) {
$mismatches[] = "property {$property} ({$property_value_show}) does not match field {$field_id} value ({$field_value_show})";
}
}
return $mismatches;
}
}
