Added: tests for new collection preview item

Author: GPortas

test/integration/collections/CollectionsRepository.test.ts

@@ -1,6 +1,7 @@
 import { CollectionsRepository } from '../../../src/collections/infra/repositories/CollectionsRepository'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import {
+  CollectionPreview,
   CreatedDatasetIdentifiers,
   DatasetPreview,
   FilePreview,
@@ -212,13 +213,20 @@ describe('CollectionsRepository', () => {
 
   describe('getCollectionItems', () => {
     let testDatasetIds: CreatedDatasetIdentifiers
+
     const testTextFile1Name = 'test-file-1.txt'
+    const testSubCollectionAlias = 'collectionsRepositoryTestSubCollection'
 
     beforeAll(async () => {
+      await createCollectionViaApi(testSubCollectionAlias, testCollectionAlias).catch(() => {
+        throw new Error(
+          `Tests beforeAll(): Error while creating subcollection ${testSubCollectionAlias}`
+        )
+      })
       try {
         testDatasetIds = await createDataset.execute(
           TestConstants.TEST_NEW_DATASET_DTO,
-          testCollectionAlias
+          testSubCollectionAlias
         )
       } catch (error) {
         throw new Error('Tests beforeAll(): Error while creating test dataset')
@@ -232,7 +240,16 @@ describe('CollectionsRepository', () => {
       try {
         await deleteUnpublishedDatasetViaApi(testDatasetIds.numericId)
       } catch (error) {
-        throw new Error('Tests afterAll(): Error while deleting test dataset')
+        throw new Error(
+          `Tests afterAll(): Error while deleting test dataset ${testDatasetIds.numericId}`
+        )
+      }
+      try {
+        await deleteCollectionViaApi(testSubCollectionAlias)
+      } catch (error) {
+        throw new Error(
+          `Tests afterAll(): Error while deleting subcollection ${testSubCollectionAlias}`
+        )
       }
     })
 
@@ -243,6 +260,7 @@ describe('CollectionsRepository', () => {
       let actual = await sut.getCollectionItems(testCollectionAlias)
       const actualFilePreview = actual.items[0] as FilePreview
       const actualDatasetPreview = actual.items[1] as DatasetPreview
+      const actualCollectionPreview = actual.items[2] as CollectionPreview
 
       const expectedFileMd5 = '68b22040025784da775f55cfcb6dee2e'
       const expectedDatasetCitationFragment =
@@ -264,6 +282,7 @@ describe('CollectionsRepository', () => {
       expect(actualFilePreview.publicationStatuses[1]).toBe(PublicationStatus.Draft)
       expect(actualFilePreview.sizeInBytes).toBe(12)
       expect(actualFilePreview.url).not.toBeUndefined()
+      expect(actualFilePreview.releaseOrCreateDate).not.toBeUndefined()
 
       expect(actualDatasetPreview.title).toBe('Dataset created using the createDataset use case')
       expect(actualDatasetPreview.citation).toContain(expectedDatasetCitationFragment)
@@ -279,12 +298,23 @@ describe('CollectionsRepository', () => {
       expect(actualDatasetPreview.versionInfo.minorNumber).toBeUndefined()
       expect(actualDatasetPreview.versionInfo.state).toBe('DRAFT')
 
-      expect(actual.totalItemCount).toBe(2)
+      const expectedCollectionsName = 'Scientific Research'
+      expect(actualCollectionPreview.name).toBe(expectedCollectionsName)
+      expect(actualCollectionPreview.alias).toBe(testSubCollectionAlias)
+      expect(actualCollectionPreview.description).toBe('We do all the science.')
+      expect(actualCollectionPreview.imageUrl).toBe(undefined)
+      expect(actualCollectionPreview.parentAlias).toBe(testCollectionAlias)
+      expect(actualCollectionPreview.parentName).toBe(expectedCollectionsName)
+      expect(actualCollectionPreview.publicationStatuses[0]).toBe(PublicationStatus.Unpublished)
+      expect(actualCollectionPreview.releaseOrCreateDate).not.toBeUndefined()
+      expect(actualCollectionPreview.affiliation).toBe('Scientific Research University')
+
+      expect(actual.totalItemCount).toBe(3)
 
       // Test limit and offset
       actual = await sut.getCollectionItems(testCollectionAlias, 1, 1)
       expect((actual.items[0] as DatasetPreview).persistentId).toBe(testDatasetIds.persistentId)
-      expect(actual.totalItemCount).toBe(2)
+      expect(actual.totalItemCount).toBe(3)
     })
 
     test('should return error when collection does not exist', async () => {

test/testHelpers/collections/collectionHelper.ts

@@ -60,11 +60,18 @@ export const createCollectionPayload = (): CollectionPayload => {
   return collectionPayload
 }
 
-export async function createCollectionViaApi(collectionAlias: string): Promise<CollectionPayload> {
+export async function createCollectionViaApi(
+  collectionAlias: string,
+  parentCollectionAlias?: string
+): Promise<CollectionPayload> {
   try {
+    if (parentCollectionAlias == undefined) {
+      parentCollectionAlias = 'root'
+    }
+
     return await axios
       .post(
-        `${TestConstants.TEST_API_URL}/dataverses/root`,
+        `${TestConstants.TEST_API_URL}/dataverses/${parentCollectionAlias}`,
         JSON.stringify({
           alias: collectionAlias,
           name: 'Scientific Research',

test/testHelpers/collections/collectionPreviewHelper.ts

@@ -0,0 +1,34 @@
+import { CollectionPreview } from '../../../src'
+import { CollectionPreviewPayload } from '../../../src/collections/infra/repositories/transformers/CollectionPreviewPayload'
+import { PublicationStatus } from '../../../src/core/domain/models/PublicationStatus'
+
+export const createCollectionPreviewModel = (): CollectionPreview => {
+  const collectionPreviewModel: CollectionPreview = {
+    name: 'test collection',
+    parentName: 'parent collection',
+    alias: 'testcollection',
+    parentAlias: 'parentcollection',
+    description: 'test description',
+    affiliation: 'test affiliation',
+    publicationStatuses: [PublicationStatus.Published],
+    releaseOrCreateDate: new Date('2023-05-15T08:21:01Z'),
+    imageUrl: 'http://dataverse.com'
+  }
+  return collectionPreviewModel
+}
+
+export const createCollectionPreviewPayload = (): CollectionPreviewPayload => {
+  return {
+    name: 'test collection',
+    parentDataverseName: 'parent collection',
+    identifier: 'testcollection',
+    parentDataverseIdentifier: 'parentcollection',
+    description: 'test description',
+    affiliation: 'test affiliation',
+    publicationStatuses: ['Published'],
+    published_at: '2023-05-15T08:21:01Z',
+    image_url: 'http://dataverse.com',
+    type: 'dataverse',
+    url: 'http://dataverse.com'
+  }
+}

test/unit/collections/CollectionsRepository.test.ts

@@ -27,6 +27,10 @@ import {
   createFilePreviewPayload
 } from '../../testHelpers/files/filePreviewHelper'
 import { CollectionItemSubset } from '../../../src/collections/domain/models/CollectionItemSubset'
+import {
+  createCollectionPreviewModel,
+  createCollectionPreviewPayload
+} from '../../testHelpers/collections/collectionPreviewHelper'
 
 describe('CollectionsRepository', () => {
   const sut: CollectionsRepository = new CollectionsRepository()
@@ -293,7 +297,11 @@ describe('CollectionsRepository', () => {
   })
 
   describe('getCollectionItems', () => {
-    const testItems = [createDatasetPreviewModel(), createFilePreviewModel()]
+    const testItems = [
+      createDatasetPreviewModel(),
+      createFilePreviewModel(),
+      createCollectionPreviewModel()
+    ]
     const testTotalCount = 2
 
     const testItemSubset: CollectionItemSubset = {
@@ -306,7 +314,11 @@ describe('CollectionsRepository', () => {
         status: 'OK',
         data: {
           total_count: testTotalCount,
-          items: [createDatasetPreviewPayload(), createFilePreviewPayload()]
+          items: [
+            createDatasetPreviewPayload(),
+            createFilePreviewPayload(),
+            createCollectionPreviewPayload()
+          ]
         }
       }
     }

test/unit/collections/GetCollectionItems.test.ts

@@ -4,11 +4,16 @@ import { ReadError } from '../../../src'
 import { createDatasetPreviewModel } from '../../testHelpers/datasets/datasetPreviewHelper'
 import { createFilePreviewModel } from '../../testHelpers/files/filePreviewHelper'
 import { CollectionItemSubset } from '../../../src/collections/domain/models/CollectionItemSubset'
+import { createCollectionPreviewModel } from '../../testHelpers/collections/collectionPreviewHelper'
 
 describe('execute', () => {
   test('should return item subset on repository success', async () => {
-    const testItems = [createDatasetPreviewModel(), createFilePreviewModel()]
-    const testTotalCount = 2
+    const testItems = [
+      createDatasetPreviewModel(),
+      createFilePreviewModel(),
+      createCollectionPreviewModel()
+    ]
+    const testTotalCount = 3
 
     const testItemSubset: CollectionItemSubset = {
       items: testItems,