Stash: createCollection unit tests WIP (failing)

Author: GPortas

src/collections/infra/repositories/CollectionsRepository.ts

@@ -4,6 +4,17 @@ import { transformCollectionResponseToCollection } from './transformers/collecti
 import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
 import { CollectionDTO } from '../../domain/dtos/CollectionDTO'
 
+export interface NewCollectionRequestPayload {
+  alias: string,
+  name: string,
+  dataverseContacts: NewCollectionContactRequestPayload[],
+  dataverseType: string
+}
+
+export interface NewCollectionContactRequestPayload {
+  contactEmail: string
+}
+
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
 
@@ -23,11 +34,11 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     collectionDTO: CollectionDTO,
     parentCollectionId: number | string = ROOT_COLLECTION_ALIAS
   ): Promise<number> {
-    const dataverseContacts = collectionDTO.contacts.map((contact) => ({
+    const dataverseContacts: NewCollectionContactRequestPayload[] = collectionDTO.contacts.map((contact) => ({
       contactEmail: contact
     }))
 
-    const requestBody = {
+    const requestBody: NewCollectionRequestPayload = {
       alias: collectionDTO.alias,
       name: collectionDTO.name,
       dataverseContacts: dataverseContacts,

test/testHelpers/collections/collectionHelper.ts

@@ -4,6 +4,7 @@ import { CollectionPayload } from '../../../src/collections/infra/repositories/t
 import { TestConstants } from '../TestConstants'
 import axios from 'axios'
 import { CollectionDTO, CollectionType } from '../../../src/collections/domain/dtos/CollectionDTO'
+import { NewCollectionRequestPayload } from '../../../src/collections/infra/repositories/CollectionsRepository'
 
 const COLLECTION_ID = 11111
 const COLLECTION_IS_RELEASED = 'true'
@@ -110,3 +111,16 @@ export const createCollectionDTO = (alias: string = 'test-collection'): Collecti
     type: CollectionType.DEPARTMENT
   }
 }
+
+export const createNewCollectionRequestPayload = (): NewCollectionRequestPayload => {
+  return {
+    alias: 'test-collection',
+    name: 'Test Collection',
+    dataverseContacts: [
+      {
+        contactEmail: '[email protected]'
+      }
+    ],
+    dataverseType: 'DEPARTMENT'
+  }
+}

test/unit/collections/CollectionsRepository.test.ts

@@ -5,11 +5,13 @@ import {
   DataverseApiAuthMechanism
 } from '../../../src/core/infra/repositories/ApiConfig'
 import {
+  createCollectionDTO,
   createCollectionModel,
-  createCollectionPayload
+  createCollectionPayload,
+  createNewCollectionRequestPayload
 } from '../../testHelpers/collections/collectionHelper'
 import { TestConstants } from '../../testHelpers/TestConstants'
-import { ReadError } from '../../../src'
+import { ReadError, WriteError } from '../../../src'
 import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
 
 describe('CollectionsRepository', () => {
@@ -28,7 +30,10 @@ describe('CollectionsRepository', () => {
       DataverseApiAuthMechanism.API_KEY,
       TestConstants.TEST_DUMMY_API_KEY
     )
+    
+    jest.clearAllMocks()
   })
+
   describe('getCollection', () => {
     const expectedRequestConfigApiKey = {
       params: {
@@ -108,4 +113,63 @@ describe('CollectionsRepository', () => {
       })
     })
   })
+
+  describe('createCollection', () => {
+    const testNewCollection = createCollectionDTO()
+    
+    const testCreatedCollectionId = 1
+    const testCreateCollectionResponse = {
+      data: {
+        status: 'OK',
+        data: {
+          id: testCreatedCollectionId,
+        }
+      }
+    }
+
+    const expectedNewCollectionRequestPayloadJson = JSON.stringify(createNewCollectionRequestPayload())
+    const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/root`
+
+    test('should call the API with a correct request payload', async () => {
+      jest.spyOn(axios, 'post').mockResolvedValue(testCreateCollectionResponse)
+
+      // API Key auth
+      let actual = await sut.createCollection(testNewCollection)
+
+      expect(axios.post).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedNewCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+      )
+      expect(actual).toStrictEqual(testCreatedCollectionId)
+
+      // Session cookie auth
+      ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
+
+      actual = await sut.createCollection(testNewCollection)
+
+      expect(axios.post).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedNewCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_SESSION_COOKIE
+      )
+      expect(actual).toStrictEqual(testCreatedCollectionId)
+    })
+
+    test('should return error result on error response', async () => {
+      jest.spyOn(axios, 'post').mockRejectedValue(TestConstants.TEST_ERROR_RESPONSE)
+
+      let error = undefined as unknown as WriteError
+      await sut
+        .createCollection(testNewCollection)
+        .catch((e) => (error = e))
+
+      expect(axios.post).toHaveBeenCalledWith(
+        expectedApiEndpoint,
+        expectedNewCollectionRequestPayloadJson,
+        TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
+      )
+      expect(error).toBeInstanceOf(Error)
+    })
+  })
 })