- Add enableFailingTask flag for enabling exception throwing of gradl…

…e plugin task failure. (#404) - Upgrade version of plugin to 1.1.6
microsoft · Mar 30, 2023 · a60d901 · a60d901
1 parent f556f84
commit a60d901
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 7 deletions.
diff --git a/docs/images/UML/gradle_plugin_yaml_config_design.png b/docs/images/UML/gradle_plugin_yaml_config_design.png
diff --git a/gradle_plugin/build.gradle b/gradle_plugin/build.gradle
@@ -37,7 +37,7 @@ dependencies {
 }
 
 // plugin publishing related
-version = '1.1.5'
+version = '1.1.6'
 group = 'com.microsoft.hydralab'
 // alter group to this when publish to local, in order to distinguish local version and gradle plugin portal version
 //group = 'com.microsoft.hydralab.local'

diff --git a/gradle_plugin/doc/UML/gradle_plugin_yaml_config_design.puml b/gradle_plugin/doc/UML/gradle_plugin_yaml_config_design.puml
@@ -90,5 +90,6 @@ testSpec:
         inspectorType: INSPECTOR_ANDROID_BATTERY_INFO
         appId: com.microsoft.hydralab.android.client
         description: test schedule
+    enableFailingTask: true
 
 @endyaml
diff --git a/gradle_plugin/src/main/groovy/com/microsoft/hydralab/ClientUtilsPlugin.groovy b/gradle_plugin/src/main/groovy/com/microsoft/hydralab/ClientUtilsPlugin.groovy
@@ -145,6 +145,10 @@ class ClientUtilsPlugin implements Plugin<Project> {
                     // add quotes back as quotes in gradle plugins will be replaced by blanks
                     testConfig.inspectionStrategiesStr = project.inspectionStrategiesStr.replace("\\", "\"")
                 }
+                if (project.hasProperty('enableFailingTask')) {
+                    // add quotes back as quotes in gradle plugins will be replaced by blanks
+                    testConfig.enableFailingTask = Boolean.parseBoolean(project.enableFailingTask)
+                }
 
                 requiredParamCheck(apiConfig, testConfig)
 

diff --git a/gradle_plugin/src/main/groovy/com/microsoft/hydralab/config/TestConfig.java b/gradle_plugin/src/main/groovy/com/microsoft/hydralab/config/TestConfig.java
@@ -48,6 +48,7 @@ public class TestConfig {
     public int testRound = -1;
     public List<InspectionStrategy> inspectionStrategies = new ArrayList<>();
     public String inspectionStrategiesStr = "";
+    public boolean enableFailingTask = true;
 
     public void constructField(HashMap<String, Object> map) {
         Object queueTimeOutSeconds = map.get("queueTimeOutSeconds");
@@ -100,6 +101,7 @@ public String toString() {
                 "\ttestRunArgs=" + testRunArgs + "\n" +
                 "\tmaxStepCount=" + maxStepCount + "\n" +
                 "\ttestRound=" + testRound + "\n" +
-                "\tinspectionStrategiesStr=" + inspectionStrategiesStr;
+                "\tinspectionStrategiesStr=" + inspectionStrategiesStr + "\n" +
+                "\tenableFailingTask=" + enableFailingTask;
     }
 }
diff --git a/gradle_plugin/src/main/groovy/com/microsoft/hydralab/utils/HydraLabClientUtils.java b/gradle_plugin/src/main/groovy/com/microsoft/hydralab/utils/HydraLabClientUtils.java
@@ -23,8 +23,6 @@ public class HydraLabClientUtils {
     private static HydraLabAPIClient hydraLabAPIClient = new HydraLabAPIClient();
     private static final int waitStartSec = 30;
     private static final int minWaitFinishSec = 15;
-
-    private static boolean isTestRunningFailed = false;
     private static boolean isTestResultFailed = false;
 
     public static void switchClientInstance(HydraLabAPIClient client) {
@@ -336,16 +334,19 @@ private static void runTestInner(String reportFolderPath, HydraLabAPIConfig apiC
         printlnf(testReportUrl);
         printlnf("##vso[task.setvariable variable=TestTaskReportLink;]%s", testReportUrl);
 
-        displayFinalTestState();
+        displayFinalTestState(testConfig.enableFailingTask);
     }
 
     private static void markTestResultFail() {
         isTestResultFailed = true;
     }
 
-    private static void displayFinalTestState() {
+    private static void displayFinalTestState(boolean enableFailingTask) {
         if (isTestResultFailed) {
             printlnf("##[error]Final test state: fail.");
+            if (enableFailingTask) {
+                throw new RuntimeException("Test result failed, please check the output test result XML file.");
+            }
         } else {
             printlnf("Final test state: success.");
         }

diff --git a/gradle_plugin/template/gradle.properties b/gradle_plugin/template/gradle.properties
@@ -47,6 +47,8 @@ inspectionStrategiesStr =
 # Normal result folder name: $(runningType)-$(dateTime)
 # Result folder name with tag: $(runningType)-$(tag)-$(dateTime)
 tag =
+# Flag to enable failing the task by throwing exception when test failed.
+enableFailTask = # Optional, Value: {true (Default), false}
 
 # Dynamic params, should be kept secret or may change frequently.
 # Recommend to set these variables within pipeline.

diff --git a/gradle_plugin/template/testSpec.yml b/gradle_plugin/template/testSpec.yml
@@ -61,4 +61,5 @@ testSpec:
       inspection:
         inspectorType: # <Required if inspectionStrategies is enabled>
         appId: # <Required if inspectionStrategies is enabled>
-        description: # <Required if inspectionStrategies is enabled>
+        description: # <Required if inspectionStrategies is enabled>
+  enableFailingTask: # <Optional>