http: enable groovy config for http validation handlers

Author: MykolaGolubyev

webtau-feature-testing/examples/scenarios/rest/handlers/ThrowExceptionHttpValidationHandler.groovy

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2021 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package scenarios.rest.handlers
+
+import org.testingisdocumenting.webtau.http.validation.HttpValidationHandler
+import org.testingisdocumenting.webtau.http.validation.HttpValidationResult
+
+class ThrowExceptionHttpValidationHandler implements HttpValidationHandler {
+    @Override
+    void validate(HttpValidationResult validationResult) {
+        throw new RuntimeException("custom validation: " + validationResult.getUrl())
+    }
+}

webtau-feature-testing/examples/scenarios/rest/httpValidationHandler.groovy

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2020 webtau maintainers
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package scenarios.rest
+
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+scenario('validation handler') {
+    http.get("/weather") {
+        temperature.shouldBe < 100
+    }
+}

webtau-feature-testing/examples/scenarios/rest/ping.groovy

@@ -17,7 +17,6 @@
 package scenarios.rest
 
 import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
-import static org.testingisdocumenting.webtau.http.Http.http
 
 scenario('ping') {
     if (!http.ping("/weather")) {

webtau-feature-testing/examples/scenarios/rest/webtau.validation-handler.cfg.groovy

@@ -0,0 +1,5 @@
+package scenarios.rest
+
+import scenarios.rest.handlers.ThrowExceptionHttpValidationHandler
+
+httpValidationHandlers = [ThrowExceptionHttpValidationHandler]

webtau-feature-testing/src/test/groovy/org/testingisdocumenting/webtau/featuretesting/WebTauRestFeaturesTest.groovy

@@ -73,6 +73,11 @@ class WebTauRestFeaturesTest {
         ])
     }
 
+    @Test
+    void "validation handler"() {
+        runCli('httpValidationHandler.groovy', 'webtau.validation-handler.cfg.groovy', "--url=${testRunner.testServer.uri}")
+    }
+
     @Test
     void "schema validation"() {
         runCli('jsonSchema/validateSchema.groovy', 'jsonSchema/webtau.cfg.groovy', "--url=${testRunner.testServer.uri}")

webtau-feature-testing/test-expectations/scenarios/rest/httpValidationHandler/run-details.json

@@ -0,0 +1,11 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "validation handler",
+    "shortContainerId" : "httpValidationHandler.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 2,
+      "numberOfFailed" : 1
+    }
+  } ],
+  "exitCode" : 1
+}

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cfg/WebTauGroovyFileConfigHandler.groovy

@@ -26,6 +26,8 @@ import org.testingisdocumenting.webtau.graphql.listener.GraphQLListener
 import org.testingisdocumenting.webtau.graphql.listener.GraphQLListeners
 import org.testingisdocumenting.webtau.http.listener.HttpListener
 import org.testingisdocumenting.webtau.http.listener.HttpListeners
+import org.testingisdocumenting.webtau.http.validation.HttpValidationHandler
+import org.testingisdocumenting.webtau.http.validation.HttpValidationHandlers
 import org.testingisdocumenting.webtau.report.ReportGenerator
 import org.testingisdocumenting.webtau.report.ReportGenerators
 import org.testingisdocumenting.webtau.reporter.TestListener
@@ -84,6 +86,7 @@ class WebTauGroovyFileConfigHandler implements WebTauConfigHandler {
         setupTestListeners(parsedConfig)
         setupGraphQLListeners(parsedConfig)
         setupHttpListeners(parsedConfig)
+        setupHttpValidationHandlers(parsedConfig)
         setupDbDataSourceProviders(parsedConfig)
     }
 
@@ -182,6 +185,11 @@ class WebTauGroovyFileConfigHandler implements WebTauConfigHandler {
         listenerInstances.each { HttpListeners.add(it) }
     }
 
+    private static void setupHttpValidationHandlers(ConfigObject config) {
+        List<HttpValidationHandler> handlerInstances = instancesFromConfig(config, 'httpValidationHandlers')
+        handlerInstances.each { HttpValidationHandlers.add(it) }
+    }
+
     private static void setupDbDataSourceProviders(ConfigObject config) {
         List<DbDataSourceProvider> providers = instancesFromConfig(config, 'dbDataSourceProviders')
         providers.each { DbDataSourceProviders.add(it) }

webtau-groovy/src/main/groovy/org/testingisdocumenting/webtau/cli/WebTauCliApp.groovy

@@ -31,6 +31,7 @@ import org.testingisdocumenting.webtau.console.ConsoleOutputs
 import org.testingisdocumenting.webtau.console.ansi.AnsiConsoleOutput
 import org.testingisdocumenting.webtau.console.ansi.Color
 import org.testingisdocumenting.webtau.console.ansi.NoAnsiConsoleOutput
+import org.testingisdocumenting.webtau.http.validation.HttpValidationHandlers
 import org.testingisdocumenting.webtau.report.ReportGenerator
 import org.testingisdocumenting.webtau.report.ReportGenerators
 import org.testingisdocumenting.webtau.reporter.*
@@ -150,6 +151,7 @@ class WebTauCliApp implements TestListener, ReportGenerator {
         ConsoleOutputs.remove(consoleOutput)
         TestListeners.clearAdded()
         ReportGenerators.clearAdded()
+        HttpValidationHandlers.clearAdded()
         GroovyConfigBasedHttpConfiguration.clear()
     }
 

webtau-http/src/main/java/org/testingisdocumenting/webtau/http/validation/HttpValidationHandlers.java

@@ -26,15 +26,21 @@
 
 public class HttpValidationHandlers {
     private static final List<HttpValidationHandler> globalHandlers = ServiceLoaderUtils.load(HttpValidationHandler.class);
+    private static final List<HttpValidationHandler> addedHandlers = new ArrayList<>();
+
     private static final ThreadLocal<List<HttpValidationHandler>> localHandlers = ThreadLocal.withInitial(ArrayList::new);
     private static final ThreadLocal<Boolean> enabled = ThreadLocal.withInitial(() -> true);
 
     public static void add(HttpValidationHandler handler) {
-        globalHandlers.add(handler);
+        addedHandlers.add(handler);
     }
 
     public static void remove(HttpValidationHandler handler) {
-        globalHandlers.remove(handler);
+        addedHandlers.remove(handler);
+    }
+
+    public static void clearAdded() {
+        addedHandlers.clear();
     }
 
     public static <R> R withDisabledHandlers(Supplier<R> code) {
@@ -57,8 +63,9 @@ public static <R> R withAdditionalHandler(HttpValidationHandler handler, Supplie
 
     public static void validate(HttpValidationResult validationResult) {
         if (enabled.get()) {
-            Stream.concat(localHandlers.get().stream(), globalHandlers.stream())
-                    .forEach(c -> c.validate(validationResult));
+            Stream.concat(addedHandlers.stream(),
+                    Stream.concat(localHandlers.get().stream(), globalHandlers.stream()))
+                            .forEach(c -> c.validate(validationResult));
         }
     }