Skip to content

Add project tag filter to component identity endpoint (#6089) #6523

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

Open
anand1416 wants to merge 1 commit into
base: main
Choose a base branch
from
+36 −20
Open

Add project tag filter to component identity endpoint (#6089) #6523

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
20 changes: 15 additions & 5 deletions apiserver/src/main/java/org/dependencytrack/persistence/ComponentQueryManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import jakarta.json.JsonArray;
import jakarta.json.JsonValue;
import org.apache.commons.lang3.tuple.Pair;
import org.dependencytrack.model.Tag;
import org.dependencytrack.model.Component;
import org.dependencytrack.model.ComponentIdentity;
import org.dependencytrack.model.ComponentOccurrence;
Expand Down Expand Up @@ -325,11 +326,12 @@ public PaginatedResult getComponentByHash(String hash) {
* @return a list of components
*/
public PaginatedResult getComponents(
ComponentIdentity identity,
Project project,
boolean includeMetrics,
boolean excludeInactiveProjects,
boolean onlyLatestProjectVersions) {
ComponentIdentity identity,
Project project,
boolean includeMetrics,
boolean excludeInactiveProjects,
boolean onlyLatestProjectVersions,
String projectTag) {
if (identity == null) {
return null;
}
Expand All @@ -347,6 +349,14 @@ public PaginatedResult getComponents(
if (onlyLatestProjectVersions) {
queryFilterElements.add(" project.isLatest == true ");
}
if (projectTag != null && !projectTag.isBlank()) {
final Tag tag = getTagByName(projectTag.trim());

if (tag != null) {
queryFilterElements.add(" project.tags.contains(:tag) ");
queryParams.put("tag", tag);
}
}

final PaginatedResult result;
if (identity.getGroup() != null || identity.getName() != null || identity.getVersion() != null) {
Expand Down
20 changes: 11 additions & 9 deletions apiserver/src/main/java/org/dependencytrack/persistence/QueryManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,16 +486,18 @@ public PaginatedResult getComponentByHash(String hash) {

public PaginatedResult getComponents(
ComponentIdentity identity,
Project project,
boolean includeMetrics,
boolean excludeInactiveProjects,
boolean onlyLatestProjectVersions) {
Project project,
boolean includeMetrics,
boolean excludeInactiveProjects,
boolean onlyLatestProjectVersions,
String projectTag) {
return getComponentQueryManager().getComponents(
identity,
project,
includeMetrics,
excludeInactiveProjects,
onlyLatestProjectVersions);
identity,
project,
includeMetrics,
excludeInactiveProjects,
onlyLatestProjectVersions,
projectTag);
}

public Component createComponent(Component component, boolean commitIndex) {
Expand Down
16 changes: 10 additions & 6 deletions apiserver/src/main/java/org/dependencytrack/resources/v1/ComponentResource.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,10 @@ public Response getComponentByIdentity(@Parameter(description = "The group of th
@Parameter(description = "When true, only return components from active projects")
@QueryParam("excludeInactiveProjects") boolean excludeInactiveProjects,
@Parameter(description = "When true, only return components from projects flagged as the latest version")
@QueryParam("onlyLatestProjectVersions") boolean onlyLatestProjectVersions) {
@QueryParam("onlyLatestProjectVersions") boolean onlyLatestProjectVersions,
@Parameter(description = "Only return components belonging to projects with the specified tag")
@QueryParam("projectTag")
String projectTag) {
try (QueryManager qm = new QueryManager(getAlpineRequest())) {
Project project = null;
if (projectUuid != null) {
Expand All @@ -254,11 +257,12 @@ public Response getComponentByIdentity(@Parameter(description = "The group of th
return Response.ok().header(TOTAL_COUNT_HEADER, 0).build();
} else {
final PaginatedResult result = qm.getComponents(
identity,
project,
/* includeMetrics */ true,
excludeInactiveProjects,
onlyLatestProjectVersions);
identity,
project,
/* includeMetrics */ true,
excludeInactiveProjects,
onlyLatestProjectVersions,
projectTag);
return Response.ok(result.getObjects()).header(TOTAL_COUNT_HEADER, result.getTotal()).build();
}
}
Expand Down