From de1b3a43a157d99d9e253917afb96185ecbe8739 Mon Sep 17 00:00:00 2001 From: Nikesh kumar Date: Thu, 16 Jan 2025 14:52:28 +0530 Subject: [PATCH] fix(rest): Add license information linking for project releases. Signed-off-by: Nikesh kumar --- .../project/ProjectController.java | 54 ++++++++++++ .../project/Sw360ProjectService.java | 88 +++++++++++++++++++ .../restdocs/ProjectSpecTest.java | 17 ++++ 3 files changed, 159 insertions(+) diff --git a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java index 9050770317..9e009ff272 100644 --- a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java +++ b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/ProjectController.java @@ -113,6 +113,7 @@ import org.eclipse.sw360.rest.resourceserver.vulnerability.Sw360VulnerabilityService; import org.eclipse.sw360.rest.resourceserver.vulnerability.VulnerabilityController; import org.jetbrains.annotations.NotNull; +import org.jose4j.json.internal.json_simple.JSONObject; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.json.GsonJsonParser; import org.springframework.data.domain.Pageable; @@ -131,6 +132,7 @@ import org.springframework.security.access.prepost.PreAuthorize; import org.springframework.util.FileCopyUtils; import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; @@ -3418,4 +3420,56 @@ public ResponseEntity createDuplicateProjectWithDependencyNetwork( return ResponseEntity.created(location).body(projectDTOHalResource); } + + @Operation( + summary = "Add licenses to linked releases of a project.", + description = "This API adds license information to linked releases of a project by processing the approved CLI attachments for each release. It categorizes releases based on the number of CLI attachments (single, multiple, or none) and updates their main and other licenses accordingly.", + tags = {"Project"}, + parameters = { + @Parameter( + name = "projectId", + description = "The ID of the project whose linked releases need license updates.", + required = true, + example = "12345", + schema = @Schema(type = "string") + ) + }, + responses = { + @ApiResponse( + responseCode = "200", + description = "License information successfully added to linked releases.", + content = @Content( + mediaType = "application/hal+json", + schema = @Schema(type = "object", implementation = JSONObject.class), + examples = @ExampleObject( + value = "{\n \"one\": [\"Release1\", \"Release2\"],\n \"mul\": [\"Release3\"]\n}" + ) + ) + ), + @ApiResponse( + responseCode = "500", + description = "Error occurred while processing license information for linked releases.", + content = @Content( + mediaType = "application/json", + examples = @ExampleObject( + value = "{\n \"error\": \"Error adding license info to linked releases.\"\n}" + ) + ) + ) + } + ) + @PostMapping(value = PROJECTS_URL + "/{id}/addLinkedRelesesLicenses") + public ResponseEntity addLicenseToLinkedReleases( + @Parameter(description = "Project ID", example = "376576") + @PathVariable("id") String projectId + ) throws TTransportException, TException { + try { + User sw360User = restControllerHelper.getSw360UserFromAuthentication(); + JSONObject result = projectService.addLicenseToLinkedReleases(projectId, sw360User); + return ResponseEntity.ok(result.toString()); + } catch (Exception e) { + return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR) + .body("Error adding license info to linked releases: " + e.getMessage()); + } + } } diff --git a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/Sw360ProjectService.java b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/Sw360ProjectService.java index d5dfee3ad7..81253d9a4c 100644 --- a/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/Sw360ProjectService.java +++ b/rest/resource-server/src/main/java/org/eclipse/sw360/rest/resourceserver/project/Sw360ProjectService.java @@ -1538,4 +1538,92 @@ public List serveLinkedReleasesInDependencyNetworkByIndexPath(Strin ProjectService.Iface sw360ProjectClient = getThriftProjectClient(); return sw360ProjectClient.getReleaseLinksOfProjectNetWorkByIndexPath(projectId, indexPath, sw360User); } + + public JSONObject addLicenseToLinkedReleases(String projectId, User sw360User) throws TTransportException, TException { + ThriftClients thriftClients = new ThriftClients(); + ProjectService.Iface projectClient = getThriftProjectClient(); + LicenseInfoService.Iface licenseInfoClient = thriftClients.makeLicenseInfoClient(); + ComponentService.Iface componentClient = thriftClients.makeComponentClient(); + JSONObject jsonResult = new JSONObject(); + + try { + Project project = projectClient.getProjectById(projectId, sw360User); + if (project == null) { + throw new IllegalArgumentException("Project with ID " + projectId + " not found."); + } + + Set releaseIds = CommonUtils.getNullToEmptyKeyset(project.getReleaseIdToUsage()); + List releasesWithSingleCLI = new ArrayList<>(); + List releasesWithMultipleCLI = new ArrayList<>(); + + for (String releaseId : releaseIds) { + Release release = componentClient.getReleaseById(releaseId, sw360User); + if (release == null) { + throw new IllegalArgumentException("Release with ID " + releaseId + " not found."); + } + + List approvedCliAttachments = SW360Utils.getApprovedClxAttachmentForRelease(release); + if (approvedCliAttachments.isEmpty()) { + approvedCliAttachments = SW360Utils.getClxAttachmentForRelease(release); + } + + if (approvedCliAttachments.size() == 1) { + processSingleAttachment(approvedCliAttachments.get(0), release, licenseInfoClient, sw360User); + releasesWithSingleCLI.add(release); + } else { + if (approvedCliAttachments.size() > 1) { + releasesWithMultipleCLI.add(release); + } + jsonResult.put(SW360Constants.STATUS, SW360Constants.FAILURE); + } + + componentClient.updateRelease(release, sw360User); + } + + jsonResult.put("releasesWithSingleCLI", releasesWithSingleCLI); + jsonResult.put("releasesWithMultipleCLI", releasesWithMultipleCLI); + + } catch (Exception e) { + throw new RuntimeException("Error processing linked releases for project: " + projectId, e); + } + + return jsonResult; + } + + private void processSingleAttachment(Attachment attachment, Release release, + LicenseInfoService.Iface licenseInfoClient, User sw360User) throws TTransportException, TException { + String attachmentName = attachment.getFilename(); + Set mainLicenses = release.getMainLicenseIds() != null ? release.getMainLicenseIds() : new HashSet<>(); + Set otherLicenses = release.getOtherLicenseIds() != null ? release.getOtherLicenseIds() + : new HashSet<>(); + + List licenseInfoResults = licenseInfoClient.getLicenseInfoForAttachment(release, + attachment.getAttachmentContentId(), true, sw360User); + + if (attachmentName.endsWith(SW360Constants.RDF_FILE_EXTENSION)) { + licenseInfoResults.forEach(result -> { + if (result.getLicenseInfo() != null) { + mainLicenses.addAll(result.getLicenseInfo().getConcludedLicenseIds()); + otherLicenses.addAll(result.getLicenseInfo().getLicenseNamesWithTexts().stream() + .map(LicenseNameWithText::getLicenseName).collect(Collectors.toSet())); + } + }); + otherLicenses.removeAll(mainLicenses); + } else if (attachmentName.endsWith(SW360Constants.XML_FILE_EXTENSION)) { + licenseInfoResults.forEach(result -> { + if (result.getLicenseInfo() != null) { + result.getLicenseInfo().getLicenseNamesWithTexts().forEach(license -> { + if (SW360Constants.LICENSE_TYPE_GLOBAL.equals(license.getType())) { + mainLicenses.add(license.getLicenseName()); + } else { + otherLicenses.add(license.getLicenseName()); + } + }); + } + }); + } + + release.setMainLicenseIds(mainLicenses); + release.setOtherLicenseIds(otherLicenses); + } } diff --git a/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ProjectSpecTest.java b/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ProjectSpecTest.java index c7910f8b3a..a3ec94892b 100644 --- a/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ProjectSpecTest.java +++ b/rest/resource-server/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ProjectSpecTest.java @@ -73,6 +73,8 @@ import org.eclipse.sw360.rest.resourceserver.user.Sw360UserService; import org.eclipse.sw360.rest.resourceserver.vulnerability.Sw360VulnerabilityService; import org.hamcrest.Matchers; +import org.jose4j.json.internal.json_simple.JSONArray; +import org.jose4j.json.internal.json_simple.JSONObject; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; @@ -3200,4 +3202,19 @@ public void should_document_get_project_release_with_ecc_spreadsheet() throws Ex parameterWithName("projectId").description("Id of a project")) )); } + + @Test + public void should_add_license_to_linked_releases() throws Exception { + String projectId = "1234567"; + JSONObject jsonResult = new JSONObject(); + jsonResult.put("message", "Licenses linked successfully"); + jsonResult.put("linkedReleases", new JSONArray(List.of("345678", "987654"))); + when(projectServiceMock.addLicenseToLinkedReleases(eq(projectId), any(User.class))).thenReturn(jsonResult); + + MockHttpServletRequestBuilder requestBuilder = post("/api/projects/" + projectId + "/addLinkedRelesesLicenses") + .contentType(MediaType.APPLICATION_JSON) + .header("Authorization", TestHelper.generateAuthHeader(testUserId, testUserPassword)); + this.mockMvc.perform(requestBuilder).andExpect(status().isOk()).andDo(this.documentationHandler.document()); + } + }