deploy: 5b85580

Author: MykolaGolubyev

GraphQL/customized-graphql-urls/index.html

@@ -89,6 +89,7 @@
 </article>
 </section>
 </div>
+<script type="text/javascript" src="/webtau/footer.js"></script>
 <script type="text/javascript" src="/webtau/toc.js"></script>
 <script type="text/javascript" src="/webtau/documentation-references.js"></script>
 <script type="text/javascript" src="/webtau/assets.js"></script>
@@ -199,7 +200,7 @@
         "type" : "Snippet"
       } ]
     } ],
-    "lastModifiedTime" : 1624834582454,
+    "lastModifiedTime" : 1630089937550,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Customized Graphql Urls",
@@ -212,30 +213,6 @@
         "id" : "customizing-the-graphql-endpoint"
       } ]
     }
-  },
-  "footer" : {
-    "type" : "Footer",
-    "content" : [ {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "If you have documentation suggestions, features or bugs to report, please create ",
-        "type" : "SimpleText"
-      }, {
-        "url" : "https://github.com/testingisdocumenting/webtau/issues",
-        "isFile" : false,
-        "type" : "Link",
-        "content" : [ {
-          "text" : "GitHub Issue",
-          "type" : "SimpleText"
-        } ]
-      } ]
-    }, {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "Contributions are welcome",
-        "type" : "SimpleText"
-      } ]
-    } ]
   }
 }), document.getElementById("znai"));
 /*-->*/

GraphQL/introduction/index.html

@@ -88,6 +88,7 @@
 </article>
 </section>
 </div>
+<script type="text/javascript" src="/webtau/footer.js"></script>
 <script type="text/javascript" src="/webtau/toc.js"></script>
 <script type="text/javascript" src="/webtau/documentation-references.js"></script>
 <script type="text/javascript" src="/webtau/assets.js"></script>
@@ -255,7 +256,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1624834582454,
+    "lastModifiedTime" : 1630089937550,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Introduction",
@@ -265,30 +266,6 @@
       "viewOnRelativePath" : null,
       "pageSectionIdTitles" : [ ]
     }
-  },
-  "footer" : {
-    "type" : "Footer",
-    "content" : [ {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "If you have documentation suggestions, features or bugs to report, please create ",
-        "type" : "SimpleText"
-      }, {
-        "url" : "https://github.com/testingisdocumenting/webtau/issues",
-        "isFile" : false,
-        "type" : "Link",
-        "content" : [ {
-          "text" : "GitHub Issue",
-          "type" : "SimpleText"
-        } ]
-      } ]
-    }, {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "Contributions are welcome",
-        "type" : "SimpleText"
-      } ]
-    } ]
   }
 }), document.getElementById("znai"));
 /*-->*/

GraphQL/queries-and-mutations/index.html

@@ -94,6 +94,7 @@
 </article>
 </section>
 </div>
+<script type="text/javascript" src="/webtau/footer.js"></script>
 <script type="text/javascript" src="/webtau/toc.js"></script>
 <script type="text/javascript" src="/webtau/documentation-references.js"></script>
 <script type="text/javascript" src="/webtau/assets.js"></script>
@@ -276,7 +277,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1624834582454,
+    "lastModifiedTime" : 1630089937550,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Queries And Mutations",
@@ -292,30 +293,6 @@
         "id" : "response-assertions"
       } ]
     }
-  },
-  "footer" : {
-    "type" : "Footer",
-    "content" : [ {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "If you have documentation suggestions, features or bugs to report, please create ",
-        "type" : "SimpleText"
-      }, {
-        "url" : "https://github.com/testingisdocumenting/webtau/issues",
-        "isFile" : false,
-        "type" : "Link",
-        "content" : [ {
-          "text" : "GitHub Issue",
-          "type" : "SimpleText"
-        } ]
-      } ]
-    }, {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "Contributions are welcome",
-        "type" : "SimpleText"
-      } ]
-    } ]
   }
 }), document.getElementById("znai"));
 /*-->*/

GraphQL/report/index.html

@@ -85,10 +85,11 @@
 </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; 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 = [:] report.customDataStream.each { additionalData.putAll(it.toMap()) } 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 reportData.graphQLCoveredSuccessBranches = additionalData.graphQLCoveredSuccessBranches // All queries present in the GraphQL schema that were hit with a success result reportData.graphQLSkippedSuccessBranches = additionalData.graphQLSkippedSuccessBranches // All queries present in the GraphQL schema but not hit with a success result reportData.graphQLCoveredErrorBranches = additionalData.graphQLCoveredErrorBranches // All queries present in the GraphQL schema that were hit with an error result reportData.graphQLSkippedErrorBranches = additionalData.graphQLSkippedErrorBranches // All queries present in the GraphQL schema but not hit with an error result 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;complete&quot;, &quot;type&quot; : &quot;mutation&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;graphQLCoveredQueries&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLCoverageSummary&quot; : { &quot;coverage&quot; : 0.2, &quot;branchCoverage&quot; : 0.1, &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;successBranchCoverage&quot; : 0.2, &quot;errorBranchCoverage&quot; : 0.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; : 3.0, &quot;min&quot; : 3, &quot;max&quot; : 3, &quot;count&quot; : 1, &quot;p95&quot; : 3.0, &quot;p99&quot; : 3.0 } } ], &quot;graphQLCoveredSuccessBranches&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLSkippedSuccessBranches&quot; : [ { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&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;graphQLCoveredErrorBranches&quot; : [ ], &quot;graphQLSkippedErrorBranches&quot; : [ { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&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;weather&quot;, &quot;type&quot; : &quot;query&quot; } ] } Coverage and Timing Statistics 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 coverage timing 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 = [:] report.customDataStream.each { additionalData.putAll(it.toMap()) } 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 reportData.graphQLCoveredSuccessBranches = additionalData.graphQLCoveredSuccessBranches // All queries present in the GraphQL schema that were hit with a success result reportData.graphQLSkippedSuccessBranches = additionalData.graphQLSkippedSuccessBranches // All queries present in the GraphQL schema but not hit with a success result reportData.graphQLCoveredErrorBranches = additionalData.graphQLCoveredErrorBranches // All queries present in the GraphQL schema that were hit with an error result reportData.graphQLSkippedErrorBranches = additionalData.graphQLSkippedErrorBranches // All queries present in the GraphQL schema but not hit with an error result 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;complete&quot;, &quot;type&quot; : &quot;mutation&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;taskById&quot;, &quot;type&quot; : &quot;query&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;branchCoverage&quot; : 0.1, &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;successBranchCoverage&quot; : 0.2, &quot;errorBranchCoverage&quot; : 0.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 } } ], &quot;graphQLCoveredSuccessBranches&quot; : [ { &quot;name&quot; : &quot;weather&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLSkippedSuccessBranches&quot; : [ { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&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;taskById&quot;, &quot;type&quot; : &quot;query&quot; } ], &quot;graphQLCoveredErrorBranches&quot; : [ ], &quot;graphQLSkippedErrorBranches&quot; : [ { &quot;name&quot; : &quot;complete&quot;, &quot;type&quot; : &quot;mutation&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;weather&quot;, &quot;type&quot; : &quot;query&quot; }, { &quot;name&quot; : &quot;taskById&quot;, &quot;type&quot; : &quot;query&quot; } ] } Coverage and Timing Statistics 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 coverage timing information - http call timing statistics by query</p>
 </article>
 </section>
 </div>
+<script type="text/javascript" src="/webtau/footer.js"></script>
 <script type="text/javascript" src="/webtau/toc.js"></script>
 <script type="text/javascript" src="/webtau/documentation-references.js"></script>
 <script type="text/javascript" src="/webtau/assets.js"></script>
@@ -158,7 +159,7 @@
         } ]
       }, {
         "lang" : "json",
-        "snippet" : "{\n  \"graphQLSkippedQueries\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoveredQueries\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoverageSummary\" : {\n    \"coverage\" : 0.2,\n    \"branchCoverage\" : 0.1,\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    \"successBranchCoverage\" : 0.2,\n    \"errorBranchCoverage\" : 0.0,\n    \"totalDeclaredQueries\" : 5.0,\n    \"totalCoveredQueries\" : 1.0\n  },\n  \"graphQLQueryTimeStatistics\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\",\n    \"statistics\" : {\n      \"mean\" : 3.0,\n      \"min\" : 3,\n      \"max\" : 3,\n      \"count\" : 1,\n      \"p95\" : 3.0,\n      \"p99\" : 3.0\n    }\n  } ],\n  \"graphQLCoveredSuccessBranches\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLSkippedSuccessBranches\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoveredErrorBranches\" : [ ],\n  \"graphQLSkippedErrorBranches\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ]\n}",
+        "snippet" : "{\n  \"graphQLSkippedQueries\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoveredQueries\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoverageSummary\" : {\n    \"coverage\" : 0.2,\n    \"branchCoverage\" : 0.1,\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    \"successBranchCoverage\" : 0.2,\n    \"errorBranchCoverage\" : 0.0,\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  \"graphQLCoveredSuccessBranches\" : [ {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLSkippedSuccessBranches\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  } ],\n  \"graphQLCoveredErrorBranches\" : [ ],\n  \"graphQLSkippedErrorBranches\" : [ {\n    \"name\" : \"complete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"uncomplete\",\n    \"type\" : \"mutation\"\n  }, {\n    \"name\" : \"allTasks\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"weather\",\n    \"type\" : \"query\"\n  }, {\n    \"name\" : \"taskById\",\n    \"type\" : \"query\"\n  } ]\n}",
         "title" : "webtau.graphql-report.json",
         "type" : "Snippet"
       }, {
@@ -202,7 +203,7 @@
         } ]
       } ]
     } ],
-    "lastModifiedTime" : 1624834582454,
+    "lastModifiedTime" : 1630089937550,
     "tocItem" : {
       "sectionTitle" : "GraphQL",
       "pageTitle" : "Report",
@@ -215,30 +216,6 @@
         "id" : "additional-reports"
       } ]
     }
-  },
-  "footer" : {
-    "type" : "Footer",
-    "content" : [ {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "If you have documentation suggestions, features or bugs to report, please create ",
-        "type" : "SimpleText"
-      }, {
-        "url" : "https://github.com/testingisdocumenting/webtau/issues",
-        "isFile" : false,
-        "type" : "Link",
-        "content" : [ {
-          "text" : "GitHub Issue",
-          "type" : "SimpleText"
-        } ]
-      } ]
-    }, {
-      "type" : "Paragraph",
-      "content" : [ {
-        "text" : "Contributions are welcome",
-        "type" : "SimpleText"
-      } ]
-    } ]
   }
 }), document.getElementById("znai"));
 /*-->*/