Added: tweaks to createCollection parameters and missing IT tests

Author: GPortas

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -3,5 +3,5 @@ import { Collection } from '../models/Collection'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
-  createCollection(collectionDTO: CollectionDTO, parentCollectionId: string): Promise<number>
+  createCollection(collectionDTO: CollectionDTO, parentCollectionId: number | string): Promise<number>
 }

src/collections/domain/useCases/CreateCollection.ts

@@ -1,5 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { CollectionDTO } from '../dtos/CollectionDTO'
+import { ROOT_COLLECTION_ALIAS } from '../models/Collection'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 
 export class CreateCollection implements UseCase<number> {
@@ -12,7 +13,7 @@ export class CreateCollection implements UseCase<number> {
   /**
    * TODO
    */
-  async execute(newCollection: CollectionDTO, parentCollectionId = 'root'): Promise<number> {
+  async execute(newCollection: CollectionDTO, parentCollectionId: number | string = ROOT_COLLECTION_ALIAS): Promise<number> {
     return await this.collectionsRepository.createCollection(newCollection, parentCollectionId)
   }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -21,7 +21,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
   public async createCollection(
     collectionDTO: CollectionDTO,
-    parentCollectionId = 'root'
+    parentCollectionId: number | string = ROOT_COLLECTION_ALIAS
   ): Promise<number> {
     const dataverseContacts = collectionDTO.contacts.map((contact) => ({
       contactEmail: contact

test/integration/collections/CollectionsRepository.test.ts

@@ -1,6 +1,6 @@
 import { CollectionsRepository } from '../../../src/collections/infra/repositories/CollectionsRepository'
 import { TestConstants } from '../../testHelpers/TestConstants'
-import { ReadError } from '../../../src'
+import { ReadError, WriteError } from '../../../src'
 import { ApiConfig } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import {
@@ -88,10 +88,32 @@ describe('CollectionsRepository', () => {
   })
 
   describe('createCollection', () => {
+    const testCreateCollectionAlias1 = 'createCollection-test-1'
+    const testCreateCollectionAlias2 = 'createCollection-test-2'
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(testCreateCollectionAlias1)
+      await deleteCollectionViaApi(testCreateCollectionAlias2)
+    })
+
     test('should create collection in root when no parent collection is set', async () => {
-      const newCollectionDTO = createCollectionDTO()
-      const actual = await sut.createCollection(newCollectionDTO)
+      const actual = await sut.createCollection(createCollectionDTO(testCreateCollectionAlias1))
+      expect(typeof actual).toBe('number')
+    })
+
+    test('should create collection in parent collection when parent collection is set', async () => {
+      const actual = await sut.createCollection(createCollectionDTO(testCreateCollectionAlias2), testCollectionId)
       expect(typeof actual).toBe('number')
     })
+
+    test('should return error when parent collection does not exist', async () => {
+      const expectedError = new WriteError(
+        `[404] Can't find dataverse with identifier='${TestConstants.TEST_DUMMY_COLLECTION_ID}'`
+      )
+      const testCreateCollectionAlias3 = 'createCollection-test-3'
+      await expect(sut.createCollection(createCollectionDTO(testCreateCollectionAlias3), TestConstants.TEST_DUMMY_COLLECTION_ID)).rejects.toThrow(
+        expectedError
+      )
+    })
   })
 })

test/testHelpers/collections/collectionHelper.ts

@@ -102,9 +102,9 @@ export async function setStorageDriverViaApi(
   }
 }
 
-export const createCollectionDTO = (): CollectionDTO => {
+export const createCollectionDTO = (alias: string = 'test-collection'): CollectionDTO => {
   return {
-    alias: 'test-collection',
+    alias: alias,
     name: 'Test Collection',
     contacts: ['[email protected]'],
     type: CollectionType.DEPARTMENT