Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CSV column to map permission for Viewer role on folder #10

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add CSV column to map permission for Viewer role on folder #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2d0930
Add CSV column to map permission for Viewer role on folder
May 22, 2023
59fee8b
Fix test_ldap.py
May 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions example.csv
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
ZBV/LDAP-Gruppe,Grafana-Team-Name,Grafana-Team-ID,Grafana-Folder-Name,Grafana-Folder-UUID,Grafana-Folder-Permissions
mathematicians,mathematicians,2,math,math_folder,Admin
mathematicians,smart people,2,all,all,View
scientists,scientists,2,science,science_folder,Admin
scientists,smart people,2,all,all,View
chemists,chemists,2,chemistry,chemistry_folder,Admin
chemists,smart people,2,all,all,View
ZBV/LDAP-Gruppe,Grafana-Team-Name,Grafana-Team-ID,Grafana-Folder-Name,Grafana-Folder-UUID,Grafana-Folder-Permissions,Grafana-Folder-Permissions-For-Viewer
mathematicians,mathematicians,2,math,math_folder,Admin,View
mathematicians,smart people,2,all,all,View,View
scientists,scientists,2,science,science_folder,Admin,
scientists,smart people,2,all,all,View,
chemists,chemists,2,chemistry,chemistry_folder,Admin,
chemists,smart people,2,all,all,View,
6 changes: 5 additions & 1 deletion script/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ def read_mapping_from_csv(bind):
folder_name = line[3]
folder_uuid = line[4]
permission = line[5]
permission_for_viewer = line[6]
if not team in result["teams"]:
result["teams"][team] = {"ldap": []}
if not ldap in result["teams"][team]["ldap"]:
Expand All @@ -78,6 +79,9 @@ def read_mapping_from_csv(bind):
access = {"teamId": team, "permission": permission}
if not access in result["folders"][folder_uuid]["permissions"]:
result["folders"][folder_uuid]["permissions"].append(access)
viewer_access = {"role": "Viewer", "permission": permission_for_viewer}
if permission_for_viewer != "" and not viewer_access in result["folders"][folder_uuid]["permissions"]:
result["folders"][folder_uuid]["permissions"].append(viewer_access)
else:
is_header = False
return result
Expand Down Expand Up @@ -175,7 +179,7 @@ def update_folders(folders):
create_folder(folders[folder_id]["name"], folder_id)
permissions = folders[folder_id]["permissions"]
for permission in permissions:
permission["teamId"] = get_id_of_team(permission["teamId"])
permission["teamId"] = get_id_of_team(permission["teamId"]) if not "role" in permission else 0
permission["permission"] = PERMISSION_MAP[permission["permission"]]
update_folder_permissions(folder_id, permissions)

Expand Down
19 changes: 11 additions & 8 deletions tests/test_core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,18 @@ def test_reads_mapping(self, mock_read_csv):
"header3",
"header4",
"header5",
"header6"],
"header6",
"header7"],
["test_ldap_group",
"test_grafana_team",
"test_grafana_team-id",
"test_grafana_folder_name",
"test_grafana_folder_uid",
"test_grafana_folder_permission"]
"test_grafana_folder_permission",
"test_grafana_folder_permission_for_viewer"]
]

mapping = core.read_mapping_from_csv()
mapping = core.read_mapping_from_csv("")

self.assertTrue("teams" in mapping)
self.assertTrue("test_grafana_team" in mapping["teams"])
Expand All @@ -51,7 +53,8 @@ def test_reads_mapping(self, mock_read_csv):
self.assertTrue("name" in mapping["folders"]["test_grafana_folder_uid"])
self.assertTrue("permissions" in mapping["folders"]["test_grafana_folder_uid"])
self.assertEqual("test_grafana_folder_name", mapping["folders"]["test_grafana_folder_uid"]["name"])
self.assertEqual([{"teamId": "test_grafana_team", "permission": "test_grafana_folder_permission"}],
self.assertEqual([{"teamId": "test_grafana_team", "permission": "test_grafana_folder_permission"},
{"role": "Viewer", "permission": "test_grafana_folder_permission_for_viewer"}],
mapping["folders"]["test_grafana_folder_uid"]["permissions"])


Expand Down Expand Up @@ -379,7 +382,7 @@ def test_locks_and_unlocks(self, mock_setup_ldap, mock_unlock, mock_remove_unuse
mock_config.return_value = True
mock_lock.return_value = True

core.startUserSync("")
core.startUserSync("", "", "")

self.assertEqual(mock_lock.call_count, 1)
self.assertEqual(mock_unlock.call_count, 1)
Expand All @@ -405,7 +408,7 @@ def test_locks_and_unlocks_on_connection_error(self, mock_setup_ldap, mock_unloc
mock_config.return_value = True
mock_lock.return_value = True

core.startUserSync("")
core.startUserSync("", "", "")

self.assertEqual(mock_lock.call_count, 1)
self.assertEqual(mock_unlock.call_count, 1)
Expand All @@ -432,7 +435,7 @@ def test_locks_and_unlocks_on_LDAPSocketOpenError(self, mock_setup_ldap, mock_un
mock_config.return_value = True
mock_lock.return_value = True

core.startUserSync("")
core.startUserSync("", "", "")

self.assertEqual(mock_lock.call_count, 1)
self.assertEqual(mock_unlock.call_count, 1)
Expand All @@ -457,7 +460,7 @@ def test_nothing_called_when_locked(self, mock_unlock, mock_remove_unused_items,
mock_config.return_value = True
mock_lock.return_value = False

core.startUserSync("")
core.startUserSync("", "", "")

self.assertEqual(mock_lock.call_count, 1)
self.assertFalse(mock_remove_unused_items.called)
Expand Down
58 changes: 40 additions & 18 deletions tests/test_ldap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,43 +50,65 @@ def test_creates_connection(self, mock_configuration, mock_server, mock_connecti


class fetch_users_of_group(TestCase):
@patch("script.ldap.get_ntlm_connection")
@patch("script.ldap.connection")
@patch("script.ldap.configuration")
def test_retrieves_users_NTML(self, mock_configuration, mock_get_ntlm_connection):
def test_retrieves_users_NTML(self, mock_configuration, mock_connection):
mock_configuration.LDAP_USER_SEARCH_BASE.value = "my_search_base"
mock_configuration.LDAP_GROUP_DESCRIPTOR = "my_group"
mock_configuration.LDAP_IS_NTLM = True
mock_configuration.LDAP_MEMBER_ATTRIBUTE = "member"
mock_configuration.LDAP_USER_LOGIN_ATTRIBUTE = "uid"
mock_connection = Mock()
mock_connection.extend.standard.paged_search.return_value = [
{"attributes": {"member": ["uid=my_login, foo=bar"],
"another_attribute": ["i_am_not_retrieved"]}}]
mock_get_ntlm_connection.return_value = mock_connection
mock_configuration.LDAP_USER_NAME_ATTRIBUTE = "name"
mock_configuration.LDAP_USER_MAIL_ATTRIBUTE = "mail"
mock_connection.extend.standard.paged_search.side_effect = [
[
{
"attributes": {
"member": ["uid=my_login, foo=bar"],
"another_attribute": ["i_am_not_retrieved"]
}
}
],[
{
"attributes": {"uid":"my_login", "name":"my_name","mail":"my_mail"}
}
]
]

output = ldap.fetch_users_of_group("test_group")

self.assertEqual([{"login": "my_login"}], output)
self.assertEqual(mock_get_ntlm_connection.call_count, 1)
self.assertEqual([{"login": "my_login", "name":"my_name","email":"my_mail"}], output)
self.assertEqual(mock_connection.extend.standard.paged_search.call_count, 2)

@patch("script.ldap.get_ldap_connection")
@patch("script.ldap.connection")
@patch("script.ldap.configuration")
def test_retrieves_users(self, mock_configuration, mock_get_ldap_connection):
def test_retrieves_users(self, mock_configuration, mock_connection):
mock_configuration.LDAP_USER_SEARCH_BASE.value = "my_search_base"
mock_configuration.LDAP_GROUP_DESCRIPTOR = "my_group"
mock_configuration.LDAP_IS_NTLM = False
mock_configuration.LDAP_MEMBER_ATTRIBUTE = "member"
mock_configuration.LDAP_USER_LOGIN_ATTRIBUTE = "uid"
mock_connection = Mock()
mock_connection.extend.standard.paged_search.return_value = [
{"attributes": {"member": ["uid=my_login, foo=bar"],
"another_attribute": ["i_am_not_retrieved"]}}]
mock_get_ldap_connection.return_value = mock_connection
mock_configuration.LDAP_USER_NAME_ATTRIBUTE = "name"
mock_configuration.LDAP_USER_MAIL_ATTRIBUTE = "mail"
mock_connection.extend.standard.paged_search.side_effect = [
[
{
"attributes": {
"member": ["uid=my_login, foo=bar"],
"another_attribute": ["i_am_not_retrieved"]
}
}
],[
{
"attributes": {"uid":"my_login", "name":"my_name","mail":"my_mail"}
}
]
]

output = ldap.fetch_users_of_group("test_group")

self.assertEqual([{"login": "my_login"}], output)
self.assertEqual(mock_get_ldap_connection.call_count, 1)
self.assertEqual([{"login": "my_login", "name":"my_name","email":"my_mail"}], output)
self.assertEqual(mock_connection.extend.standard.paged_search.call_count, 2)


class get_users_of_group(TestCase):
Expand Down