test: Add tests for api/v1/users API endpoint

packages/backend/src/controllers/api/v1/users/get-users.test.js

@@ -0,0 +1,56 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import request from 'supertest';
+import app from '../../../../app';
+import createAuthTokenByUserId from '../../../../helpers/create-auth-token-by-user-id';
+import { createRole } from '../../../../../test/factories/role';
+import { createPermission } from '../../../../../test/factories/permission';
+import { createUser } from '../../../../../test/factories/user';
+import getUsersMock from '../../../../../test/mocks/rest/api/v1/users/get-users';
+
+describe('GET /api/v1/users', () => {
+  let currentUser, currentUserRole, anotherUser, anotherUserRole, token;
+
+  beforeEach(async () => {
+    currentUserRole = await createRole({
+      key: 'currentUser',
+      name: 'Current user role',
+    });
+
+    await createPermission({
+      action: 'read',
+      subject: 'User',
+      roleId: currentUserRole.id,
+    });
+
+    currentUser = await createUser({
+      roleId: currentUserRole.id,
+      fullName: 'Current User',
+    });
+
+    anotherUserRole = await createRole({
+      key: 'anotherUser',
+      name: 'Another user role',
+    });
+
+    anotherUser = await createUser({
+      roleId: anotherUserRole.id,
+      fullName: 'Another User',
+    });
+
+    token = createAuthTokenByUserId(currentUser.id);
+  });
+
+  it('should return users data', async () => {
+    const response = await request(app)
+      .get('/api/v1/users')
+      .set('Authorization', token)
+      .expect(200);
+
+    const expectedResponsePayload = await getUsersMock(
+      [anotherUser, currentUser],
+      [anotherUserRole, currentUserRole]
+    );
+
+    expect(response.body).toEqual(expectedResponsePayload);
+  });
+});

packages/backend/src/helpers/authorization.js

@@ -3,6 +3,10 @@ const authorizationList = {
     action: 'read',
     subject: 'User',
   },
+  '/api/v1/users/': {
+    action: 'read',
+    subject: 'User',
+  },
 };
 
 export const authorizeUser = async (request, response, next) => {

packages/backend/test/mocks/rest/api/v1/users/get-users.js

@@ -0,0 +1,38 @@
+const getUsersMock = async (users, roles) => {
+  const data = users.map((user) => {
+    const role = roles.find((r) => r.id === user.roleId);
+    return {
+      createdAt: user.createdAt.toISOString(),
+      email: user.email,
+      fullName: user.fullName,
+      id: user.id,
+      role: role
+        ? {
+            createdAt: role.createdAt.toISOString(),
+            description: role.description,
+            id: role.id,
+            isAdmin: role.isAdmin,
+            key: role.key,
+            name: role.name,
+            updatedAt: role.updatedAt.toISOString(),
+          }
+        : null, // Fallback to null if role not found
+      roleId: user.roleId,
+      trialExpiryDate: user.trialExpiryDate.toISOString(),
+      updatedAt: user.updatedAt.toISOString(),
+    };
+  });
+
+  return {
+    data: data,
+    meta: {
+      count: data.length,
+      currentPage: 1,
+      isArray: true,
+      totalPages: 1,
+      type: 'User',
+    },
+  };
+};
+
+export default getUsersMock;