Fix/google next standard response (#962)

* refactor: standardize error handling and response modeling in Google API integration

* refactor: enhance module documentation for Google Workspace API integration

* refactor: improve test coverage and error handling in Google Workspace API integration

* feat: add FakeGoogleService for testing Google API integrations

* fix: double wrapping IntegrationResponse

* refactor: update Google Directory API functions to return IntegrationResponse

* refactor: update tests to utilize IntegrationResponse for Google API calls

* refactor: enhance Google Workspace schemas with additional fields and validation

* feat: add factory helper functions for creating Google groups, users, and members

* test: add validation tests for Google groups, users, and members helpers

* refactor: delegate Google groups, users, and members fixture logic to shared helper functions

* refactor: replace fixture logic with factory helpers for Google groups, users, and members in tests

* test: update assertions in API error handling test for IntegrationResponse

* refactor: revert legacy fixture logic with direct implementations for Google groups, users, and members

* refactor: propagate standardized IntegrationResponse directly

Author: gcharest

app/integrations/google_workspace/google_directory_next.py

@@ -1,48 +1,143 @@
-from typing import List, Optional
-from pydantic import BaseModel
+from typing import Any, Dict, List, Optional, Union
+from pydantic import BaseModel, Field, field_validator
+
+
+class Name(BaseModel):
+    givenName: Optional[str] = None
+    familyName: Optional[str] = None
+    fullName: Optional[str] = None
+    displayName: Optional[str] = None
+
+    model_config = {"extra": "ignore"}
+
+
+class User(BaseModel):
+    id: Optional[str] = None
+    primaryEmail: Optional[str] = None
+    name: Optional[Name] = None
+    suspended: Optional[bool] = None
+    emails: Optional[List[Dict[str, Any]]] = None
+    aliases: Optional[List[str]] = None
+    nonEditableAliases: Optional[List[str]] = None
+    customerId: Optional[str] = None
+    orgUnitPath: Optional[str] = None
+    thumbnailPhotoUrl: Optional[str] = None
+    thumbnailPhotoEtag: Optional[str] = None
+    recoveryEmail: Optional[str] = None
+    recoveryPhone: Optional[str] = None
+    isAdmin: Optional[bool] = None
+    isDelegatedAdmin: Optional[bool] = None
+    lastLoginTime: Optional[str] = None
+    creationTime: Optional[str] = None
+    agreedToTerms: Optional[bool] = None
+    archived: Optional[bool] = None
+    changePasswordAtNextLogin: Optional[bool] = None
+    ipWhitelisted: Optional[bool] = None
+    isMailboxSetup: Optional[bool] = None
+    isEnrolledIn2Sv: Optional[bool] = None
+    isEnforcedIn2Sv: Optional[bool] = None
+    includeInGlobalAddressList: Optional[bool] = None
+    # languages can be a list of dicts in sample JSON; accept any for flexibility
+    languages: Optional[List[Any]] = None
+
+    model_config = {"extra": "ignore"}
+
+
+class Member(BaseModel):
+    kind: Optional[str] = None
+    etag: Optional[str] = None
+    id: Optional[str] = None
+    email: Optional[str] = None
+    role: Optional[str] = None
+    type: Optional[str] = None
+    status: Optional[str] = None
+    primaryEmail: Optional[str] = None
+    name: Optional[Dict[str, Any]] = None
+    isAdmin: Optional[bool] = None
+    isDelegatedAdmin: Optional[bool] = None
+
+    model_config = {"extra": "ignore"}
 
 
 class Group(BaseModel):
-    id: Optional[str]
-    email: Optional[str]
-    name: Optional[str]
-    description: Optional[str]
-    directMembersCount: Optional[int]
+    kind: Optional[str] = None
+    id: Optional[str] = None
+    etag: Optional[str] = None
+    email: Optional[str] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    # directMembersCount may be returned as string by API; accept both and coerce to int when possible
+    directMembersCount: Optional[Union[int, str]] = None
+    adminCreated: Optional[bool] = None
+    nonEditableAliases: Optional[List[str]] = None
+
+    model_config = {"extra": "ignore"}
+
+    @field_validator("directMembersCount", mode="before")
+    def _coerce_direct_members_count(cls, v):
+        if v is None:
+            return None
+        # Accept int already
+        if isinstance(v, int):
+            return v
+        # Accept numeric strings
+        if isinstance(v, str):
+            try:
+                return int(v)
+            except ValueError:
+                return None
+        # Fallback: try to coerce to int
+        try:
+            return int(v)
+        except Exception:
+            return None
+
 
+# Enriched member used for assembled responses (contains nested user details)
+class MemberWithUser(Member):
+    user: Optional[User] = None
 
+    model_config = {"extra": "ignore"}
+
+
+# Assembled group model that includes members (enriched)
+class GroupWithMembers(Group):
+    members: List[MemberWithUser] = Field(default_factory=list)
+
+    model_config = {"extra": "ignore"}
+
+
+class GroupsResult(BaseModel):
+    result: List[Group] = Field(default_factory=list)
+    time: Optional[float] = None
+    summary: Optional[str] = None
+
+    model_config = {"extra": "ignore"}
+
+
+# Backwards-compatible list response types (keep for existing tests/code)
 class GroupsListResponse(BaseModel):
     kind: Optional[str]
     etag: Optional[str]
-    groups: List[Group] = []
+    groups: List[Group] = Field(default_factory=list)
     nextPageToken: Optional[str]
 
-
-class Member(BaseModel):
-    kind: Optional[str]
-    email: Optional[str]
-    role: Optional[str]
-    type: Optional[str]
-    status: Optional[str]
-    id: Optional[str]
+    model_config = {"extra": "ignore"}
 
 
 class MembersListResponse(BaseModel):
     kind: Optional[str]
     etag: Optional[str]
-    members: List[Member] = []
+    members: List[Member] = Field(default_factory=list)
     nextPageToken: Optional[str]
 
-
-class User(BaseModel):
-    id: Optional[str]
-    primaryEmail: Optional[str]
-    name: Optional[dict]
-    suspended: Optional[bool]
-    emails: Optional[list]
+    model_config = {"extra": "ignore"}
 
 
 class UsersListResponse(BaseModel):
     kind: Optional[str]
     etag: Optional[str]
-    users: List[User] = []
+    users: List[User] = Field(default_factory=list)
     nextPageToken: Optional[str]
+
+    model_config = {"extra": "ignore"}

app/integrations/google_workspace/google_service_next.py

@@ -1,15 +1,15 @@
 import pytest
-from integrations.google_workspace.schemas import (
-    Group,
-    User,
-    Member,
+from tests.factory_helpers import (
+    make_google_groups,
+    make_google_users,
+    make_google_members,
 )
 
 # Google API Python Client
 
 
 # Google Discovery Directory Resource
-# Base fixtures
+# Legacy Fixtures
 @pytest.fixture
 def google_groups():
     def _google_groups(n=3, prefix="", domain="test.com"):
@@ -75,127 +75,6 @@ def _google_group_members(n=3, prefix="", domain="test.com"):
     return _google_group_members
 
 
-# --- Google Directory API Pydantic factories ---
-
-
-@pytest.fixture
-def google_group_factory():
-    """
-    Factory fixture to generate a list of valid Google Group dicts for tests.
-    Usage:
-        groups = google_group_factory(n=2, prefix="dev-")
-        # returns a list of dicts (model_dump)
-    """
-
-    def _factory(n=3, prefix="", domain="test.com", as_model=False):
-        groups = [
-            Group(
-                id=f"{prefix}google_group_id{i+1}",
-                name=f"{prefix}group-name{i+1}",
-                email=f"{prefix}group-name{i+1}@{domain}",
-                description=f"{prefix}description{i+1}",
-                directMembersCount=i + 1,
-            )
-            for i in range(n)
-        ]
-        if as_model:
-            return groups
-        return [g.model_dump() for g in groups]
-
-    return _factory
-
-
-@pytest.fixture
-def google_user_factory():
-    """
-    Factory fixture to generate a list of valid Google User dicts or models for tests.
-    Usage:
-        users = google_user_factory(n=2, prefix="dev-")
-        # returns a list of dicts (model_dump)
-        users = google_user_factory(n=2, as_model=True)
-        # returns a list of User models
-    """
-
-    def _factory(n=3, prefix="", domain="test.com", as_model=False):
-        users = [
-            User(
-                id=f"{prefix}user_id{i+1}",
-                primaryEmail=f"{prefix}user-email{i+1}@{domain}",
-                emails=[
-                    {
-                        "address": f"{prefix}user-email{i+1}@{domain}",
-                        "primary": True,
-                        "type": "work",
-                    }
-                ],
-                suspended=False,
-                name={
-                    "fullName": f"Given_name_{i+1} Family_name_{i+1}",
-                    "familyName": f"Family_name_{i+1}",
-                    "givenName": f"Given_name_{i+1}",
-                    "displayName": f"Given_name_{i+1} Family_name_{i+1}",
-                },
-            )
-            for i in range(n)
-        ]
-        if as_model:
-            return users
-        return [u.model_dump() for u in users]
-
-    return _factory
-
-
-@pytest.fixture
-def google_member_factory():
-    """
-    Factory fixture to generate a list of valid Google Member dicts or models for tests.
-    Usage:
-        members = google_member_factory(n=2, prefix="dev-")
-        # returns a list of dicts (model_dump)
-        members = google_member_factory(n=2, as_model=True)
-        # returns a list of Member models
-    """
-
-    def _factory(n=3, prefix="", domain="test.com", as_model=False):
-        users = [
-            User(
-                id=f"{prefix}user_id{i+1}",
-                primaryEmail=f"{prefix}user-email{i+1}@{domain}",
-                emails=[
-                    {
-                        "address": f"{prefix}user-email{i+1}@{domain}",
-                        "primary": True,
-                        "type": "work",
-                    }
-                ],
-                suspended=False,
-                name={
-                    "fullName": f"Given_name_{i+1} Family_name_{i+1}",
-                    "familyName": f"Family_name_{i+1}",
-                    "givenName": f"Given_name_{i+1}",
-                    "displayName": f"Given_name_{i+1} Family_name_{i+1}",
-                },
-            )
-            for i in range(n)
-        ]
-        members = [
-            Member(
-                kind="admin#directory#member",
-                email=user.primaryEmail,
-                role="MEMBER",
-                type="USER",
-                status="ACTIVE",
-                id=user.id,
-            )
-            for user in users
-        ]
-        if as_model:
-            return members
-        return [m.model_dump() for m in members]
-
-    return _factory
-
-
 # Fixture with users
 @pytest.fixture
 def google_groups_w_users(google_groups, google_group_members, google_users):
@@ -264,6 +143,61 @@ def _factory(n_groups=1, n_members_per_group=2, domain="test.com"):
     return _factory
 
 
+# --- Google Directory API Pydantic factories ---
+
+
+@pytest.fixture
+def google_group_factory():
+    """
+    Factory fixture to generate a list of valid Google Group dicts for tests.
+    Usage:
+        groups = google_group_factory(n=2, prefix="dev-")
+        # returns a list of dicts (model_dump)
+    """
+
+    def _factory(n=3, prefix="", domain="test.com", as_model=False):
+        # Delegate to shared helper to avoid duplicated logic
+        return make_google_groups(n=n, prefix=prefix, domain=domain, as_model=as_model)
+
+    return _factory
+
+
+@pytest.fixture
+def google_user_factory():
+    """
+    Factory fixture to generate a list of valid Google User dicts or models for tests.
+    Usage:
+        users = google_user_factory(n=2, prefix="dev-")
+        # returns a list of dicts (model_dump)
+        users = google_user_factory(n=2, as_model=True)
+        # returns a list of User models
+    """
+
+    def _factory(n=3, prefix="", domain="test.com", as_model=False):
+        # Delegate to shared helper to avoid duplicated logic
+        return make_google_users(n=n, prefix=prefix, domain=domain, as_model=as_model)
+
+    return _factory
+
+
+@pytest.fixture
+def google_member_factory():
+    """
+    Factory fixture to generate a list of valid Google Member dicts or models for tests.
+    Usage:
+        members = google_member_factory(n=2, prefix="dev-")
+        # returns a list of dicts (model_dump)
+        members = google_member_factory(n=2, as_model=True)
+        # returns a list of Member models
+    """
+
+    def _factory(n=3, prefix="", domain="test.com", as_model=False):
+        # Delegate to shared helper to avoid duplicated logic
+        return make_google_members(n=n, prefix=prefix, domain=domain, as_model=as_model)
+
+    return _factory
+
+
 @pytest.fixture
 def google_batch_response_factory():
     """Factory to create Google API batch response structures."""