overhaul for comanage syncing

Author: kyre6371

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Python: Remote Attach",
+        "type": "python",
+        "request": "attach",
+        "host": "localhost",
+        "port": 5678,
+        "pathMappings": [
+          {
+            "localRoot": "${workspaceFolder}/rcamp",
+            "remoteRoot": "/opt/rcamp"
+          }
+        ]
+      }
+    ]
+}

Dockerfile

@@ -9,10 +9,10 @@ ARG GOSU_VERSION=1.16
 
 # Install dependencies 
 RUN dnf -y install 'dnf-command(config-manager)' \
- && dnf config-manager --set-enabled powertools \
- && dnf -y install epel-release \
- && dnf -y groupinstall "Development Tools" \
- && dnf -y install xz dpkg which sssd pam_radius sqlite pam-devel openssl-devel python3-devel openldap-devel mysql-devel pcre-devel
+  && dnf config-manager --set-enabled powertools \
+  && dnf -y install epel-release \
+  && dnf -y groupinstall "Development Tools" \
+  && dnf -y install xz dpkg which sssd pam_radius sqlite pam-devel python3-devel openssl-devel openldap-devel mysql-devel pcre-devel
 
 # Install gosu to drop user and chown shared volumes at runtime
 ADD ["https://github.com/tianon/gosu/releases/download/${GOSU_VERSION}/gosu-amd64", "/usr/bin/gosu"]
@@ -74,4 +74,5 @@ HEALTHCHECK --interval=30s --timeout=30s --start-period=60s --retries=3 CMD curl
 
 COPY ["docker-entrypoint.sh", "/usr/local/bin/"]
 ENTRYPOINT ["sh","/usr/local/bin/docker-entrypoint.sh"]
+#CMD python3 -m debugpy --listen 0.0.0.0:5678 --wait-for-client manage.py runserver 0.0.0.0:8000
 CMD ["/opt/rcamp_venv/bin/uwsgi", "/opt/uwsgi.ini"]

cmds

@@ -0,0 +1,2 @@
+docker-compose run --rm --entrypoint "python3" rcamp-uwsgi manage.py migrate
+docker-compose run --rm --entrypoint "python3" rcamp-uwsgi manage.py createsuperuser

docker-compose.yml

@@ -1,11 +1,11 @@
-version: "3.6"
 
 services:
   rcamp-uwsgi:
     build:
       context: .
     container_name: rcamp-uwsgi
     command: ["python3", "manage.py", "runserver", "0.0.0.0:8000"]
+    # command: ["python3", "-m", "debugpy", "--listen", "0.0.0.0:5678", "--wait-for-client", "manage.py", "runserver", "0.0.0.0:8000"]
     env_file:
       - dev-environment.env
     environment:
@@ -19,9 +19,10 @@ services:
       - rcamp-logs:/opt/logs
     ports:
       - "80:8000"
+      - "5678:5678"  # Debugger port
     depends_on:
-      - database
-      - ldap
+      database:
+        condition: service_healthy
 
   database:
     image: mysql:5.7
@@ -31,10 +32,11 @@ services:
       - MYSQL_DATABASE=rcamp1712
     volumes:
       - database:/var/lib/mysql
-
-  ldap:
-    image: researchcomputing/rc-test-ldap
-    container_name: ldap
+    healthcheck:
+      test: ["CMD-SHELL", "mysqladmin ping -h localhost -u root -ppassword"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
 
 volumes:
   static-content:

rcamp/accounts/admin.py

@@ -1,6 +1,6 @@
 import logging
 
-from django.contrib import admin
+from django.contrib import admin, messages
 from django.contrib.auth import admin as auth_admin
 from django import forms
 from lib.fields import LdapCsvField
@@ -10,10 +10,24 @@
     CuLdapUser,
     RcLdapGroup,
     IdTracker,
+    ComanageUser,
+    ComanageGroup,
     AccountRequest,
     Intent,
     ORGANIZATIONS
 )
+from django.urls import reverse_lazy
+from django.shortcuts import render
+from .forms import ComanageSyncForm
+from .models import ComanageUser
+from comanage.lib import UserCO
+from lib.utils import get_user_and_groups, get_comanage_users_by_org
+from django.urls import path
+from django.utils.html import format_html
+from django.urls import reverse
+from django.shortcuts import redirect
+from django.http import HttpResponseRedirect
+from django.db.models import Q
 
 
 @admin.register(User)
@@ -204,4 +218,267 @@ class RcLdapGroupAdmin(RcLdapModelAdmin):
     search_fields = ['name']
     form = RcLdapGroupForm
 
+# Custom action to sync users from Comanage
+def sync_users_from_comanage(modeladmin, request, queryset):
+    """
+    Sync the selected users from Comanage.
+    """
+    if not queryset:
+        users = ["kyre0001_amc"]
+        for user in users:
+            # try:
+            #     ComanageUser.sync_from_comanage(user.user_id)  # Call the sync method on the user
+            #     modeladmin.message_user(request, f"User {user.name} synced successfully!")
+            # except Exception as e:
+            #     modeladmin.message_user(request, f"Error syncing user {user.name}: {str(e)}", level='debug')
+            try:
+                ComanageUser.sync_from_comanage(user)  # Call the sync method on the user
+                modeladmin.message_user(request, f"User {user} synced successfully!")
+            except Exception as e:
+                modeladmin.message_user(request, f"Error syncing user {user}: {str(e)}", level='debug')
+
+# Action to sync users in bulk
+def sync_users_from_comanage(modeladmin, request, queryset):
+    """
+    Sync the selected users from Comanage.
+    """
+    if queryset.count() == 0:
+        modeladmin.message_user(request, "No users selected to sync.", level=messages.WARNING)
+        return
+
+    for user in queryset:
+        try:
+            # Assuming ComanageUser.sync_from_comanage expects user ID
+            ComanageUser.sync_from_comanage(user.user_id)  # Sync logic here
+            modeladmin.message_user(request, f"User {user.name} synced successfully!", level=messages.SUCCESS)
+        except Exception as e:
+            modeladmin.message_user(request, f"Error syncing user {user.name}: {str(e)}", level=messages.ERROR)
+
+# ComanageUserAdmin with additional customization and sync functionality
+class ComanageUserAdmin(admin.ModelAdmin):
+    list_display = ['user_id', 'name', 'email', 'co_person_id']
+    search_fields = ['user_id', 'name', 'email', 'co_person_id']
+    readonly_fields = ['user_id', 'name', 'email', 'co_person_id', 'group_names', 'created_at', 'modified']
+    actions = [sync_users_from_comanage]
+
+    # Disable the "Add" button in the list view
+    def has_add_permission(self, request):
+        return False
+
+    # Disable the delete button for individual objects
+    def has_delete_permission(self, request, obj=None):
+        return False
+    
+    def changelist_view(self, request, extra_context=None):
+        """
+        Override the changelist view to trigger a function when the list of users is accessed.
+        """
+        # Call your custom function here (e.g., sync users from Comanage)
+        try:
+            user = "kyre0001_amc"  # Or you can filter users as needed
+            ComanageUser.sync_from_comanage(user)  # Call your sync function here
+            self.message_user(request, "Users synced successfully!", level=messages.SUCCESS)
+        except Exception as e:
+            self.message_user(request, f"Error syncing users: {str(e)}", level=messages.ERROR)
+
+        # Proceed with the normal changelist view rendering
+        return super().changelist_view(request, extra_context)
+
+    # Override the change_view method to remove the "Save" button and show custom sync button
+    def change_view(self, request, object_id, form_url='', extra_context=None):
+        extra_context = extra_context or {}
+        extra_context['show_save_and_add_another'] = False
+        extra_context['show_save_and_continue'] = False
+        extra_context['show_save'] = False
+
+        return super().change_view(request, object_id, form_url, extra_context)
+
+# class ComanageUserAdmin(admin.ModelAdmin):
+#     list_display = ['user_id', 'name', 'email', 'co_person_id']
+#     search_fields = ['user_id', 'name', 'email', 'co_person_id']
+#     readonly_fields = ['user_id', 'name', 'email', 'co_person_id', 'group_names', 'created_at', 'modified',]
+#     actions = [sync_users_from_comanage]
+
+#     # Disable the "Add" button in the list view
+#     def has_add_permission(self, request):
+#         return False
+
+#     # Disable the delete button for individual objects
+#     def has_delete_permission(self, request, obj=None):
+#         return False
+
+#     # Override the change_view method to remove the "Save" button
+#     def change_view(self, request, object_id, form_url='', extra_context=None):
+#         extra_context = extra_context or {}
+#         extra_context['show_save_and_add_another'] = False
+#         extra_context['show_save_and_continue'] = False
+#         extra_context['show_save'] = False
+#         return super().change_view(request, object_id, form_url, extra_context)
+
+    # Optionally, you can define a custom form (not shown here)
+    # form = CustomUserForm  # Uncomment and define your form if necessary
+
+# class ComanageSyncAdmin(admin.ModelAdmin):
+#     change_list_template = "comanage_sync_list.html"  # Custom template for the changelist page
+#     list_display = ('user_id', 'name', 'email', 'created_at', 'modified', 'actions')
+#     search_fields = ['user_id', 'name', 'email']
+#     actions = ['custom_action'] 
+
+#     def changelist_view(self, request, extra_context=None):
+#         search_query = request.GET.get('q', '') 
+        
+#         # Filter user data if there is a search query
+#         if search_query:
+#             user_data = ComanageUser.objects.filter(
+#                 Q(user_id__icontains=search_query) | Q(email__icontains=search_query)
+#             )
+#         else:
+#             # Fetch all user data if no search query is provided
+#             user_data = ComanageUser.objects.all()
+
+#         # Add user data to the context for rendering
+#         extra_context = extra_context or {}
+#         extra_context['user_data'] = user_data
+#         extra_context['search_query'] = search_query  # Optional: to display the query in the search bar
+
+#         # Render the custom changelist view with the extra context
+#         return super().changelist_view(request, extra_context=extra_context)
+
+#     # Define custom URL for detailed group view
+#     def get_urls(self):
+#         # Get default admin URLs
+#         urls = super().get_urls()
+
+#         # Add custom URL for sync users and user detail view
+#         custom_urls = [
+#             path('sync-users/', self.admin_site.admin_view(self.sync_multiple_users), name='comanage-sync-users'),
+#             path('comanage-sync/<str:user_id>/view-groups/', self.admin_site.admin_view(self.view_groups), name='comanage-sync-view-groups'),
+#             path('comanage-sync/<str:user_id>/', self.admin_site.admin_view(self.comanage_sync_view), name='comanage-sync-user-detail'),
+#         ]
+#         return custom_urls + urls
+
+#     # View to show detailed user info and groups
+#     def comanage_sync_view(self, request, user_id):
+#         # Fetch user and group data based on user_id
+#         user_data, groups = get_user_and_groups(user_id)  # You need to implement this function
+
+#         # Render the user detail page with user data and groups
+#         return render(request, 'comanage_sync_detail.html', {
+#             'user_data': user_data,
+#             'groups': groups,
+#         })
+
+#     # Function to handle syncing multiple users
+#     def sync_multiple_users(self, request):
+#         # Define your list of user_ids to sync
+
+#         user_data = get_comanage_users_by_org()
+
+#         # Sync users from Comanage
+#         for user in user_data:
+#             ComanageUser.sync_from_comanage(user.cuhpcuid)  # Sync method for updating users
+
+#         # Redirect back to the changelist view after sync is complete
+#         self.message_user(request, "Users have been synced successfully!")
+#         url = reverse('admin:accounts_comanageuser_changelist')
+
+#         return redirect(url)  # Update this URL if necessary
+
+#     # Add actions to your admin class to display a custom button
+#     def changelist_actions(self, request):
+#         # Custom button that will trigger the sync function
+#         return format_html('<a class="button" href="{}">Sync Users</a>', 
+#             self.admin_site.urls['comanage-sync-users']
+#         )
+
+#     def custom_action(self, obj):
+#         # Add "View Groups" link for each user
+#         return format_html('<a href="{}" class="button">View Groups</a>',
+#             reverse('admin:comanage-sync-user-detail', args=[obj.user_id])
+#         )
+        
+#     def view_groups(self, request, user_id):
+#         try:
+#             # Fetch the user based on user_id
+#             user = ComanageUser.objects.get(user_id=user_id)
+            
+#             # Fetch the user's groups, assuming you have a `groups` field or relation in your model
+#             user_groups = user.groups.all()
+
+#             # Get members of each group (assuming there's a Many-to-Many or ForeignKey relationship with users)
+#             group_members = {}
+#             for group in user_groups:
+#                 group_members[group.name] = group.members.all()  # Adjust based on your Group model
+
+#             return render(request, 'view_groups.html', {
+#                 'user': user,
+#                 'user_groups': user_groups,
+#                 'group_members': group_members,
+#             })
+
+#         except ComanageUser.DoesNotExist:
+#             raise Http404("User not found")
+
+class ComanageGroupForm(forms.ModelForm):
+    def __init__(self, *args, **kwargs):
+        super(ComanageGroupForm, self).__init__(*args, **kwargs)
+        instance = getattr(self, 'instance', None)
+        group_members = None
+
+        if instance and instance.pk:
+            # If the group instance exists, filter out the members already in the group
+            group_members = instance.members.all()
+            available_users = ComanageUser.objects.all()
+        else:
+            # If this is a new group, show all users
+            available_users = ComanageUser.objects.all()
+
+        # Prepare choices for the 'members' field (users not already in the group)
+        user_choices = [
+            (user.id, f'{user.name} ({user.user_id})') for user in available_users
+        ]
+
+        # Set pre-selected members based on the group instance
+        self.fields['members'].initial = group_members
+
+        # Set the required fields
+        self.fields['gid'].required = False
+        self.fields['members'].required = False
+
+        # Apply the filtered multi-select widget
+        self.fields['members'].widget = admin.widgets.FilteredSelectMultiple(
+            verbose_name='Members',
+            is_stacked=False
+        )
+
+        # Assign the available choices dynamically
+        self.fields['members'].choices = user_choices
+
+    class Meta:
+        model = ComanageGroup
+        fields = ['name', 'group_id', 'gid', 'created_at', 'modified', 'members']
+
+class ComanageGroupAdmin(admin.ModelAdmin):
+    list_display = ['name', 'gid', 'get_members']
+    search_fields = ['name', 'group_id', 'gid']
+    readonly_fields = ['group_id', 'created_at', 'modified']
+    form = ComanageGroupForm
+
+    # Custom method to display group members
+    def get_members(self, obj):
+        """
+        Custom method to display all members of the group in the admin list view.
+        """
+        return ", ".join([user.name for user in obj.members.all()])
+
+    get_members.short_description = 'Group Members'
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request)
+        # Optionally, modify the queryset if needed
+        return queryset
+
+admin.site.register(ComanageGroup, ComanageGroupAdmin)
+admin.site.register(ComanageUser, ComanageUserAdmin)
+
 admin.site.register(IdTracker)

rcamp/accounts/forms.py

@@ -12,6 +12,9 @@
     REQUEST_ROLES
 )
 
+class ComanageSyncForm(forms.Form):
+    user_id = forms.CharField(max_length=255)
+
 class AccountRequestVerifyForm(forms.Form):
     """
     An abstract form for verifying user credentials against a configured authority