Skip to content

Commit 12810ed

Browse files
ChengShi-1ChengShi-1
authored
Merge branch 'develop' into 407-add-use-cases-for-publish-dataset-settings
2 parents 1631011 + 67721ee commit 12810ed

11 files changed

+67
-24
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
1818
- New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
1919
- New Use Case: [Get Publish Dataset Disclaimer Text](./docs/useCases.md#get-publish-dataset-disclaimer-text).
2020
- New Use Case: [Get Dataset Publish Popup Custom Text](./docs/useCases.md#get-dataset-publish-popup-custom-text).
21+
- DatasetType: Updated datasetType data model. Added two more fields: description and displayName.
2122

2223
### Changed
2324

‎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 {
@@ -1821,8 +1822,11 @@ describe('DatasetsRepository', () => {
18211822
{
18221823
id: 1,
18231824
name: 'dataset',
1825+
displayName: 'Dataset',
18241826
linkedMetadataBlocks: [],
1825-
availableLicenses: []
1827+
availableLicenses: [],
1828+
description:
1829+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
18261830
}
18271831
]
18281832

@@ -1839,8 +1843,11 @@ describe('DatasetsRepository', () => {
18391843
const expectedDatasetType = {
18401844
id: 1,
18411845
name: 'dataset',
1846+
displayName: 'Dataset',
18421847
linkedMetadataBlocks: [],
1843-
availableLicenses: []
1848+
availableLicenses: [],
1849+
description:
1850+
'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
18441851
}
18451852

18461853
expect(actualDatasetType).toEqual(expectedDatasetType)
@@ -1849,11 +1856,13 @@ describe('DatasetsRepository', () => {
18491856

18501857
describe('addDatasetType', () => {
18511858
test('should add a dataset type', async () => {
1852-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1859+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18531860
const actual: DatasetType = await addDatasetType.execute({
18541861
name: randomName,
18551862
linkedMetadataBlocks: [],
1856-
availableLicenses: []
1863+
availableLicenses: [],
1864+
displayName: randomName,
1865+
description: 'A dataset type created for testing purposes'
18571866
})
18581867

18591868
expect(actual.name).toEqual(randomName)
@@ -1862,11 +1871,13 @@ describe('DatasetsRepository', () => {
18621871

18631872
describe('deleteDatasetType', () => {
18641873
test('should delete a dataset type (after adding it)', async () => {
1865-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1874+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18661875
const actual: DatasetType = await addDatasetType.execute({
18671876
name: randomName,
18681877
linkedMetadataBlocks: [],
1869-
availableLicenses: []
1878+
availableLicenses: [],
1879+
displayName: randomName,
1880+
description: 'A dataset type created for testing purposes'
18701881
})
18711882
expect(actual.name).toEqual(randomName)
18721883

@@ -1877,11 +1888,13 @@ describe('DatasetsRepository', () => {
18771888

18781889
describe('linkDatasetTypeWithMetadataBlocks', () => {
18791890
test('should allow for linking a dataset type to metadata blocks', async () => {
1880-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1891+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
18811892
const actual: DatasetType = await addDatasetType.execute({
18821893
name: randomName,
18831894
linkedMetadataBlocks: [],
1884-
availableLicenses: []
1895+
availableLicenses: [],
1896+
displayName: randomName,
1897+
description: 'A dataset type created for testing purposes'
18851898
})
18861899
expect(actual.name).toEqual(randomName)
18871900

@@ -1899,11 +1912,13 @@ describe('DatasetsRepository', () => {
18991912

19001913
describe('setAvailableLicensesForDatasetType', () => {
19011914
test('should allow for setting available licenses for a dataset type', async () => {
1902-
const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
1915+
const randomName = `datasetType-${randomUUID().slice(0, 6)}`
19031916
const actual: DatasetType = await addDatasetType.execute({
19041917
name: randomName,
19051918
linkedMetadataBlocks: [],
1906-
availableLicenses: []
1919+
availableLicenses: [],
1920+
displayName: randomName,
1921+
description: 'A dataset type created for testing purposes'
19071922
})
19081923
expect(actual.name).toEqual(randomName)
19091924

‎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)