Merge branch 'master' into releases/feature-spdx_information_management

eclipse-sw360 · May 25, 2022 · 7dee8c6 · 7dee8c6
2 parents ef94a18 + 011762a
commit 7dee8c6
Show file tree

Hide file tree

Showing 16 changed files with 105 additions and 30 deletions.
diff --git a/backend/src/src-fossology/src/main/java/org/eclipse/sw360/fossology/FossologyHandler.java b/backend/src/src-fossology/src/main/java/org/eclipse/sw360/fossology/FossologyHandler.java
@@ -125,7 +125,7 @@ public RequestStatus markFossologyProcessOutdated(String releaseId, User user) t
     }
 
     @Override
-    public ExternalToolProcess process(String releaseId, User user) throws TException {
+    public ExternalToolProcess process(String releaseId, User user, String uploadDescription) throws TException {
         ExternalToolProcess fossologyProcess;
 
         Iface componentClient = thriftClients.makeComponentClient();
@@ -159,7 +159,7 @@ public ExternalToolProcess process(String releaseId, User user) throws TExceptio
 
         ExternalToolProcessStep furthestStep = fossologyProcess.getProcessSteps().get(fossologyProcess.getProcessSteps().size() - 1); 
         if (FossologyUtils.FOSSOLOGY_STEP_NAME_UPLOAD.equals(furthestStep.getStepName())) {
-            handleUploadStep(componentClient, release, user, fossologyProcess, sourceAttachment);
+            handleUploadStep(componentClient, release, user, fossologyProcess, sourceAttachment, uploadDescription);
         } else if (FossologyUtils.FOSSOLOGY_STEP_NAME_SCAN.equals(furthestStep.getStepName())) {
             handleScanStep(componentClient, release, user, fossologyProcess);
         } else if (FossologyUtils.FOSSOLOGY_STEP_NAME_REPORT.equals(furthestStep.getStepName())) {
@@ -313,7 +313,7 @@ private ExternalToolProcessStep createFossologyProcessStep(User user, String ste
     }
 
     private void handleUploadStep(Iface componentClient, Release release, User user,
-            ExternalToolProcess fossologyProcess, Attachment sourceAttachment) throws TException {
+            ExternalToolProcess fossologyProcess, Attachment sourceAttachment, String uploadDescription) throws TException {
         ExternalToolProcessStep furthestStep = fossologyProcess.getProcessSteps()
                 .get(fossologyProcess.getProcessSteps().size() - 1);
         switch (furthestStep.getStepStatus()) {
@@ -332,7 +332,7 @@ private void handleUploadStep(Iface componentClient, Release release, User user,
             AttachmentContent attachmentContent = attachmentConnector.getAttachmentContent(attachmentContentId);
 
             InputStream attachmentStream = attachmentConnector.getAttachmentStream(attachmentContent, user, release);
-            int uploadId = fossologyRestClient.uploadFile(attachmentFilename, attachmentStream);
+            int uploadId = fossologyRestClient.uploadFile(attachmentFilename, attachmentStream, uploadDescription);
             if (uploadId > -1) {
                 furthestStep.setFinishedOn(Instant.now().toString());
                 furthestStep.setStepStatus(ExternalToolProcessStatus.DONE);

diff --git a/...src/src-fossology/src/main/java/org/eclipse/sw360/fossology/rest/FossologyRestClient.java b/...src/src-fossology/src/main/java/org/eclipse/sw360/fossology/rest/FossologyRestClient.java
@@ -13,6 +13,7 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
+import org.eclipse.sw360.datahandler.common.CommonUtils;
 import org.eclipse.sw360.fossology.config.FossologyRestConfig;
 
 import org.apache.commons.lang.StringUtils;
@@ -139,7 +140,7 @@ public boolean checkConnection() {
      * @return the uploadId provided by FOSSology in case of an successful upload,
      *         -1 otherwise
      */
-    public int uploadFile(String filename, InputStream fileStream) {
+    public int uploadFile(String filename, InputStream fileStream, String uploadDescription) {
         String baseUrl = restConfig.getBaseUrlWithSlash();
         String token = restConfig.getAccessToken();
         String folderId = restConfig.getFolderId();
@@ -160,6 +161,9 @@ public int uploadFile(String filename, InputStream fileStream) {
         headers.set("Authorization", "Bearer " + token);
         headers.set("folderId", folderId);
 
+        if (CommonUtils.isNotNullEmptyOrWhitespace(uploadDescription)) {
+            headers.set("uploadDescription", uploadDescription);
+        }
         MultiValueMap<String, Object> body = new LinkedMultiValueMap<>();
         body.add("fileInput", new FossologyInputStreamResource(filename, fileStream));
 

diff --git a/...y/src/test/java/org/eclipse/sw360/fossology/FossologyHandlerLocalhostIntegrationTest.java b/...y/src/test/java/org/eclipse/sw360/fossology/FossologyHandlerLocalhostIntegrationTest.java
@@ -181,7 +181,7 @@ public void test_01_noFossologyProcessYet_soUploadSource() throws TException, Fi
         prepareValidPreconditions(user);
 
         // when:
-        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user);
+        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user, "");
 
         // then:
         assertNotNull(actual);
@@ -207,7 +207,7 @@ public void test_02_uploadFinishedSynchronously_soStartScan()
                 || actual.getProcessSteps().get(1).getStepStatus().equals(ExternalToolProcessStatus.NEW)) {
             // give fossology some time to process the upload
             Thread.sleep(1_000l);
-            actual = uut.process(sharedRelease.getId(), user);
+            actual = uut.process(sharedRelease.getId(), user, "");
         }
 
         // then:
@@ -228,7 +228,7 @@ public void test_03_scanRunning() throws TException, FileNotFoundException, Inte
         prepareValidPreconditions(user);
 
         // when:
-        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user);
+        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user, "");
 
         // then:
         assertNotNull(actual);
@@ -252,7 +252,7 @@ public void test_04_scanRunning_soWaitOnResult() throws TException, FileNotFound
         while (actual.getProcessSteps().get(1).getStepStatus().equals(ExternalToolProcessStatus.IN_WORK)) {
             // give fossology some time to process the scan
             Thread.sleep(5_000l);
-            actual = uut.process(sharedRelease.getId(), user);
+            actual = uut.process(sharedRelease.getId(), user, "");
         }
 
         // then:
@@ -273,7 +273,7 @@ public void test_05_scanFinished_soStartReport() throws TException, FileNotFound
         prepareValidPreconditions(user);
 
         // when:
-        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user);
+        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user, "");
 
         // then:
         assertNotNull(actual);
@@ -293,7 +293,7 @@ public void test_06_reportRunning() throws TException, FileNotFoundException, In
         prepareValidPreconditions(user);
 
         // when:
-        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user);
+        ExternalToolProcess actual = uut.process(sharedRelease.getId(), user, "");
 
         // then:
         assertNotNull(actual);
@@ -326,7 +326,7 @@ public void test_07_reportRunning_soWaitOnResult() throws TException, FileNotFou
         while (actual.getProcessSteps().get(2).getStepStatus().equals(ExternalToolProcessStatus.IN_WORK)) {
             // give fossology some time to process the report generation
             Thread.sleep(1_000l);
-            actual = uut.process(sharedRelease.getId(), user);
+            actual = uut.process(sharedRelease.getId(), user, "");
         }
 
         // then:

diff --git a/.../sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/FossologyAwarePortlet.java b/.../sw360-portlet/src/main/java/org/eclipse/sw360/portal/portlets/FossologyAwarePortlet.java
@@ -233,7 +233,7 @@ protected void serveFossologyProcess(ResourceRequest request, ResourceResponse r
         JSONObject jsonObject = JSONFactoryUtil.createJSONObject();
         try {
             ExternalToolProcess fossologyProcess = fossologyClient.process(releaseId,
-                    UserCacheHolder.getUserFromRequest(request));
+                    UserCacheHolder.getUserFromRequest(request), "");
             fillJsonObjectFromFossologyProcess(jsonObject, Stream.of(fossologyProcess).collect(Collectors.toSet()));
         } catch (TException e) {
             jsonObject.put("error", "Could not determine FOSSology state for this release!");

diff --git a/...main/resources/META-INF/resources/html/components/includes/components/detailOverview.jspf b/...main/resources/META-INF/resources/html/components/includes/components/detailOverview.jspf
@@ -134,7 +134,7 @@
 <script>
     document.title = $("<span></span>").html("<sw360:out value='${component.name}'/> - " + document.title).text();
 
-    require(['jquery', 'modules/button', 'modules/listgroup', 'utils/link', 'utils/includes/clipboard'], function($, button, listgroup, linkutil, clipboard) {
+    require(['jquery', 'components/includes/releases/regexjs','modules/button', 'modules/listgroup', 'utils/link', 'utils/includes/clipboard'], function($,regexjs, button, listgroup, linkutil, clipboard) {
         listgroup.initialize('detailTab', $('#detailTab').data('initial-tab') || 'tab-Summary');
 
         $('#mergeButton').on('click', function(event) {
@@ -213,5 +213,18 @@
                 textToCopy = $(textSelector).clone().children().remove().end().text().trim();
             clipboard.copyToClipboard(textToCopy, textSelector);
         });
+
+        let keyComponent, valueComponent;
+        renderDataComponent();
+        function renderDataComponent() {
+            let content = '';
+            <core_rt:forEach items="${component.additionalData}" var="additional">
+                keyComponent = '<sw360:out value='${additional.key}'/>';
+                valueComponent = '<sw360:out value='${additional.value}'/>';
+                content+=regexjs.regex(keyComponent,valueComponent);
+            </core_rt:forEach>
+            $('#list-data-additional-contentComponent').append(content);
+        }
 	});
+
 </script>
diff --git a/...et/src/main/resources/META-INF/resources/html/components/includes/components/summary.jspf b/...et/src/main/resources/META-INF/resources/html/components/includes/components/summary.jspf
@@ -82,7 +82,7 @@
     </tr>
     <tr>
         <td><liferay-ui:message key="additional.data" />:</td>
-        <td><sw360:DisplayMap value="${component.additionalData}"/></td>
+        <td><ul id="list-data-additional-contentComponent" class="mapDisplayRootItem"></ul> </td>
     </tr>
 </table>
 

diff --git a/...c/main/resources/META-INF/resources/html/components/includes/releases/detailOverview.jspf b/...c/main/resources/META-INF/resources/html/components/includes/releases/detailOverview.jspf
@@ -210,7 +210,8 @@
 <script>
 	document.title = $("<span></span>").html("<sw360:out value='${component.name}'/> - " + document.title).text();
 
-    require(['jquery', 'components/includes/releases/linkProject', 'modules/button', 'modules/listgroup', 'utils/includes/clipboard', 'modules/dialog'], function($, linkProject, button, listgroup, clipboard, dialog) {
+
+    require(['jquery','components/includes/releases/regexjs','components/includes/releases/linkProject', 'modules/button', 'modules/listgroup', 'utils/includes/clipboard'], function($,regexjs,linkProject, button, listgroup, clipboard) {
         linkProject.initialize();
         listgroup.initialize('detailTab', $('#detailTab').data('initial-tab') || 'tab-Summary');
 
@@ -362,5 +363,17 @@
                 }
             });
         }
+
+        let keyReleases, valueReleases;
+        renderDataReleases();
+        function renderDataReleases() {
+            let content ='';
+            <core_rt:forEach items="${release.additionalData}" var="additional">
+                keyReleases = '<sw360:out value='${additional.key}'/>';
+                valueReleases = '<sw360:out value='${additional.value}'/>';
+                content+=regexjs.regex(keyReleases,valueReleases);
+            </core_rt:forEach>
+            $('#list-data-additional-release').append(content);
+        }
 	});
 </script>
diff --git a/...c/main/resources/META-INF/resources/html/components/includes/releases/summaryRelease.jspf b/...c/main/resources/META-INF/resources/html/components/includes/releases/summaryRelease.jspf
@@ -104,7 +104,7 @@
         </tr>
         <tr>
             <td><liferay-ui:message key="additional.data" />:</td>
-            <td><sw360:DisplayMap value="${release.additionalData}"/></td>
+            <td><ul id="list-data-additional-release" class="mapDisplayRootItem"></ul> </td>
         </tr>
     </table>
 

diff --git a/frontend/sw360-portlet/src/main/resources/META-INF/resources/html/moderation/view.jsp b/frontend/sw360-portlet/src/main/resources/META-INF/resources/html/moderation/view.jsp
@@ -790,7 +790,7 @@ AUI().use('liferay-portlet-url', function () {
                         projCell.data(renderLinkToProject(response[i].id, projName));
                         if (isOpenCrTable) {
                             let clearing = response[i].clearing,
-                                totalCount = d(clearing.newRelease) + d(clearing.underClearing) + d(clearing.sentToClearingTool) + d(clearing.reportAvailable) + d(clearing.approved),
+                                totalCount = d(clearing.newRelease) + d(clearing.underClearing) + d(clearing.sentToClearingTool) + d(clearing.reportAvailable) + d(clearing.approved) + d(clearing.scanAvailable),
                                 approvedCount = d(clearing.reportAvailable) + d(clearing.approved);
                             compCell.data(totalCount - approvedCount);
                             if (!totalCount || $(table.cell('#'+crId, 4).node()).find('span.sw360-tt-ClearingRequestState-NEW').text()) {

diff --git a/frontend/sw360-portlet/src/main/resources/META-INF/resources/html/projects/view.jsp b/frontend/sw360-portlet/src/main/resources/META-INF/resources/html/projects/view.jsp
@@ -523,7 +523,7 @@
                     approvedCount;
 
                 if (clearing) {
-                    releaseCount = d(clearing.newRelease) + d(clearing.underClearing) + d(clearing.sentToClearingTool) + d(clearing.reportAvailable) + d(clearing.approved);
+                    releaseCount = d(clearing.newRelease) + d(clearing.underClearing) + d(clearing.sentToClearingTool) + d(clearing.reportAvailable) + d(clearing.approved) + d(clearing.scanAvailable);
                     approvedCount = d(clearing.approved);
                     resultElementAsString = "<span class=\"clearingstate content-center\" title=\"" + approvedCount + (approvedCount === 1 ? " <liferay-ui:message key='release' />" : " <liferay-ui:message key='releases' />")
                         + " <liferay-ui:message key='out.of' /> " + releaseCount + (approvedCount === 1 ? " <liferay-ui:message key='has' />" : " <liferay-ui:message key='have' />")

diff --git a/...-portlet/src/main/resources/META-INF/resources/js/components/includes/releases/regexjs.js b/...-portlet/src/main/resources/META-INF/resources/js/components/includes/releases/regexjs.js
@@ -0,0 +1,41 @@
+/*
+ * Copyright TOSHIBA CORPORATION, 2022. Part of the SW360 Portal Project.
+ * Copyright Toshiba Software Development (Vietnam) Co., Ltd., 2022. Part of the SW360 Portal Project.
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+
+define('components/includes/releases/regexjs', ['jquery'] , function($) {
+    function regex(key,value) {
+                let regexEmail = /^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$/;
+                let regexUrl = /^(https?|chrome):\/\/[^\s$.?#].[^\s]*$/g;
+                let content = '';
+                if (value.match(regexEmail)) {
+                    content +=
+                        '<li>' +
+                        '<span class="mapDisplayChildItemLeft">'+ key +': </span>'+
+                        '<span class="mapDisplayChildItemRight"><a href="mailto:'+ value +'"> '+ value +'</a></span>'+
+                        '</li>'
+                } else if (value.match(regexUrl)) {
+                    content +=
+                        '<li>' +
+                        '<span class="mapDisplayChildItemLeft">'+ key +': </span>'+
+                        '<span class="mapDisplayChildItemRight"><a href="'+ value +'"> '+ value +'</a></span>'+
+                        '</li>'
+                } else {
+                    content +=
+                        '<li>' +
+                        '<span class="mapDisplayChildItemLeft">' + key + ': </span>' +
+                        '<span class="mapDisplayChildItemRight"> ' + value + '</span>' +
+                        '</li>'
+                }
+                return content;
+    }
+    return {
+        regex: regex,
+    };
+});
diff --git a/libraries/lib-datahandler/src/main/thrift/fossology.thrift b/libraries/lib-datahandler/src/main/thrift/fossology.thrift
@@ -43,7 +43,7 @@ service FossologyService {
      * Not only saves the reached state in the release, but also returns the 
      * ExternalToolProcess.
      **/
-    ExternalToolProcess process(1: string releaseId, 2: User user);
+    ExternalToolProcess process(1: string releaseId, 2: User user,3: string uploadDescription);
 
     /**
      * Since there should only be one actice Fossology process at most for a release

diff --git a/rest/resource-server/src/docs/asciidoc/releases.adoc b/rest/resource-server/src/docs/asciidoc/releases.adoc
@@ -239,7 +239,9 @@ have been successful.
 ==== Trigger FOSSology process
 
 A `GET` request will allow you to Trigger FOSSology process for a release. +
-Please set the request parameter `&markFossologyProcessOutdated=<true|false>` to set previous FOSSology process outdated and generate new.
+Please set the request parameter  +
+   `&markFossologyProcessOutdated=<true|false>` to set previous FOSSology process outdated and generate new. +
+   `&uploadDescription=uploadDescription` with the upload description to FOSSology +
 
 ===== Response structure
 include::{snippets}/should_document_trigger_fossology_process/response-fields.adoc[]

diff --git a/...server/src/main/java/org/eclipse/sw360/rest/resourceserver/release/ReleaseController.java b/...server/src/main/java/org/eclipse/sw360/rest/resourceserver/release/ReleaseController.java
@@ -398,6 +398,7 @@ public ResponseEntity<Map<String, Object>> checkFossologyProcessStatus(@PathVari
     @RequestMapping(value = RELEASES_URL + "/{id}/triggerFossologyProcess", method = RequestMethod.GET)
     public ResponseEntity<HalResource> triggerFossologyProcess(@PathVariable("id") String releaseId,
             @RequestParam(value = "markFossologyProcessOutdated", required = false) boolean markFossologyProcessOutdated,
+            @RequestParam(value = "uploadDescription", required = false) String uploadDescription,
             HttpServletResponse response) throws TException, IOException {
         releaseService.checkFossologyConnection();
 
@@ -412,7 +413,7 @@ public ResponseEntity<HalResource> triggerFossologyProcess(@PathVariable("id") S
             } else {
                 User user = restControllerHelper.getSw360UserFromAuthentication();
                 releaseService.executeFossologyProcess(user, attachmentService, mapOfLocks, releaseId,
-                        markFossologyProcessOutdated);
+                        markFossologyProcessOutdated, uploadDescription);
                 responseMap.put("message", "FOSSology Process for Release Id : " + releaseId + " has been triggered.");
                 status = HttpStatus.OK;
             }