feat(ui) : Use the id instead of the name for scenario dataset in cam… (#117)

Author: DelaunayAlex

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

@@ -20,4 +20,8 @@ public class DataSetNotFoundException extends RuntimeException {
     public DataSetNotFoundException(String id) {
         super("Dataset [" + id + "] could not be found");
     }
+
+  public DataSetNotFoundException(String id, Throwable throwable) {
+    super("Dataset [" + id + "] could not be found", throwable);
+  }
 }

chutney/server/src/main/java/com/chutneytesting/RestExceptionHandler.java

@@ -97,7 +97,8 @@ public ResponseEntity<Object> _500(RuntimeException ex, WebRequest request) {
         ReportNotFoundException.class,
         ScenarioNotFoundException.class,
         ScenarioNotRunningException.class,
-        TargetNotFoundException.class
+        TargetNotFoundException.class,
+        DataSetNotFoundException.class
     })
     protected ResponseEntity<Object> notFound(RuntimeException ex, WebRequest request) {
         return handleExceptionInternalWithExceptionMessageAsBody(ex, HttpStatus.NOT_FOUND, request);

chutney/server/src/main/java/com/chutneytesting/campaign/api/CampaignController.java

@@ -29,6 +29,7 @@
 import com.chutneytesting.campaign.domain.CampaignExecutionRepository;
 import com.chutneytesting.campaign.domain.CampaignRepository;
 import com.chutneytesting.campaign.domain.CampaignService;
+import com.chutneytesting.dataset.domain.DatasetService;
 import com.chutneytesting.scenario.api.raw.dto.TestCaseIndexDto;
 import com.chutneytesting.scenario.infra.TestCaseRepositoryAggregator;
 import com.chutneytesting.server.core.domain.execution.history.ExecutionHistory;
@@ -39,6 +40,7 @@
 import java.util.Comparator;
 import java.util.List;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 import org.apache.commons.lang3.StringUtils;
 import org.springframework.http.MediaType;
 import org.springframework.security.access.prepost.PreAuthorize;
@@ -61,19 +63,20 @@ public class CampaignController {
 
     private final TestCaseRepositoryAggregator repositoryAggregator;
     private final CampaignRepository campaignRepository;
-
+    private final DatasetService datasetService;
     private final CampaignExecutionRepository campaignExecutionRepository;
     private final ExecutionHistoryRepository executionHistoryRepository;
     private final CampaignService campaignService;
 
     public CampaignController(TestCaseRepositoryAggregator repositoryAggregator,
                               CampaignRepository campaignRepository,
-                              CampaignExecutionRepository campaignExecutionRepository,
+                              DatasetService datasetService, CampaignExecutionRepository campaignExecutionRepository,
                               ExecutionHistoryRepository executionHistoryRepository,
                               CampaignService campaignService) {
 
         this.repositoryAggregator = repositoryAggregator;
         this.campaignRepository = campaignRepository;
+        this.datasetService = datasetService;
         this.campaignExecutionRepository = campaignExecutionRepository;
         this.executionHistoryRepository = executionHistoryRepository;
         this.campaignService = campaignService;
@@ -83,13 +86,15 @@ public CampaignController(TestCaseRepositoryAggregator repositoryAggregator,
     @PostMapping(path = "", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     public CampaignDto saveCampaign(@RequestBody CampaignDto campaign) {
         hasEnvironment(campaign);
+        validateDataset(campaign);
         return toDtoWithoutReport(campaignRepository.createOrUpdate(fromDto(campaign)));
     }
 
     @PreAuthorize("hasAuthority('CAMPAIGN_WRITE')")
     @PutMapping(path = "", consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
     public CampaignDto updateCampaign(@RequestBody CampaignDto campaign) {
         hasEnvironment(campaign);
+        validateDataset(campaign);
         return toDtoWithoutReport(campaignRepository.createOrUpdate(fromDto(campaign)));
     }
 
@@ -160,4 +165,14 @@ private void hasEnvironment(CampaignDto campaign) {
             throw new IllegalArgumentException("Environment is missing for campaign with name " + campaign.getTitle());
         }
     }
+
+    private void validateDataset(CampaignDto campaign) {
+        Stream.concat(
+            Stream.of(campaign.getDatasetId()),
+            campaign.getScenarios().stream().map(CampaignDto.CampaignScenarioDto::datasetId)
+        )
+        .filter(StringUtils::isNotBlank)
+        .distinct()
+        .forEach(datasetService::findById);
+    }
 }

chutney/server/src/main/java/com/chutneytesting/dataset/infra/FileDatasetRepository.java

@@ -25,6 +25,7 @@
 import com.chutneytesting.dataset.domain.DataSetRepository;
 import com.chutneytesting.server.core.domain.dataset.DataSet;
 import com.chutneytesting.server.core.domain.dataset.DataSetAlreadyExistException;
+import com.chutneytesting.server.core.domain.dataset.DataSetNotFoundException;
 import com.chutneytesting.tools.file.FileUtils;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -83,7 +84,7 @@ private boolean alreadyExists(DataSet dataSet) {
         try {
             DataSet byId = findById(dataSet.name);
             return !byId.equals(DataSet.NO_DATASET);
-        } catch (UncheckedIOException e) {
+        } catch (DataSetNotFoundException e) {
             return false;
         }
     }
@@ -95,12 +96,12 @@ public DataSet findById(String fileName) {
         }
 
         Path file = this.storeFolderPath.resolve(fileName + FILE_EXTENSION);
-        String content = FileUtils.readContent(file);
         try {
+            String content = FileUtils.readContent(file);
             BasicFileAttributes attr = Files.readAttributes(file, BasicFileAttributes.class);
             return fromDto(objectMapper.readValue(content, DatasetDto.class), attr.creationTime().toInstant());
-        } catch (IOException e) {
-            throw new UncheckedIOException("Cannot read " + file.toUri(), e);
+        } catch (IOException | UncheckedIOException e) {
+            throw new DataSetNotFoundException("Cannot read " + file.toUri(), e);
         }
     }
 

chutney/server/src/test/java/com/chutneytesting/campaign/api/CampaignControllerTest.java

@@ -35,9 +35,11 @@
 import com.chutneytesting.campaign.api.dto.ScenarioExecutionReportOutlineDto;
 import com.chutneytesting.campaign.domain.CampaignService;
 import com.chutneytesting.campaign.infra.FakeCampaignRepository;
+import com.chutneytesting.dataset.domain.DatasetService;
 import com.chutneytesting.scenario.api.raw.dto.ImmutableTestCaseIndexDto;
 import com.chutneytesting.scenario.api.raw.dto.TestCaseIndexDto;
 import com.chutneytesting.scenario.infra.TestCaseRepositoryAggregator;
+import com.chutneytesting.server.core.domain.dataset.DataSetNotFoundException;
 import com.chutneytesting.server.core.domain.execution.history.ExecutionHistory;
 import com.chutneytesting.server.core.domain.execution.history.ExecutionHistoryRepository;
 import com.chutneytesting.server.core.domain.execution.report.ServerReportStatus;
@@ -78,6 +80,7 @@ public class CampaignControllerTest {
     private TestCaseRepositoryAggregator repositoryAggregator;
 
     private final ExecutionHistoryRepository executionHistoryRepository = mock(ExecutionHistoryRepository.class);
+    private final DatasetService datasetService = mock(DatasetService.class);
     private MockMvc mockMvc;
     private ResultExtractor resultExtractor;
     private CampaignDto existingCampaign;
@@ -88,7 +91,7 @@ public void setUp() throws Exception {
         resultExtractor = new ResultExtractor();
 
         repositoryAggregator = mock(TestCaseRepositoryAggregator.class);
-        CampaignController campaignController = new CampaignController(repositoryAggregator, repository, repository, executionHistoryRepository, new CampaignService(repository));
+        CampaignController campaignController = new CampaignController(repositoryAggregator, repository, datasetService, repository, executionHistoryRepository, new CampaignService(repository));
         mockMvc = MockMvcBuilders.standaloneSetup(campaignController)
             .setControllerAdvice(new RestExceptionHandler(Mockito.mock(ChutneyMetrics.class)))
             .build();
@@ -380,6 +383,36 @@ public void should_retrieve_scenarios_of_a_campaign() throws Exception {
         );
     }
 
+    @Test
+    public void should_throw_exception_if_campaign_dataset_is_not_found() throws Exception {
+        // When
+        CampaignDto campaignDto = new CampaignDto(null, "test", "desc",
+            List.of(new CampaignScenarioDto("1")), emptyList(), "env", false, false, "UNKNOWN_DATASET", emptyList());
+
+        when(datasetService.findById("UNKNOWN_DATASET")).thenThrow(new DataSetNotFoundException("UNKNOWN_DATASET"));
+
+        // Then
+        execute(post(BASE_URL)
+            .content(om.writeValueAsString(campaignDto))
+            .contentType(APPLICATION_JSON_VALUE))
+            .andExpect(MockMvcResultMatchers.status().isNotFound());
+    }
+
+    @Test
+    public void should_throw_exception_if_scenario_dataset_is_not_found() throws Exception {
+        // When
+        CampaignDto campaignDto = new CampaignDto(null, "test", "desc",
+            List.of(new CampaignScenarioDto("1", "UNKNOWN_DATASET")), emptyList(), "env", false, false, null, emptyList());;
+
+        when(datasetService.findById("UNKNOWN_DATASET")).thenThrow(new DataSetNotFoundException("UNKNOWN_DATASET"));
+
+        // Then
+        execute(post(BASE_URL)
+            .content(om.writeValueAsString(campaignDto))
+            .contentType(APPLICATION_JSON_VALUE))
+            .andExpect(MockMvcResultMatchers.status().isNotFound());
+    }
+
     private void createExistingCampaign() throws Exception {
         existingCampaign = insertCampaign(SAMPLE_CAMPAIGN);
     }

chutney/server/src/test/java/com/chutneytesting/dataset/infra/FileDatasetRepositoryTest.java

@@ -22,6 +22,7 @@
 import com.chutneytesting.dataset.domain.DataSetRepository;
 import com.chutneytesting.server.core.domain.dataset.DataSet;
 import com.chutneytesting.server.core.domain.dataset.DataSetAlreadyExistException;
+import com.chutneytesting.server.core.domain.dataset.DataSetNotFoundException;
 import com.chutneytesting.tools.file.FileUtils;
 import java.io.File;
 import java.io.IOException;
@@ -55,6 +56,13 @@ void should_create_and_update_dataset() {
         assertThat(toValid.description).isEqualTo("new description");
     }
 
+    @Test
+    void should_throw_exception_when_dataset_not_found() {
+      String datasetId = "UNKNOWED_DATASET";
+      assertThatThrownBy(() -> sut.findById(datasetId))
+          .isInstanceOf(DataSetNotFoundException.class);
+    }
+
     @Test
     void should_not_save_new_dataset_already_exist() {
         DataSet dataset = DataSet.builder().withName("name").build();

chutney/ui/src/app/modules/campaign/components/create-campaign/campaign-edition.component.ts

@@ -108,7 +108,7 @@ export class CampaignEditionComponent implements OnInit, OnDestroy {
         this.loadAllScenarios();
         this.datasetService.findAll().subscribe((res: Array<Dataset>) => {
             this.datasets = res.map(dataset => {
-                return {"id": dataset.name, "text": dataset.name}
+                return {"id": dataset.id, "text": dataset.name}
             });
         });
         this.dropdownDatasetSettings = {...this.dropdownSettings, singleSelection: true}
@@ -410,7 +410,7 @@ export class CampaignEditionComponent implements OnInit, OnDestroy {
         try {
             error.json();
         } catch (exception) {
-            error.message = error.text();
+            error.message = error.error;
         }
         this.submitted = false;
         this.errorMessage = error.message;