Skip to content

Commit dfc608d

Browse files
jp-toscajp-tosca
committed
Merge remote-tracking branch 'origin/develop' into 409-create-use-case-for-getting-storage-quota-on-dataset
2 parents 6d795bb + 67721ee commit dfc608d

11 files changed

Lines changed: 67 additions & 24 deletions

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
1616
- New Use Case: [Get a Template](./docs/useCases.md#get-a-template) under Templates.
1717
- New Use Case: [Delete a Template](./docs/useCases.md#delete-a-template) under Templates.
1818
- New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
19+
- DatasetType: Updated datasetType data model. Added two more fields: description and displayName.
1920

2021
### Changed
2122

‎src/datasets/domain/models/DatasetType.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
export interface DatasetType {
22
id: number
33
name: string
4+
displayName: string
45
linkedMetadataBlocks?: string[]
56
availableLicenses?: string[]
7+
description?: string
68
}

‎test/functional/datasets/AddDatasetType.test.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { randomUUID } from 'node:crypto'
12
import { ApiConfig, DatasetType, addDatasetType, deleteDatasetType } from '../../../src'
23
import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
34
import { TestConstants } from '../../testHelpers/TestConstants'
@@ -13,11 +14,13 @@ describe('AddDatasetType', () => {
1314
})
1415

1516
test('should allow for adding and deleting a dataset type', async () => {
16-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
17+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
1718
const actual: DatasetType = await addDatasetType.execute({
1819
name: randomName,
1920
linkedMetadataBlocks: [],
20-
availableLicenses: []
21+
availableLicenses: [],
22+
displayName: randomName,
23+
description: 'A dataset type created for testing purposes'
2124
})
2225
expect(actual.name).toEqual(randomName)
2326

‎test/functional/datasets/DeleteDatasetType.test.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { randomUUID } from 'node:crypto'
12
import { ApiConfig, DatasetType, addDatasetType, deleteDatasetType } from '../../../src'
23
import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
34
import { TestConstants } from '../../testHelpers/TestConstants'
@@ -13,11 +14,13 @@ describe('DeleteDatasetType', () => {
1314
})
1415

1516
test('should allow for adding and deleting a dataset type', async () => {
16-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
17+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
1718
const actual: DatasetType = await addDatasetType.execute({
1819
name: randomName,
1920
linkedMetadataBlocks: [],
20-
availableLicenses: []
21+
availableLicenses: [],
22+
displayName: randomName,
23+
description: 'A dataset type created for testing purposes'
2124
})
2225
expect(actual.name).toEqual(randomName)
2326

‎test/functional/datasets/GetDatasetAvailableDatasetType.test.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@ describe('getDatasetAvailableDatasetType', () => {
2020
const expectedDatasetType = {
2121
id: 1,
2222
name: 'dataset',
23+
displayName: 'Dataset',
2324
linkedMetadataBlocks: [],
24-
availableLicenses: []
25+
availableLicenses: [],
26+
description:
27+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
2528
}
2629

2730
expect(actualDatasetType).toEqual(expectedDatasetType)

‎test/functional/datasets/GetDatasetAvailableDatasetTypes.test.ts‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,12 @@ describe('getDatasetAvailableDatasetTypes', () => {
1919
id: 1,
2020
name: 'dataset',
2121
linkedMetadataBlocks: [],
22-
availableLicenses: []
22+
availableLicenses: [],
23+
description:
24+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.',
25+
displayName: 'Dataset'
2326
}
2427
]
25-
2628
expect(actualDatasetTypes).toEqual(expectedDatasetTypes)
2729
})
2830
})

‎test/functional/datasets/LinkDatasetTypeWithMetadataBlocks.test.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { randomUUID } from 'node:crypto'
12
import {
23
ApiConfig,
34
DatasetType,
@@ -19,11 +20,13 @@ describe('LinkDatasetTypeWithMetadataBlocks', () => {
1920
})
2021

2122
test('should allow for linking a dataset type to metadata blocks', async () => {
22-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
23+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
2324
const actual: DatasetType = await addDatasetType.execute({
2425
name: randomName,
2526
linkedMetadataBlocks: [],
26-
availableLicenses: []
27+
availableLicenses: [],
28+
displayName: randomName,
29+
description: 'A dataset type created for testing purposes'
2730
})
2831
expect(actual.name).toEqual(randomName)
2932

‎test/functional/datasets/SetAvailableLicensesForDatasetType.test.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { randomUUID } from 'node:crypto'
12
import {
23
ApiConfig,
34
DatasetType,
@@ -19,11 +20,13 @@ describe('SetAvailableLicensesForDatasetType', () => {
1920
})
2021

2122
test('should allow for setting available licenses for a dataset type', async () => {
22-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
23+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
2324
const actual: DatasetType = await addDatasetType.execute({
2425
name: randomName,
2526
linkedMetadataBlocks: [],
26-
availableLicenses: []
27+
availableLicenses: [],
28+
displayName: randomName,
29+
description: 'A dataset type created for testing purposes'
2730
})
2831
expect(actual.name).toEqual(randomName)
2932

‎test/integration/datasets/DatasetsRepository.test.ts‎

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { randomUUID } from 'node:crypto'
12
import { DatasetsRepository } from '../../../src/datasets/infra/repositories/DatasetsRepository'
23
import { TestConstants } from '../../testHelpers/TestConstants'
34
import {
@@ -1823,8 +1824,11 @@ describe('DatasetsRepository', () => {
18231824
{
18241825
id: 1,
18251826
name: 'dataset',
1827+
displayName: 'Dataset',
18261828
linkedMetadataBlocks: [],
1827-
availableLicenses: []
1829+
availableLicenses: [],
1830+
description:
1831+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
18281832
}
18291833
]
18301834

@@ -1841,8 +1845,11 @@ describe('DatasetsRepository', () => {
18411845
const expectedDatasetType = {
18421846
id: 1,
18431847
name: 'dataset',
1848+
displayName: 'Dataset',
18441849
linkedMetadataBlocks: [],
1845-
availableLicenses: []
1850+
availableLicenses: [],
1851+
description:
1852+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
18461853
}
18471854

18481855
expect(actualDatasetType).toEqual(expectedDatasetType)
@@ -1851,11 +1858,13 @@ describe('DatasetsRepository', () => {
18511858

18521859
describe('addDatasetType', () => {
18531860
test('should add a dataset type', async () => {
1854-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1861+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18551862
const actual: DatasetType = await addDatasetType.execute({
18561863
name: randomName,
18571864
linkedMetadataBlocks: [],
1858-
availableLicenses: []
1865+
availableLicenses: [],
1866+
displayName: randomName,
1867+
description: 'A dataset type created for testing purposes'
18591868
})
18601869

18611870
expect(actual.name).toEqual(randomName)
@@ -1864,11 +1873,13 @@ describe('DatasetsRepository', () => {
18641873

18651874
describe('deleteDatasetType', () => {
18661875
test('should delete a dataset type (after adding it)', async () => {
1867-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1876+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18681877
const actual: DatasetType = await addDatasetType.execute({
18691878
name: randomName,
18701879
linkedMetadataBlocks: [],
1871-
availableLicenses: []
1880+
availableLicenses: [],
1881+
displayName: randomName,
1882+
description: 'A dataset type created for testing purposes'
18721883
})
18731884
expect(actual.name).toEqual(randomName)
18741885

@@ -1879,11 +1890,13 @@ describe('DatasetsRepository', () => {
18791890

18801891
describe('linkDatasetTypeWithMetadataBlocks', () => {
18811892
test('should allow for linking a dataset type to metadata blocks', async () => {
1882-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1893+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18831894
const actual: DatasetType = await addDatasetType.execute({
18841895
name: randomName,
18851896
linkedMetadataBlocks: [],
1886-
availableLicenses: []
1897+
availableLicenses: [],
1898+
displayName: randomName,
1899+
description: 'A dataset type created for testing purposes'
18871900
})
18881901
expect(actual.name).toEqual(randomName)
18891902

@@ -1901,11 +1914,13 @@ describe('DatasetsRepository', () => {
19011914

19021915
describe('setAvailableLicensesForDatasetType', () => {
19031916
test('should allow for setting available licenses for a dataset type', async () => {
1904-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1917+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
19051918
const actual: DatasetType = await addDatasetType.execute({
19061919
name: randomName,
19071920
linkedMetadataBlocks: [],
1908-
availableLicenses: []
1921+
availableLicenses: [],
1922+
displayName: randomName,
1923+
description: 'A dataset type created for testing purposes'
19091924
})
19101925
expect(actual.name).toEqual(randomName)
19111926

‎test/unit/datasets/GetDatasetAvailableDatasetType.test.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,11 @@ describe('GetDatasetAvailableDatasetType', () => {
1111
const expectedDatasetType: DatasetType = {
1212
id: datasetTypeId,
1313
name: datasetTypeName,
14+
displayName: 'Dataset',
1415
linkedMetadataBlocks: [],
15-
availableLicenses: []
16+
availableLicenses: [],
17+
description:
18+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
1619
}
1720

1821
it('should get a dataset type by database id', async () => {

0 commit comments

Comments
 (0)