test: add integration cases

Author: g-saracca

src/datasets/domain/models/DatasetVersionSummary.ts

@@ -11,9 +11,9 @@ export type Summary = {
 }
 
 export interface SummaryUpdates {
-  added: string // deberia ser number chequear
-  deleted: string
-  changed: string
+  added: number
+  deleted: number
+  changed: number
 }
 
 export interface SummaryUpdatesWithFields {
@@ -39,77 +39,3 @@ export enum SummaryKnownFields {
   files = 'files',
   termsAccessChanged = 'termsAccessChanged'
 }
-
-// SummaryUpdates Example:
-/*
-    summary: {
-        "Geospatial Metadata": {
-            added: 1,
-            deleted: 0,
-            changed: 0
-        },
-    }
-*/
-
-// SummaryUpdatesWithFields Example:
-/*
-    summary: {
-        'Citation Metadata': {
-            Description: {
-                added: 0,
-                deleted: 0,
-                changed: 1
-            },
-            Title: {
-                added: 0,
-                deleted: 0,
-                changed: 1
-            }
-        }
-    }
-*/
-
-// FilesSummaryUpdates Example:
-/*
-    summary: {
-        files: {
-            added: 1,
-            removed: 0,
-            replaced: 0,
-            changedFileMetaData: 2,
-            changedVariableMetadata: 0
-        },
-    }
-*/
-
-const version: DatasetVersionSummary = {
-  id: 1,
-  versionNumber: '1.0',
-  contributors: 'John Doe',
-  publishedOn: '2021-06-01',
-  summary: {
-    files: {
-      added: 1,
-      changedFileMetaData: 2,
-      removed: 0,
-      replaced: 0,
-      changedVariableMetadata: 0
-    },
-    'Citation Metadata': {
-      Title: {
-        added: '0',
-        deleted: '0',
-        changed: '1'
-      }
-    },
-    termsAccessChanged: true
-  }
-}
-
-console.log({
-  typeof: typeof (
-    (version.summary as Summary)?.['Citation Metadata'] as SummaryUpdatesWithFields
-  )?.['Title'].changed
-})
-
-// console.log({ typeof: typeof (version.summary as SummaryChanges)?.['Title'].changed })

test/integration/datasets/DatasetsRepository.test.ts

@@ -7,7 +7,8 @@ import {
   deleteUnpublishedDatasetViaApi,
   waitForDatasetsIndexedInSolr,
   deletePublishedDatasetViaApi,
-  deaccessionDatasetViaApi
+  deaccessionDatasetViaApi,
+  createDatasetLicenseModel
 } from '../../testHelpers/datasets/datasetHelper'
 import { ReadError } from '../../../src/core/domain/repositories/ReadError'
 import {
@@ -18,7 +19,8 @@ import {
   createDataset,
   CreatedDatasetIdentifiers,
   DatasetDTO,
-  DatasetDeaccessionDTO
+  DatasetDeaccessionDTO,
+  publishDataset
 } from '../../../src/datasets'
 import { ApiConfig, WriteError } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
@@ -31,9 +33,23 @@ import {
 import {
   createCollectionViaApi,
   deleteCollectionViaApi,
-  ROOT_COLLECTION_ALIAS
+  publishCollectionViaApi,
+  ROOT_COLLECTION_ALIAS,
+  setStorageDriverViaApi
 } from '../../testHelpers/collections/collectionHelper'
-import { testTextFile1Name, uploadFileViaApi } from '../../testHelpers/files/filesHelper'
+import {
+  calculateBlobChecksum,
+  createSinglepartFileBlob,
+  testTextFile1Name,
+  uploadFileViaApi
+} from '../../testHelpers/files/filesHelper'
+import {
+  Summary,
+  SummaryStringValues
+} from '../../../src/datasets/domain/models/DatasetVersionSummary'
+import { FilesRepository } from '../../../src/files/infra/repositories/FilesRepository'
+import { DirectUploadClient } from '../../../src/files/infra/clients/DirectUploadClient'
+import { createTestFileUploadDestination } from '../../testHelpers/files/fileUploadDestinationHelper'
 
 const TEST_DIFF_DATASET_DTO: DatasetDTO = {
   license: {
@@ -79,6 +95,9 @@ describe('DatasetsRepository', () => {
   const sut: DatasetsRepository = new DatasetsRepository()
   const nonExistentTestDatasetId = 100
 
+  const filesRepositorySut = new FilesRepository()
+  const directUploadSut: DirectUploadClient = new DirectUploadClient(filesRepositorySut)
+
   beforeAll(async () => {
     ApiConfig.init(
       TestConstants.TEST_API_URL,
@@ -925,4 +944,179 @@ describe('DatasetsRepository', () => {
       ).rejects.toBeInstanceOf(WriteError)
     })
   })
+
+  describe('getDatasetVersions', () => {
+    const testDatasetVersionsCollectionAlias = 'testDatasetVersionsCollection'
+
+    beforeAll(async () => {
+      await createCollectionViaApi(testDatasetVersionsCollectionAlias)
+      await publishCollectionViaApi(testDatasetVersionsCollectionAlias)
+      await setStorageDriverViaApi(testDatasetVersionsCollectionAlias, 'LocalStack')
+    })
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(testDatasetVersionsCollectionAlias)
+    })
+
+    test('should return dataset versions when dataset exists', async () => {
+      const testDatasetIds = await createDataset.execute(
+        TestConstants.TEST_NEW_DATASET_DTO,
+        testDatasetVersionsCollectionAlias
+      )
+
+      const actual = await sut.getDatasetVersions(testDatasetIds.numericId)
+
+      expect(actual.length).toBeGreaterThan(0)
+      expect(actual[0].versionNumber).toBe('DRAFT')
+      expect(actual[0].summary).toBe(SummaryStringValues.firstDraft)
+
+      await deleteUnpublishedDatasetViaApi(testDatasetIds.numericId)
+    })
+
+    test('should return dataset versions correctly after first publish', async () => {
+      const testDatasetIds = await createDataset.execute(
+        TestConstants.TEST_NEW_DATASET_DTO,
+        testDatasetVersionsCollectionAlias
+      )
+      await publishDataset.execute(testDatasetIds.numericId, VersionUpdateType.MAJOR)
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const actual = await sut.getDatasetVersions(testDatasetIds.numericId)
+
+      expect(actual.length).toBeGreaterThan(0)
+      expect(actual[0].versionNumber).toBe('1.0')
+      expect(actual[0].summary).toBe(SummaryStringValues.firstPublished)
+
+      await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
+    })
+
+    test('should return dataset versions correctly after 1st publish and metadata fields update', async () => {
+      const testDatasetIds = await createDataset.execute(
+        TestConstants.TEST_NEW_DATASET_DTO,
+        testDatasetVersionsCollectionAlias
+      )
+      await publishDataset.execute(testDatasetIds.numericId, VersionUpdateType.MAJOR)
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const metadataBlocksRepository = new MetadataBlocksRepository()
+      const citationMetadataBlock = await metadataBlocksRepository.getMetadataBlockByName(
+        'citation'
+      )
+
+      await sut.updateDataset(
+        testDatasetIds.numericId,
+        {
+          license: createDatasetLicenseModel(true),
+          metadataBlockValues: [
+            {
+              name: 'citation',
+              fields: {
+                title: 'Updated Dataset Title'
+              }
+            }
+          ]
+        },
+        [citationMetadataBlock]
+      )
+
+      const actual = await sut.getDatasetVersions(testDatasetIds.numericId)
+
+      expect(actual.length).toEqual(2)
+
+      expect(actual[0].versionNumber).toBe('DRAFT')
+      expect(actual[0].summary).toMatchObject<Summary>({
+        'Citation Metadata': {
+          Title: {
+            added: 0,
+            deleted: 0,
+            changed: 1
+          }
+        },
+        files: {
+          added: 0,
+          removed: 0,
+          replaced: 0,
+          changedFileMetaData: 0,
+          changedVariableMetadata: 0
+        },
+        termsAccessChanged: false
+      })
+
+      expect(actual[1].versionNumber).toBe('1.0')
+      expect(actual[1].summary).toBe(SummaryStringValues.firstPublished)
+
+      await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
+    })
+
+    test('should return correct files summary', async () => {
+      const testDatasetIds = await createDataset.execute(
+        TestConstants.TEST_NEW_DATASET_DTO,
+        testDatasetVersionsCollectionAlias
+      )
+      await publishDataset.execute(testDatasetIds.numericId, VersionUpdateType.MAJOR)
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const singlepartFile = await createSinglepartFileBlob()
+
+      const destination = await createTestFileUploadDestination(
+        singlepartFile,
+        testDatasetIds.numericId
+      )
+
+      const actualStorageId = await directUploadSut.uploadFile(
+        testDatasetIds.numericId,
+        singlepartFile,
+        jest.fn(),
+        new AbortController(),
+        destination
+      )
+
+      const fileArrayBuffer = await singlepartFile.arrayBuffer()
+      const fileBuffer = Buffer.from(fileArrayBuffer)
+
+      const uploadedFileDTO = {
+        fileName: singlepartFile.name,
+        storageId: actualStorageId,
+        checksumType: 'md5',
+        checksumValue: calculateBlobChecksum(fileBuffer, 'md5'),
+        mimeType: singlepartFile.type
+      }
+
+      await filesRepositorySut.addUploadedFilesToDataset(testDatasetIds.numericId, [
+        uploadedFileDTO
+      ])
+
+      const actual = await sut.getDatasetVersions(testDatasetIds.numericId)
+
+      expect(actual.length).toEqual(2)
+
+      expect(actual[0].versionNumber).toBe('DRAFT')
+      expect(actual[0].summary).toMatchObject<Summary>({
+        files: {
+          added: 1,
+          removed: 0,
+          replaced: 0,
+          changedFileMetaData: 0,
+          changedVariableMetadata: 0
+        },
+        termsAccessChanged: false
+      })
+
+      expect(actual[1].versionNumber).toBe('1.0')
+      expect(actual[1].summary).toBe(SummaryStringValues.firstPublished)
+
+      await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
+    })
+
+    test('should return error when dataset does not exist', async () => {
+      const expectedError = new ReadError(
+        `[404] Dataset with ID ${nonExistentTestDatasetId} not found.`
+      )
+
+      await expect(sut.getDatasetVersions(nonExistentTestDatasetId)).rejects.toThrow(expectedError)
+    })
+  })
 })

test/integration/files/DirectUpload.test.ts

@@ -15,13 +15,15 @@ import {
   setStorageDriverViaApi
 } from '../../testHelpers/collections/collectionHelper'
 import { deleteUnpublishedDatasetViaApi } from '../../testHelpers/datasets/datasetHelper'
-import axios from 'axios'
+
 import {
+  calculateBlobChecksum,
   createMultipartFileBlob,
-  createSinglepartFileBlob
+  createSinglepartFileBlob,
+  singlepartFileExistsInBucket
 } from '../../testHelpers/files/filesHelper'
 import { FileUploadCancelError } from '../../../src/files/infra/clients/errors/FileUploadCancelError'
-import * as crypto from 'crypto'
+import { createTestFileUploadDestination } from '../../testHelpers/files/fileUploadDestinationHelper'
 
 describe('Direct Upload', () => {
   const testCollectionAlias = 'directUploadTestCollection'
@@ -113,7 +115,7 @@ describe('Direct Upload', () => {
       fileName: singlepartFile.name,
       storageId: actualStorageId,
       checksumType: checksumAlgorithm,
-      checksumValue: calculateBlobChecksum(fileBuffer),
+      checksumValue: calculateBlobChecksum(fileBuffer, checksumAlgorithm),
       mimeType: singlepartFile.type
     }
 
@@ -170,7 +172,7 @@ describe('Direct Upload', () => {
       fileName: multipartFile.name,
       storageId: actualStorageId,
       checksumType: checksumAlgorithm,
-      checksumValue: calculateBlobChecksum(fileBuffer),
+      checksumValue: calculateBlobChecksum(fileBuffer, checksumAlgorithm),
       mimeType: multipartFile.type
     }
 
@@ -212,30 +214,4 @@ describe('Direct Upload', () => {
       )
     ).rejects.toThrow(FileUploadCancelError)
   })
-
-  const createTestFileUploadDestination = async (file: File, testDatasetId: number) => {
-    const filesRepository = new FilesRepository()
-    const destination = await filesRepository.getFileUploadDestination(testDatasetId, file)
-    destination.urls.forEach((destinationUrl, index) => {
-      destination.urls[index] = destinationUrl.replace('localstack', 'localhost')
-    })
-    return destination
-  }
-
-  const singlepartFileExistsInBucket = async (fileUrl: string): Promise<boolean> => {
-    return axios
-      .get(fileUrl)
-      .then(() => {
-        return true
-      })
-      .catch(() => {
-        return false
-      })
-  }
-
-  const calculateBlobChecksum = (blob: Buffer): string => {
-    const hash = crypto.createHash(checksumAlgorithm)
-    hash.update(blob)
-    return hash.digest('hex')
-  }
 })