SARC-292 SARC-293 users exceptions

sarc/ldap/acquire.py

@@ -16,7 +16,7 @@
 import sarc.ldap.mymila
 from sarc.config import config
 from sarc.ldap.mymila import fetch_mymila
-from sarc.ldap.read_mila_ldap import fetch_ldap
+from sarc.ldap.read_mila_ldap import fetch_ldap, load_ldap_exceptions
 from sarc.ldap.revision import commit_matches_to_database
 
 
@@ -92,7 +92,13 @@ def run(prompt=False):
     #       "drac_members": {...} or None
     #     }
 
+    exceptions = load_ldap_exceptions(cfg.ldap)
+
     for _, user in DD_persons_matched.items():
+        if user["mila_ldap"]["mila_email_username"] in exceptions["delegations"]:
+            user["teacher_delegations"] = exceptions["delegations"][
+                user["mila_ldap"]["mila_email_username"]
+            ]
         fill_computed_fields(user)
 
     # These associations can now be propagated to the database.

sarc/ldap/api.py

@@ -30,6 +30,8 @@ class User(BaseModel):
     mila: Credentials
     drac: Optional[Credentials]
 
+    teacher_delegations: Optional[list[str]] = None
+
     mila_ldap: dict
     drac_members: Optional[dict]
     drac_roles: Optional[dict]

sarc/ldap/revision.py

@@ -106,6 +106,7 @@ def user_insert(newuser: dict) -> list:
         "mila",
         "drac_roles",
         "drac_members",
+        "teacher_delegations",
     )
 
     update = {

sarc/ldap/supervisor.py

@@ -177,6 +177,7 @@ def sortkey(x):
     return sorted(supervisors, key=sortkey, reverse=True)
 
 
+# pylint: disable=too-many-branches
 def resolve_supervisors(
     ldap_people: list[dict], group_to_prof: dict, exceptions: dict
 ) -> SupervisorMatchingErrors:
@@ -204,7 +205,22 @@ def resolve_supervisors(
         people.append(result)
 
     for person in people:
-        if person.is_student:
+        # if there is a supervisors override, use it whatever the student status may be
+        if exceptions and person.ldap["mail"][0] in exceptions.get(
+            "supervisors_overrides", []
+        ):
+            supervisors = exceptions["supervisors_overrides"][person.ldap["mail"][0]]
+            person.ldap["supervisor"] = None
+            person.ldap["co_supervisor"] = None
+            if len(supervisors) >= 1:
+                person.ldap["supervisor"] = supervisors[0]
+            else:
+                person.ldap["supervisor"] = None
+            if len(supervisors) >= 2:
+                person.ldap["co_supervisor"] = supervisors[1]
+            else:
+                person.ldap["co_supervisor"] = None
+        elif person.is_student:
             person.ldap["is_student"] = True
 
             supervisors = _extract_supervisors_from_groups(

tests/conftest.py

@@ -180,8 +180,24 @@ def file_contents():
     """
     exceptions_json_path = """
     {
-        "not_prof": [],
-        "not_student": []
+        "not_teacher": [],
+        "not_student": [],
+        "delegations": {
+            "[email protected]": [
+                "[email protected]",            
+                "[email protected]"            
+            ]
+        },
+        "supervisors_overrides": {
+            "[email protected]": [
+                "[email protected]"        
+            ],
+            "[email protected]": [
+                "[email protected]",            
+                "[email protected]"            
+            ]
+        }
+
     }
     """
 

tests/functional/cli/acquire/test_acquire_users.py

@@ -120,6 +120,37 @@ def mock_query_ldap(
     js_user = get_user(drac_account_username="stranger.person")
     assert js_user is None
 
+    # test supervisor overrides
+    js_user = get_user(mila_email_username="[email protected]")
+    assert js_user is not None
+    assert js_user.mila_ldap["supervisor"] == "[email protected]"
+    assert js_user.mila_ldap["co_supervisor"] == None
+
+    js_user = get_user(mila_email_username="[email protected]")
+    assert js_user is not None
+    assert js_user.mila_ldap["supervisor"] == "[email protected]"
+    assert js_user.mila_ldap["co_supervisor"] == "[email protected]"
+
+    # test delegations
+    # john.smith003 should have delegations for john.smith004 and john.smith005
+    # john.smith004 should have no delegations
+    # john.smith005 should have no delegations
+
+    js_user = get_user(mila_email_username="[email protected]")
+    assert js_user is not None
+    assert js_user.teacher_delegations is not None
+    assert "[email protected]" in js_user.teacher_delegations
+    assert "[email protected]" in js_user.teacher_delegations
+    assert "[email protected]" not in js_user.teacher_delegations
+
+    js_user = get_user(mila_email_username="[email protected]")
+    assert js_user is not None
+    assert js_user.teacher_delegations == None
+
+    js_user = get_user(mila_email_username="[email protected]")
+    assert js_user is not None
+    assert js_user.teacher_delegations == None
+
 
 @pytest.mark.parametrize(
     "ldap_supervisor,mymila_supervisor,expected_supervisor",
@@ -163,6 +194,10 @@ def test_acquire_users_supervisors(
     nbr_users = 4
     nbr_profs = 2
 
+    # for the test we will use the user with index 3,
+    # which is the first user who has no supervisor override in the mock data
+    # so that this test won't be affected by the previous test
+
     # Mock the fake LDAP data used for the tests
     def mock_query_ldap(
         local_private_key_file, local_certificate_file, ldap_service_uri
@@ -171,7 +206,7 @@ def mock_query_ldap(
         return fake_raw_ldap_data(
             nbr_users,
             hardcoded_values_by_user={
-                2: {  # The first user who is not a prof is the one with index 2
+                3: {  # The first user who is not a prof is the one with index 3
                     "supervisor": ldap_supervisor
                 }
             },
@@ -185,7 +220,7 @@ def mock_query_mymila(tmp_json_path):
             nbr_users=nbr_users,
             nbr_profs=nbr_profs,
             hardcoded_values_by_user={
-                2: {  # The first user who is not a prof is the one with index 2
+                3: {  # The first user who is not a prof is the one with index 3
                     "Supervisor Principal": mymila_supervisor
                 }
             },
@@ -208,8 +243,8 @@ def mock_query_mymila(tmp_json_path):
 
     # Validate the results of all of this by inspecting the database.
     js_user = get_user(
-        mila_email_username=f"john.smith002@mila.quebec"
-    )  # We modified the user with index 2; thus this is the one we retrieve
+        mila_email_username=f"john.smith003@mila.quebec"
+    )  # We modified the user with index 3; thus this is the one we retrieve
     assert js_user.mila_ldap["supervisor"] == expected_supervisor
 
 
@@ -255,6 +290,10 @@ def test_acquire_users_co_supervisors(
     nbr_users = 4
     nbr_profs = 2
 
+    # for the test we will use the user with index 3,
+    # which is the first user who has no supervisor override in the mock data
+    # so that this test won't be affected by the previous test
+
     # Mock the fake LDAP data used for the tests
     def mock_query_ldap(
         local_private_key_file, local_certificate_file, ldap_service_uri
@@ -263,7 +302,7 @@ def mock_query_ldap(
         return fake_raw_ldap_data(
             nbr_users,
             hardcoded_values_by_user={
-                2: {  # The first user who is not a prof is the one with index 2
+                3: {  # The first user who is not a prof is the one with index 3
                     "co_supervisor": ldap_co_supervisor
                 }
             },
@@ -277,7 +316,7 @@ def mock_query_mymila(tmp_json_path):
             nbr_users=nbr_users,
             nbr_profs=nbr_profs,
             hardcoded_values_by_user={
-                2: {  # The first user who is not a prof is the one with index 2
+                3: {  # The first user who is not a prof is the one with index 3
                     "Co-Supervisor": mymila_co_supervisor
                 }
             },
@@ -300,8 +339,8 @@ def mock_query_mymila(tmp_json_path):
 
     # Validate the results of all of this by inspecting the database.
     js_user = get_user(
-        mila_email_username=f"john.smith002@mila.quebec"
-    )  # We modified the user with index 2; thus this is the one we retrieve
+        mila_email_username=f"john.smith003@mila.quebec"
+    )  # We modified the user with index 3; thus this is the one we retrieve
     assert js_user.mila_ldap["co_supervisor"] == expected_co_supervisor
 
 

tests/functional/ldap/test_functional_revision.py

@@ -74,7 +74,6 @@ def user_with_history(username):
 
 @pytest.mark.usefixtures("write_setup")
 def test_get_user_fetch_latest():
-
     user_with_history("user1")
 
     #
@@ -140,7 +139,6 @@ def test_update_status_nodb_snapshots(status):
 @pytest.mark.usefixtures("write_setup")
 @pytest.mark.parametrize("status", statuses)
 def test_update_status_db_nosnapshots(status):
-
     collection = users_collection().get_collection()
     update_user(collection, make_user(status))
     users = user_dict([])
@@ -171,7 +169,6 @@ def test_update_status_db_nosnapshots(status):
 @pytest.mark.usefixtures("write_setup")
 @pytest.mark.parametrize("start,end", transitions())
 def test_update_status_users_exists_on_both(start, end):
-
     collection = users_collection().get_collection()
     update_user(collection, make_user(start, record_start=datetime(2000, 1, 1)))
     documents_before = list(collection.find({}))

tests/functional/ldap/test_read_mila_ldap.py

@@ -45,6 +45,7 @@ def mock_query_ldap(
 
             # resolve_supervisors is not called here
             e["supervisor"] = None
+            e["co_supervisor"] = None
 
             assert e == processed_user
 

tests/unittests/ldap/test_backfill.py

@@ -32,7 +32,6 @@ def userhistory(email, history):
     latest_record = base_user
 
     for start, fields in history:
-
         if prev_fields is not None:
             prev_fields["End Date with MILA"] = start
             latest_record = dictset(latest_record, prev_fields)

tests/unittests/ldap/test_revision.py

@@ -139,7 +139,6 @@ def test_ldap_update_status_db_noldap(status):
 
 @pytest.mark.parametrize("start,end", transitions())
 def test_ldap_update_status_users_exists_on_both(start, end):
-
     collection = MockCollection(
         [STANDARD_USER, make_user(start, record_start=datetime(2000, 1, 1))]
     )