test: add integration cases

Author: g-saracca

src/collections/infra/repositories/CollectionsRepository.ts

@@ -451,7 +451,6 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
   public async linkCollection(
     linkedCollectionIdOrAlias: number | string,
     linkingCollectionIdOrAlias: number | string
@@ -465,7 +464,6 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
   public async unlinkCollection(
     linkedCollectionIdOrAlias: number | string,
     linkingCollectionIdOrAlias: number | string
@@ -478,7 +476,6 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
   public async getCollectionLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/links`, true)
       .then((response) => {

src/datasets/domain/models/DatasetTemplate.ts

@@ -1,4 +1,4 @@
-import { DatasetLicense, DatasetMetadataBlocks, TermsOfUse } from './Dataset'
+import { DatasetLicense, DatasetMetadataBlock, TermsOfUse } from './Dataset'
 
 export interface DatasetTemplate {
   id: number
@@ -9,7 +9,7 @@ export interface DatasetTemplate {
   createTime: string
   createDate: string
   // 👇 From Edit Template Metadata
-  datasetMetadataBlocks: DatasetMetadataBlocks
+  datasetMetadataBlocks: DatasetMetadataBlock[]
   instructions: DatasetTemplateInstruction[]
   // 👇 From Edit Template Terms
   termsOfUse: TermsOfUse

test/integration/datasets/DatasetsRepository.test.ts

@@ -52,6 +52,10 @@ import { FilesRepository } from '../../../src/files/infra/repositories/FilesRepo
 import { DirectUploadClient } from '../../../src/files/infra/clients/DirectUploadClient'
 import { createTestFileUploadDestination } from '../../testHelpers/files/fileUploadDestinationHelper'
 import { CitationFormat } from '../../../src/datasets/domain/models/CitationFormat'
+import {
+  createDatasetTemplateViaApi,
+  deleteDatasetTemplateViaApi
+} from '../../testHelpers/datasets/datasetTemplatesHelper'
 
 const TEST_DIFF_DATASET_DTO: DatasetDTO = {
   license: {
@@ -1649,4 +1653,39 @@ describe('DatasetsRepository', () => {
       await expect(sut.getDatasetAvailableCategories(nonExistentTestDatasetId)).rejects.toThrow()
     })
   })
+
+  describe('getDatasetTemplates', () => {
+    const testCollectionAlias = 'testGetDatasetTemplates'
+
+    beforeAll(async () => {
+      await createCollectionViaApi(testCollectionAlias)
+    })
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(testCollectionAlias)
+    })
+
+    test('should return empty dataset templates', async () => {
+      const actual = await sut.getDatasetTemplates(testCollectionAlias)
+
+      expect(actual.length).toBe(0)
+    })
+
+    test('should return dataset templates for a collection', async () => {
+      const templateCreated = await createDatasetTemplateViaApi(testCollectionAlias)
+
+      const actual = await sut.getDatasetTemplates(testCollectionAlias)
+
+      expect(actual.length).toBe(1)
+
+      expect(actual[0].name).toBe(templateCreated.name)
+      expect(actual[0].isDefault).toBe(templateCreated.isDefault)
+      expect(actual[0].datasetMetadataBlocks.length).toBe(1)
+      expect(actual[0].datasetMetadataBlocks[0].name).toBe('citation')
+      expect(actual[0].datasetMetadataBlocks[0].fields.author.length).toBe(1)
+      expect(actual[0].instructions.length).toBe(templateCreated.instructions.length)
+
+      await deleteDatasetTemplateViaApi(actual[0].id)
+    })
+  })
 })

test/testHelpers/datasets/datasetTemplatesHelper.ts

@@ -0,0 +1,67 @@
+import axios from 'axios'
+import { TestConstants } from '../TestConstants'
+import { DatasetTemplatePayload } from '../../../src/datasets/infra/repositories/transformers/DatasetTemplatePayload'
+
+const DATASET_TEMPLATE_DTO = {
+  name: 'Dataset Template',
+  isDefault: true,
+  fields: [
+    {
+      typeName: 'author',
+      value: [
+        {
+          authorName: {
+            typeName: 'authorName',
+            value: 'Belicheck, Bill'
+          },
+          authorAffiliation: {
+            typeName: 'authorIdentifierScheme',
+            value: 'ORCID'
+          }
+        }
+      ]
+    }
+  ],
+  instructions: [
+    {
+      instructionField: 'author',
+      instructionText: 'The author data'
+    }
+  ]
+}
+
+const DATAVERSE_API_REQUEST_HEADERS = {
+  headers: { 'Content-Type': 'application/json', 'X-Dataverse-Key': process.env.TEST_API_KEY }
+}
+
+export async function createDatasetTemplateViaApi(
+  collectionAlias: string
+): Promise<DatasetTemplatePayload> {
+  try {
+    if (collectionAlias == undefined) {
+      collectionAlias = ':root'
+    }
+    return await axios
+      .post(
+        `${TestConstants.TEST_API_URL}/dataverses/${collectionAlias}/templates`,
+        JSON.stringify(DATASET_TEMPLATE_DTO),
+        DATAVERSE_API_REQUEST_HEADERS
+      )
+      .then((response) => response.data.data)
+  } catch (error) {
+    throw new Error(`Error while creating dataset template in collection ${collectionAlias}`)
+  }
+}
+
+export async function deleteDatasetTemplateViaApi(templateId: number): Promise<void> {
+  try {
+    return await axios
+      .delete(
+        `${TestConstants.TEST_API_URL}/admin/template/${templateId}`,
+        DATAVERSE_API_REQUEST_HEADERS
+      )
+      .then((response) => response.data.data)
+  } catch (error) {
+    throw new Error(`Error while deleting dataset template with id ${templateId}`)
+  }
+}