feat(google): helper checks if user is in OU

Author: thekaveman

compiler_admin/services/google.py

@@ -153,9 +153,54 @@ def user_in_group(username: str, group: str) -> bool:
         return False
 
 
+def user_in_ou(username: str, ou: str) -> bool:
+    """Checks if a user is in an OU.
+
+    Args:
+        username (str): The user@compiler.la to check for membership in the group.
+        ou (str): The name of an OU to check for username's membership.
+    Returns:
+        True if the user is a member of the OU. False otherwise.
+    """
+    if user_exists(username):
+        with NamedTemporaryFile("w+") as stdout:
+            CallGAMCommand(("info", "ou", ou), stdout=stdout.name, stderr="stdout")
+            output = "\n".join(stdout.readlines())
+        return username in output
+    else:
+        print(f"User does not exist: {username}")
+        return False
+
+
+def user_is_deactivated(username: str) -> bool:
+    """Checks if a user is in an OU.
+
+    Args:
+        username (str): The user@compiler.la to check for membership in the group.
+        ou (str): The name of an OU to check for username's membership.
+    Returns:
+        True if the user is a member of the OU. False otherwise.
+    """
+    return user_in_ou(username, OU_ALUMNI)
+
+
 def user_is_partner(username: str) -> bool:
+    """Checks if a user is a Compiler Partner.
+
+    Args:
+        username (str): The user@compiler.la to check for partner status.
+    Returns:
+        True if the user is a Partner. False otherwise.
+    """
     return user_in_group(username, GROUP_PARTNERS)
 
 
 def user_is_staff(username: str) -> bool:
+    """Checks if a user is a Compiler Staff.
+
+    Args:
+        username (str): The user@compiler.la to check for staff status.
+    Returns:
+        True if the user is a Staff. False otherwise.
+    """
     return user_in_group(username, GROUP_STAFF)

tests/services/test_google.py

@@ -20,6 +20,7 @@
     remove_user_from_group,
     user_exists,
     user_in_group,
+    user_in_ou,
     user_info,
     user_is_partner,
     user_is_staff,
@@ -249,6 +250,33 @@ def test_user_in_group_user_exists_not_in_group(mock_NamedTemporaryFile_with_rea
     assert res is False
 
 
+@pytest.mark.usefixtures("mock_google_user_exists_no")
+def test_user_in_ou_user_does_not_exist(capfd):
+    res = user_in_ou("username", "ou")
+    captured = capfd.readouterr()
+
+    assert res is False
+    assert "User does not exist" in captured.out
+
+
+@pytest.mark.usefixtures("mock_google_user_exists_yes")
+def test_user_in_ou_user_exists_in_ou(mock_NamedTemporaryFile_with_readlines):
+    mock_NamedTemporaryFile_with_readlines(MODULE, ["username"])
+
+    res = user_in_ou("username", "ou")
+
+    assert res is True
+
+
+@pytest.mark.usefixtures("mock_google_user_exists_yes")
+def test_user_in_ou_user_exists_not_in_ou(mock_NamedTemporaryFile_with_readlines):
+    mock_NamedTemporaryFile_with_readlines(MODULE, ["nope"])
+
+    res = user_in_ou("username", "ou")
+
+    assert res is False
+
+
 def test_user_is_partner_checks_partner_group(mock_google_user_in_group):
     user_is_partner("username")