feat(server, ui): Show dataset usage in dataset page (#204)

Author: DelaunayAlex

chutney/server-core/pom.xml

@@ -72,6 +72,11 @@
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.data</groupId>
+            <artifactId>spring-data-commons</artifactId>
+            <scope>compile</scope>
+        </dependency>
 
         <!-- Test -->
         <dependency>

chutney/server-core/src/main/java/com/chutneytesting/server/core/domain/dataset/DataSet.java

@@ -10,6 +10,7 @@
 import static java.time.temporal.ChronoUnit.MILLIS;
 import static java.util.Collections.emptyList;
 import static java.util.Collections.emptyMap;
+import static java.util.Collections.emptySet;
 import static java.util.Optional.ofNullable;
 import static java.util.stream.Collectors.toList;
 import static org.apache.commons.lang3.StringUtils.isNotBlank;
@@ -19,13 +20,14 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 import java.util.stream.Collectors;
 import org.apache.commons.lang3.StringUtils;
 
 public class DataSet {
 
     public static Comparator<DataSet> datasetComparator = Comparator.comparing(DataSet::getName, String.CASE_INSENSITIVE_ORDER);
-    public static DataSet NO_DATASET = new DataSet(null, null, null, null, null, emptyMap(), emptyList());
+    public static DataSet NO_DATASET = new DataSet(null, null, null, null, null, emptyMap(), emptyList(), emptySet(), emptyMap(), emptySet());
 
     public final String id;
     public final String name;
@@ -34,15 +36,21 @@ public class DataSet {
     public final List<String> tags;
     public final Map<String, String> constants;
     public final List<Map<String, String>> datatable;
+    public final Set<String> campaignUsage;
+    public final Map<String, Set<String>> scenarioInCampaignUsage;
+    public final Set<String> scenarioUsage;
 
-    private DataSet(String id, String name, String description, Instant creationDate, List<String> tags, Map<String, String> constants, List<Map<String, String>> datatable) {
+    private DataSet(String id, String name, String description, Instant creationDate, List<String> tags, Map<String, String> constants, List<Map<String, String>> datatable, Set<String> campaignUsage, Map<String, Set<String>> scenarioInCampaignUsage, Set<String> scenarioUsage) {
         this.id = id;
         this.name = name;
         this.description = description;
         this.creationDate = creationDate;
         this.tags = tags;
         this.constants = constants;
         this.datatable = datatable;
+        this.campaignUsage = campaignUsage;
+        this.scenarioInCampaignUsage = scenarioInCampaignUsage;
+        this.scenarioUsage = scenarioUsage;
     }
 
     private String getName() {
@@ -88,6 +96,9 @@ public static class DataSetBuilder {
         private List<String> tags;
         private Map<String, String> constants;
         private List<Map<String, String>> datatable;
+        public Set<String> campaignUsage;
+        public Set<String> scenarioUsage;
+        public Map<String, Set<String>> scenarioInCampaignUsage;
 
         private DataSetBuilder() {
         }
@@ -104,7 +115,10 @@ public DataSet build() {
                 ofNullable(creationDate).orElseGet(() -> Instant.now().truncatedTo(MILLIS)),
                 (ofNullable(tags).orElse(emptyList())).stream().map(String::toUpperCase).map(String::strip).collect(toList()),
                 cleanConstants(ofNullable(constants).orElse(emptyMap())),
-                cleanDatatable(ofNullable(datatable).orElse(emptyList()))
+                cleanDatatable(ofNullable(datatable).orElse(emptyList())),
+                ofNullable(campaignUsage).orElse(emptySet()),
+                ofNullable(scenarioInCampaignUsage).orElse(emptyMap()),
+                ofNullable(scenarioUsage).orElse(emptySet())
             );
         }
 
@@ -147,6 +161,21 @@ public DataSetBuilder withDatatable(List<Map<String, String>> datatable) {
             return this;
         }
 
+        public DataSetBuilder withScenarioUsage(Set<String> scenarioUsage) {
+            this.scenarioUsage = scenarioUsage;
+            return this;
+        }
+
+        public DataSetBuilder withCampaignUsage(Set<String> campaignUsage) {
+            this.campaignUsage = campaignUsage;
+            return this;
+        }
+
+        public DataSetBuilder withScenarioInCampaign(Map<String, Set<String>> scenarioInCampaignUsage) {
+            this.scenarioInCampaignUsage = scenarioInCampaignUsage;
+            return this;
+        }
+
         public DataSetBuilder fromDataSet(DataSet dataset) {
             return new DataSetBuilder()
                 .withId(dataset.id)
@@ -155,7 +184,10 @@ public DataSetBuilder fromDataSet(DataSet dataset) {
                 .withCreationDate(dataset.creationDate)
                 .withTags(dataset.tags)
                 .withConstants(dataset.constants)
-                .withDatatable(dataset.datatable);
+                .withDatatable(dataset.datatable)
+                .withCampaignUsage(dataset.campaignUsage)
+                .withScenarioUsage(dataset.scenarioUsage)
+                .withScenarioInCampaign(dataset.scenarioInCampaignUsage);
         }
 
         private Map<String, String> cleanConstants(Map<String, String> constants) {

chutney/server-core/src/main/java/com/chutneytesting/server/core/domain/scenario/AggregatedRepository.java

@@ -20,6 +20,8 @@ public interface AggregatedRepository<T extends TestCase> {
 
     List<TestCaseMetadata> findAll();
 
+    List<TestCaseMetadata> findAllByDatasetId(String datasetId);
+
     void removeById(String testCaseId);
 
     Optional<Integer> lastVersion(String testCaseId);

chutney/server/src/main/java/com/chutneytesting/campaign/domain/CampaignRepository.java

@@ -33,4 +33,6 @@ public interface CampaignRepository {
     List<Campaign> findCampaignsByScenarioId(String scenarioId);
 
     List<Campaign> findCampaignsByEnvironment(String environment);
+
+    List<Campaign> findCampaignsByDatasetId(String datasetId);
 }

chutney/server/src/main/java/com/chutneytesting/campaign/infra/CampaignJpaRepository.java

@@ -24,4 +24,5 @@ void saveWithExplicitId(
         String description);
 
     List<CampaignEntity> findByEnvironment(String environment);
+    List<CampaignEntity> findByDatasetId(String dataset);
 }

chutney/server/src/main/java/com/chutneytesting/campaign/infra/CampaignScenarioJpaRepository.java

@@ -15,4 +15,5 @@
 public interface CampaignScenarioJpaRepository extends CrudRepository<CampaignScenarioEntity, Long>, JpaSpecificationExecutor<CampaignScenarioEntity> {
 
     List<CampaignScenarioEntity> findAllByScenarioId(String scenarioId);
+    List<CampaignScenarioEntity> findAllByDatasetId(String datasetId);
 }

chutney/server/src/main/java/com/chutneytesting/campaign/infra/DatabaseCampaignRepository.java

@@ -136,4 +136,14 @@ public List<Campaign> findCampaignsByEnvironment(String environment) {
             .map(CampaignEntity::toDomain)
             .toList();
     }
+
+    @Override
+    public List<Campaign> findCampaignsByDatasetId(String datasetId) {
+        if (isNullOrEmpty(datasetId)) {
+            return emptyList();
+        }
+        return campaignJpaRepository.findByDatasetId(datasetId).stream()
+            .map(CampaignEntity::toDomain)
+            .toList();
+    }
 }

chutney/server/src/main/java/com/chutneytesting/dataset/api/DataSetController.java

@@ -42,8 +42,8 @@ public DataSetController(DatasetService datasetService) {
 
     @PreAuthorize("hasAuthority('DATASET_READ') or hasAuthority('SCENARIO_WRITE') or hasAuthority('CAMPAIGN_WRITE')")
     @GetMapping(path = "", produces = MediaType.APPLICATION_JSON_VALUE)
-    public List<DataSetDto> findAll() {
-        return datasetService.findAll()
+    public List<DataSetDto> findAll(@RequestParam("usage") Optional<Boolean> query) {
+        return datasetService.findAll(query.orElse(false))
             .stream()
             .map(DataSetMapper::toDto)
             .collect(Collectors.toList());

chutney/server/src/main/java/com/chutneytesting/dataset/api/DataSetDto.java

@@ -9,6 +9,7 @@
 
 import static java.time.Instant.now;
 import static java.util.Collections.emptyList;
+import static java.util.Collections.emptyMap;
 import static java.util.stream.Collectors.counting;
 import static java.util.stream.Collectors.groupingBy;
 
@@ -19,6 +20,7 @@
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
 import org.immutables.value.Value;
 
 @Value.Immutable
@@ -57,6 +59,21 @@ default List<List<KeyValue>> datatable() {
         return emptyList();
     }
 
+    @Value.Default()
+    default List<String> scenarioUsage() {
+        return emptyList();
+    }
+
+    @Value.Default()
+    default List<String> campaignUsage() {
+        return emptyList();
+    }
+
+    @Value.Default()
+    default Map<String, Set<String>> scenarioInCampaignUsage() {
+        return emptyMap();
+    }
+
     default List<String> duplicatedHeaders() {
         if(!datatable().isEmpty()) {
             List<String> headers = datatable().get(0).stream().map(KeyValue::key).toList();

chutney/server/src/main/java/com/chutneytesting/dataset/api/DataSetMapper.java

@@ -28,6 +28,9 @@ public static DataSetDto toDto(DataSet dataSet) {
         if (dataSet.tags != null) datasetBuilder.tags(dataSet.tags);
         if (dataSet.description != null) datasetBuilder.description(dataSet.description);
         if (dataSet.creationDate != null) datasetBuilder.lastUpdated(dataSet.creationDate);
+        if (dataSet.campaignUsage != null) datasetBuilder.campaignUsage(dataSet.campaignUsage);
+        if (dataSet.scenarioUsage != null) datasetBuilder.scenarioUsage(dataSet.scenarioUsage);
+        if (dataSet.scenarioInCampaignUsage != null) datasetBuilder.scenarioInCampaignUsage(dataSet.scenarioInCampaignUsage);
         return datasetBuilder.build();
     }