feat: Add Households to Mealie (#3970)

tests/integration_tests/admin_tests/test_admin_about.py

@@ -9,13 +9,15 @@ from tests.utils.fixture_schemas import TestUser
 
 
 @pytest.mark.parametrize("is_private_group", [True, False], ids=["private group", "public group"])
-def test_public_about_get_app_info(api_client: TestClient, is_private_group: bool, database: AllRepositories):
+def test_public_about_get_app_info(
+    api_client: TestClient, is_private_group: bool, unfiltered_database: AllRepositories
+):
     settings = get_app_settings()
-    group = database.groups.get_by_name(settings.DEFAULT_GROUP)
+    group = unfiltered_database.groups.get_by_name(settings.DEFAULT_GROUP)
     assert group and group.preferences
 
     group.preferences.private_group = is_private_group
-    database.group_preferences.update(group.id, group.preferences)
+    unfiltered_database.group_preferences.update(group.id, group.preferences)
 
     response = api_client.get(api_routes.app_about)
     as_dict = response.json()

tests/integration_tests/admin_tests/test_admin_group_actions.py

@@ -1,5 +1,8 @@
 from fastapi.testclient import TestClient
 
+from mealie.core.config import get_app_settings
+from mealie.repos.repository_factory import AllRepositories
+from mealie.schema.user.user import GroupInDB
 from tests.utils import api_routes
 from tests.utils.assertion_helpers import assert_ignore_keys
 from tests.utils.factories import random_bool, random_string
@@ -29,21 +32,34 @@ def test_admin_create_group(api_client: TestClient, admin_user: TestUser):
     response = api_client.post(api_routes.admin_groups, json={"name": random_string()}, headers=admin_user.token)
     assert response.status_code == 201
 
+    # verify preferences are set and the default household is created
+    group = GroupInDB.model_validate(response.json())
+    assert group.preferences and len(group.households) == 1
+    created_household = group.households[0]
+    assert created_household.name == get_app_settings().DEFAULT_HOUSEHOLD
+
+    response = api_client.get(api_routes.admin_households_item_id(created_household.id), headers=admin_user.token)
+    assert response.status_code == 200
+    assert response.json()["id"] == str(created_household.id)
+
+    # verify no extra households are created
+    response = api_client.get(api_routes.admin_households, headers=admin_user.token, params={"page": 1, "perPage": -1})
+    assert response.status_code == 200
+    items = response.json()["items"]
+    filtered_item_ids: list[str] = []
+    for item in items:
+        if item["groupId"] == str(group.id):
+            filtered_item_ids.append(item["id"])
+
+    assert len(filtered_item_ids) == 1
+    assert filtered_item_ids[0] == str(created_household.id)
+
 
 def test_admin_update_group(api_client: TestClient, admin_user: TestUser, unique_user: TestUser):
     update_payload = {
         "id": unique_user.group_id,
         "name": "New Name",
-        "preferences": {
-            "privateGroup": random_bool(),
-            "firstDayOfWeek": 2,
-            "recipePublic": random_bool(),
-            "recipeShowNutrition": random_bool(),
-            "recipeShowAssets": random_bool(),
-            "recipeLandscapeView": random_bool(),
-            "recipeDisableComments": random_bool(),
-            "recipeDisableAmount": random_bool(),
-        },
+        "preferences": {"privateGroup": random_bool()},
     }
 
     response = api_client.put(
@@ -57,18 +73,13 @@ def test_admin_update_group(api_client: TestClient, admin_user: TestUser, unique
     as_json = response.json()
 
     assert as_json["name"] == update_payload["name"]
-    assert_ignore_keys(as_json["preferences"], update_payload["preferences"])
+    assert_ignore_keys(as_json["preferences"], update_payload["preferences"])  # type: ignore
 
 
-def test_admin_delete_group(api_client: TestClient, admin_user: TestUser, unique_user: TestUser):
-    # Delete User
-    response = api_client.delete(api_routes.admin_users_item_id(unique_user.user_id), headers=admin_user.token)
+def test_admin_delete_group(unfiltered_database: AllRepositories, api_client: TestClient, admin_user: TestUser):
+    group = unfiltered_database.groups.create({"name": random_string()})
+    response = api_client.delete(api_routes.admin_groups_item_id(group.id), headers=admin_user.token)
     assert response.status_code == 200
 
-    # Delete Group
-    response = api_client.delete(api_routes.admin_groups_item_id(unique_user.group_id), headers=admin_user.token)
-    assert response.status_code == 200
-
-    # Ensure Group is Deleted
-    response = api_client.get(api_routes.admin_groups_item_id(unique_user.group_id), headers=admin_user.token)
+    response = api_client.get(api_routes.admin_groups_item_id(group.id), headers=admin_user.token)
     assert response.status_code == 404

tests/integration_tests/admin_tests/test_admin_household_actions.py

@@ -0,0 +1,76 @@
+from fastapi.testclient import TestClient
+
+from mealie.repos.repository_factory import AllRepositories
+from tests.utils import api_routes
+from tests.utils.assertion_helpers import assert_ignore_keys
+from tests.utils.factories import random_bool, random_string
+from tests.utils.fixture_schemas import TestUser
+
+
+def test_home_household_not_deletable(api_client: TestClient, admin_user: TestUser):
+    response = api_client.delete(api_routes.admin_households_item_id(admin_user.household_id), headers=admin_user.token)
+    assert response.status_code == 400
+
+
+def test_admin_household_routes_are_restricted(api_client: TestClient, unique_user: TestUser, admin_user: TestUser):
+    response = api_client.get(api_routes.admin_households, headers=unique_user.token)
+    assert response.status_code == 403
+
+    response = api_client.post(api_routes.admin_households, json={}, headers=unique_user.token)
+    assert response.status_code == 403
+
+    response = api_client.get(api_routes.admin_households_item_id(admin_user.household_id), headers=unique_user.token)
+    assert response.status_code == 403
+
+    response = api_client.get(api_routes.admin_households_item_id(admin_user.household_id), headers=unique_user.token)
+    assert response.status_code == 403
+
+
+def test_admin_create_household(api_client: TestClient, admin_user: TestUser):
+    response = api_client.post(
+        api_routes.admin_households,
+        json={"name": random_string(), "groupId": admin_user.group_id},
+        headers=admin_user.token,
+    )
+    assert response.status_code == 201
+
+
+def test_admin_update_household(api_client: TestClient, admin_user: TestUser, unique_user: TestUser):
+    update_payload = {
+        "id": unique_user.household_id,
+        "groupId": admin_user.group_id,
+        "name": "New Name",
+        "preferences": {
+            "privateHousehold": random_bool(),
+            "firstDayOfWeek": 2,
+            "recipePublic": random_bool(),
+            "recipeShowNutrition": random_bool(),
+            "recipeShowAssets": random_bool(),
+            "recipeLandscapeView": random_bool(),
+            "recipeDisableComments": random_bool(),
+            "recipeDisableAmount": random_bool(),
+        },
+    }
+
+    response = api_client.put(
+        api_routes.admin_households_item_id(unique_user.household_id),
+        json=update_payload,
+        headers=admin_user.token,
+    )
+
+    assert response.status_code == 200
+
+    as_json = response.json()
+
+    assert as_json["name"] == update_payload["name"]
+    assert_ignore_keys(as_json["preferences"], update_payload["preferences"])  # type: ignore
+
+
+def test_admin_delete_household(unfiltered_database: AllRepositories, api_client: TestClient, admin_user: TestUser):
+    group = unfiltered_database.groups.create({"name": random_string()})
+    household = unfiltered_database.households.create({"name": random_string(), "group_id": group.id})
+    response = api_client.delete(api_routes.admin_households_item_id(household.id), headers=admin_user.token)
+    assert response.status_code == 200
+
+    response = api_client.get(api_routes.admin_households_item_id(household.id), headers=admin_user.token)
+    assert response.status_code == 404

tests/integration_tests/admin_tests/test_admin_user_actions.py

@@ -32,7 +32,7 @@ def test_init_superuser(api_client: TestClient, admin_user: TestUser):
 
     admin_data = response.json()
 
-    assert admin_data["id"] == admin_user.user_id
+    assert admin_data["id"] == str(admin_user.user_id)
     assert admin_data["groupId"] == admin_user.group_id
 
     assert admin_data["fullName"] == "Change Me"
@@ -93,7 +93,7 @@ def test_update_other_user_as_not_admin(api_client: TestClient, unique_user: Tes
     settings = get_app_settings()
 
     update_data = {
-        "id": unique_user.user_id,
+        "id": str(unique_user.user_id),
         "fullName": "Updated Name",
         "email": settings._DEFAULT_EMAIL,
         "group": "Home",
@@ -122,7 +122,7 @@ def test_self_demote_admin(api_client: TestClient, admin_user: TestUser):
 
 def test_self_promote_admin(api_client: TestClient, unique_user: TestUser):
     update_data = {
-        "id": unique_user.user_id,
+        "id": str(unique_user.user_id),
         "fullName": "Updated Name",
         "email": "user@example.com",
         "group": "Home",