openapi: lazy init; relative http spec url (#808)

MykolaGolubyev · web-flow · commit d84105290ef2 · 2021-02-14T18:02:24.000-05:00
diff --git a/webtau-feature-testing/examples/listeners/ServerAutoStartListener.groovy b/webtau-feature-testing/examples/listeners/ServerAutoStartListener.groovy
@@ -0,0 +1,45 @@
+/*
+ * 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 listeners
+
+import org.testingisdocumenting.webtau.cli.CliBackgroundCommand
+import org.testingisdocumenting.webtau.reporter.TestListener
+import org.testingisdocumenting.webtau.utils.RegexpUtils
+import org.testingisdocumenting.webtau.version.WebtauVersion
+
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+class ServerAutoStartListener implements TestListener {
+    CliBackgroundCommand server
+
+    @Override
+    void beforeFirstTest() {
+        def jarName = "webtau-testapp-${WebtauVersion.version}-exec.jar"
+        server = cli.runInBackground("java -jar ../webtau-testapp/target/${jarName} --server.port=0 --spring.profiles.active=qa")
+        server.output.waitTo(contain("Tomcat started on port(s)"), 10_000)
+
+        def port = RegexpUtils.extractByRegexp(server.output.get(), /Tomcat started on port\(s\): (\d+)/)
+        cfg.baseUrl = "http://localhost:${port}"
+    }
+
+    @Override
+    void afterAllTests() {
+        if (server) {
+            server.stop()
+        }
+    }
+}
diff --git a/webtau-feature-testing/examples/scenarios/rest/openapi/openApiHttpSpec.groovy b/webtau-feature-testing/examples/scenarios/rest/openapi/openApiHttpSpec.groovy
@@ -4,6 +4,6 @@ import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
 
 scenario("open api validation") {
     http.post("/employee", [firstName: 'First']) {
-        // ...
+        statusCode.shouldBe > 0
     }
 }
diff --git a/webtau-feature-testing/examples/scenarios/rest/springboot/startAndStopAsPartOfSuite.groovy b/webtau-feature-testing/examples/scenarios/rest/springboot/startAndStopAsPartOfSuite.groovy
@@ -0,0 +1,25 @@
+/*
+ * 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.springboot
+
+import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*
+
+scenario("list customers on started server as part of listeners") {
+    http.get("/customers") {
+        body.should == []
+    }
+}
diff --git a/webtau-feature-testing/examples/scenarios/rest/springboot/webtau-auto-start.groovy b/webtau-feature-testing/examples/scenarios/rest/springboot/webtau-auto-start.groovy
@@ -0,0 +1,7 @@
+package scenarios.rest.springboot
+
+import listeners.ServerAutoStartListener
+
+testListeners = [ServerAutoStartListener]
+
+openApiSpecUrl = "/v3/api-docs"
diff --git a/webtau-feature-testing/src/test/groovy/org/testingisdocumenting/webtau/featuretesting/WebTauRestFeaturesTest.groovy b/webtau-feature-testing/src/test/groovy/org/testingisdocumenting/webtau/featuretesting/WebTauRestFeaturesTest.groovy
@@ -100,8 +100,8 @@ class WebTauRestFeaturesTest {
     @Test
     void "open api http spec"() {
         runCli('openapi/openApiHttpSpec.groovy', 'openapi/webtau.httpspec.cfg.groovy',
-                "--url=${testRunner.testServer.uri}",
-                "--openApiSpecUrl=${testRunner.testServer.uri}/v3/api-docs")
+                "--url=${customersBaseUrl}",
+                "--openApiSpecUrl=/v3/api-docs")
     }
 
     @Test
@@ -137,7 +137,10 @@ class WebTauRestFeaturesTest {
 
     @Test
     void "list contain"() {
-        http.post(customersUrl(), [firstName: 'FN1', lastName: 'LN1'])
+        OpenApi.withoutValidation {
+            http.post(customersUrl(), [firstName: 'FN1', lastName: 'LN1'])
+        }
+
         runCli('springboot/listContain.groovy', 'springboot/webtau.cfg.groovy', "--url=$customersBaseUrl")
     }
 
@@ -153,6 +156,11 @@ class WebTauRestFeaturesTest {
         runCli('springboot/listMatchByKey.groovy', 'springboot/webtau.cfg.groovy', "--url=$customersBaseUrl")
     }
 
+    @Test
+    void "start server before first test and stop after"() {
+        runCli("springboot/startAndStopAsPartOfSuite.groovy", "springboot/webtau-auto-start.groovy")
+    }
+
     @Test
     void "recursive scenario discovery"() {
         testRunner.runCli("recursive/scenarios", "urlOnly.cfg.groovy", "--url=${testRunner.testServer.uri}")
diff --git a/webtau-feature-testing/test-expectations/scenarios/rest/openapi/openApiHttpSpec/run-details.json b/webtau-feature-testing/test-expectations/scenarios/rest/openapi/openApiHttpSpec/run-details.json
@@ -3,7 +3,7 @@
     "scenario" : "open api validation",
     "shortContainerId" : "openApiHttpSpec.groovy",
     "stepsSummary" : {
-      "numberOfSuccessful" : 2
+      "numberOfSuccessful" : 3
     }
   } ],
   "exitCode" : 0
diff --git a/webtau-feature-testing/test-expectations/scenarios/rest/springboot/startAndStopAsPartOfSuite/run-details.json b/webtau-feature-testing/test-expectations/scenarios/rest/springboot/startAndStopAsPartOfSuite/run-details.json
@@ -0,0 +1,22 @@
+{
+  "scenarioDetails" : [ {
+    "scenario" : "before first test",
+    "shortContainerId" : "Setup",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 2
+    }
+  }, {
+    "scenario" : "after all tests",
+    "shortContainerId" : "Teardown",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 2
+    }
+  }, {
+    "scenario" : "list customers on started server as part of listeners",
+    "shortContainerId" : "startAndStopAsPartOfSuite.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 4
+    }
+  } ],
+  "exitCode" : 0
+}
diff --git a/webtau-graphql/src/main/java/org/testingisdocumenting/webtau/graphql/GraphQLSchemaLoader.java b/webtau-graphql/src/main/java/org/testingisdocumenting/webtau/graphql/GraphQLSchemaLoader.java
@@ -38,7 +38,6 @@
 import java.util.stream.Stream;
 
 import static org.testingisdocumenting.webtau.graphql.GraphQL.GRAPHQL_URL;
-import static org.testingisdocumenting.webtau.graphql.GraphQL.reset;
 import static org.testingisdocumenting.webtau.http.Http.http;
 
 public class GraphQLSchemaLoader {
diff --git a/webtau-open-api/pom.xml b/webtau-open-api/pom.xml
@@ -28,7 +28,7 @@
     <artifactId>webtau-open-api</artifactId>
 
     <properties>
-        <swagger.validator.version>2.11.0</swagger.validator.version>
+        <swagger.validator.version>2.15.1</swagger.validator.version>
     </properties>
 
     <dependencies>
diff --git a/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApi.java b/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApi.java
@@ -17,39 +17,68 @@
 
 package org.testingisdocumenting.webtau.openapi;
 
+import java.util.concurrent.atomic.AtomicReference;
+
 public class OpenApi {
-    private static OpenApiSpec spec;
-    private static OpenApiSpecValidator validator;
-    private static OpenApiCoverage coverage;
+    private static final ValidationMode DEFAULT_MODE = ValidationMode.ALL;
 
-    static OpenApiSpec getSpec() {
-        return spec;
-    }
+    private static final AtomicReference<OpenApiSpec> spec = new AtomicReference<>();
+    private static final AtomicReference<OpenApiSpecValidator> validator = new AtomicReference<>();
+    private static final AtomicReference<OpenApiCoverage> coverage = new AtomicReference<>();
+
+    static final ThreadLocal<ValidationMode> validationMode = ThreadLocal.withInitial(() -> DEFAULT_MODE);
 
-    static OpenApiSpecValidator getValidator() {
-        return validator;
+    synchronized static OpenApiSpecValidator getValidator() {
+        if (validator.get() == null) {
+            initialize();
+        }
+
+        return validator.get();
     }
 
-    static OpenApiCoverage getCoverage() {
-        return coverage;
+    synchronized static OpenApiCoverage getCoverage() {
+        if (coverage.get() == null) {
+            initialize();
+        }
+
+        return coverage.get();
     }
 
     public static void withoutValidation(Runnable code) {
-        OpenApiResponseValidator.withMode(ValidationMode.NONE, code);
+        withMode(ValidationMode.NONE, code);
     }
 
     public static void responseOnlyValidation(Runnable code) {
-        OpenApiResponseValidator.withMode(ValidationMode.RESPONSE_ONLY, code);
+        withMode(ValidationMode.RESPONSE_ONLY, code);
     }
 
     public static void requestOnlyValidation(Runnable code) {
-        OpenApiResponseValidator.withMode(ValidationMode.REQUEST_ONLY, code);
+        withMode(ValidationMode.REQUEST_ONLY, code);
+    }
+
+    static void withMode(ValidationMode mode, Runnable code) {
+        validationMode.set(mode);
+        try {
+            code.run();
+        } finally {
+            validationMode.set(DEFAULT_MODE);
+        }
     }
 
     static void reset() {
-        spec = new OpenApiSpec(OpenApiSpecConfig.getSpecFullPathOrUrl());
-        validator = new OpenApiSpecValidator(spec, validationConfig());
-        coverage = new OpenApiCoverage(spec);
+        spec.set(null);
+        validator.set(null);
+        coverage.set(null);
+    }
+
+    static void initialize() {
+        if (validationMode.get() == ValidationMode.NONE) {
+            return;
+        }
+
+        spec.set(new OpenApiSpec(OpenApiSpecConfig.determineSpecFullPathOrUrl()));
+        validator.set(new OpenApiSpecValidator(spec.get(), validationConfig()));
+        coverage.set(new OpenApiCoverage(spec.get()));
     }
 
     private static OpenApiValidationConfig validationConfig() {
@@ -58,5 +87,4 @@ private static OpenApiValidationConfig validationConfig() {
 
         return config;
     }
-
 }
diff --git a/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiCoverageRecorder.java b/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiCoverageRecorder.java
@@ -22,6 +22,11 @@
 public class OpenApiCoverageRecorder implements HttpValidationHandler {
     @Override
     public void validate(HttpValidationResult validationResult) {
-        OpenApi.getCoverage().recordOperation(validationResult);
+        OpenApiCoverage coverage = OpenApi.getCoverage();
+        if (coverage == null) {
+            return;
+        }
+
+        coverage.recordOperation(validationResult);
     }
 }
diff --git a/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiResponseValidator.java b/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiResponseValidator.java
@@ -26,34 +26,24 @@
 import static org.testingisdocumenting.webtau.reporter.TokenizedMessage.tokenizedMessage;
 
 public class OpenApiResponseValidator implements HttpValidationHandler {
-    private static final ValidationMode DEFAULT_MODE = ValidationMode.ALL;
-    private static final ThreadLocal<ValidationMode> validationMode = ThreadLocal.withInitial(() -> DEFAULT_MODE);
-
-    static void withMode(ValidationMode mode, Runnable code) {
-        validationMode.set(mode);
-        try {
-            code.run();
-        } finally {
-            validationMode.set(DEFAULT_MODE);
-        }
-    }
-
     @Override
     public void validate(HttpValidationResult validationResult) {
-        ValidationMode mode = OpenApiResponseValidator.validationMode.get();
+        ValidationMode mode = OpenApi.validationMode.get();
         if (mode.equals(ValidationMode.NONE)) {
             return;
         }
 
-        if (!OpenApi.getValidator().isSpecDefined()) {
+        OpenApiSpecValidator validator = OpenApi.getValidator();
+
+        if (!validator.isSpecDefined()) {
             return;
         }
 
         String modeLabel = validationModeLabel(mode);
         WebTauStep.createAndExecuteStep(
                 tokenizedMessage(action("validating"), classifier(modeLabel)),
                 () -> tokenizedMessage(action("validated"), classifier(modeLabel)),
-                () -> OpenApi.getValidator().validateApiSpec(validationResult, mode));
+                () -> validator.validateApiSpec(validationResult, mode));
     }
 
     private static String validationModeLabel(ValidationMode mode) {
diff --git a/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiSpecConfig.java b/webtau-open-api/src/main/java/org/testingisdocumenting/webtau/openapi/OpenApiSpecConfig.java
@@ -20,10 +20,14 @@
 import org.testingisdocumenting.webtau.cfg.ConfigValue;
 import org.testingisdocumenting.webtau.cfg.WebTauConfig;
 import org.testingisdocumenting.webtau.cfg.WebTauConfigHandler;
+import org.testingisdocumenting.webtau.utils.UrlUtils;
 
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.stream.Stream;
 
 import static org.testingisdocumenting.webtau.cfg.ConfigValue.declare;
+import static org.testingisdocumenting.webtau.cfg.WebTauConfig.getCfg;
 
 public class OpenApiSpecConfig implements WebTauConfigHandler {
     static final ConfigValue specUrl = declare("openApiSpecUrl",
@@ -32,15 +36,12 @@ public class OpenApiSpecConfig implements WebTauConfigHandler {
     static final ConfigValue ignoreAdditionalProperties = declare("openApiIgnoreAdditionalProperties",
             "ignore additional OpenAPI properties ", () -> false);
 
-    private static String fullPathOrUrl;
-
-    static String getSpecFullPathOrUrl() {
-        return fullPathOrUrl;
+    static String determineSpecFullPathOrUrl() {
+        return resolveFullPathOrUrl();
     }
 
     @Override
     public void onAfterCreate(WebTauConfig cfg) {
-        fullPathOrUrl = resolveFullPathOrUrl(cfg, specUrl.getAsString());
         OpenApi.reset();
     }
 
@@ -49,15 +50,25 @@ public Stream<ConfigValue> additionalConfigValues() {
         return Stream.of(specUrl, ignoreAdditionalProperties);
     }
 
-    private static String resolveFullPathOrUrl(WebTauConfig cfg, String configValue) {
+    private static String resolveFullPathOrUrl() {
+        String configValue = specUrl.getAsString();
+
         if (configValue.isEmpty()) {
             return "";
         }
 
+        if (configValue.startsWith("/")) {
+            if (Files.exists(Paths.get(configValue))) {
+                return configValue;
+            }
+
+            return UrlUtils.concat(getCfg().getBaseUrl(), configValue);
+        }
+
         if (configValue.startsWith("http:") || configValue.startsWith("https:")) {
             return configValue;
         }
 
-        return cfg.getWorkingDir().resolve(specUrl.getAsString()).toString();
+        return getCfg().getWorkingDir().resolve(specUrl.getAsString()).toString();
     }
 }
diff --git a/webtau-testapp/pom.xml b/webtau-testapp/pom.xml
diff --git a/webtau-testapp/src/main/java/com/example/demo/springboot/app/data/CustomerController.java b/webtau-testapp/src/main/java/com/example/demo/springboot/app/data/CustomerController.java
diff --git a/webtau-testapp/src/main/java/com/example/demo/springboot/app/data/CustomerRepository.java b/webtau-testapp/src/main/java/com/example/demo/springboot/app/data/CustomerRepository.java
diff --git a/webtau-testapp/src/main/resources/application-qa.properties b/webtau-testapp/src/main/resources/application-qa.properties

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@ import static org.testingisdocumenting.webtau.WebTauGroovyDsl.*`
`4`	`4`
`5`	`5`	`scenario("open api validation") {`
`6`	`6`	`http.post("/employee", [firstName: 'First']) {`
`7`		`- // ...`
	`7`	`+ statusCode.shouldBe > 0`
`8`	`8`	`}`
`9`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`"scenario" : "open api validation",`
`4`	`4`	`"shortContainerId" : "openApiHttpSpec.groovy",`
`5`	`5`	`"stepsSummary" : {`
`6`		`- "numberOfSuccessful" : 2`
	`6`	`+ "numberOfSuccessful" : 3`
`7`	`7`	`}`
`8`	`8`	`} ],`
`9`	`9`	`"exitCode" : 0`