Skip to content

Make files parameter in dataset creation and update optional #1058

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2025
Merged

Make files parameter in dataset creation and update optional #1058

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
251 changes: 251 additions & 0 deletions api/src/integrationTest/kotlin/com/cosmotech/api/home/dataset/DatasetControllerTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ import com.cosmotech.api.rbac.ROLE_EDITOR
import com.cosmotech.api.rbac.ROLE_NONE
import com.cosmotech.api.rbac.ROLE_VIEWER
import com.cosmotech.dataset.domain.DatasetAccessControl
import com.cosmotech.dataset.domain.DatasetCreateRequest
import com.cosmotech.dataset.domain.DatasetPart
import com.cosmotech.dataset.domain.DatasetPartCreateRequest
import com.cosmotech.dataset.domain.DatasetPartTypeEnum
import com.cosmotech.dataset.domain.DatasetPartUpdateRequest
Expand All @@ -44,6 +46,7 @@ import com.cosmotech.solution.domain.RunTemplateResourceSizing
import java.io.InputStream
import kotlin.test.Ignore
import org.apache.commons.io.IOUtils
import org.hamcrest.Matchers.empty
import org.hamcrest.Matchers.greaterThan
import org.json.JSONArray
import org.json.JSONObject
Expand Down Expand Up @@ -160,6 +163,91 @@ class DatasetControllerTests : ControllerTestBase() {
.andDo(document("organizations/{organization_id}/workspaces/{workspace_id}/datasets/POST"))
}

@Test
@WithMockOauth2User
fun create_dataset_with_no_files_parameter() {
val datasetCreateRequest =
MockMultipartFile(
"datasetCreateRequest",
null,
MediaType.APPLICATION_JSON_VALUE,
JSONObject(
DatasetCreateRequest(
name = DATASET_NAME,
description = DATASET_DESCRIPTION,
tags = mutableListOf("tag1", "tag2"),
runnerId = "r-12345678910"))
.toString()
.byteInputStream())

mvc.perform(
multipart("/organizations/$organizationId/workspaces/$workspaceId/datasets")
.file(datasetCreateRequest)
.accept(MediaType.APPLICATION_JSON)
.with(csrf()))
.andExpect(status().is2xxSuccessful)
.andExpect(jsonPath("$.name").value(DATASET_NAME))
.andExpect(jsonPath("$.description").value(DATASET_DESCRIPTION))
.andExpect(jsonPath("$.organizationId").value(organizationId))
.andExpect(jsonPath("$.workspaceId").value(workspaceId))
.andExpect(jsonPath("$.parts", empty<DatasetPart>()))
.andExpect(jsonPath("$.createInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.createInfo.runnerId").value("r-12345678910"))
.andExpect(jsonPath("$.createInfo.timestamp").isNumber)
.andExpect(jsonPath("$.createInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.updateInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.updateInfo.timestamp").isNumber)
.andExpect(jsonPath("$.updateInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.tags").value(mutableListOf("tag1", "tag2")))
.andExpect(jsonPath("$.security.default").value(ROLE_NONE))
.andExpect(jsonPath("$.security.accessControlList[0].role").value(ROLE_ADMIN))
.andExpect(jsonPath("$.security.accessControlList[0].id").value(PLATFORM_ADMIN_EMAIL))
.andDo(MockMvcResultHandlers.print())
}

@Test
@WithMockOauth2User
fun create_dataset_with_no_files_parameter_empty_parts() {
val datasetCreateRequest =
MockMultipartFile(
"datasetCreateRequest",
null,
MediaType.APPLICATION_JSON_VALUE,
JSONObject(
DatasetCreateRequest(
name = DATASET_NAME,
description = DATASET_DESCRIPTION,
tags = mutableListOf("tag1", "tag2"),
parts = mutableListOf(),
runnerId = "r-12345678910"))
.toString()
.byteInputStream())

mvc.perform(
multipart("/organizations/$organizationId/workspaces/$workspaceId/datasets")
.file(datasetCreateRequest)
.accept(MediaType.APPLICATION_JSON)
.with(csrf()))
.andExpect(status().is2xxSuccessful)
.andExpect(jsonPath("$.name").value(DATASET_NAME))
.andExpect(jsonPath("$.description").value(DATASET_DESCRIPTION))
.andExpect(jsonPath("$.organizationId").value(organizationId))
.andExpect(jsonPath("$.workspaceId").value(workspaceId))
.andExpect(jsonPath("$.parts", empty<DatasetPart>()))
.andExpect(jsonPath("$.createInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.createInfo.runnerId").value("r-12345678910"))
.andExpect(jsonPath("$.createInfo.timestamp").isNumber)
.andExpect(jsonPath("$.createInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.updateInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.updateInfo.timestamp").isNumber)
.andExpect(jsonPath("$.updateInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.tags").value(mutableListOf("tag1", "tag2")))
.andExpect(jsonPath("$.security.default").value(ROLE_NONE))
.andExpect(jsonPath("$.security.accessControlList[0].role").value(ROLE_ADMIN))
.andExpect(jsonPath("$.security.accessControlList[0].id").value(PLATFORM_ADMIN_EMAIL))
.andDo(MockMvcResultHandlers.print())
}

@Test
@WithMockOauth2User
fun download_dataset_part() {
Expand Down Expand Up @@ -901,6 +989,169 @@ class DatasetControllerTests : ControllerTestBase() {
"organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/PATCH"))
}

@Test
@WithMockOauth2User
fun update_dataset_with_no_files_parameter() {
val datasetId =
createDatasetAndReturnId(
mvc,
organizationId,
workspaceId,
constructDatasetCreateRequest(
security =
DatasetSecurity(
default = ROLE_NONE,
accessControlList =
mutableListOf(
DatasetAccessControl(id = PLATFORM_ADMIN_EMAIL, role = ROLE_ADMIN),
DatasetAccessControl(
id = ORGANIZATION_USER_EMAIL, role = ROLE_EDITOR)))))

val newName = "this_a_new_name_for_dataset"
val newDescription = "this_a_new_description_for_dataset"
val newTags = mutableListOf("tag1_updated", "tag2_updated")

val datasetUpdateRequest =
DatasetUpdateRequest(
name = newName,
description = newDescription,
tags = newTags,
security =
DatasetSecurity(
default = ROLE_NONE,
accessControlList =
mutableListOf(
DatasetAccessControl(id = PLATFORM_ADMIN_EMAIL, role = ROLE_ADMIN),
DatasetAccessControl(
id = ORGANIZATION_USER_EMAIL, role = ROLE_VIEWER))))

val datasetUpdateRequestMultipartFile =
MockMultipartFile(
"datasetUpdateRequest",
null,
MediaType.APPLICATION_JSON_VALUE,
JSONObject(datasetUpdateRequest).toString().byteInputStream())
mvc.perform(
multipart("/organizations/$organizationId/workspaces/$workspaceId/datasets/$datasetId")
.file(datasetUpdateRequestMultipartFile)
.accept(MediaType.APPLICATION_JSON)
.with(csrf())
// By default, behind multipart, the HTTP verb used is POST
// We can override the HTTP verb as following
// https://stackoverflow.com/questions/38571716/how-to-put-multipart-form-data-using-spring-mockmvc
.with { request ->
request.method = "PATCH"
request
})
.andExpect(status().is2xxSuccessful)
.andExpect(jsonPath("$.name").value(newName))
.andExpect(jsonPath("$.description").value(newDescription))
.andExpect(jsonPath("$.organizationId").value(organizationId))
.andExpect(jsonPath("$.workspaceId").value(workspaceId))
.andExpect(jsonPath("$.createInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.createInfo.timestamp").isNumber)
.andExpect(jsonPath("$.createInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.updateInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.updateInfo.timestamp").isNumber)
.andExpect(jsonPath("$.updateInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.parts[0].name").value(DATASET_PART_NAME))
.andExpect(jsonPath("$.parts[0].description").value(DATASET_PART_DESCRIPTION))
.andExpect(jsonPath("$.parts[0].organizationId").value(organizationId))
.andExpect(jsonPath("$.parts[0].workspaceId").value(workspaceId))
.andExpect(jsonPath("$.parts[0].sourceName").value(TEST_FILE_NAME))
.andExpect(jsonPath("$.parts[0].tags").value(mutableListOf("tag_part1", "tag_part2")))
.andExpect(jsonPath("$.parts[0].type").value(DatasetPartTypeEnum.File.value))
.andExpect(jsonPath("$.parts[0].createInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.parts[0].createInfo.timestamp").isNumber)
.andExpect(jsonPath("$.parts[0].createInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.parts[0].updateInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.parts[0].updateInfo.timestamp").isNumber)
.andExpect(jsonPath("$.parts[0].updateInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.tags").value(newTags))
.andExpect(jsonPath("$.security.default").value(ROLE_NONE))
.andExpect(jsonPath("$.security.accessControlList[0].role").value(ROLE_ADMIN))
.andExpect(jsonPath("$.security.accessControlList[0].id").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.security.accessControlList[1].role").value(ROLE_VIEWER))
.andExpect(jsonPath("$.security.accessControlList[1].id").value(ORGANIZATION_USER_EMAIL))
.andDo(MockMvcResultHandlers.print())
}

@Test
@WithMockOauth2User
fun update_dataset_with_no_files_parameter_empty_parts() {
val datasetId =
createDatasetAndReturnId(
mvc,
organizationId,
workspaceId,
constructDatasetCreateRequest(
security =
DatasetSecurity(
default = ROLE_NONE,
accessControlList =
mutableListOf(
DatasetAccessControl(id = PLATFORM_ADMIN_EMAIL, role = ROLE_ADMIN),
DatasetAccessControl(
id = ORGANIZATION_USER_EMAIL, role = ROLE_EDITOR)))))

val newName = "this_a_new_name_for_dataset"
val newDescription = "this_a_new_description_for_dataset"
val newTags = mutableListOf("tag1_updated", "tag2_updated")

val datasetUpdateRequest =
DatasetUpdateRequest(
name = newName,
description = newDescription,
tags = newTags,
parts = mutableListOf(),
security =
DatasetSecurity(
default = ROLE_NONE,
accessControlList =
mutableListOf(
DatasetAccessControl(id = PLATFORM_ADMIN_EMAIL, role = ROLE_ADMIN),
DatasetAccessControl(
id = ORGANIZATION_USER_EMAIL, role = ROLE_VIEWER))))

val datasetUpdateRequestMultipartFile =
MockMultipartFile(
"datasetUpdateRequest",
null,
MediaType.APPLICATION_JSON_VALUE,
JSONObject(datasetUpdateRequest).toString().byteInputStream())
mvc.perform(
multipart("/organizations/$organizationId/workspaces/$workspaceId/datasets/$datasetId")
.file(datasetUpdateRequestMultipartFile)
.accept(MediaType.APPLICATION_JSON)
.with(csrf())
// By default, behind multipart, the HTTP verb used is POST
// We can override the HTTP verb as following
// https://stackoverflow.com/questions/38571716/how-to-put-multipart-form-data-using-spring-mockmvc
.with { request ->
request.method = "PATCH"
request
})
.andExpect(status().is2xxSuccessful)
.andExpect(jsonPath("$.name").value(newName))
.andExpect(jsonPath("$.description").value(newDescription))
.andExpect(jsonPath("$.organizationId").value(organizationId))
.andExpect(jsonPath("$.workspaceId").value(workspaceId))
.andExpect(jsonPath("$.parts", empty<DatasetPart>()))
.andExpect(jsonPath("$.createInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.createInfo.timestamp").isNumber)
.andExpect(jsonPath("$.createInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.updateInfo.userId").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.updateInfo.timestamp").isNumber)
.andExpect(jsonPath("$.updateInfo.timestamp").value(greaterThan(0.toLong())))
.andExpect(jsonPath("$.tags").value(newTags))
.andExpect(jsonPath("$.security.default").value(ROLE_NONE))
.andExpect(jsonPath("$.security.accessControlList[0].role").value(ROLE_ADMIN))
.andExpect(jsonPath("$.security.accessControlList[0].id").value(PLATFORM_ADMIN_EMAIL))
.andExpect(jsonPath("$.security.accessControlList[1].role").value(ROLE_VIEWER))
.andExpect(jsonPath("$.security.accessControlList[1].id").value(ORGANIZATION_USER_EMAIL))
.andDo(MockMvcResultHandlers.print())
}

@Test
@WithMockOauth2User
fun update_dataset_access_control() {
Expand Down
3 changes: 3 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,9 @@ subprojects {
tasks.withType<GenerateTask> {
inputSpec.set("${projectDir}/src/main/openapi/${projectDirName}.yaml")
outputDir.set(openApiServerSourcesGenerationDir)
// Templates here were enabled due to an open PR in OpenAPITools/openapi-generator
// https://github.com/OpenAPITools/openapi-generator/pull/21994
templateDir.set("${rootDir}/openapi/templates")
generatorName.set("kotlin-spring")
apiPackage.set("com.cosmotech.${projectDirName}.api")
modelPackage.set("com.cosmotech.${projectDirName}.domain")
Expand Down
16 changes: 10 additions & 6 deletions dataset/src/main/kotlin/com/cosmotech/dataset/service/DatasetServiceImpl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,12 @@ class DatasetServiceImpl(
organizationId: String,
workspaceId: String,
datasetCreateRequest: DatasetCreateRequest,
files: Array<MultipartFile>
files: Array<MultipartFile>?
): Dataset {
val filesUploaded = files ?: emptyArray()
workspaceService.getVerifiedWorkspace(organizationId, workspaceId, PERMISSION_CREATE_CHILDREN)
logger.debug("Registering Dataset: {}", datasetCreateRequest)
validDatasetCreateRequest(datasetCreateRequest, files)
validDatasetCreateRequest(datasetCreateRequest, filesUploaded)

val datasetId = idGenerator.generate("dataset")
val now = Instant.now().toEpochMilli()
Expand All @@ -144,7 +145,8 @@ class DatasetServiceImpl(
val constructDatasetPart =
constructDatasetPart(organizationId, workspaceId, datasetId, part)
datasetPartManagementFactory.storeData(
constructDatasetPart, files.first { it.originalFilename == part.sourceName })
constructDatasetPart,
filesUploaded.first { it.originalFilename == part.sourceName })
constructDatasetPart
}
?.toMutableList()
Expand Down Expand Up @@ -290,20 +292,22 @@ class DatasetServiceImpl(
workspaceId: String,
datasetId: String,
datasetUpdateRequest: DatasetUpdateRequest,
files: Array<MultipartFile>
files: Array<MultipartFile>?
): Dataset {
logger.debug("Updating Dataset: {}", datasetUpdateRequest)
val filesUploaded = files ?: emptyArray()
val previousDataset =
getVerifiedDataset(organizationId, workspaceId, datasetId, PERMISSION_WRITE)
validDatasetUpdateRequest(datasetUpdateRequest, files)
validDatasetUpdateRequest(datasetUpdateRequest, filesUploaded)

val newDatasetParts =
datasetUpdateRequest.parts
?.map { part ->
val constructDatasetPart =
constructDatasetPart(organizationId, workspaceId, datasetId, part)
datasetPartManagementFactory.storeData(
constructDatasetPart, files.first { it.originalFilename == part.sourceName })
constructDatasetPart,
filesUploaded.first { it.originalFilename == part.sourceName })
constructDatasetPart
}
?.toMutableList()
Expand Down
1 change: 1 addition & 0 deletions openapi/templates/optionalDataType.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{^isFile}}{{{dataType}}}{{^required}}{{^defaultValue}}?{{/defaultValue}}{{/required}}{{/isFile}}{{#isFile}}{{#isArray}}Array<{{/isArray}}org.springframework.web.multipart.MultipartFile{{#isArray}}>{{/isArray}}{{^required}}?{{/required}}{{/isFile}}