servers: auto generated id when none provided (#1554)

Author: MykolaGolubyev

webtau-docs/znai/release-notes/2.3/add-2023-12-11-server-auto-id.md

@@ -0,0 +1 @@
+* Add: auto generated [Server](servers/introduction) `id` when none provided

webtau-docs/znai/servers/fake-server.md

@@ -38,4 +38,6 @@ Java:
 }
 ```
 
+Note: If you omit `serverId` parameter, an auto generated one will be used instead. It affects what you see in the generated report
+
 

webtau-feature-testing/examples/scenarios/server/fakeRest.groovy

@@ -40,6 +40,13 @@ scenario("fake rest server") {
     // fake-response-check
 }
 
+scenario("auto generated server id") {
+    def myServer = server.fake(router)
+    http.get("${myServer.baseUrl}/hello/person") {
+        message.should == "hello person"
+    }
+}
+
 scenario("slow down") {
     def myServer = server.fake("my-rest-server-slowed-down", router)
 

webtau-feature-testing/examples/scenarios/server/staticContent.groovy

@@ -55,6 +55,13 @@ scenario("static content server") {
     // static-server-html
 }
 
+scenario("auto generated server id") {
+    def myServer = server.serve("data/staticcontent")
+    http.get("${myServer.baseUrl}/hello.html") {
+        body.should == expectedHtml
+    }
+}
+
 scenario("slow down") {
     def myServer = server.serve("my-server-slown-down", "data/staticcontent")
     myServer.setAsBaseUrl()

webtau-feature-testing/test-expectations/scenarios/server/fakeRest/run-details.json

@@ -3,14 +3,20 @@
     "scenario" : "after all tests",
     "shortContainerId" : "Teardown",
     "stepsSummary" : {
-      "numberOfSuccessful" : 4
+      "numberOfSuccessful" : 5
     }
   }, {
     "scenario" : "fake rest server",
     "shortContainerId" : "fakeRest.groovy",
     "stepsSummary" : {
       "numberOfSuccessful" : 7
     }
+  }, {
+    "scenario" : "auto generated server id",
+    "shortContainerId" : "fakeRest.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 4
+    }
   }, {
     "scenario" : "slow down",
     "shortContainerId" : "fakeRest.groovy",

webtau-feature-testing/test-expectations/scenarios/server/staticContent/run-details.json

@@ -3,14 +3,20 @@
     "scenario" : "after all tests",
     "shortContainerId" : "Teardown",
     "stepsSummary" : {
-      "numberOfSuccessful" : 6
+      "numberOfSuccessful" : 7
     }
   }, {
     "scenario" : "static content server",
     "shortContainerId" : "staticContent.groovy",
     "stepsSummary" : {
       "numberOfSuccessful" : 16
     }
+  }, {
+    "scenario" : "auto generated server id",
+    "shortContainerId" : "staticContent.groovy",
+    "stepsSummary" : {
+      "numberOfSuccessful" : 4
+    }
   }, {
     "scenario" : "slow down",
     "shortContainerId" : "staticContent.groovy",

webtau-server/src/main/java/org/testingisdocumenting/webtau/server/WebTauServerFacade.java

@@ -22,6 +22,7 @@
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Collections;
+import java.util.UUID;
 
 import static org.testingisdocumenting.webtau.server.WebTauServerResponseBuilder.*;
 
@@ -98,6 +99,24 @@ public WebTauServer serve(String serverId, Path path) {
         return serve(serverId, path, 0);
     }
 
+    /**
+     * creates static content server with an auto generated serverId and starts it on a random part
+     * @param path static content path
+     * @return server instance
+     */
+    public WebTauServer serve(String path) {
+        return serve(generateUniqueServerId(), path, 0);
+    }
+
+    /**
+     * creates static content server with an auto generated serverId and starts it on a random part
+     * @param path static content path
+     * @return server instance
+     */
+    public WebTauServer serve(Path path) {
+        return serve(generateUniqueServerId(), path, 0);
+    }
+
     /**
      * creates static content server and starts it on the specified part
      * @param serverId unique server id
@@ -147,6 +166,15 @@ public WebTauProxyServer proxy(String serverId, String urlToProxy) {
         return proxy(serverId, urlToProxy, 0);
     }
 
+    /**
+     * creates proxy server with an auto generated server id and starts it on a random part
+     * @param urlToProxy url to proxy to
+     * @return server instance
+     */
+    public WebTauProxyServer proxy(String urlToProxy) {
+        return proxy(generateUniqueServerId(), urlToProxy, 0);
+    }
+
     /**
      * creates a fake server and starts it on the specified port
      * @param serverId unique server id
@@ -171,6 +199,15 @@ public WebTauServer fake(String serverId) {
         return fake(serverId, 0);
     }
 
+    /**
+     * creates a fake server with auto genrated server id and starts it on a random port
+     * @return server instance
+     * @see WebTauRouter
+     */
+    public WebTauServer fake() {
+        return fake(generateUniqueServerId(), 0);
+    }
+
     /**
      * creates a fake server and starts it on the specified port using provided router to defined responses
      * @param serverId unique server id
@@ -197,6 +234,16 @@ public WebTauServer fake(String serverId, WebTauRouter router) {
         return fake(serverId, 0, router);
     }
 
+    /**
+     * creates a fake server with auto generated server id and starts it on a random port using provided router to defined responses
+     * @param router responses definition
+     * @return server instance
+     * @see WebTauRouter
+     */
+    public WebTauServer fake(WebTauRouter router) {
+        return fake(generateUniqueServerId(), 0, router);
+    }
+
     /**
      * creates an instance of router to define or override responses
      * @param id unique router id
@@ -215,4 +262,8 @@ public WebTauRouter router(String id) {
     public WebTauRouter router() {
         return new WebTauRouter("main-router");
     }
+
+    private String generateUniqueServerId() {
+        return UUID.randomUUID().toString();
+    }
 }