Stowage/dependency-track
2
0
Fork 0
mirror of https://github.com/DependencyTrack/dependency-track.git synced 2025-10-19 16:03:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Allow projects to be configured as collections with different ProjectCollectionLogics.

Browse source 
Modifies project metrics updates to consider collection project logics.

Added several events to trigger project metrics updates to update collection projects if child projects change in a relevant way.

Signed-off-by: Ralf King <rkg@mm-software.com>
This commit is contained in:
Ralf King 2023-12-02 01:08:53 +01:00
parent 6f7c49c0f2
commit 0e73c0c814
5 changed files with 362 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

79
src/main/java/org/dependencytrack/persistence/ProjectQueryManager.java
View file

@ -37,6 +37,7 @@ import org.apache.commons.lang3.StringUtils;
import org.datanucleus.api.jdo.JDOQuery;
import org.dependencytrack.auth.Permissions;
import org.dependencytrack.event.IndexEvent;
import org.dependencytrack.event.ProjectMetricsUpdateEvent;
import org.dependencytrack.model.Analysis;
import org.dependencytrack.model.AnalysisComment;
import org.dependencytrack.model.Classifier;
@ -51,6 +52,7 @@ import org.dependencytrack.model.ProjectVersion;
import org.dependencytrack.model.ServiceComponent;
import org.dependencytrack.model.Tag;
import org.dependencytrack.model.Vulnerability;
import org.dependencytrack.model.ProjectCollectionLogic;
import org.dependencytrack.notification.NotificationConstants;
import org.dependencytrack.notification.NotificationGroup;
import org.dependencytrack.notification.NotificationScope;
@ -71,6 +73,7 @@ import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.Collections;
import java.util.concurrent.atomic.AtomicReference;
final class ProjectQueryManager extends QueryManager implements IQueryManager {
@ -516,6 +519,12 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
@Override
public Project updateProject(Project transientProject, boolean commitIndex) {
final Project project = getObjectByUuid(Project.class, transientProject.getUuid());
Project oldParent = project.getParent();
boolean scheduleProjectMetricsUpdate = this.needScheduleProjectMetricsUpdate(project, transientProject);
boolean scheduleParentMetricsUpdate = this.needScheduleParentMetricsUpdate(transientProject, scheduleProjectMetricsUpdate);
boolean scheduleOldParentMetricsUpdate = this.needScheduleOldParentMetricsUpdate(oldParent, transientProject);
project.setAuthors(transientProject.getAuthors());
project.setPublisher(transientProject.getPublisher());
project.setManufacturer(transientProject.getManufacturer());
@ -525,6 +534,7 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
project.setDescription(transientProject.getDescription());
project.setVersion(transientProject.getVersion());
project.setClassifier(transientProject.getClassifier());
project.setCollectionLogic(transientProject.getCollectionLogic());
project.setCpe(transientProject.getCpe());
project.setPurl(transientProject.getPurl());
project.setSwidTagId(transientProject.getSwidTagId());
@ -570,6 +580,17 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
final List<Tag> resolvedTags = resolveTags(transientProject.getTags());
bind(project, resolvedTags);
// Set collection tag only if selected collectionLogic requires it. Clear it otherwise.
if(transientProject.getCollectionLogic().equals(ProjectCollectionLogic.AGGREGATE_DIRECT_CHILDREN_WITH_TAG) &&
transientProject.getCollectionTag() != null) {
final List<Tag> resolvedCollectionTags = resolveTags(Collections.singletonList(
transientProject.getCollectionTag()
));
project.setCollectionTag(resolvedCollectionTags.get(0));
} else {
project.setCollectionTag(null);
}
return persist(project);
});
@ -579,9 +600,53 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
}
Event.dispatch(new IndexEvent(IndexEvent.Action.UPDATE, result));
commitSearchIndex(commitIndex, Project.class);
this.scheduleMetricsUpdates(project, oldParent, scheduleProjectMetricsUpdate, scheduleParentMetricsUpdate, scheduleOldParentMetricsUpdate);
return result;
}
/**
* if collection logic changes or collection tag changes or version changes we need to re-calculate the project's metrics in the end
*/
private boolean needScheduleProjectMetricsUpdate(Project project, Project transientProject) {
return project.getCollectionLogic() != transientProject.getCollectionLogic()
|| (transientProject.getCollectionTag() != null && !transientProject.getCollectionTag().equals(project.getCollectionTag()));
}
/**
* if parent is collection schedule an update, unless this project itself is scheduled already since that will trigger a parent update, too
*/
private boolean needScheduleParentMetricsUpdate(Project transientProject, boolean scheduleProjectMetricsUpdate) {
return !scheduleProjectMetricsUpdate
&& transientProject.getParent() != null
&& transientProject.getParent().getCollectionLogic() != ProjectCollectionLogic.NONE;
}
/**
* if project gets a new parent and old parent was collection, we need to update old parent's metrics
*/
private boolean needScheduleOldParentMetricsUpdate(Project oldParent, Project transientProject) {
return oldParent != transientProject.getParent()
&& oldParent != null
&& oldParent.getCollectionLogic() != ProjectCollectionLogic.NONE;
}
/**
* Schedules metrics updates for the project itself, the new parent and/or the old parent, as necessary.
*/
private void scheduleMetricsUpdates(Project project, Project oldParent, boolean scheduleProjectMetricsUpdate, boolean scheduleParentMetricsUpdate, boolean scheduleOldParentMetricsUpdate) {
if(scheduleProjectMetricsUpdate) {
Event.dispatch(new ProjectMetricsUpdateEvent(project.getUuid()));
}
if(scheduleParentMetricsUpdate) {
Event.dispatch(new ProjectMetricsUpdateEvent(project.getParent().getUuid()));
}
if(scheduleOldParentMetricsUpdate) {
Event.dispatch(new ProjectMetricsUpdateEvent(oldParent.getUuid()));
}
}
@Override
public Project clone(
final UUID from,
@ -625,6 +690,8 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
project.setDescription(source.getDescription());
project.setVersion(newVersion);
project.setClassifier(source.getClassifier());
project.setCollectionLogic(source.getCollectionLogic());
project.setCollectionTag(source.getCollectionTag());
project.setActive(source.isActive());
project.setIsLatest(makeCloneLatest);
project.setCpe(source.getCpe());
@ -799,6 +866,11 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
}
Event.dispatch(new IndexEvent(IndexEvent.Action.CREATE, clonedProject));
commitSearchIndex(true, Project.class);
if(clonedProject.getParent() != null && clonedProject.getParent().getCollectionLogic() != ProjectCollectionLogic.NONE) {
Event.dispatch(new ProjectMetricsUpdateEvent(clonedProject.getParent().getUuid()));
}
return clonedProject;
}
@ -833,6 +905,8 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
*/
@Override
public void recursivelyDelete(final Project project, final boolean commitIndex) {
Project parent = project.getParent();
if (project.getChildren() != null) {
for (final Project child: project.getChildren()) {
recursivelyDelete(child, false);
@ -862,6 +936,11 @@ final class ProjectQueryManager extends QueryManager implements IQueryManager {
delete(getAllBoms(project));
delete(project.getChildren());
delete(project);
// if project had a parent we need to re-calculate parents metrics to update collection projects
if(commitIndex && parent != null && parent.getCollectionLogic() != ProjectCollectionLogic.NONE) {
Event.dispatch(new ProjectMetricsUpdateEvent(parent.getUuid()));
}
}
/**