deploy: 4570f70

Author: MykolaGolubyev

GraphQL/getting-started/index.html

@@ -85,12 +85,12 @@
 </div><section style="max-width: 640px; margin-left: auto; margin-right: auto;">
 <article>
 <header><h1>Minimal Groovy Setup</h1></header>
-<p>Download and unzip https://repo.maven.apache.org/maven2/org/testingisdocumenting/webtau/webtau-dist/1.33/webtau-dist-1.33-webtau.zip webtau. Add it to your PATH . Generate webtau examples webtau --example Navigate into graphql example cd examples/graphql import static org.testingisdocumenting.webtau.WebTauGroovyDsl.* scenario('fetch types from schema') { def query = '{ __schema { types { name } } }' graphql.execute(query) { __schema.types.numberOfElements().shouldBe &gt; 0 } } To run test webtau introspection.groovy --url=http://localhost:8080 Note: using import is optional and is mainly for IDE auto completion. Imports are added implicitly during command line run. Url parameter can be moved to a webtau.cfg.groovy file. Please note that WebTau will automatically append /graphql to the url.You may also wish to add a graphQLEnabled = true property which will result in WebTau recording coverage and timing information per query for your tests. url = &quot;http://localhost:8080/&quot; graphQLEnabled = true configuration/environments Specify multiple environments to streamline test execution.</p>
+<p>Download and unzip https://repo.maven.apache.org/maven2/org/testingisdocumenting/webtau/webtau-dist/1.33/webtau-dist-1.33-webtau.zip webtau. Add it to your PATH . Generate webtau examples webtau --example Navigate into graphql example cd examples/graphql import static org.testingisdocumenting.webtau.WebTauGroovyDsl.* scenario('fetch types from schema') { def query = '{ __schema { types { name } } }' graphql.execute(query) { __schema.types.numberOfElements().shouldBe &gt; 0 } } To run test webtau introspection.groovy --url=http://localhost:8080 Note: using import is optional and is mainly for IDE auto completion. Imports are added implicitly during command line run. Url parameter can be moved to a webtau.cfg.groovy file. Please note that WebTau will automatically append /graphql to the url.Webtau will attempt to send an introspection query in order to obtain information about the GraphQL schema. If this fails, it will not be able to record coverage information for GraphQL. Should you wish to fail the test if introspection fails, please set the graphQLIgnoreIntrospectionFailures property to false . url = &quot;http://localhost:8080/&quot; graphQLIgnoreIntrospectionFailures = false configuration/environments Specify multiple environments to streamline test execution.</p>
 </article>
 
 <article>
 <header><h1>Minimal JUnit Setup</h1></header>
-<p>Groovy &lt;dependency&gt; &lt;groupId&gt;org.testingisdocumenting.webtau&lt;/groupId&gt; &lt;artifactId&gt;webtau-groovy&lt;/artifactId&gt; &lt;version&gt;1.33&lt;/version&gt; &lt;/dependency&gt; Java &lt;dependency&gt; &lt;groupId&gt;org.testingisdocumenting.webtau&lt;/groupId&gt; &lt;artifactId&gt;webtau&lt;/artifactId&gt; &lt;version&gt;1.33&lt;/version&gt; &lt;/dependency&gt; Groovy package com.example.tests.junit4 import org.testingisdocumenting.webtau.junit4.WebTauRunner import org.junit.Test import org.junit.runner.RunWith import static org.testingisdocumenting.webtau.WebTauGroovyDsl.* @RunWith(WebTauRunner.class) class WeatherGroovyIT { @Test void checkWeather() { http.get(&quot;/weather&quot;) { temperature.shouldBe &lt; 100 } } } Java package com.example.tests.junit4; import org.testingisdocumenting.webtau.junit4.WebTauRunner; import org.junit.Test; import org.junit.runner.RunWith; import static org.testingisdocumenting.webtau.WebTauDsl.*; @RunWith(WebTauRunner.class) public class WeatherJavaIT { @Test public void checkWeather() { http.get(&quot;/weather&quot;, (header, body) -&gt; { body.get(&quot;temperature&quot;).shouldBe(lessThan(100)); }); } } Add webtau.properties to test class path url = http://localhost graphQLEnabled = true</p>
+<p>Groovy &lt;dependency&gt; &lt;groupId&gt;org.testingisdocumenting.webtau&lt;/groupId&gt; &lt;artifactId&gt;webtau-groovy&lt;/artifactId&gt; &lt;version&gt;1.33&lt;/version&gt; &lt;/dependency&gt; Java &lt;dependency&gt; &lt;groupId&gt;org.testingisdocumenting.webtau&lt;/groupId&gt; &lt;artifactId&gt;webtau&lt;/artifactId&gt; &lt;version&gt;1.33&lt;/version&gt; &lt;/dependency&gt; Groovy package com.example.tests.junit4 import org.junit.Test import org.junit.runner.RunWith import org.testingisdocumenting.webtau.junit4.WebTauRunner import static org.testingisdocumenting.webtau.WebTauDsl.graphql @RunWith(WebTauRunner.class) class GraphQLWeatherGroovyIT { @Test void checkWeather() { def query = &quot;{ weather { temperature } }&quot;; graphql.execute(query) { weather.temperature.shouldBe &lt; 100 } } } Java package com.example.tests.junit4; import org.junit.Test; import org.junit.runner.RunWith; import org.testingisdocumenting.webtau.junit4.WebTauRunner; import static org.testingisdocumenting.webtau.Matchers.lessThan; import static org.testingisdocumenting.webtau.WebTauDsl.graphql; @RunWith(WebTauRunner.class) public class GraphQLWeatherJavaIT { @Test public void checkWeather() { String query = &quot;{ weather { temperature } }&quot;; graphql.execute(query, (header, body) -&gt; { body.get(&quot;data.weather.temperature&quot;).shouldBe(lessThan(100)); }); } } Add webtau.properties to test class path url = http://localhost graphQLIgnoreIntrospectionFailures = false</p>
 </article>
 
 <article>
@@ -240,23 +240,34 @@
       }, {
         "type" : "Paragraph",
         "content" : [ {
-          "text" : "You may also wish to add a ",
+          "text" : "Webtau will attempt to send an introspection query in order to obtain information about the GraphQL schema.  If this fails, it",
           "type" : "SimpleText"
         }, {
-          "code" : "graphQLEnabled = true",
-          "type" : "InlinedCode"
+          "type" : "SoftLineBreak"
         }, {
-          "text" : " property which will result in WebTau recording coverage and timing information",
+          "text" : "will not be able to record coverage information for GraphQL.  Should you wish to fail the test if introspection fails, please",
           "type" : "SimpleText"
         }, {
           "type" : "SoftLineBreak"
         }, {
-          "text" : "per query for your tests.",
+          "text" : "set the ",
+          "type" : "SimpleText"
+        }, {
+          "code" : "graphQLIgnoreIntrospectionFailures",
+          "type" : "InlinedCode"
+        }, {
+          "text" : " property to ",
+          "type" : "SimpleText"
+        }, {
+          "code" : "false",
+          "type" : "InlinedCode"
+        }, {
+          "text" : ".",
           "type" : "SimpleText"
         } ]
       }, {
         "lang" : "groovy",
-        "snippet" : "url = \"http://localhost:8080/\"\ngraphQLEnabled = true",
+        "snippet" : "url = \"http://localhost:8080/\"\ngraphQLIgnoreIntrospectionFailures = false",
         "title" : "webtau.cfg.groovy",
         "type" : "Snippet"
       }, {
@@ -302,15 +313,15 @@
           "name" : "Groovy",
           "content" : [ {
             "lang" : "groovy",
-            "snippet" : "package com.example.tests.junit4\n\nimport org.testingisdocumenting.webtau.junit4.WebTauRunner\nimport org.junit.Test\nimport org.junit.runner.RunWith\n\nimport static org.testingisdocumenting.webtau.WebTauGroovyDsl.*\n\n@RunWith(WebTauRunner.class)\nclass WeatherGroovyIT {\n    @Test\n    void checkWeather() {\n        http.get(\"/weather\") {\n            temperature.shouldBe < 100\n        }\n    }\n}",
+            "snippet" : "package com.example.tests.junit4\n\nimport org.junit.Test\nimport org.junit.runner.RunWith\nimport org.testingisdocumenting.webtau.junit4.WebTauRunner\n\nimport static org.testingisdocumenting.webtau.WebTauDsl.graphql\n\n@RunWith(WebTauRunner.class)\nclass GraphQLWeatherGroovyIT {\n    @Test\n    void checkWeather() {\n        def query = \"{ weather { temperature } }\";\n        graphql.execute(query) {\n            weather.temperature.shouldBe < 100\n        }\n    }\n}",
             "title" : "JUnit 4 example",
             "type" : "Snippet"
           } ]
         }, {
           "name" : "Java",
           "content" : [ {
             "lang" : "java",
-            "snippet" : "package com.example.tests.junit4;\n\nimport org.testingisdocumenting.webtau.junit4.WebTauRunner;\nimport org.junit.Test;\nimport org.junit.runner.RunWith;\n\nimport static org.testingisdocumenting.webtau.WebTauDsl.*;\n\n@RunWith(WebTauRunner.class)\npublic class WeatherJavaIT {\n    @Test\n    public void checkWeather() {\n        http.get(\"/weather\", (header, body) -> {\n            body.get(\"temperature\").shouldBe(lessThan(100));\n        });\n    }\n}",
+            "snippet" : "package com.example.tests.junit4;\n\nimport org.junit.Test;\nimport org.junit.runner.RunWith;\nimport org.testingisdocumenting.webtau.junit4.WebTauRunner;\n\nimport static org.testingisdocumenting.webtau.Matchers.lessThan;\nimport static org.testingisdocumenting.webtau.WebTauDsl.graphql;\n\n@RunWith(WebTauRunner.class)\npublic class GraphQLWeatherJavaIT {\n    @Test\n    public void checkWeather() {\n        String query = \"{ weather { temperature } }\";\n        graphql.execute(query, (header, body) -> {\n            body.get(\"data.weather.temperature\").shouldBe(lessThan(100));\n        });\n    }\n}",
             "title" : "JUnit 4 example",
             "type" : "Snippet"
           } ]
@@ -335,7 +346,7 @@
         } ]
       }, {
         "lang" : "properties",
-        "snippet" : "url = http://localhost\ngraphQLEnabled = true",
+        "snippet" : "url = http://localhost\ngraphQLIgnoreIntrospectionFailures = false",
         "title" : "webtau.properties",
         "type" : "Snippet"
       } ]
@@ -406,7 +417,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1604459318229,
+    "lastModifiedTime" : 1604812521923,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Getting Started",

GraphQL/queries-and-mutations/index.html

@@ -274,7 +274,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1604459318229,
+    "lastModifiedTime" : 1604812521923,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Queries And Mutations",

GraphQL/report/index.html

@@ -85,7 +85,7 @@
 </div><section style="max-width: 640px; margin-left: auto; margin-right: auto;">
 <article>
 <header><h1>Additional Reports</h1></header>
-<p>To generate custom reports or upload report data to your server, specify a reportGenerator config property. package scenarios.graphql url = &quot;http://localhost:8180&quot; graphQLEnabled = true reportGenerator = Report.&amp;generateReport Where Report.&amp;generateReport is implemented as follows: package scenarios.graphql import org.testingisdocumenting.webtau.console.ConsoleOutputs import org.testingisdocumenting.webtau.console.ansi.Color import org.testingisdocumenting.webtau.report.ReportDataProviders import org.testingisdocumenting.webtau.reporter.WebTauReport import org.testingisdocumenting.webtau.utils.JsonUtils import static org.testingisdocumenting.webtau.WebTauDsl.cfg class Report { static void generateReport(WebTauReport report) { def additionalData = [:] ReportDataProviders.provide(report.tests) .map { it.toMap() } .forEach { additionalData.putAll(it) } def reportData = [:] reportData.graphQLSkippedQueries = additionalData.graphQLSkippedQueries // All queries present in the GraphQL schema but not tested reportData.graphQLCoveredQueries = additionalData.graphQLCoveredQueries // All queries present in the GraphQL schema and tested reportData.graphQLCoverageSummary = additionalData.graphQLCoverageSummary // Summary of test coverage compared to the GraphQL schema reportData.graphQLQueryTimeStatistics = additionalData.graphQLQueryTimeStatistics // Summary of timing by query def reportPath = cfg.workingDir.resolve('webtau.graphql-report.json') ConsoleOutputs.out('generating report: ', Color.PURPLE, reportPath) reportPath.toFile().text = JsonUtils.serializePrettyPrint(reportData) } } The output looks as follows: { &quot;graphQLSkippedQueries&quot; : [ { &quot;name&quot; : &quot;taskById&quot;, &quot;type&quot; : &quot;query&quot; }, { &quot;name&quot; : &quot;uncomplete&quot;, &quot;type&quot; : &quot;mutation&quot; }, { &quot;name&quot; : &quot;allTasks&quot;, &quot;type&quot; : &quot;query&quot; }, { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&quot; } ], &quot;graphQLCoveredQueries&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLCoverageSummary&quot; : { &quot;coverage&quot; : 0.2, &quot;types&quot; : { &quot;mutation&quot; : { &quot;coverage&quot; : 0.0, &quot;declaredQueries&quot; : 2, &quot;coveredQueries&quot; : 0.0 }, &quot;query&quot; : { &quot;coverage&quot; : 0.3333333333333333, &quot;declaredQueries&quot; : 3, &quot;coveredQueries&quot; : 1.0 } }, &quot;totalDeclaredQueries&quot; : 5.0, &quot;totalCoveredQueries&quot; : 1.0 }, &quot;graphQLQueryTimeStatistics&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot;, &quot;statistics&quot; : { &quot;mean&quot; : 5.0, &quot;min&quot; : 5, &quot;max&quot; : 5, &quot;count&quot; : 1, &quot;p95&quot; : 5.0, &quot;p99&quot; : 5.0 } } ] } WebTau will implicitly invoke your GraphQL server's introspection queries in order to fetch a subset of the schema. It uses this schema in conjunction with the requests in tests to compute:query coverage - which queries were invoked by tests and which were not as well as an overall summary of coveragetiming information - http call timing statistics by query</p>
+<p>To generate custom reports or upload report data to your server, specify a reportGenerator config property. package scenarios.graphql url = &quot;http://localhost:8180&quot; graphQLIgnoreIntrospectionFailures = false reportGenerator = Report.&amp;generateReport Where Report.&amp;generateReport is implemented as follows: package scenarios.graphql import org.testingisdocumenting.webtau.console.ConsoleOutputs import org.testingisdocumenting.webtau.console.ansi.Color import org.testingisdocumenting.webtau.report.ReportDataProviders import org.testingisdocumenting.webtau.reporter.WebTauReport import org.testingisdocumenting.webtau.utils.JsonUtils import static org.testingisdocumenting.webtau.WebTauDsl.cfg class Report { static void generateReport(WebTauReport report) { def additionalData = [:] ReportDataProviders.provide(report.tests) .map { it.toMap() } .forEach { additionalData.putAll(it) } def reportData = [:] reportData.graphQLSkippedQueries = additionalData.graphQLSkippedQueries // All queries present in the GraphQL schema but not tested reportData.graphQLCoveredQueries = additionalData.graphQLCoveredQueries // All queries present in the GraphQL schema and tested reportData.graphQLCoverageSummary = additionalData.graphQLCoverageSummary // Summary of test coverage compared to the GraphQL schema reportData.graphQLQueryTimeStatistics = additionalData.graphQLQueryTimeStatistics // Summary of timing by query def reportPath = cfg.workingDir.resolve('webtau.graphql-report.json') ConsoleOutputs.out('generating report: ', Color.PURPLE, reportPath) reportPath.toFile().text = JsonUtils.serializePrettyPrint(reportData) } } The output looks as follows: { &quot;graphQLSkippedQueries&quot; : [ { &quot;name&quot; : &quot;allTasks&quot;, &quot;type&quot; : &quot;query&quot; }, { &quot;name&quot; : &quot;taskById&quot;, &quot;type&quot; : &quot;query&quot; }, { &quot;name&quot; : &quot;uncomplete&quot;, &quot;type&quot; : &quot;mutation&quot; }, { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&quot; } ], &quot;graphQLCoveredQueries&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLCoverageSummary&quot; : { &quot;coverage&quot; : 0.2, &quot;types&quot; : { &quot;mutation&quot; : { &quot;coverage&quot; : 0.0, &quot;declaredQueries&quot; : 2, &quot;coveredQueries&quot; : 0.0 }, &quot;query&quot; : { &quot;coverage&quot; : 0.3333333333333333, &quot;declaredQueries&quot; : 3, &quot;coveredQueries&quot; : 1.0 } }, &quot;totalDeclaredQueries&quot; : 5.0, &quot;totalCoveredQueries&quot; : 1.0 }, &quot;graphQLQueryTimeStatistics&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot;, &quot;statistics&quot; : { &quot;mean&quot; : 6.0, &quot;min&quot; : 6, &quot;max&quot; : 6, &quot;count&quot; : 1, &quot;p95&quot; : 6.0, &quot;p99&quot; : 6.0 } } ] } WebTau will implicitly invoke your GraphQL server's introspection queries in order to fetch a subset of the schema. It uses this schema in conjunction with the requests in tests to compute:query coverage - which queries were invoked by tests and which were not as well as an overall summary of coveragetiming information - http call timing statistics by query</p>
 </article>
 </section>
 </div>
@@ -127,7 +127,7 @@
         } ]
       }, {
         "lang" : "groovy",
-        "snippet" : "package scenarios.graphql\n\nurl = \"http://localhost:8180\"\n\ngraphQLEnabled = true\n\nreportGenerator = Report.&generateReport",
+        "snippet" : "package scenarios.graphql\n\nurl = \"http://localhost:8180\"\n\ngraphQLIgnoreIntrospectionFailures = false\n\nreportGenerator = Report.&generateReport",
         "title" : "webtau.cfg.groovy",
         "type" : "Snippet"
       }, {
@@ -156,7 +156,7 @@
         } ]
       }, {
         "lang" : "json",
-        "snippet" : "{\n  \"graphQLSkippedQueries\" : [ {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  } ],\n  \"graphQLCoveredQueries\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoverageSummary\" : {\n    \"coverage\" : 0.2,\n    \"types\" : {\n      \"mutation\" : {\n        \"coverage\" : 0.0,\n        \"declaredQueries\" : 2,\n        \"coveredQueries\" : 0.0\n      },\n      \"query\" : {\n        \"coverage\" : 0.3333333333333333,\n        \"declaredQueries\" : 3,\n        \"coveredQueries\" : 1.0\n      }\n    },\n    \"totalDeclaredQueries\" : 5.0,\n    \"totalCoveredQueries\" : 1.0\n  },\n  \"graphQLQueryTimeStatistics\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\",\n    \"statistics\" : {\n      \"mean\" : 5.0,\n      \"min\" : 5,\n      \"max\" : 5,\n      \"count\" : 1,\n      \"p95\" : 5.0,\n      \"p99\" : 5.0\n    }\n  } ]\n}",
+        "snippet" : "{\n  \"graphQLSkippedQueries\" : [ {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  } ],\n  \"graphQLCoveredQueries\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoverageSummary\" : {\n    \"coverage\" : 0.2,\n    \"types\" : {\n      \"mutation\" : {\n        \"coverage\" : 0.0,\n        \"declaredQueries\" : 2,\n        \"coveredQueries\" : 0.0\n      },\n      \"query\" : {\n        \"coverage\" : 0.3333333333333333,\n        \"declaredQueries\" : 3,\n        \"coveredQueries\" : 1.0\n      }\n    },\n    \"totalDeclaredQueries\" : 5.0,\n    \"totalCoveredQueries\" : 1.0\n  },\n  \"graphQLQueryTimeStatistics\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\",\n    \"statistics\" : {\n      \"mean\" : 6.0,\n      \"min\" : 6,\n      \"max\" : 6,\n      \"count\" : 1,\n      \"p95\" : 6.0,\n      \"p99\" : 6.0\n    }\n  } ]\n}",
         "title" : "webtau.graphql-report.json",
         "type" : "Snippet"
       }, {
@@ -200,7 +200,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1604459318229,
+    "lastModifiedTime" : 1604812521923,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Report",

JVM-business-logic/data-driven/index.html

@@ -234,7 +234,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1604459318229,
+    "lastModifiedTime" : 1604812521923,
     "tocItem" : {
       "sectionTitle" : "JVM Business Logic",
       "pageTitle" : "Data Driven",