groovy-runner: print version and build date (#742)

Author: MykolaGolubyev

webtau-config/src/main/java/org/testingisdocumenting/webtau/cfg/WebTauConfig.java

@@ -24,6 +24,7 @@
 import org.testingisdocumenting.webtau.persona.Persona;
 import org.testingisdocumenting.webtau.utils.ServiceLoaderUtils;
 import org.testingisdocumenting.webtau.utils.StringUtils;
+import org.testingisdocumenting.webtau.version.WebtauVersion;
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -62,7 +63,7 @@ public class WebTauConfig {
     private final ConfigValue disableFollowingRedirects = declareBoolean("disableRedirects", "disable following of redirects from HTTP calls", false);
     private final ConfigValue maxRedirects = declare("maxRedirects", "Maximum number of redirects to follow for an HTTP call", () -> 20);
     private final ConfigValue userAgent = declare("userAgent", "User agent to send on HTTP requests",
-            () -> "webtau/" + WebTauMeta.getVersion());
+            () -> "webtau/" + WebtauVersion.getVersion());
     private final ConfigValue removeWebtauFromUserAgent = declare("removeWebtauFromUserAgent",
             "By default webtau appends webtau and its version to the user-agent, this disables that part",
             () -> false);

webtau-config/src/main/java/org/testingisdocumenting/webtau/cfg/WebTauMeta.java

@@ -26,7 +26,11 @@
     </parent>
 
     <artifactId>webtau-core</artifactId>
-    <version>1.35-SNAPSHOT</version>
+
+    <properties>
+        <build.timestamp>${maven.build.timestamp}</build.timestamp>
+        <maven.build.timestamp.format>yyyy-MM-dd</maven.build.timestamp.format>
+    </properties>
 
     <dependencies>
         <dependency>
@@ -54,6 +58,13 @@
     </dependencies>
 
     <build>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>true</filtering>
+            </resource>
+        </resources>
+
         <plugins>
             <plugin>
                 <groupId>org.codehaus.gmavenplus</groupId>

webtau-config/src/main/java/org/testingisdocumenting/webtau/cfg/WebTauVersionOverrider.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020 znai 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 org.testingisdocumenting.webtau.version;
+
+import org.testingisdocumenting.webtau.console.ConsoleOutputs;
+import org.testingisdocumenting.webtau.console.ansi.Color;
+import org.testingisdocumenting.webtau.utils.ResourceUtils;
+
+public class WebtauVersion {
+    private static final String version;
+    private static final String timeStamp;
+
+    static {
+        String[] versionTimeStamp = ResourceUtils.textContent("webtau-version.txt").trim().split(" ");
+        version = versionTimeStamp[0];
+        timeStamp = versionTimeStamp[1];
+    }
+
+    private WebtauVersion() {
+    }
+
+    public static String getVersion() {
+        return version;
+    }
+
+    public static String getTimeStamp() {
+        return timeStamp;
+    }
+
+    public static void print() {
+        ConsoleOutputs.out(Color.YELLOW, "webtau version: ", Color.CYAN, WebtauVersion.getVersion(),
+                Color.GREEN, " (", WebtauVersion.getTimeStamp(), ")");
+    }
+}

webtau-core/pom.xml

@@ -0,0 +1 @@
+${project.version} ${build.timestamp}

webtau-core/src/main/java/org/testingisdocumenting/webtau/version/WebtauVersion.java

@@ -23,6 +23,7 @@ import org.apache.commons.cli.DefaultParser
 import org.apache.commons.cli.HelpFormatter
 import org.apache.commons.cli.Options
 import org.apache.commons.cli.ParseException
+import org.testingisdocumenting.webtau.version.WebtauVersion
 
 import java.nio.file.Paths
 
@@ -95,8 +96,8 @@ class WebTauCliArgsConfig {
     private void printHelp(Options options) {
         HelpFormatter helpFormatter = new HelpFormatter()
 
-        def header = "version: " + WebTauMeta.version
-        helpFormatter.printHelp("webtau [options] [testFile1] [testFile2]", header, options, "")
+        WebtauVersion.print()
+        helpFormatter.printHelp("webtau [options] [testFile1] [testFile2]", "", options, "")
         exitHandler.exit(1)
     }
 

webtau-core/src/main/resources/webtau-version.txt

@@ -37,6 +37,7 @@ import org.testingisdocumenting.webtau.report.ReportGenerator
 import org.testingisdocumenting.webtau.report.ReportGenerators
 import org.testingisdocumenting.webtau.reporter.*
 import org.testingisdocumenting.webtau.runner.standalone.StandaloneTestRunner
+import org.testingisdocumenting.webtau.version.WebtauVersion
 
 import java.nio.file.Files
 import java.util.function.Consumer
@@ -66,6 +67,7 @@ class WebTauCliApp implements TestListener, ReportGenerator {
         WebTauConfig.registerConfigHandlerAsLastHandler(cliConfigHandler)
 
         setupAnsi()
+        printVersion()
     }
 
     static void main(String[] args) {
@@ -174,6 +176,14 @@ class WebTauCliApp implements TestListener, ReportGenerator {
         }
     }
 
+    private static void printVersion() {
+        if (getCfg().getVerbosityLevel() == 0) {
+            return
+        }
+
+        WebtauVersion.print()
+    }
+
     @Override
     void generate(WebTauReport report) {
         problemCount = (int) (report.failed + report.errored)

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

@@ -1,4 +1,5 @@
 /*
+ * Copyright 2020 webtau maintainers
  * Copyright 2019 TWO SIGMA OPEN SOURCE, LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,14 +21,15 @@
 import static java.util.stream.Collectors.toList;
 
 import org.testingisdocumenting.webtau.cfg.ConfigValue;
-import org.testingisdocumenting.webtau.cfg.WebTauMeta;
 import org.testingisdocumenting.webtau.console.ConsoleOutputs;
 import org.testingisdocumenting.webtau.console.ansi.Color;
 import org.testingisdocumenting.webtau.reporter.WebTauReport;
 import org.testingisdocumenting.webtau.reporter.WebTauTest;
 import org.testingisdocumenting.webtau.utils.FileUtils;
 import org.testingisdocumenting.webtau.utils.JsonUtils;
 import org.testingisdocumenting.webtau.utils.ResourceUtils;
+import org.testingisdocumenting.webtau.version.WebtauVersion;
+
 import java.nio.file.Path;
 import java.util.Base64;
 import java.util.LinkedHashMap;
@@ -37,8 +39,8 @@
 import java.util.stream.Stream;
 
 public class HtmlReportGenerator implements ReportGenerator {
-    private String css;
-    private String bundleJavaScript;
+    private final String css;
+    private final String bundleJavaScript;
 
     public HtmlReportGenerator() {
         Map<String, Object> manifest = loadManifest();
@@ -59,7 +61,7 @@ private String generateHtml(WebTauReport report) {
         Map<String, Object> reportAsMap = new LinkedHashMap<>();
         reportAsMap.put("config", configAsListOfMaps(getCfg().getEnumeratedCfgValuesStream()));
         reportAsMap.put("summary", reportSummaryToMap(report));
-        reportAsMap.put("version", WebTauMeta.getVersion());
+        reportAsMap.put("version", WebtauVersion.getVersion());
         reportAsMap.put("tests", report.getTests().stream()
                 .map(WebTauTest::toMap).collect(Collectors.toList()));