Issue 1295: Allow to submit item with only metadata - with no need to set Clarin License (#1302)

kuchtiak-ufal · web-flow · commit d6862336b572 · 2026-01-08T13:56:37.000+01:00
* Issue 1295: Allow to submit item with only metadata - with no need to set the Clarin License

* checkstyle

* fixed test failures

* fixed IT test failures

* resolve MR comments
diff --git a/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml b/dspace-api/src/test/data/dspaceFolder/config/item-submission.xml
@@ -109,10 +109,16 @@
         <!--Step will be to select a Creative Commons License -->
         <step-definition id="cclicense"> <heading>submit.progressbar.CClicense</heading>
             <processing-class>org.dspace.app.rest.submit.step.CCLicenseStep</processing-class>
-            <type>cclicense</type> 
+            <type>cclicense</type>
         </step-definition>
 
-        <step-definition id="extractionstep"> 
+        <step-definition id="clarin-license">
+            <heading>submit.progressbar.clarin-license</heading>
+            <processing-class>org.dspace.app.rest.submit.step.ClarinLicenseResourceStep</processing-class>
+            <type>clarin-license</type>
+        </step-definition>
+
+        <step-definition id="extractionstep">
             <heading>submit.progressbar.ExtractMetadataStep</heading>
             <processing-class>org.dspace.app.rest.submit.step.ExtractMetadataStep</processing-class>
             <type>extract</type>
@@ -219,6 +225,8 @@
             <!--Step will be to Sign off on the License -->
             <step id="license"/>
             <step id="cclicense"/>
+
+            <step id="clarin-license"/>
         </submission-process>
 
         <submission-process name="languagetestprocess">
diff --git a/dspace-api/src/test/data/dspaceFolder/config/local.cfg b/dspace-api/src/test/data/dspaceFolder/config/local.cfg
@@ -331,3 +331,6 @@ webui.supported.locales = cs
 ##### S3 #####
 # S3 direct download is not used in the test environment
 s3.download.direct.enabled = false
+
+# Enable user registration for tests
+user.registration = true
diff --git a/dspace-api/src/test/java/org/dspace/builder/WorkspaceItemBuilder.java b/dspace-api/src/test/java/org/dspace/builder/WorkspaceItemBuilder.java
@@ -41,13 +41,18 @@ protected WorkspaceItemBuilder(Context context) {
     }
 
     public static WorkspaceItemBuilder createWorkspaceItem(final Context context, final Collection col) {
-        WorkspaceItemBuilder builder = new WorkspaceItemBuilder(context);
-        return builder.create(context, col, null);
+        return createWorkspaceItem(context, col, null);
     }
 
     public static WorkspaceItemBuilder createWorkspaceItem(final Context context, final Collection col, UUID uuid) {
         WorkspaceItemBuilder builder = new WorkspaceItemBuilder(context);
-        return builder.create(context, col, uuid);
+        return builder.create(context, col, uuid).withClarinLicense();
+    }
+
+    public static WorkspaceItemBuilder createWorkspaceItemWithNoClarinLicense(final Context context,
+                                                                              final Collection col) {
+        WorkspaceItemBuilder builder = new WorkspaceItemBuilder(context);
+        return builder.create(context, col, null);
     }
 
     /**
@@ -226,6 +231,12 @@ public WorkspaceItemBuilder grantLicense() {
         return this;
     }
 
+    public WorkspaceItemBuilder withClarinLicense() {
+        addMetadataValue(MetadataSchemaEnum.DC.getName(), "rights", null, "GNU General Public Licence, version 3");
+        addMetadataValue(MetadataSchemaEnum.DC.getName(), "rights", "uri", "http://opensource.org/licenses/GPL-3.0");
+        return addMetadataValue(MetadataSchemaEnum.DC.getName(), "rights", "label", "PUB");
+    }
+
     public WorkspaceItemBuilder withFulltext(String name, String source, InputStream is) {
         try {
             Item item = workspaceItem.getItem();
diff --git a/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/validation/ClarinLicenseResourceValidation.java b/dspace-server-webapp/src/main/java/org/dspace/app/rest/submit/step/validation/ClarinLicenseResourceValidation.java
@@ -45,14 +45,16 @@ public List<? extends ErrorRest> validate(SubmissionService submissionService, I
         List<MetadataValue> licenseLabel = itemService.getMetadataByMetadataString(item, "dc.rights.label");
 
         List<ErrorRest> errors = new ArrayList<>();
-        if (CollectionUtils.isEmpty(licenseDefinition) || CollectionUtils.isEmpty(licenseName) ||
-            CollectionUtils.isEmpty(licenseLabel)) {
-            addError(errors, ERROR_VALIDATION_CLARIN_LICENSE_GRANTED,
-                    "/" + WorkspaceItemRestRepository.OPERATION_PATH_SECTIONS + "/"
-                            + config.getId());
+        // check that if there are local files, the license fields are filled
+        if (hasFiles(item)) {
+            if (CollectionUtils.isEmpty(licenseDefinition) || CollectionUtils.isEmpty(licenseName) ||
+                    CollectionUtils.isEmpty(licenseLabel)) {
+                addError(errors, ERROR_VALIDATION_CLARIN_LICENSE_GRANTED,
+                        "/" + WorkspaceItemRestRepository.OPERATION_PATH_SECTIONS + "/"
+                                + config.getId());
+            }
         }
 
-
         return errors;
     }
 
@@ -63,4 +65,13 @@ public ItemService getItemService() {
     public void setItemService(ItemService itemService) {
         this.itemService = itemService;
     }
+
+    private boolean hasFiles(Item item) {
+        List<MetadataValue> hasFiles = itemService.getMetadataByMetadataString(item, "local.has.files");
+        if (CollectionUtils.isEmpty(hasFiles)) {
+            return false;
+        } else {
+            return "yes".equalsIgnoreCase(hasFiles.get(0).getValue());
+        }
+    }
 }
diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseAddPatchOperationIT.java
@@ -53,7 +53,7 @@ public void patchSubmissionCCLicense() throws Exception {
                                                  .withName("Collection")
                                                  .build();
 
-        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection)
+        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, collection)
                                                           .withTitle("Workspace Item")
                                                           .build();
 
@@ -93,7 +93,7 @@ public void patchSubmissionCCLicenseInvalid() throws Exception {
                                                  .withName("Collection")
                                                  .build();
 
-        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection)
+        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, collection)
                                                           .withTitle("Workspace Item")
                                                           .build();
 
diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/CCLicenseRemovePatchOperationIT.java
@@ -53,7 +53,7 @@ public void patchRemoveSubmissionCCLicense() throws Exception {
                                                  .withName("Collection")
                                                  .build();
 
-        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection)
+        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, collection)
                                                           .withTitle("Workspace Item")
                                                           .build();
 
@@ -115,7 +115,7 @@ public void patchRemoveSubmissionCCLicenseNonExisting() throws Exception {
                                                  .withName("Collection")
                                                  .build();
 
-        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItem(context, collection)
+        WorkspaceItem workspaceItem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, collection)
                                                           .withTitle("Workspace Item")
                                                           .build();
 
diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/ClarinLicenseResourceValidationIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/ClarinLicenseResourceValidationIT.java
@@ -0,0 +1,164 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+package org.dspace.app.rest;
+
+import static com.jayway.jsonpath.matchers.JsonPathMatchers.hasJsonPath;
+import static org.hamcrest.Matchers.contains;
+import static org.hamcrest.Matchers.hasSize;
+import static org.hamcrest.Matchers.is;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import java.io.InputStream;
+
+import org.dspace.app.rest.test.AbstractControllerIntegrationTest;
+import org.dspace.builder.CollectionBuilder;
+import org.dspace.builder.CommunityBuilder;
+import org.dspace.builder.WorkspaceItemBuilder;
+import org.dspace.content.Collection;
+import org.dspace.content.Community;
+import org.dspace.content.WorkspaceItem;
+import org.dspace.content.service.CollectionService;
+import org.dspace.content.service.ItemService;
+import org.dspace.services.ConfigurationService;
+import org.junit.Before;
+import org.junit.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.mock.web.MockMultipartFile;
+
+/**
+ * Test suite for testing ClarinLicenseResourceValidation.
+ *
+ * @author Milan Kuchtiak
+ *
+ */
+public class ClarinLicenseResourceValidationIT extends AbstractControllerIntegrationTest {
+
+    @Autowired
+    private CollectionService cs;
+    @Autowired
+    private ItemService itemService;
+    @Autowired
+    private ConfigurationService configurationService;
+
+    @Before
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+
+        // make file upload mandatory in submissions
+        configurationService.setProperty("webui.submit.upload.required", true);
+    }
+
+    @Test
+    public void createWorkspaceWithFiles_TitleAndClarinLicenseMissing() throws Exception {
+        context.turnOffAuthorisationSystem();
+
+        parentCommunity = CommunityBuilder.createCommunity(context)
+                .withName("Parent Community")
+                .build();
+        Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
+                .withName("Sub Community")
+                .build();
+        Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
+
+        String authToken = getAuthToken(eperson.getEmail(), password);
+
+        WorkspaceItem wItem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, col1)
+                .withIssueDate("2017-10-17")
+                .grantLicense()
+                .build();
+
+        InputStream pdf = getClass().getResourceAsStream("simple-article.pdf");
+        final MockMultipartFile pdfFile = new MockMultipartFile("file", "/local/path/simple-article.pdf",
+                "application/pdf", pdf);
+
+        context.restoreAuthSystemState();
+        // upload the file in our workspaceitem
+        getClient(authToken).perform(multipart("/api/submission/workspaceitems/" + wItem.getID())
+                        .file(pdfFile))
+                .andExpect(status().isCreated())
+                .andExpect(jsonPath("$.sections.upload.files[0].metadata['dc.title'][0].value",
+                        is("simple-article.pdf")))
+                .andExpect(jsonPath("$.sections.upload.files[0].metadata['dc.source'][0].value",
+                        is("/local/path/simple-article.pdf")));
+
+        // Verify errors for missing title and clarin license
+        getClient(authToken).perform(get("/api/submission/workspaceitems/" + wItem.getID()))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.errors", hasSize(2)))
+                .andExpect(jsonPath("$.errors[?(@.message=='error.validation.required')]",
+                        contains( hasJsonPath("$.paths",
+                                contains(hasJsonPath("$", is("/sections/traditionalpageone/dc.title")))))))
+                .andExpect(jsonPath("$.errors[?(@.message=='error.validation.clarin-license.notgranted')]",
+                        contains( hasJsonPath("$.paths",
+                                contains(hasJsonPath("$", is("/sections/clarin-license")))))));
+    }
+
+    @Test
+    public void createWorkspaceWithoutFiles_UploadRequired() throws Exception {
+        context.turnOffAuthorisationSystem();
+
+        parentCommunity = CommunityBuilder.createCommunity(context)
+                .withName("Parent Community")
+                .build();
+        Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
+                .withName("Sub Community")
+                .build();
+        Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
+
+        String authToken = getAuthToken(eperson.getEmail(), password);
+
+        WorkspaceItem witem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, col1)
+                .withTitle("Test WorkspaceItem")
+                .withIssueDate("2017-10-17")
+                .build();
+
+        context.restoreAuthSystemState();
+        // Verify error for missing files (with upload required to be set to true)
+        // Also check whether there is no error for missing license.
+        // Since there are no files, the license is not required.
+        getClient(authToken).perform(get("/api/submission/workspaceitems/" + witem.getID()))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.errors", hasSize(1)))
+                .andExpect(jsonPath("$.errors[?(@.message=='error.validation.filerequired')]",
+                        contains(hasJsonPath("$.paths", contains(hasJsonPath("$", is("/sections/upload")))))));
+    }
+
+    @Test
+    public void createWorkspaceWithoutFiles_UploadNotRequired() throws Exception {
+        context.turnOffAuthorisationSystem();
+
+        configurationService.setProperty("webui.submit.upload.required", false);
+
+        parentCommunity = CommunityBuilder.createCommunity(context)
+                .withName("Parent Community")
+                .build();
+        Community child1 = CommunityBuilder.createSubCommunity(context, parentCommunity)
+                .withName("Sub Community")
+                .build();
+        Collection col1 = CollectionBuilder.createCollection(context, child1).withName("Collection 1").build();
+
+        String authToken = getAuthToken(eperson.getEmail(), password);
+
+        WorkspaceItem witem = WorkspaceItemBuilder.createWorkspaceItemWithNoClarinLicense(context, col1)
+                .withTitle("Test WorkspaceItem")
+                .withIssueDate("2017-10-17")
+                .build();
+
+        context.restoreAuthSystemState();
+        // Verify there are no errors (with upload required to be set to false).
+        // Since there are no files, the license is not required.
+        getClient(authToken).perform(get("/api/submission/workspaceitems/" + witem.getID()))
+                .andExpect(status().isOk())
+                .andExpect(jsonPath("$.errors").doesNotExist());
+    }
+
+}
diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/SubmissionDefinitionsControllerIT.java
@@ -205,7 +205,7 @@ public void findSections() throws Exception {
                    // We expect the content type to be "application/hal+json;charset=UTF-8"
                    .andExpect(content().contentType(contentType))
                    // Match only that a section exists with a submission configuration behind
-                   .andExpect(jsonPath("$._embedded.submissionsections", hasSize(9)))
+                   .andExpect(jsonPath("$._embedded.submissionsections", hasSize(10)))
                    .andExpect(jsonPath("$._embedded.submissionsections",
                                        Matchers.hasItem(
                                            allOf(
diff --git a/dspace-server-webapp/src/test/java/org/dspace/app/rest/WorkspaceItemRestRepositoryIT.java b/dspace-server-webapp/src/test/java/org/dspace/app/rest/WorkspaceItemRestRepositoryIT.java
@@ -150,6 +150,9 @@ public void setUp() throws Exception {
         adminGroup = EPersonServiceFactory.getInstance().getGroupService().findByName(context, Group.ADMIN);
 
         context.restoreAuthSystemState();
+
+        // make file upload mandatory in submissions
+        configurationService.setProperty("webui.submit.upload.required", true);
     }
 
     @Test
diff --git a/dspace/config/clarin-dspace.cfg b/dspace/config/clarin-dspace.cfg
@@ -341,3 +341,6 @@ plugin.sequence.org.dspace.authenticate.AuthenticationMethod = org.dspace.authen
 # self-registration(new registration), for the name/password authentication, is disabled
 # but existing users can still use the name/password authentication
 user.registration = false
+
+# This option allows submitter to skip file upload step in the submission process
+webui.submit.upload.required = false

Original file line number	Diff line number	Diff line change
`@@ -150,6 +150,9 @@ public void setUp() throws Exception {`
`150`	`150`	`adminGroup = EPersonServiceFactory.getInstance().getGroupService().findByName(context, Group.ADMIN);`
`151`	`151`
`152`	`152`	`context.restoreAuthSystemState();`
	`153`	`+`
	`154`	`+ // make file upload mandatory in submissions`
	`155`	`+ configurationService.setProperty("webui.submit.upload.required", true);`
`153`	`156`	`}`
`154`	`157`
`155`	`158`	`@Test`