Add failure details when AzureEngine test validation fails.

Author: rabelenda-abstracta

jmeter-java-dsl-azure/src/main/java/us/abstracta/jmeter/javadsl/azure/AzureEngine.java

@@ -12,6 +12,7 @@
 import java.util.Locale;
 import java.util.Map;
 import java.util.concurrent.TimeoutException;
+import java.util.function.Function;
 import java.util.function.Predicate;
 import org.apache.http.entity.ContentType;
 import org.apache.jorphan.collections.HashTree;
@@ -392,31 +393,32 @@ private void awaitProvisionedResourceGroup(ResourceGroup group)
       throws IOException, InterruptedException, TimeoutException {
     awaitStatus(group, () -> apiClient.findResourceGroup(group.getName(), group.getSubscription()),
         ResourceGroup::isPendingProvisioning, ResourceGroup::isProvisioned, PROVISIONING_TIMEOUT,
-        "resource group provisioning", "Azure usage");
+        "resource group provisioning", "Azure usage", null);
   }
 
   private <T> void awaitStatus(T entity, EntityProvider<T> entityProvider,
       Predicate<T> checkIntermediateStatus, Predicate<T> checkSuccessStatus, Duration timeout,
-      String waitName, String detailsName)
+      String waitName, String detailsName, Function<T, String> failureDetailExtractor)
       throws InterruptedException, TimeoutException, IOException {
     if (checkSuccessStatus.test(entity)) {
       return;
     }
-    LOG.info("Waiting for " + waitName + "... ");
+    LOG.info("Waiting for {}... ", waitName);
     Instant start = Instant.now();
     while (!hasTimedOut(timeout, start) && checkIntermediateStatus.test(entity)) {
       Thread.sleep(STATUS_POLL_PERIOD.toMillis());
       entity = entityProvider.get();
     }
     if (checkIntermediateStatus.test(entity)) {
-      throw new TimeoutException(
-          "Timeout while waiting for " + waitName + " after " + prettyDuration(timeout)
-              + ". You may try executing again, or create an issue in jmeter-java-dsl GitHub "
-              + "repository with " + detailsName + " details.");
+      throw new TimeoutException(String.format("Timeout while waiting for %s after %s. "
+          + "You may try executing again, or create an issue in jmeter-java-dsl GitHub repository "
+          + "with %s details.", waitName, prettyDuration(timeout), detailsName));
     } else if (!checkSuccessStatus.test(entity)) {
-      throw new IllegalArgumentException(
-          firstLetterToUpper(waitName) + " failed. Create an issue in jmeter-java-dsl GitHub "
-              + "repository with " + detailsName + " details.");
+      throw new IllegalArgumentException(String.format("%s failed%s. "
+              + "Create an issue in jmeter-java-dsl GitHub repository with %s details.",
+          firstLetterToUpper(waitName),
+          failureDetailExtractor != null ? " due to: " + failureDetailExtractor.apply(entity) : "",
+          detailsName));
     }
   }
 
@@ -444,7 +446,7 @@ private void awaitProvisionedTestResource(LoadTestResource testResource)
     awaitStatus(testResource,
         () -> apiClient.findTestResource(testResource.getName(), testResource.getResourceGroup()),
         LoadTestResource::isPendingProvisioning, LoadTestResource::isProvisioned,
-        PROVISIONING_TIMEOUT, "test resource provisioning", "Azure usage");
+        PROVISIONING_TIMEOUT, "test resource provisioning", "Azure usage", null);
   }
 
   private LoadTest createLoadTest(LoadTestResource testResource) throws IOException {
@@ -498,7 +500,8 @@ private void awaitValidatedTestFile(LoadTest loadTest)
     LOG.info("Validating test script");
     EntityProvider<LoadTest> testProvider = () -> apiClient.findTestById(loadTest.getTestId());
     awaitStatus(testProvider.get(), testProvider, LoadTest::isPendingValidation,
-        LoadTest::isSuccessValidation, VALIDATION_TIMEOUT, "test script validation", "test plan");
+        LoadTest::isSuccessValidation, VALIDATION_TIMEOUT, "test script validation", "test plan",
+        LoadTest::getValidationFailureDetails);
   }
 
   private String solveTestRunName() {

jmeter-java-dsl-azure/src/main/java/us/abstracta/jmeter/javadsl/azure/AzureTestStopper.java

@@ -78,8 +78,8 @@ protected void stopTestExecution() {
       try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
         String auth = "Bearer " + getAccessToken(tenantId, clientId, clientSecret, httpClient);
         try {
-          stopTestRun(testRunUrl, auth, httpClient);
           setTestRunStopMessage(getStopMessage(), testRunUrl, testId, tenantId, auth, httpClient);
+          stopTestRun(testRunUrl, auth, httpClient);
         } catch (AzureApiException e) {
           if (e.statusCode != 400 || !"TestRunAlreadyFinished".equals(e.getErrorCode())) {
             throw e;

jmeter-java-dsl-azure/src/main/java/us/abstracta/jmeter/javadsl/azure/api/FileInfo.java

@@ -7,12 +7,15 @@ public class FileInfo {
 
   private final String fileName;
   private final String validationStatus;
+  private final String validationFailureDetails;
 
   @JsonCreator
   public FileInfo(@JsonProperty("fileName") String fileName,
-      @JsonProperty("validationStatus") String validationStatus) {
+      @JsonProperty("validationStatus") String validationStatus,
+      @JsonProperty("validationFailureDetails") String validationFailureDetails) {
     this.fileName = fileName;
     this.validationStatus = validationStatus;
+    this.validationFailureDetails = validationFailureDetails;
   }
 
   public String getFileName() {
@@ -23,4 +26,8 @@ public String getValidationStatus() {
     return validationStatus;
   }
 
+  public String getValidationFailureDetails() {
+    return validationFailureDetails;
+  }
+
 }

jmeter-java-dsl-azure/src/main/java/us/abstracta/jmeter/javadsl/azure/api/LoadTest.java

@@ -85,10 +85,6 @@ public String getUrl() {
     }
   }
 
-  public void removeTestScriptFile() {
-    inputArtifacts.testScriptFileInfo = null;
-  }
-
   @JsonIgnore
   public boolean isPendingValidation() {
     String validationStatus = getValidationStatus();
@@ -108,6 +104,10 @@ public boolean isSuccessValidation() {
     return validationStatus == null || "VALIDATION_SUCCESS".equals(validationStatus);
   }
 
+  public String getValidationFailureDetails() {
+    return inputArtifacts.testScriptFileInfo.getValidationFailureDetails();
+  }
+
   public static class LoadTestConfiguration {
 
     private int engineInstances;