Fix department endpoints + add tests

tests/__snapshots__/test_departments/test_addDepartment.json

@@ -0,0 +1,9 @@
+{
+  "department": {
+    "id": "int",
+    "id_in_org": "int",
+    "name": "Developers",
+    "org_id": -1,
+    "parent_id": "int"
+  }
+}

tests/__snapshots__/test_departments/test_addUserToDepartments.json

@@ -0,0 +1,23 @@
+{
+  "failed": [
+    {
+      "department": {
+        "id": "int",
+        "id_in_org": "int",
+        "name": "multi-add-1",
+        "org_id": -1,
+        "parent_id": "int"
+      },
+      "error_msg": "User has been in multi-add-1"
+    }
+  ],
+  "success": [
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "multi-add-2",
+      "org_id": -1,
+      "parent_id": "int"
+    }
+  ]
+}

tests/__snapshots__/test_departments/test_deleteDepartment.json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

tests/__snapshots__/test_departments/test_department_group[create].json

@@ -0,0 +1,4 @@
+{
+  "group_id": "int",
+  "group_name": "group-test"
+}

tests/__snapshots__/test_departments/test_department_group[delete].json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

tests/__snapshots__/test_departments/test_department_members[add].json

@@ -0,0 +1,11 @@
+{
+  "failed": [],
+  "success": [
+    {
+      "avatar_url": "str",
+      "contact_email": "testuser@example.com",
+      "email": "str",
+      "name": "Test User"
+    }
+  ]
+}

tests/__snapshots__/test_departments/test_department_members[list].json

@@ -0,0 +1,11 @@
+{
+  "member_list": [
+    {
+      "avatar_url": "str",
+      "contact_email": "testuser@example.com",
+      "email": "str",
+      "is_staff": false,
+      "name": "Test User"
+    }
+  ]
+}

tests/__snapshots__/test_departments/test_department_members[remove].json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

tests/__snapshots__/test_departments/test_department_members[update].json

@@ -0,0 +1,9 @@
+{
+  "member": {
+    "avatar_url": "str",
+    "contact_email": "testuser@example.com",
+    "email": "str",
+    "is_staff": true,
+    "name": "Test User"
+  }
+}

tests/__snapshots__/test_departments/test_listDepartments_top_level.json

@@ -0,0 +1,11 @@
+{
+  "department_list": [
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "automated-testing-top",
+      "org_id": -1,
+      "parent_id": "int"
+    }
+  ]
+}

tests/__snapshots__/test_departments/test_listNonDepartmentUsers.json

@@ -0,0 +1,6 @@
+{
+  "avatar_url": "str",
+  "contact_email": "testuser@example.com",
+  "email": "str",
+  "name": "Test User"
+}

tests/__snapshots__/test_departments/test_updateDepartment.json

@@ -0,0 +1,9 @@
+{
+  "department": {
+    "id": "int",
+    "id_in_org": "int",
+    "name": "new-name",
+    "org_id": -1,
+    "parent_id": "int"
+  }
+}

tests/__snapshots__/test_user_departments/test_department_members[add].json

@@ -0,0 +1,16 @@
+{
+  "failed": [],
+  "success": [
+    {
+      "avatar_url": "str",
+      "contact_email": "admin@example.com",
+      "department_id": "int",
+      "email": "str",
+      "group_id": "int",
+      "is_admin": false,
+      "login_id": "",
+      "name": "admin",
+      "role": "Member"
+    }
+  ]
+}

tests/__snapshots__/test_user_departments/test_department_members[remove].json

@@ -0,0 +1,3 @@
+{
+  "success": true
+}

tests/__snapshots__/test_user_departments/test_department_members[update].json

@@ -0,0 +1,11 @@
+{
+  "avatar_url": "str",
+  "contact_email": "admin@example.com",
+  "department_id": "int",
+  "email": "str",
+  "group_id": "int",
+  "is_admin": true,
+  "login_id": "",
+  "name": "admin",
+  "role": "Admin"
+}

tests/__snapshots__/test_user_departments/test_getDepartmentGroupMembersCount.json

@@ -0,0 +1,3 @@
+{
+  "count": 1
+}

tests/__snapshots__/test_user_departments/test_listDepartmentMemberBases.json

@@ -0,0 +1,18 @@
+{
+  "dtable_list": [
+    {
+      "backend": "js",
+      "color": null,
+      "created_at": "str",
+      "icon": null,
+      "id": "int",
+      "in_storage": true,
+      "is_encrypted": false,
+      "name": "automated-testing-departments",
+      "text_color": null,
+      "updated_at": "str",
+      "uuid": "str",
+      "workspace_id": "int"
+    }
+  ]
+}

tests/__snapshots__/test_user_departments/test_listDepartmentMembers.json

@@ -0,0 +1,13 @@
+{
+  "member_list": [
+    {
+      "avatar_url": "str",
+      "contact_email": "testuser@example.com",
+      "email": "str",
+      "is_admin": true,
+      "is_staff": true,
+      "name": "Test User",
+      "role": "Admin"
+    }
+  ]
+}

tests/__snapshots__/test_user_departments/test_listDepartments.json

@@ -0,0 +1,18 @@
+{
+  "departments": [
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "automated-testing-top",
+      "org_id": -1,
+      "parent_id": "int"
+    },
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "automated-testing-sub",
+      "org_id": -1,
+      "parent_id": "int"
+    }
+  ]
+}

tests/__snapshots__/test_user_departments/test_listSubDepartments.json

@@ -0,0 +1,11 @@
+{
+  "department_list": [
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "automated-testing-sub",
+      "org_id": -1,
+      "parent_id": "int"
+    }
+  ]
+}

tests/__snapshots__/test_user_departments/test_listUserDepartments.json

@@ -0,0 +1,12 @@
+{
+  "department_list": [
+    {
+      "id": "int",
+      "id_in_org": "int",
+      "name": "automated-testing-sub",
+      "org_id": -1,
+      "parent_id": "int",
+      "sub_departments": []
+    }
+  ]
+}

tests/conftest.py

@@ -356,6 +356,69 @@ def delete_group(account_token: Secret, group_id: int):
 
         assert response.status_code == 200
 
+# Departments (system admin)
+
+def _admin_headers(token: Secret) -> dict:
+    return {'Authorization': f'Bearer {token.value}'}
+
+
+def list_departments(token: Secret, parent_id: int = -1) -> list[dict]:
+    case: Case = system_admin_account_operations.find_operation_by_id('listDepartments') \
+        .Case(query={'parent_id': parent_id})
+    response = case.call(headers=_admin_headers(token))
+    assert response.status_code == 200
+    return response.json()['department_list']
+
+
+def create_department(token: Secret, name: str, parent_id: int) -> int:
+    case: Case = system_admin_account_operations.find_operation_by_id('addDepartment') \
+        .Case(body={'name': name, 'parent_id': parent_id})
+    response = case.call(headers=_admin_headers(token))
+    assert response.status_code == 200
+
+    department_id = response.json()['department']['id']
+    assert isinstance(department_id, int)
+    return department_id
+
+
+def delete_department(token: Secret, department_id: int):
+    """Deletes a department including all of its sub-departments."""
+    if CLEANUP_AFTER_TESTS != 'True':
+        return
+
+    for sub_department in list_departments(token, department_id):
+        delete_department(token, sub_department['id'])
+
+    case: Case = system_admin_account_operations.find_operation_by_id('deleteDepartment') \
+        .Case(path_parameters={'department_id': department_id})
+    response = case.call(headers=_admin_headers(token))
+    assert response.status_code == 200
+
+
+@pytest.fixture(scope='module')
+def top_department(system_admin_account_token: Secret) -> Generator[int, None, None]:
+    """There can be only one top-level department, so it is shared by all tests in a module."""
+    existing = list_departments(system_admin_account_token)
+    if existing:
+        department_id = existing[0]['id']
+    else:
+        department_id = create_department(system_admin_account_token, 'automated-testing-top', -1)
+
+    yield department_id
+
+    delete_department(system_admin_account_token, department_id)
+
+
+@pytest.fixture(scope='module')
+def user_id(system_admin_account_token: Secret) -> str:
+    """The internal @auth.local ID of the regular test user."""
+    case: Case = system_admin_account_operations.find_operation_by_id('listUsers').Case()
+    response = case.call(headers=_admin_headers(system_admin_account_token))
+    assert response.status_code == 200
+
+    user = next(u for u in response.json()['data'] if u['contact_email'] == USERNAME)
+    return user['email']
+
 MIN_LICENSE_USERS = 10
 
 def _get_license_maxusers() -> int: