feat(google): get a user info dict

Author: thekaveman

compiler_admin/services/google.py

@@ -3,6 +3,8 @@
 from tempfile import NamedTemporaryFile
 from typing import Any, Sequence, IO
 
+from compiler_admin import RESULT_SUCCESS
+
 # import and alias CallGAMCommand so we can simplify usage in this app
 from gam import CallGAMCommand as __CallGAMCommand, initializeLogging
 
@@ -96,9 +98,38 @@ def user_exists(username: str) -> bool:
         print(f"User not in domain: {username}")
         return False
 
-    res = CallGAMCommand(("info", "user", username, "quick"))
+    info = user_info(username)
+
+    return info != {}
+
 
-    return res == 0
+def user_info(username: str) -> dict:
+    """Get a dict of basic user information.
+
+    Args:
+        username (str): The user@compiler.la to get.
+    Returns:
+        A dict of user information
+    """
+    if not str(username).endswith(DOMAIN):
+        print(f"User not in domain: {username}")
+        return {}
+
+    with NamedTemporaryFile("w+") as stdout:
+        res = CallGAMCommand(("info", "user", username, "quick"), stdout=stdout.name)
+        if res != RESULT_SUCCESS:
+            # user doesn't exist
+            return {}
+        # user exists, read data
+        lines = stdout.readlines()
+        # split on newline and filter out lines that aren't line "Key:Value" and empty value lines like "Key:<empty>"
+        lines = [L.strip() for L in lines if len(L.split(":")) == 2 and L.split(":")[1].strip()]
+        # make a map by splitting the lines, trimming key and value
+        info = {}
+        for line in lines:
+            k, v = line.split(":")
+            info[k.strip()] = v.strip()
+        return info
 
 
 def user_in_group(username: str, group: str) -> bool:

tests/conftest.py

@@ -118,6 +118,12 @@ def mock_google_user_exists(mock_module_name):
     return mock_module_name("user_exists")
 
 
+@pytest.fixture
+def mock_google_user_info(mock_module_name):
+    """Fixture returns a function that patches the user_info function from a given module."""
+    return mock_module_name("user_info")
+
+
 @pytest.fixture
 def mock_google_user_in_group(mock_module_name):
     """Fixture returns a function that patches the user_in_group function from a given module."""

tests/services/test_google.py

@@ -3,6 +3,7 @@
 
 import pytest
 
+from compiler_admin import RESULT_SUCCESS, RESULT_FAILURE
 from compiler_admin.services.google import (
     DOMAIN,
     GAM,
@@ -19,6 +20,7 @@
     remove_user_from_group,
     user_exists,
     user_in_group,
+    user_info,
     user_is_partner,
     user_is_staff,
     __name__ as MODULE,
@@ -40,6 +42,11 @@ def mock_google_user_exists(mock_google_user_exists):
     return mock_google_user_exists(MODULE)
 
 
+@pytest.fixture
+def mock_google_user_info(mock_google_user_info):
+    return mock_google_user_info(MODULE)
+
+
 @pytest.fixture
 def mock_google_user_in_group(mock_google_user_in_group):
     return mock_google_user_in_group(MODULE)
@@ -177,22 +184,39 @@ def test_user_exists_username_not_in_domain(capfd):
     assert "User not in domain" in captured.out
 
 
-def test_user_exists_user_exists(mock_google_CallGAMCommand):
-    mock_google_CallGAMCommand.return_value = 0
+def test_user_exists_user_exists(mock_google_user_info):
+    mock_google_user_info.return_value = {"First Name": "Test", "Last Name": "User"}
 
     res = user_exists(user_account_name("username"))
 
     assert res is True
 
 
-def test_user_exists_user_does_not_exists(mock_google_CallGAMCommand):
-    mock_google_CallGAMCommand.return_value = -1
+def test_user_exists_user_does_not_exist(mock_google_user_info):
+    mock_google_user_info.return_value = {}
 
     res = user_exists(user_account_name("username"))
 
     assert res is False
 
 
+def test_user_info_user_exists(mock_gam_CallGAMCommand, mock_NamedTemporaryFile_with_readlines):
+    mock_NamedTemporaryFile_with_readlines(MODULE, ["First Name:Test", "Last Name:User"])
+    mock_gam_CallGAMCommand.return_value = RESULT_SUCCESS
+
+    res = user_info(user_account_name("username"))
+
+    assert res == {"First Name": "Test", "Last Name": "User"}
+
+
+def test_user_info_user_does_not_exists(mock_gam_CallGAMCommand):
+    mock_gam_CallGAMCommand.return_value = RESULT_FAILURE
+
+    res = user_info(user_account_name("username"))
+
+    assert res == {}
+
+
 def test_user_in_group_user_does_not_exist(mock_google_user_exists, capfd):
     mock_google_user_exists.return_value = False