Supporting VNC in JSON (fixes #9)

Author: vania-pooh

README.md

@@ -91,4 +91,29 @@ Cloud provider attributes `username` and `password` can be included in the input
       }
     }
   }
+```
+
+To specify VNC proxying settings - use `vnc` attribute as follows:
+```
+  "vnc-hosts": {
+    "some-dc" : {
+      "selenoid-host.example.com": {
+        "port": 4444,
+        "count": 1,
+        "vnc": "selenoid"
+      }
+    }
+  }
+```
+When `vnc` equals to `selenoid` then VNC will be set to `ws://host:port/vnc`, otherwise it will be set to specified value with `$hostName` placeholder is replaced by respective host name:
+```
+  "vnc-hosts": {
+    "some-dc" : {
+      "some-host-[1:5].example.com": {
+        "port": 4444,
+        "count": 5,
+        "vnc": "vnc://$hostName:5900"
+      }
+    }
+  }
 ```

cmd/data.go

@@ -5,6 +5,7 @@ type Host struct {
 	Count    int    `json:"count"`
 	Username string `json:"username"`
 	Password string `json:"password"`
+	VNC      string `json:"vnc"`
 }
 
 type Region map[string]Host

cmd/generate.go

@@ -126,13 +126,17 @@ func jsonRegionsToXmlRegions(regions Regions) []ggr.Region {
 		for hostPattern, host := range region {
 			hostNames := parseHostPattern(hostPattern)
 			for _, hostName := range hostNames {
-				xmlHosts = append(xmlHosts, ggr.Host{
+				h := ggr.Host{
 					Name:     hostName,
 					Port:     host.Port,
 					Count:    host.Count,
 					Username: host.Username,
 					Password: host.Password,
-				})
+				}
+				if host.VNC != "" {
+					h.VNC = preProcessVNC(hostName, host.Port, host.VNC)
+				}
+				xmlHosts = append(xmlHosts, h)
 			}
 		}
 		xmlRegions = append(xmlRegions, ggr.Region{
@@ -143,6 +147,15 @@ func jsonRegionsToXmlRegions(regions Regions) []ggr.Region {
 	return xmlRegions
 }
 
+func preProcessVNC(hostName string, port int, vnc string) string {
+	const selenoid = "selenoid"
+	const hostPattern = "$hostName"
+	if vnc == selenoid {
+		return fmt.Sprintf("ws://%s:%d/vnc", hostName, port)
+	}
+	return strings.Replace(vnc, hostPattern, hostName, -1)
+}
+
 func parseInputFile(filePath string) (*Input, error) {
 	bytes, err := ioutil.ReadFile(filePath)
 	if err != nil {

cmd/generate_test.go

@@ -9,7 +9,7 @@ import (
 func TestParseInputFile(t *testing.T) {
 	input, err := parseInputFile("../test-data/input.json")
 	AssertThat(t, err, Is{nil})
-	AssertThat(t, len(input.Hosts), EqualTo{2})
+	AssertThat(t, len(input.Hosts), EqualTo{3})
 	AssertThat(t, len(input.Quota), EqualTo{1})
 }
 
@@ -46,10 +46,10 @@ func TestConvert(t *testing.T) {
 	AssertThat(t, secondVersion.Number, EqualTo{"42.0"})
 	thirdVersion := versions[2]
 	AssertThat(t, thirdVersion.Number, EqualTo{"43.0"})
-	AssertThat(t, thirdVersion.Platform, EqualTo{"LINUX"})
+	AssertThat(t, thirdVersion.Platform, EqualTo{"WINDOWS"})
 	fourthVersion := versions[3]
-	AssertThat(t, fourthVersion.Number, EqualTo{"43.0"})
-	AssertThat(t, fourthVersion.Platform, EqualTo{"WINDOWS"})
+	AssertThat(t, fourthVersion.Number, EqualTo{"45.0"})
+	AssertThat(t, fourthVersion.Platform, EqualTo{"LINUX"})
 
 	firstRegions := firstVersion.Regions
 	AssertThat(t, len(firstRegions), EqualTo{2})
@@ -73,13 +73,21 @@ func TestConvert(t *testing.T) {
 		AssertThat(t, firstHost.Password == "" && secondHost.Password == "", Is{true})
 	}
 
-	secondRegions := thirdVersion.Regions
-	AssertThat(t, len(secondRegions), EqualTo{1})
-	region := secondRegions[0]
+	thirdRegions := thirdVersion.Regions
+	AssertThat(t, len(thirdRegions), EqualTo{1})
+	region := thirdRegions[0]
 	AssertThat(t, region.Name == "provider-1", Is{true})
 
 	AssertThat(t, len(region.Hosts), EqualTo{5})
 
+	fourthRegions := fourthVersion.Regions
+	AssertThat(t, len(fourthRegions), EqualTo{1})
+	fourthRegion := fourthRegions[0]
+	AssertThat(t, fourthRegion.Name == "some-dc", Is{true})
+	AssertThat(t, len(fourthRegion.Hosts), EqualTo{1})
+	vncHost := fourthRegion.Hosts[0]
+	AssertThat(t, vncHost.VNC, EqualTo{"ws://selenoid-host.example.com:4444/vnc"})
+
 	for _, host := range region.Hosts {
 		AssertThat(t, host.Username, EqualTo{"user1"})
 		AssertThat(t, host.Password, EqualTo{"Password1"})
@@ -99,3 +107,8 @@ func TestParseVersionPlatform(t *testing.T) {
 	AssertThat(t, v, EqualTo{"version"})
 	AssertThat(t, p, EqualTo{"platform@platform"})
 }
+
+func TestPreProcessVNC(t *testing.T) {
+	AssertThat(t, preProcessVNC("selenoid-host.example.com", 4444, "selenoid"), EqualTo{"ws://selenoid-host.example.com:4444/vnc"})
+	AssertThat(t, preProcessVNC("vnc-host.example.com", 5900, "vnc://$hostName:5900"), EqualTo{"vnc://vnc-host.example.com:5900"})
+}

test-data/input.json

@@ -23,6 +23,15 @@
           "password": "Password1"
         }
       }
+    },
+    "vnc-hosts": {
+      "some-dc": {
+        "selenoid-host.example.com": {
+          "port": 4444,
+          "count": 1,
+          "vnc": "selenoid"
+        }
+      }
     }
   },
 
@@ -34,8 +43,8 @@
         "versions": {
           "33.0": "cloud",
           "42.0": "cloud",
-          "43.0@LINUX": "cloud-provider",
-          "43.0@WINDOWS": "cloud-provider"
+          "43.0@WINDOWS": "cloud-provider",
+          "45.0@LINUX": "vnc-hosts"
         }
       }
     }

test-data/output.xml

@@ -92,7 +92,7 @@
                 <host name="selenium-cloud-b-20.example.com" port="4444" count="2"></host>
             </region>
         </version>
-        <version number="43.0" platform="LINUX">
+        <version number="43.0" platform="WINDOWS">
             <region name="provider-1">
                 <host name="cloud-provider-1.com" port="4444" count="1" username="user1" password="Password1"></host>
                 <host name="cloud-provider-2.com" port="4444" count="1" username="user1" password="Password1"></host>
@@ -101,13 +101,10 @@
                 <host name="cloud-provider-5.com" port="4444" count="1" username="user1" password="Password1"></host>
             </region>
         </version>
-        <version number="43.0" platform="WINDOWS">
-            <region name="provider-1">
-                <host name="cloud-provider-1.com" port="4444" count="1" username="user1" password="Password1"></host>
-                <host name="cloud-provider-2.com" port="4444" count="1" username="user1" password="Password1"></host>
-                <host name="cloud-provider-3.com" port="4444" count="1" username="user1" password="Password1"></host>
-                <host name="cloud-provider-4.com" port="4444" count="1" username="user1" password="Password1"></host>
-                <host name="cloud-provider-5.com" port="4444" count="1" username="user1" password="Password1"></host>
+        <version number="45.0" platform="LINUX">
+            <region name="some-dc">
+                <host name="selenoid-host.example.com" port="4444" count="1"
+                      vnc="ws://selenoid-host.example.com:4444/vnc"></host>
             </region>
         </version>
     </browser>