add use case and unit test

Author: ekraffmiller

src/roles/domain/models/Role.ts

@@ -0,0 +1,7 @@
+export interface Role {
+  id: number
+  name: string
+  alias: string
+  description: string
+  permissions: string[]
+}

src/roles/domain/repositories/IRolesRepository.ts

@@ -0,0 +1,5 @@
+import { Role } from '../models/Role'
+
+export interface IRolesRepository {
+  getUserSelectableRoles(): Promise<Role[]>
+}

src/roles/domain/repositories/transformers/roleTransformers.ts

@@ -0,0 +1,14 @@
+import { AxiosResponse } from 'axios'
+import { Role } from '../../models/Role'
+
+export const transformRolesUserSelectableResponseToRoles = (response: AxiosResponse): Role[] => {
+  const roleUserSelectablePayload = response.data.data
+
+  return roleUserSelectablePayload.map((role: any) => ({
+    id: role.id,
+    name: role.name,
+    alias: role.alias,
+    description: role.description,
+    permissions: role.permissions
+  }))
+}

src/roles/domain/useCases/GetUserSelectableRoles.ts

@@ -0,0 +1,16 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { Role } from '../models/Role'
+import { IRolesRepository } from '../repositories/IRolesRepository'
+
+export class GetUserSelectableRoles implements UseCase<Role[]> {
+  constructor(private readonly rolesRepository: IRolesRepository) {}
+
+  /**
+   * Returns an array of Roles, for the currently logged in user.
+   *
+   * @returns {Promise<Role[]>} - A promise that resolves to an array of Role instances that the user can select.
+   */
+  async execute(): Promise<Role[]> {
+    return (await this.rolesRepository.getUserSelectableRoles()) as Role[]
+  }
+}

src/roles/infra/repositories/RolesRepository.ts

@@ -0,0 +1,15 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { IRolesRepository } from '../../domain/repositories/IRolesRepository'
+import { Role } from '../../domain/models/Role'
+import { transformRolesUserSelectableResponseToRoles } from '../../domain/repositories/transformers/roleTransformers'
+
+export class RolesRepository extends ApiRepository implements IRolesRepository {
+  private readonly rolesResourceName: string = 'roles'
+  public async getUserSelectableRoles(): Promise<Role[]> {
+    return this.doGet(`/${this.rolesResourceName}/userSelectable`, true)
+      .then((response) => transformRolesUserSelectableResponseToRoles(response.data.data))
+      .catch((error) => {
+        throw error
+      })
+  }
+}

test/testHelpers/roles/roleHelper.ts

@@ -0,0 +1,26 @@
+import { Role } from '../../../src/roles/domain/models/Role'
+
+export const createRoleModel = (): Role => {
+  return {
+    id: 1,
+    name: 'admin',
+    alias: 'Admin',
+    description:
+      'A person who has all permissions for dataverses, datasets, and files, including approving requests for restricted data.',
+    permissions: [
+      'AddDataverse',
+      'AddDataset',
+      'ViewUnpublishedDataverse',
+      'ViewUnpublishedDataset'
+    ]
+  }
+}
+export const createRoleModelArray = (count: number): Role[] => {
+  return Array.from({ length: count }, (_, index) => ({
+    id: index + 1,
+    name: `role${index + 1}`,
+    alias: `Role ${index + 1}`,
+    description: `Description for role ${index + 1}`,
+    permissions: [`Permission${index + 1}`]
+  }))
+}

test/unit/roles/GetUserSelectableRoles.test.ts

@@ -0,0 +1,25 @@
+import { ReadError } from '../../../src'
+import { IRolesRepository } from '../../../src/roles/domain/repositories/IRolesRepository'
+import { createRoleModelArray } from '../../testHelpers/roles/roleHelper'
+import { GetUserSelectableRoles } from '../../../src/roles/domain/useCases/GetUserSelectableRoles'
+
+describe('execute', () => {
+  test('should return roles array on repository success', async () => {
+    const rolesRepositoryStub: IRolesRepository = {} as IRolesRepository
+    const testRoles = createRoleModelArray(5)
+    rolesRepositoryStub.getUserSelectableRoles = jest.fn().mockResolvedValue(testRoles)
+    const sut = new GetUserSelectableRoles(rolesRepositoryStub)
+
+    const actual = await sut.execute()
+
+    expect(actual).toEqual(testRoles)
+  })
+
+  test('should return error result on repository error', async () => {
+    const rolesRepositoryStub: IRolesRepository = {} as IRolesRepository
+    rolesRepositoryStub.getUserSelectableRoles = jest.fn().mockRejectedValue(new ReadError())
+    const sut = new GetUserSelectableRoles(rolesRepositoryStub)
+
+    await expect(sut.execute()).rejects.toThrow(ReadError)
+  })
+})