class UserIdResolverManager(ManageDialog):
"""
Management dialog for userIdResolvers
"""
new_button_id = 'button_resolver_new'
close_button_id = 'button_resolver_close'
menu_item_id = 'menu_edit_resolvers'
def __init__(self, manage_ui):
ManageDialog.__init__(self, manage_ui, 'dialog_resolvers')
self.resolvers = None
self.new_resolvers_dialog = NewResolverDialog(manage_ui)
self.no_realms_defined_dialog = ManageDialog(manage_ui,
'text_no_realm')
@staticmethod
def get_resolver_for_type(resolver_type):
"Return the derived class for a given resolver type"
if resolver_type == 'ldapresolver':
return LdapUserIdResolver
elif resolver_type == 'sqlresolver':
return SqlUserIdResolver
elif resolver_type == 'passwdresolver':
return PasswdUserIdResolver
else:
raise Exception("Unknown UserIdResolver type:%s" % (resolver_type))
@staticmethod
def parse_resolver_element(line):
# Given an element, parse out resolver info
class ResolverElement:
def __init__(self, name, resolverType, element=None):
self.name = name
self.resolverType = resolverType
self.element = element
self.name_in_dialog = "%s [%s]" % (name, resolverType)
try:
name_element = line.find_element_by_css_selector('.name')
# New style line (2.9.2) with managed flag
resolver_element = name_element
except NoSuchElementException:
# Pre 2.9.2 without managed flag
resolver_element = line
resolver_name_re = r'([\w\-]+) \[([\w\-]+)\]$'
m = re.match(resolver_name_re, resolver_element.text)
assert m, 'Error in resolver regexp for "%s"' % (resolver_element, )
assert(line.get_attribute("class") in
('ui-widget-content ui-selectee', 'ui-widget-content ui-selectee ui-selected')), \
"Resolver dialog line class unknown"
return ResolverElement(m.group(1), m.group(2), line)
def parse_contents(self):
"""
Parse the resolver dialog list and build a list of resolvers
"""
# Ensure server communication is finished
self.wait_for_waiting_finished()
# Ensure resolvers list element is visible
resolvers_list = self.find_by_id("dialog_resolvers")
self.resolvers = []
# The dialog could be empty, so disable implicit wait for the list
with self.implicit_wait_disabled():
lines = resolvers_list.find_elements_by_css_selector(
'#resolvers_list > ol > li')
for line in lines:
self.resolvers.append(self.parse_resolver_element(line))
def _get_resolver_by_name(self, name):
"""
Get resolver given the name
Return tuple:
resolver name
type
name in dialog
"""
r = [r for r in self.resolvers if r.name == name]
assert len(
r) == 1, "Resolver name %s not found in current resolver list" % (
name, )
resolver = r[0]
return resolver
def get_defined_resolvers(self):
"""
Return a list of currently defined resolver names
"""
self.raise_if_closed()
return [r.name for r in self.resolvers]
def create_resolver(self, data):
resolver_type = data['type']
self.open()
oldlist = self.get_defined_resolvers()
assert data[
'name'] not in oldlist, 'Trying to define a resolver which already exists'
oldcount = len(oldlist)
self.find_by_id(self.new_button_id).click()
self.new_resolvers_dialog.check_text(
'Which type of resolver do you want to create?')
resolverClass = self.get_resolver_for_type(resolver_type)
resolver = resolverClass(self)
assert resolver.newbutton_id, "Resolver new button id is not defined"
self.new_resolvers_dialog.click_button(resolver.newbutton_id)
# Fill in new resolver form
resolver.fill_form(data)
self.find_by_id(resolver.savebutton_id).click()
# We should be back to the resolver list
self.raise_if_closed()
self.reparse()
newlist = self.get_defined_resolvers()
newcount = len(newlist)
if newcount != oldcount + 1:
logging.error("Could not create resolver! %s", data)
assert newcount == oldcount + 1
return data['name']
def close(self):
super(UserIdResolverManager, self).close()
if self.no_realms_defined_dialog.is_open():
self._handle_first_resolver_dialogs()
def _handle_first_resolver_dialogs(self):
self.no_realms_defined_dialog.raise_if_closed()
self.no_realms_defined_dialog.close()
# The realms dialog now opens - close it
realms = self.manage.realm_manager
realms.raise_if_closed()
realms.close()
def reload(self):
# Close and reopen
self.close_if_open()
self.open()
def select_resolver(self, name):
resolver = self._get_resolver_by_name(name)
resolver.element.click()
return resolver
def edit_resolver(self, name):
"""
return resolver, given open dialog
"""
self.raise_if_closed()
resolver = self.select_resolver(name)
self.find_by_id("button_resolver_edit").click()
return resolver
def delete_resolver(self, name):
"""Click on resolver in list and delete it"""
driver = self.driver
resolver_count = len(self.resolvers)
self.select_resolver(name)
self.find_by_id("button_resolver_delete").click()
self.testcase.assertEquals("Deleting resolver",
self.find_by_id("ui-id-3").text)
t = find_by_css(driver, "#dialog_resolver_ask_delete > p").text
self.testcase.assertEqual(t, r"Do you want to delete the resolver?")
self.find_by_id("button_resolver_ask_delete_delete").click()
# We should be back to the resolver list
self.raise_if_closed()
self.manage.wait_for_waiting_finished()
# Reload resolvers
self.parse_contents()
assert (len(self.resolvers) == resolver_count - 1), (
'The number of resolvers shown should decrease after deletion. Before: %s, after:%s'
% (resolver_count, len(self.resolvers)))
def clear_resolvers(self):
"""Clear all existing resolvers"""
self.open()
while True:
resolvers = self.resolvers
if not resolvers:
break
self.delete_resolver(resolvers[0].name)
self.close()
def test_connection(self, name, expected_users=None):
"""Test the connection with the corresponding button in the UI.
Return the number of found users.
"""
self.open()
self.edit_resolver(name)
resolver = self._get_resolver_by_name(name)
resolver_info = self.get_resolver_for_type(resolver.resolverType)(self)
testbutton_id = resolver_info.testbutton_id
cancelbutton_id = resolver_info.editcancel_button_id
if not testbutton_id:
# This resolver type does not have a test button (passwd)
num_found = -1
else:
self.find_by_id(testbutton_id).click()
# Wait for alert box to be shown and then get contents
alert_box = self.manage.alert_dialog
alert_box.wait_for_dialog()
alert_box_text = alert_box.get_text()
m = re.search("Number of users found: (?P<nusers>\d+)",
alert_box_text)
if m is None:
raise Exception("test_connection for %s failed: %s" %
(name, alert_box_text))
num_found = int(m.group('nusers'))
if expected_users:
assert num_found == expected_users, "Expected number of users:%s, found:%s" % (
expected_users, num_found)
# Close the popup
alert_box.close()
# Close the resolver edit box
self.find_by_id(cancelbutton_id).click()
return num_found
class UserIdResolverManager(ManageDialog):
"""
Management dialog for userIdResolvers
"""
new_button_id = 'button_resolver_new'
close_button_id = 'button_resolver_close'
menu_item_id = 'menu_edit_resolvers'
alert_box_handler = None
def __init__(self, manage_ui):
ManageDialog.__init__(self, manage_ui, 'dialog_resolvers')
self.resolvers = None
self.new_resolvers_dialog = NewResolverDialog(manage_ui)
self.no_realms_defined_dialog = ManageDialog(
manage_ui, 'text_no_realm')
self.alert_box_handler = self.manage.alert_box_handler
@staticmethod
def get_resolver_for_type(resolver_type):
"Return the derived class for a given resolver type"
if resolver_type == 'ldapresolver':
return LdapUserIdResolver
elif resolver_type == 'sqlresolver':
return SqlUserIdResolver
elif resolver_type == 'passwdresolver':
return PasswdUserIdResolver
else:
raise Exception("Unknown UserIdResolver type:%s" % (resolver_type))
@staticmethod
def parse_resolver_element(line):
# Given an element, parse out resolver info
class ResolverElement:
def __init__(self, name, resolverType, element=None):
self.name = name
self.resolverType = resolverType
self.element = element
self.name_in_dialog = "%s [%s]" % (name, resolverType)
try:
name_element = line.find_element_by_css_selector('.name')
# New style line (2.9.2) with managed flag
resolver_element = name_element
except NoSuchElementException:
# Pre 2.9.2 without managed flag
resolver_element = line
resolver_name_re = r'([\w\-]+) \[([\w\-]+)\]$'
m = re.match(resolver_name_re, resolver_element.text)
assert m, 'Error in resolver regexp for "%s"' % (resolver_element,)
assert('ui-selectee' in line.get_attribute("class").split(" ")), \
"Resolver dialog line not selectable"
return ResolverElement(m.group(1), m.group(2), line)
def parse_contents(self):
"""
Parse the resolver dialog list and build a list of resolvers
"""
# Ensure server communication is finished
self.wait_for_waiting_finished()
# Ensure resolvers list element is visible
resolvers_list = self.find_by_id("dialog_resolvers")
self.resolvers = []
# The dialog could be empty, so disable implicit wait for the list
with self.implicit_wait_disabled():
lines = resolvers_list.find_elements_by_css_selector(
'#resolvers_list > ol > li')
for line in lines:
self.resolvers.append(self.parse_resolver_element(line))
def _get_resolver_by_name(self, name):
"""
Get resolver given the name
Return tuple:
resolver name
type
name in dialog
"""
r = [r for r in self.resolvers if r.name == name]
assert len(
r) == 1, "Resolver name %s not found in current resolver list" % (name,)
resolver = r[0]
return resolver
def get_defined_resolvers(self):
"""
Return a list of currently defined resolver names
"""
self.raise_if_closed()
return [r.name for r in self.resolvers]
def create_resolver(self, data):
resolver_type = data['type']
self.open()
oldlist = self.get_defined_resolvers()
assert data[
'name'] not in oldlist, 'Trying to define a resolver which already exists'
oldcount = len(oldlist)
self.find_by_id(self.new_button_id).click()
self.new_resolvers_dialog.check_text(
'Which type of resolver do you want to create?')
resolverClass = self.get_resolver_for_type(resolver_type)
resolver = resolverClass(self)
assert resolver.newbutton_id, "Resolver new button id is not defined"
self.new_resolvers_dialog.click_button(
resolver.newbutton_id)
# Fill in new resolver form
resolver.fill_form(data)
self.find_by_id(resolver.savebutton_id).click()
# We should be back to the resolver list
self.raise_if_closed()
self.reparse()
newlist = self.get_defined_resolvers()
newcount = len(newlist)
if newcount != oldcount + 1:
logging.error("Could not create resolver! %s", data)
assert newcount == oldcount + 1
return data['name']
def close(self):
super(UserIdResolverManager, self).close()
if self.no_realms_defined_dialog.is_open():
self._handle_first_resolver_dialogs()
def _handle_first_resolver_dialogs(self):
self.no_realms_defined_dialog.raise_if_closed()
self.no_realms_defined_dialog.close()
# The realms dialog now opens - close it
realms = self.manage.realm_manager
realms.raise_if_closed()
realms.close()
def reload(self):
# Close and reopen
self.close_if_open()
self.open()
def select_resolver(self, name):
resolver = self._get_resolver_by_name(name)
resolver.element.click()
return resolver
def edit_resolver(self, name):
"""
return resolver, given open dialog
"""
self.raise_if_closed()
resolver = self.select_resolver(name)
self.find_by_id("button_resolver_edit").click()
return resolver
def delete_resolver(self, name):
"""Click on resolver in list and delete it"""
driver = self.driver
resolver_count = len(self.resolvers)
self.select_resolver(name)
self.find_by_id("button_resolver_delete").click()
self.testcase.assertEquals(
"Deleting resolver", self.find_by_id("ui-id-3").text)
t = find_by_css(driver, "#dialog_resolver_ask_delete > p").text
self.testcase.assertEqual(t, r"Do you want to delete the resolver?")
self.find_by_id("button_resolver_ask_delete_delete").click()
# We should be back to the resolver list
self.raise_if_closed()
self.manage.wait_for_waiting_finished()
# Resolver name would be e. g. : 'test_realm5 [SE_musicians ]'
# Capture only resolver name.
resolver = re.search(r'([^\[(]+)', name).group(1).strip(' ')
delete_ok = self.alert_box_handler.check_last_message(
"Resolver deleted successfully: " + resolver)
assert delete_ok, "Error during resolver deletion!"
# Reload resolvers
self.parse_contents()
assert (len(self.resolvers) == resolver_count - 1), (
'The number of resolvers shown should decrease after deletion. Before: %s, after:%s'
% (resolver_count, len(self.resolvers))
)
def clear_resolvers_via_api(self):
"""
Get all resolvers via API call
and delete all by resolver name.
"""
# Get the resolvers in json format
json_response = self.manage.admin_api_call("system/getResolvers")
resolvers = json_response["result"]["value"]
if(resolvers):
for curr_resolver in resolvers:
self.manage.admin_api_call("system/delResolver",
{'resolver': resolvers[curr_resolver]['resolvername']})
def clear_resolvers(self):
"""
Clear all existing resolvers.
The clean up will be done via
the following steps.
1. Clear all alert boxes in the /manage UI
2. Open the resolver dialog and get all
resolvers.
3. Delete resolver x and check alert box.
4. Repeat 3. #resolvers times
"""
# /manage needs to be open for clean up
# alert box messages.
self.manage.open_manage()
# Maybe /manage was already open:
#
# Ensure that dialogs are closed.
# Otherwise we can not clear the old
# alert boxes. Realm dialog blocks
# underlying GUI elements.
self.manage.close_all_dialogs()
self.alert_box_handler.clear_messages()
# The open method 'reparses' the dialog.
# This reparse sets an internal list
# with current realms.
self.open()
while True:
# self.resolvers only returns the
# reparsed list of resolvers - set by self.open.
# Does not 'parse' the list in the GUI again.
resolvers = self.resolvers
if not resolvers:
break
self.delete_resolver(resolvers[0].name)
self.close()
def test_connection(self, name, expected_users=None):
"""Test the connection with the corresponding button in the UI.
Return the number of found users.
"""
self.open()
self.edit_resolver(name)
resolver = self._get_resolver_by_name(name)
resolver_info = self.get_resolver_for_type(resolver.resolverType)(self)
testbutton_id = resolver_info.testbutton_id
cancelbutton_id = resolver_info.editcancel_button_id
if not testbutton_id:
# This resolver type does not have a test button (passwd)
num_found = -1
else:
self.find_by_id(testbutton_id).click()
# Wait for alert box to be shown and then get contents
alert_box = self.manage.alert_dialog
alert_box.wait_for_dialog()
alert_box_text = alert_box.get_text()
m = re.search(
"Number of users found: (?P<nusers>\d+)", alert_box_text)
if m is None:
raise Exception(
"test_connection for %s failed: %s" % (name, alert_box_text))
num_found = int(m.group('nusers'))
if expected_users:
assert num_found == expected_users, "Expected number of users:%s, found:%s" % (
expected_users, num_found)
# Close the popup
alert_box.close()
# Close the resolver edit box
self.find_by_id(cancelbutton_id).click()
return num_found