Skip to content

Commit

Permalink
Merge pull request #1983 from toshiba/release/fix_api_get_component
Browse files Browse the repository at this point in the history 
feat(update): update response api get single component

Reviewed by: rudra.chopra@siemens.com
Tested by:  rudra.chopra@siemens.com
  • Loading branch information
@ag4ums
ag4ums authored Jun 12, 2023
2 parents 90c59ac + 9bd7869 commit 9c8b759
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 5 deletions.
1 change: 1 addition & 0 deletions ...er/src/main/java/org/eclipse/sw360/rest/resourceserver/component/ComponentController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ public ResponseEntity<EntityModel<Component>> getComponent(
User user = restControllerHelper.getSw360UserFromAuthentication();
Component sw360Component = componentService.getComponentForUserById(id, user);
HalResource<Component> userHalResource = createHalComponent(sw360Component, user);
restControllerHelper.addEmbeddedDataToComponent(userHalResource, sw360Component);
return new ResponseEntity<>(userHalResource, HttpStatus.OK);
}

Expand Down
5 changes: 0 additions & 5 deletions ...erver/src/main/java/org/eclipse/sw360/rest/resourceserver/core/JacksonCustomizations.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -318,12 +318,8 @@ static abstract class UserMixin extends User {
"revision",
"attachments",
"createdBy",
"subscribers",
"moderators",
"releases",
"softwarePlatforms",
"wiki",
"blog",
"wikipedia",
"openHub",
"documentState",
Expand Down Expand Up @@ -391,7 +387,6 @@ static abstract class UserMixin extends User {
"additionalDataSize",
"setAdditionalData",
"setModifiedOn",
"modifiedOn",
"setModifiedBy",
"modifiedBy"
})
Expand Down
23 changes: 23 additions & 0 deletions ...server/src/main/java/org/eclipse/sw360/rest/resourceserver/core/RestControllerHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -941,4 +941,27 @@ public void addEmbeddedModerationRequest(HalResource halResource, ModerationRequ
halResource.addEmbeddedResource(isSingleRequest ? "sw360:moderationRequest" : "sw360:moderationRequests",
halModerationRequest);
}

public void addEmbeddedDataToComponent(HalResource halResource, Component sw360Component) {
addEmbeddedModifiedByToComponent(halResource,sw360Component);
addEmbeddedComponentOwnerToComponent(halResource,sw360Component);
}

public void addEmbeddedModifiedByToComponent(HalResource halResource, Component sw360Component) {
if (sw360Component.getModifiedBy() != null) {
User componentModify = getUserByEmail(sw360Component.getModifiedBy());
if (null != componentModify)
addEmbeddedUser(halResource, componentModify, "modifiedBy");
}
}

public void addEmbeddedComponentOwnerToComponent(HalResource halResource, Component sw360Component) {
if (sw360Component.getComponentOwner() != null) {
User componentOwner = getUserByEmail(sw360Component.getComponentOwner());
if (null != componentOwner) {
addEmbeddedUser(halResource, componentOwner, "componentOwner");
sw360Component.setComponentOwner(null);
}
}
}
}
33 changes: 33 additions & 0 deletions ...erver/src/test/java/org/eclipse/sw360/rest/resourceserver/restdocs/ComponentSpecTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,13 @@ public void before() throws TException, IOException {
angularComponent.setDescription("Angular is a development platform for building mobile and desktop web applications.");
angularComponent.setCreatedOn("2016-12-15");
angularComponent.setCreatedBy("admin@sw360.org");
angularComponent.setModifiedBy("admin1@sw360.org");
angularComponent.setModifiedOn("2016-12-30");
angularComponent.setSoftwarePlatforms(new HashSet<>(Arrays.asList("Linux")));
angularComponent.setMainLicenseIds(new HashSet<>(Arrays.asList("123")));
angularComponent.setSubscribers(new HashSet<>(Arrays.asList("Mari")));
angularComponent.setWiki("http://wiki.ubuntu.com/");
angularComponent.setBlog("http://www.javaworld.com/");
angularComponent.setComponentType(ComponentType.OSS);
angularComponent.setVendorNames(new HashSet<>(Collections.singletonList("Google")));
angularComponent.setModerators(new HashSet<>(Arrays.asList("admin@sw360.org", "john@sw360.org")));
Expand Down Expand Up @@ -194,6 +201,13 @@ public void before() throws TException, IOException {
springComponent.setDescription("The Spring Framework provides a comprehensive programming and configuration model for modern Java-based enterprise applications.");
springComponent.setCreatedOn("2016-12-18");
springComponent.setCreatedBy("jane@sw360.org");
springComponent.setModifiedBy("User@sw360.org");
springComponent.setModifiedOn("2016-12-25");
springComponent.setSoftwarePlatforms(new HashSet<>(Arrays.asList("Windows")));
springComponent.setMainLicenseIds(new HashSet<>(Arrays.asList("222")));
springComponent.setSubscribers(new HashSet<>(Arrays.asList("Natan")));
springComponent.setWiki("http://wiki.ubuntu.com/");
springComponent.setBlog("http://www.javaworld.com/");
springComponent.setComponentType(ComponentType.OSS);
springComponent.setVendorNames(new HashSet<>(Collections.singletonList("Pivotal")));
springComponent.setModerators(new HashSet<>(Arrays.asList("admin@sw360.org", "jane@sw360.org")));
Expand Down Expand Up @@ -502,6 +516,13 @@ public void should_document_get_components_with_all_details() throws Exception {
subsectionWithPath("_embedded.sw360:components.[]_embedded.defaultVendor").description("Default vendor of component"),
subsectionWithPath("_embedded.sw360:components.[]defaultVendorId").description("Default vendor of component"),

subsectionWithPath("_embedded.sw360:components.[]subscribers").description("The subscribers of component"),
subsectionWithPath("_embedded.sw360:components.[]mainLicenseIds").description("The Main License Ids of component"),
subsectionWithPath("_embedded.sw360:components.[]softwarePlatforms").description("The Software Platforms of component"),
subsectionWithPath("_embedded.sw360:components.[]wiki").description("The wiki of component"),
subsectionWithPath("_embedded.sw360:components.[]blog").description("The blog of component"),
subsectionWithPath("_embedded.sw360:components.[]modifiedOn").description("The date the component was modified"),

subsectionWithPath("_embedded.sw360:components.[]categories").description("The component categories"),
subsectionWithPath("_embedded.sw360:components.[]languages").description("The language of the component"),

Expand Down Expand Up @@ -665,6 +686,7 @@ public void should_document_get_component() throws Exception {
fieldWithPath("componentType").description("The component type, possible values are: " + Arrays.asList(ComponentType.values())),
fieldWithPath("description").description("The component description"),
fieldWithPath("createdOn").description("The date the component was created"),
fieldWithPath("modifiedOn").description("The date the component was modified"),
fieldWithPath("componentOwner").description("The owner name of the component"),
fieldWithPath("ownerAccountingUnit").description("The owner accounting unit of the component"),
fieldWithPath("ownerGroup").description("The owner group of the component"),
Expand All @@ -674,6 +696,11 @@ public void should_document_get_component() throws Exception {
subsectionWithPath("externalIds").description("When components are imported from other tools, the external ids can be stored here. Store as 'Single String' when single value, or 'Array of String' when multi-values"),
subsectionWithPath("additionalData").description("A place to store additional data used by external tools"),
fieldWithPath("operatingSystems").description("The OS on which the component operates"),
fieldWithPath("softwarePlatforms").description("The Software Platforms of component"),
fieldWithPath("subscribers").description("The subscribers of component"),
fieldWithPath("mainLicenseIds").description("The Main License Ids of component"),
fieldWithPath("wiki").description("The wiki of component"),
fieldWithPath("blog").description("The blog of component"),
fieldWithPath("mailinglist").description("Component mailing lists"),
fieldWithPath("homepage").description("The homepage url of the component"),
subsectionWithPath("_links").description("<<resources-index-links,Links>> to other resources"),
Expand Down Expand Up @@ -946,6 +973,12 @@ private RestDocumentationResultHandler documentComponentProperties() {
fieldWithPath("ownerCountry").description("The owner country of the component"),
subsectionWithPath("externalIds").description("When projects are imported from other tools, the external ids can be stored here. Store as 'Single String' when single value, or 'Array of String' when multi-values"),
subsectionWithPath("additionalData").description("A place to store additional data used by external tools"),
fieldWithPath("modifiedOn").description("The date the component was modified"),
fieldWithPath("softwarePlatforms").description("The Software Platforms of component"),
fieldWithPath("subscribers").description("The subscribers of component"),
fieldWithPath("mainLicenseIds").description("The Main License Ids of component"),
fieldWithPath("wiki").description("The wiki of component"),
fieldWithPath("blog").description("The blog of component"),
fieldWithPath("categories").description("The component categories"),
fieldWithPath("languages").description("The language of the component"),
fieldWithPath("mailinglist").description("Component mailing lists"),
Expand Down

0 comments on commit 9c8b759

Please sign in to comment.