add custom report generator extension point. report doc updates. (#64)

Author: MykolaGolubyev

webtau-docs/webtau/REST/headers.md

@@ -2,7 +2,7 @@
 
 Standard headers like `Content-Type` and `Accept` are set on your behalf. 
 When payload content is present then values are based on the content type you are sending. 
-When no palyload is present, it defaults to `application/json`.   
+When no payload is present, it defaults to `application/json`.   
 
 # Common Header
 

webtau-docs/webtau/REST/report.md

@@ -0,0 +1,25 @@
+# Location
+
+By default report is generated at `<workingdir>/webtau.report.html`. To change the location use `--reportPath` option. 
+
+# Summary
+
+Out of the box report provides high level information like number of failed tests and HTTP Operations coverage.
+
+:include-image: img/rest-report-summary.png {fit: true}
+
+# Navigation
+
+Report is a self contained single page application. 
+Url tracks your navigation through screens, so you can share url with your teammates to narrow down a problem.  
+
+# Additional Reports
+
+To generate custom reports, or upload report data to your server, specify `reportGenerator` config property.
+
+:include-file: examples/rest/report/webtau.cfg {title: "webtau.cfg"}
+
+Where `Report.&generateReport` is implemented as following
+
+:include-file: examples/rest/report/Report.groovy {title: "rest/report/Report.groovy"}
+

webtau-docs/webtau/img/rest-report-summary.png

@@ -8,6 +8,7 @@ REST
     documentation
     complex-types
     openAPI-spec
+    report
     matchers
 UI
     configuration

webtau-docs/webtau/toc

@@ -0,0 +1,16 @@
+package rest.report
+
+import com.twosigma.webtau.console.ConsoleOutputs
+import com.twosigma.webtau.console.ansi.Color
+import com.twosigma.webtau.report.ReportTestEntries
+
+import static com.twosigma.webtau.WebTauDsl.cfg
+
+class Report {
+    static void generateReport(ReportTestEntries entries) {
+        def reportPath = cfg.workingDir.resolve('report.txt')
+
+        ConsoleOutputs.out('generating report: ', Color.PURPLE, reportPath)
+        reportPath.toFile().text = entries.size()
+    }
+}

webtau-groovy/examples/rest/report/Report.groovy

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2018 TWO SIGMA OPEN SOURCE, LLC
+ *
+ * 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 rest.report
+
+import static com.twosigma.webtau.WebTauGroovyDsl.scenario
+
+scenario("no op") {
+
+}

webtau-groovy/examples/rest/report/simple.groovy

@@ -0,0 +1,5 @@
+import rest.report.Report
+
+url = "http://localhost:8080"
+
+reportGenerator = Report.&generateReport

webtau-groovy/examples/rest/report/webtau.cfg

@@ -18,6 +18,8 @@ package com.twosigma.webtau.cfg
 
 import com.twosigma.webtau.console.ConsoleOutputs
 import com.twosigma.webtau.console.ansi.Color
+import com.twosigma.webtau.report.ReportGenerator
+import com.twosigma.webtau.report.ReportGenerators
 
 import java.nio.file.Files
 import java.nio.file.Path
@@ -45,24 +47,34 @@ class WebTauGroovyFileConfigHandler implements WebTauConfigHandler {
         def parsedConfig = configSlurper.parse(configScript)
         cfg.acceptConfigValues("config file", parsedConfig.flatten())
 
+        if (!parsedConfig) {
+            return
+        }
+
         def headerProvider = httpHeaderProvider(parsedConfig)
         if (headerProvider) {
-            // we cannot add configuration here since most likely config setup will be triggered
+            // we cannot add configuration here using HttpConfigurations.add since most likely config setup will be triggered
             // as part of the first cfg value access (e.g. baseUrl lookup).
             // to lookup base url webtau loops through registered handlers, adding new handlers will cause
             // loop exception.
             // so we register GroovyConfigBasedHttpConfiguration via service loaded,
             // and adding actual header provider now
             GroovyConfigBasedHttpConfiguration.setHeaderProvider(headerProvider)
         }
-    }
 
-    private static Closure httpHeaderProvider(parsedConfig) {
-        if (!parsedConfig) {
-            return null
+        def reportGenerator = reportGenerator(parsedConfig)
+        if (reportGenerator) {
+            ReportGenerators.add(reportGenerator)
         }
+    }
 
+    private static Closure httpHeaderProvider(parsedConfig) {
         def provider = parsedConfig.get("httpHeaderProvider")
         return provider ? provider as Closure : null
     }
+
+    private static ReportGenerator reportGenerator(parsedConfig) {
+        def generator = parsedConfig.get("reportGenerator")
+        return generator ? generator as ReportGenerator : null
+    }
 }

webtau-groovy/src/main/groovy/com/twosigma/webtau/cfg/WebTauGroovyFileConfigHandler.groovy

@@ -25,7 +25,8 @@ import com.twosigma.webtau.console.ConsoleOutput
 import com.twosigma.webtau.console.ConsoleOutputs
 import com.twosigma.webtau.console.ansi.AnsiConsoleOutput
 import com.twosigma.webtau.driver.WebDriverCreator
-import com.twosigma.webtau.report.HtmlReportGenerator
+import com.twosigma.webtau.report.ReportGenerators
+import com.twosigma.webtau.report.ReportTestEntries
 import com.twosigma.webtau.reporter.ConsoleStepReporter
 import com.twosigma.webtau.reporter.IntegrationTestsMessageBuilder
 import com.twosigma.webtau.reporter.ScreenshotStepReporter
@@ -130,7 +131,7 @@ class WebTauCliApp implements StandaloneTestListener {
 
     @Override
     void afterAllTests() {
-        HtmlReportGenerator.generateAndCreateFile(tests.reportTestEntry)
+        ReportGenerators.generate(new ReportTestEntries(tests.reportTestEntry))
         problemCount = consoleTestReporter.failed + consoleTestReporter.errored + consoleTestReporter.skipped
     }
 }

webtau-groovy/src/main/groovy/com/twosigma/webtau/cli/WebTauCliApp.groovy

@@ -16,33 +16,55 @@
 
 package com.twosigma.webtau.cfg
 
+import com.twosigma.webtau.report.ReportGenerators
+import com.twosigma.webtau.report.ReportTestEntries
 import org.junit.Test
 
+import static com.twosigma.webtau.Ddjt.code
+import static com.twosigma.webtau.Ddjt.throwException
+
 class WebTauGroovyFileConfigHandlerTest {
     @Test
     void "should use default environment values when env is not specified"() {
         def cfg = createConfig()
+        handle(cfg)
 
-        def handler = new WebTauGroovyFileConfigHandler()
-        handler.onAfterCreate(cfg)
-
-        cfg.baseUrl.should == "http://localhost:8180"
+        cfg.baseUrl.should == 'http://localhost:8180'
     }
 
     @Test
     void "should use environment specific values when env is specified"() {
         def cfg = createConfig()
-        cfg.envConfigValue.set("test", "dev")
+        cfg.envConfigValue.set('test', 'dev')
 
+        handle(cfg)
+
+        cfg.baseUrl.should == 'http://dev.host:8080'
+    }
+
+    @Test
+    void "should let specify custom reporter"() {
+        def cfg = createConfig()
+        cfg.envConfigValue.set('test', 'prod')
+
+        handle(cfg)
+
+        cfg.reportPath.toFile().deleteOnExit()
+
+        // prod report throws exception on purpose
+        code {
+            ReportGenerators.generate(new ReportTestEntries())
+        } should throwException('report issue 0')
+    }
+
+    private static void handle(WebTauConfig cfg) {
         def handler = new WebTauGroovyFileConfigHandler()
         handler.onAfterCreate(cfg)
-
-        cfg.baseUrl.should == "http://dev.host:8080"
     }
 
     private static WebTauConfig createConfig() {
         def cfg = new WebTauConfig()
-        cfg.configFileName.set("test", "src/test/resources/webtau.cfg")
+        cfg.configFileName.set('test', 'src/test/resources/webtau.cfg')
 
         return cfg
     }