Skip to content

Add LDAP groups to API #204

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

Open
amanning9 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add LDAP groups to API #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 42 additions & 3 deletions jasmin_services/api/serializers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
"""Serializers for the jasmin_services api."""

import logging

import django.contrib.auth
import django_countries.serializers
import rest_framework.serializers as rf_serial
import rest_framework_nested.serializers

from .. import models

logger = logging.getLogger()


class ServiceUserSerializer(rf_serial.HyperlinkedModelSerializer):
"""Basic UserSerializer to provide a link to the full one."""
Expand All @@ -27,24 +31,59 @@ class Meta:
fields = ["id", "user"]


class LdapGroupSerializer(rf_serial.Serializer):
cn = rf_serial.CharField(source="name")
dn = rf_serial.SerializerMethodField()
gidNumber = rf_serial.IntegerField()

@staticmethod
def get_dn(obj) -> str:
"""Build the dn from the name and the base."""
return f"cn={obj.name},{obj.base_dn}"


class RoleListSerializer(rf_serial.ModelSerializer):
"""Basic list of roles."""

user_count = rf_serial.IntegerField(read_only=True)
ldap_groups = rf_serial.SerializerMethodField(read_only=True)

class Meta:
model = models.Role
fields = ["id", "name", "user_count"]
fields = ["id", "name", "user_count", "ldap_groups"]

@staticmethod
def _to_group(obj):
"""Convert behaviours to LDAP Group Objects."""
if isinstance(obj, models.behaviours.LdapGroupBehaviour):
try:
group = obj.get_ldap_group()
except django.core.exceptions.ObjectDoesNotExist:
logger.error(
"A LDAP group behaviour exists for %s : %s, but it does not exist in LDAP.",
obj.ldap_model,
obj.group_name,
)
else:
return group
return None

def get_ldap_groups(self, obj) -> LdapGroupSerializer(many=True):
"""Return a list of LDAP groups for the role."""
groups = [
group for behaviour in obj.behaviours.all() if (group := self._to_group(behaviour))
]
return LdapGroupSerializer(groups, many=True).data


class RoleSerializer(rf_serial.ModelSerializer):
class RoleSerializer(RoleListSerializer):
"""Detail of role with holders."""

accesses = AccessSerializer(many=True)

class Meta:
model = models.Role
fields = ["id", "name", "accesses"]
fields = ["id", "name", "accesses", "user_count", "ldap_groups"]


class CategoryListSerializer(rf_serial.HyperlinkedModelSerializer):
Expand Down
24 changes: 13 additions & 11 deletions jasmin_services/tests/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def test_services_detail(self):
"url": "http://testserver/api/v1/categories/test_cat1/",
"name": "test_cat1",
},
"roles": [{"id": 1, "name": "MANAGER"}],
"roles": [{"id": 1, "name": "MANAGER", "ldap_groups": []}],
"summary": "First test category",
"description": "This should be a long description.",
"approver_message": "",
Expand Down Expand Up @@ -184,7 +184,7 @@ def test_user(self):
"summary": "First test category",
"hidden": True,
},
"role": {"id": 1, "name": "MANAGER"},
"role": {"id": 1, "name": "MANAGER", "ldap_groups": []},
"granted_at": self.manager_grant.granted_at.astimezone(DJANGO_TZ).strftime(
f"%Y-%m-%dT%H:%M:%S.%f{utc_offset}"
),
Expand All @@ -207,7 +207,7 @@ def test_user(self):
"summary": "Another test category",
"hidden": True,
},
"role": {"id": 2, "name": "DEPUTY"},
"role": {"id": 2, "name": "DEPUTY", "ldap_groups": []},
"granted_at": self.deputy_grant.granted_at.astimezone(DJANGO_TZ).strftime(
f"%Y-%m-%dT%H:%M:%S.%f{utc_offset}"
),
Expand Down Expand Up @@ -242,7 +242,7 @@ def test_grants_filter_category(self):
"summary": "First test category",
"hidden": True,
},
"role": {"id": 1, "name": "MANAGER"},
"role": {"id": 1, "name": "MANAGER", "ldap_groups": []},
"granted_at": self.manager_grant.granted_at.astimezone(DJANGO_TZ).strftime(
f"%Y-%m-%dT%H:%M:%S.%f{utc_offset}"
),
Expand Down Expand Up @@ -277,7 +277,7 @@ def test_grants_filter_service(self):
"summary": "Another test category",
"hidden": True,
},
"role": {"id": 2, "name": "DEPUTY"},
"role": {"id": 2, "name": "DEPUTY", "ldap_groups": []},
"granted_at": self.deputy_grant.granted_at.astimezone(DJANGO_TZ).strftime(
f"%Y-%m-%dT%H:%M:%S.%f{utc_offset}"
),
Expand Down Expand Up @@ -312,7 +312,7 @@ def test_grants_filter_role(self):
"summary": "First test category",
"hidden": True,
},
"role": {"id": 1, "name": "MANAGER"},
"role": {"id": 1, "name": "MANAGER", "ldap_groups": []},
"granted_at": self.manager_grant.granted_at.astimezone(DJANGO_TZ).strftime(
f"%Y-%m-%dT%H:%M:%S.%f{utc_offset}"
),
Expand Down Expand Up @@ -415,7 +415,7 @@ def test_category_services_detail(self):
"url": "http://testserver/api/v1/categories/test_cat1/",
"name": "test_cat1",
},
"roles": [{"id": 1, "name": "MANAGER"}],
"roles": [{"id": 1, "name": "MANAGER", "ldap_groups": []}],
"summary": "First test category",
"description": "This should be a long description.",
"approver_message": "",
Expand All @@ -440,6 +440,7 @@ def test_service_roles_by_id(self):
{
"id": 1,
"name": "MANAGER",
"ldap_groups": [],
"accesses": [
{
"id": 1,
Expand Down Expand Up @@ -467,6 +468,7 @@ def test_service_roles_by_category_and_name(self):
{
"id": 1,
"name": "MANAGER",
"ldap_groups": [],
"accesses": [
{
"id": 1,
Expand Down Expand Up @@ -544,7 +546,7 @@ def test_grants_list(self):
"summary": "First test category",
"hidden": True,
},
"role": {"id": 1, "name": "MANAGER"},
"role": {"id": 1, "name": "MANAGER", "ldap_groups": []},
"user": {
"id": self.user.id,
"url": "http://testserver/api/v1/users/testuser/",
Expand Down Expand Up @@ -573,7 +575,7 @@ def test_grants_list(self):
"summary": "Another test category",
"hidden": True,
},
"role": {"id": 2, "name": "DEPUTY"},
"role": {"id": 2, "name": "DEPUTY", "ldap_groups": []},
"user": {
"id": self.user.id,
"url": "http://testserver/api/v1/users/testuser/",
Expand Down Expand Up @@ -616,7 +618,7 @@ def test_category_grants_list(self):
"summary": "First test category",
"hidden": True,
},
"role": {"id": 1, "name": "MANAGER"},
"role": {"id": 1, "name": "MANAGER", "ldap_groups": []},
"user": {
"id": self.user.id,
"url": "http://testserver/api/v1/users/testuser/",
Expand Down Expand Up @@ -657,7 +659,7 @@ def test_category_grants_list_different_category(self):
"summary": "Another test category",
"hidden": True,
},
"role": {"id": 2, "name": "DEPUTY"},
"role": {"id": 2, "name": "DEPUTY", "ldap_groups": []},
"user": {
"id": self.user.id,
"url": "http://testserver/api/v1/users/testuser/",
Expand Down