add functional tests

Author: ekraffmiller

.DS_Store

@@ -16,8 +16,8 @@ export class LinkCollection implements UseCase<void> {
    * @returns {Promise<void>} -This method does not return anything upon successful completion.
    */
   async execute(
-    linkedCollectionIdOrAlias: string,
-    linkingCollectionIdOrAlias: string
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
   ): Promise<void> {
     return await this.collectionsRepository.linkCollection(
       linkedCollectionIdOrAlias,

src/collections/domain/useCases/LinkCollection.ts

@@ -16,8 +16,8 @@ export class UnLinkCollection implements UseCase<void> {
    * @returns {Promise<void>} -This method does not return anything upon successful completion.
    */
   async execute(
-    linkedCollectionIdOrAlias: string,
-    linkingCollectionIdOrAlias: string
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
   ): Promise<void> {
     return await this.collectionsRepository.unlinkCollection(
       linkedCollectionIdOrAlias,

src/collections/domain/useCases/UnLinkCollection.ts

@@ -12,6 +12,8 @@ import { DeleteCollectionFeaturedItems } from './domain/useCases/DeleteCollectio
 import { DeleteCollection } from './domain/useCases/DeleteCollection'
 import { GetMyDataCollectionItems } from './domain/useCases/GetMyDataCollectionItems'
 import { DeleteCollectionFeaturedItem } from './domain/useCases/DeleteCollectionFeaturedItem'
+import { LinkCollection } from './domain/useCases/LinkCollection'
+import { UnLinkCollection } from './domain/useCases/UnLinkCollection'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -28,6 +30,8 @@ const updateCollectionFeaturedItems = new UpdateCollectionFeaturedItems(collecti
 const deleteCollectionFeaturedItems = new DeleteCollectionFeaturedItems(collectionsRepository)
 const deleteCollection = new DeleteCollection(collectionsRepository)
 const deleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(collectionsRepository)
+const linkCollection = new LinkCollection(collectionsRepository)
+const unlinkCollection = new UnLinkCollection(collectionsRepository)
 
 export {
   getCollection,
@@ -42,7 +46,9 @@ export {
   updateCollectionFeaturedItems,
   deleteCollectionFeaturedItems,
   deleteCollection,
-  deleteCollectionFeaturedItem
+  deleteCollectionFeaturedItem,
+  linkCollection,
+  unlinkCollection
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/index.ts

@@ -450,7 +450,6 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     linkedCollectionIdOrAlias: number | string,
     linkingCollectionIdOrAlias: number | string
   ): Promise<void> {
-    console.log(linkedCollectionIdOrAlias, linkingCollectionIdOrAlias)
     return this.doPut(
       `/dataverses/${linkedCollectionIdOrAlias}` + `/link/${linkingCollectionIdOrAlias}`,
       {} // No data is needed for this operation

src/collections/infra/repositories/CollectionsRepository.ts

@@ -0,0 +1,79 @@
+import {
+  ApiConfig,
+  WriteError,
+  createCollection,
+  getCollection,
+  linkCollection,
+  deleteCollection,
+  getCollectionItems
+} from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { createCollectionDTO } from '../../testHelpers/collections/collectionHelper'
+
+describe('execute', () => {
+  const firstCollectionAlias = 'linkCollection-functional-test-first'
+  const secondCollectionAlias = 'linkCollection-functional-test-second'
+
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+    const firstCollection = createCollectionDTO(firstCollectionAlias)
+    const secondCollection = createCollectionDTO(secondCollectionAlias)
+    await createCollection.execute(firstCollection)
+    await createCollection.execute(secondCollection)
+  })
+
+  afterEach(async () => {
+    await Promise.all([
+      getCollection
+        .execute(firstCollectionAlias)
+        .then((collection) =>
+          collection && collection.id ? deleteCollection.execute(collection.id) : null
+        ),
+      getCollection
+        .execute(secondCollectionAlias)
+        .then((collection) =>
+          collection && collection.id ? deleteCollection.execute(collection.id) : null
+        )
+    ])
+  })
+
+  test('should successfully link two collections', async () => {
+    const firstCollection = await getCollection.execute(firstCollectionAlias)
+    const secondCollection = await getCollection.execute(secondCollectionAlias)
+    expect.assertions(1)
+    try {
+      await linkCollection.execute(secondCollection.alias, firstCollection.alias)
+    } catch (error) {
+      throw new Error('Collections should be linked successfully')
+    } finally {
+      await new Promise((resolve) => setTimeout(resolve, 5000))
+      const collectionItemSubset = await getCollectionItems.execute(firstCollectionAlias)
+
+      expect(collectionItemSubset.items.length).toBe(1)
+    }
+  })
+
+  test('should throw an error when linking a non-existent collection', async () => {
+    const invalidCollectionId = 99999
+    const firstCollection = await getCollection.execute(firstCollectionAlias)
+
+    expect.assertions(2)
+    let writeError: WriteError | undefined = undefined
+    try {
+      await linkCollection.execute(invalidCollectionId, firstCollection.id)
+      throw new Error('Use case should throw an error')
+    } catch (error) {
+      writeError = error as WriteError
+    } finally {
+      expect(writeError).toBeInstanceOf(WriteError)
+      expect(writeError?.message).toEqual(
+        `There was an error when writing the resource. Reason was: [404] Can't find dataverse with identifier='${invalidCollectionId}'`
+      )
+    }
+  })
+})

test/functional/collections/LinkCollection.test.ts

@@ -0,0 +1,79 @@
+import {
+  ApiConfig,
+  WriteError,
+  createCollection,
+  getCollection,
+  linkCollection,
+  deleteCollection,
+  getCollectionItems,
+  unlinkCollection
+} from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { createCollectionDTO } from '../../testHelpers/collections/collectionHelper'
+
+describe('execute', () => {
+  const firstCollectionAlias = 'unlinkCollection-functional-test-first'
+  const secondCollectionAlias = 'unlinkCollection-functional-test-second'
+
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+    const firstCollection = createCollectionDTO(firstCollectionAlias)
+    const secondCollection = createCollectionDTO(secondCollectionAlias)
+    await createCollection.execute(firstCollection)
+    await createCollection.execute(secondCollection)
+    await linkCollection.execute(secondCollection.alias, firstCollection.alias)
+  })
+
+  afterEach(async () => {
+    await Promise.all([
+      getCollection
+        .execute(firstCollectionAlias)
+        .then((collection) =>
+          collection && collection.id ? deleteCollection.execute(collection.id) : null
+        ),
+      getCollection
+        .execute(secondCollectionAlias)
+        .then((collection) =>
+          collection && collection.id ? deleteCollection.execute(collection.id) : null
+        )
+    ])
+  })
+
+  test('should successfully unlink two collections', async () => {
+    const firstCollection = await getCollection.execute(firstCollectionAlias)
+    const secondCollection = await getCollection.execute(secondCollectionAlias)
+    // Give enough time to Solr for indexing
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+    const collectionItemSubset = await getCollectionItems.execute(firstCollectionAlias)
+    expect(collectionItemSubset.items.length).toBe(1)
+
+    await unlinkCollection.execute(secondCollection.alias, firstCollection.alias)
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+    const collectionItemSubset2 = await getCollectionItems.execute(firstCollectionAlias)
+    expect(collectionItemSubset2.items.length).toBe(0)
+  })
+
+  test('should throw an error when linking a non-existent collection', async () => {
+    const invalidCollectionId = 99999
+    const firstCollection = await getCollection.execute(firstCollectionAlias)
+
+    expect.assertions(2)
+    let writeError: WriteError | undefined = undefined
+    try {
+      await unlinkCollection.execute(invalidCollectionId, firstCollection.id)
+      throw new Error('Use case should throw an error')
+    } catch (error) {
+      writeError = error as WriteError
+    } finally {
+      expect(writeError).toBeInstanceOf(WriteError)
+      expect(writeError?.message).toEqual(
+        `There was an error when writing the resource. Reason was: [404] Can't find dataverse with identifier='${invalidCollectionId}'`
+      )
+    }
+  })
+})