feat(rest): API to get vulnerability tracking status

[keerthi-bl]

Please provide a summary of your changes here.

• Which issue is this pull request belonging to and how is it solving it?
  feat(Rest) : Rest API for Vulnerability tracking Status #2013

• Did you add or update any new dependencies that are required for your change?
  No

Suggest Reviewer

You can suggest reviewers here with an @mention.

How To Test?

How should these changes be tested by the reviewer?

End Point : http://localhost:8080/resource/api/vulnerabilities/trackingstatus/8b3aa2f81a764fb482d6391516d153db

Sample Response :

{
"_embedded": {
"sw360:releaseClearingStatusDatas": [
{
"release": {
"type": "release",
"name": "Component2",
"version": "1.0",
"componentId": "cb38c33187934c85a3c024414ff2dd2a",
"releaseDate": "",
"externalIds": {},
"additionalData": {},
"attachments": [
{
"filename": "projects-2023-03-02.xlsx",
"sha1": "349851d0913535925073ca0d34077bd5bd06c002",
"attachmentType": "SOURCE",
"createdBy": "[email protected]",
"createdTeam": "DEPARTMENT",
"createdComment": "",
"createdOn": "2023-06-15",
"checkedComment": "",
"checkStatus": "NOTCHECKED"
}
],
"createdOn": "2023-01-25",
"mainlineState": "OPEN",
"clearingState": "NEW_CLEARING",
"externalToolProcesses": [],
"createdBy": "[email protected]",
"contributors": [],
"subscribers": [],
"roles": {},
"mainLicenseIds": [],
"otherLicenseIds": [],
"vendor": {
"type": "vendor",
"url": "http://localhost:8999",
"shortName": "DV",
"fullName": "Demo Vendor"
},
"languages": [],
"operatingSystems": [
"Linux"
],
"softwarePlatforms": [],
"sourceCodeDownloadurl": "",
"binaryDownloadurl": "",
"externalToolProcessesIterator": [],
"cpeId": "",
"eccInformation": {
"eccStatus": "IN_PROGRESS"
}
},
"componentType": "SERVICE",
"projectNames": "Demo Project (11)",
"mainlineStates": "Open",
"accessible": true,
"setMainlineStates": true,
"setProjectNames": true,
"setComponentType": true,
"setRelease": true,
"setAccessible": true
}
]
},
"_links": {
"curies": [
{
"href": "http://localhost:8080/resource/docs/{rel}.html",
"name": "sw360",
"templated": true
}
]
}
}

Checklist

Must:

• All related issues are referenced in commit messages and in PR

[keerthi-bl]

As per the discussion, the response structure has been changed as follows and committed the changes.

Sample response :
[
{
"releaseid": "e397e509eb2344e28d11898fea168bb0",
"name": "Component2",
"projectorigin": "Demo Project (11)",
"svmtrackingstatus": null,
"shortstatus": null,
"type": "SERVICE"
}
]

[keerthi-bl]

Review comments addressed.

[keerthi-bl]

Review comment addressed.

[hoangnt2]

@keerthi-bl, the response body doesn't seem to be in JSON type

You can try to rewrite the controller like below

    @GetMapping(value = VULNERABILITIES_URL + "/trackingStatus" + "/{projectId}")
    public ResponseEntity<List<Map<String, String>>> getVulnerabilitiesTrackingStatus(@PathVariable("projectId") String projectId) throws TException {
        List<Map<String, String>> result = new ArrayList<>();
        try {
            User user = restControllerHelper.getSw360UserFromAuthentication();
            List<ReleaseClearingStatusData> releaseClearingStatusList = vulnerabilityService
                    .getReleasesClearingStatusWithAccessibility(user, projectId);
            releaseClearingStatusList.forEach(rel -> {
                if (rel.getRelease() != null) {
                    Map<String, String> vulnerabilityTrackingStatus = new TreeMap<>();
                    vulnerabilityTrackingStatus.put("releaseId", rel.getRelease().getId());
                    vulnerabilityTrackingStatus.put("name", rel.getRelease().getName());
                    vulnerabilityTrackingStatus.put("projectOrigin",  rel.getProjectNames());
                    vulnerabilityTrackingStatus.put("svmTrackingStatus",
                            null != rel.getRelease().getExternalIds() && !rel.getRelease().getExternalIds().isEmpty()
                                    ? rel.getRelease().getExternalIds().get("svmComponentId")
                                    : "");
                    vulnerabilityTrackingStatus.put("shortStatus",  null != rel.getRelease().getAdditionalData()
                            && !rel.getRelease().getAdditionalData().isEmpty()
                            ? rel.getRelease().getAdditionalData().get("svmShortStatus")
                            : "");
                    vulnerabilityTrackingStatus.put("type",   rel.getComponentType().toString());

                    result.add(vulnerabilityTrackingStatus);
                }
            });
            return ResponseEntity.ok(result);
        } catch (SW360Exception e) {
            throw new TException(e.why);
        } catch(Exception ex) {
            throw new TException(ex.getMessage());
        }
    }

[keerthi-bl]

Review comments addressed.

[keerthi-bl]

Review comments addressed.

[hoangnt2]

Changes look good