Skip to content
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

feat(rest): new endpoint listing component attachments #2038

Closed
wants to merge 1 commit into from
Closed

feat(rest): new endpoint listing component attachments #2038

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
15 changes: 15 additions & 0 deletions rest/resource-server/src/docs/asciidoc/components.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,21 @@ include::{snippets}/should_document_delete_components/curl-request.adoc[]
===== Example response
include::{snippets}/should_document_delete_components/http-response.adoc[]


[[resources-listing-component-attachments]]
==== Listing component attachments

A `GET` request will list attachments of a single component.

===== Response structure
include::{snippets}/should_document_get_component_attachments/response-fields.adoc[]

===== Example request
include::{snippets}/should_document_get_component_attachments/curl-request.adoc[]

===== Example response
include::{snippets}/should_document_get_component_attachments/http-response.adoc[]

[[resources-component-usedby-list]]
==== Resources using the component

Expand Down
15 changes: 15 additions & 0 deletions ...er/src/main/java/org/eclipse/sw360/rest/resourceserver/component/ComponentController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -713,4 +713,19 @@ public ResponseEntity<RequestStatus> mergeComponents(

return new ResponseEntity<>(requestStatus, HttpStatus.OK);
}

@RequestMapping(value = COMPONENTS_URL + "/{id}/attachmentList", method = RequestMethod.GET)
public ResponseEntity<?> attachmentList(
@PathVariable("id") String id) throws TException {


User user = restControllerHelper.getSw360UserFromAuthentication();
Component sw360Component = componentService.getComponentForUserById(id, user);
Set<Attachment> attachments = null;
if(sw360Component != null && sw360Component.getAttachments() != null) {
attachments = sw360Component.getAttachments();
}

return new ResponseEntity<>(attachments, HttpStatus.OK);
}
}
47 changes: 47 additions & 0 deletions ...erver/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ComponentSpecTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,30 @@ public void before() throws TException, IOException {
List<EntityModel<Attachment>> attachmentResources = new ArrayList<>();
attachment = new Attachment("1231231254", "spring-core-4.3.4.RELEASE.jar");
attachment.setSha1("da373e491d3863477568896089ee9457bc316783");
attachment.setAttachmentType(AttachmentType.BINARY);
attachment.setCreatedBy("admin@sw360.org");
attachment.setCreatedTeam("DEPARTMENT");
attachment.setCreatedComment("Test attachment");
attachment.setCreatedOn("2023-07-11");
attachment.setCheckedBy("admin@sw360.org");
attachment.setCheckedTeam("DEPARTMENT");
attachment.setCheckedComment("test updated");
attachment.setCheckedOn("2023-07-11");
attachment.setCheckStatus(CheckStatus.REJECTED);
attachmentList.add(attachment);
attachmentResources.add(EntityModel.of(attachment));
Attachment attachment2 = new Attachment("1231231255", "spring-mvc-4.3.4.RELEASE.jar");
attachment2.setSha1("da373e491d3863477568896089ee9457bc316784");
attachment2.setAttachmentType(AttachmentType.BINARY);
attachment2.setCreatedBy("admin@sw360.org");
attachment2.setCreatedTeam("DEPARTMENT");
attachment2.setCreatedComment("Test attachment");
attachment2.setCreatedOn("2023-07-11");
attachment2.setCheckedBy("admin@sw360.org");
attachment2.setCheckedTeam("DEPARTMENT");
attachment2.setCheckedComment("test updated");
attachment2.setCheckedOn("2023-07-11");
attachment2.setCheckStatus(CheckStatus.REJECTED);
attachmentList.add(attachment2);
attachmentResources.add(EntityModel.of(attachment2));

Expand Down Expand Up @@ -607,6 +627,7 @@ public void should_document_get_components_with_all_details() throws Exception {
subsectionWithPath("_embedded.sw360:components.[]_embedded.createdBy._links").description("Self <<resources-index-links,Links>> to Component resource").optional(),
subsectionWithPath("_embedded.sw360:components.[]_embedded.sw360:attachments.[]filename").description("Attached file name").optional(),
subsectionWithPath("_embedded.sw360:components.[]_embedded.sw360:attachments.[]sha1").description("The attachment sha1 value").optional(),
subsectionWithPath("_embedded.sw360:components.[]_embedded.sw360:attachments.[]attachmentType").description("The attachment type").optional(),
subsectionWithPath("_embedded.sw360:components.[]_embedded.sw360:attachments.[]_links").description("Self <<resources-index-links,Links>> to Component resource").optional(),
subsectionWithPath("_embedded.sw360:components.[]_embedded.sw360:vendors").description("The vendors list").optional(),

Expand Down Expand Up @@ -1261,4 +1282,30 @@ public void should_document_prepare_import_sbom_for_component() throws Exception
.queryParam("type", "SPDX");
this.mockMvc.perform(builder).andExpect(status().isOk()).andDo(this.documentationHandler.document());
}

@Test
public void should_document_get_component_attachments() throws Exception {
String accessToken = TestHelper.getAccessToken(mockMvc, testUserId, testUserPassword);
mockMvc.perform(get("/api/components/17653524/attachmentList")
.contentType(MediaTypes.HAL_JSON)
.header("Authorization", "Bearer " + accessToken)
.accept(MediaTypes.HAL_JSON))
.andExpect(status().isOk())
.andDo(this.documentationHandler.document(
responseFields(
subsectionWithPath("[].filename").description("The file name of attachment"),
subsectionWithPath("[].sha1").description("The sha1 of attachment"),
subsectionWithPath("[].attachmentType").description("The type of attachment"),
subsectionWithPath("[].createdBy").description("The attachment created by"),
subsectionWithPath("[].createdTeam").description("The team who created attachment"),
subsectionWithPath("[].createdComment").description("The comments by creater of the attachment"),
subsectionWithPath("[].createdOn").description("The attachment created on"),
subsectionWithPath("[].checkedOn").description("The attachment checked on"),
subsectionWithPath("[].checkedBy").description("The attachment checked By"),
subsectionWithPath("[].checkedTeam").description("The attachment checked team"),
subsectionWithPath("[].checkedComment").description("The attachment checked comment"),
subsectionWithPath("[].checkStatus").description("The attachment check status")
)
));
}
}