Update browser windows to allow specifying a path

Author: nicholasjackson

ChangeLog.md

@@ -1,24 +1,45 @@
 # Change Log
 
+## version 0.0.11
+
+### Browser windows
+Change `OpenInBrowser` to a string so that the user can specify the path
+
+### Version check
+Check the latest verison on startup
+
+```
+########################################################
+                   SHIPYARD UPDATE
+########################################################
+
+The current version of shipyard is "0.0.10", you have "841f3b0445cc01f44ea2728dd5113f6b0f611e1f".
+
+To upgrade Shipyard please use your package manager or, 
+see the documentation at:
+https://shipyard.run/docs/install for other options.
+```
+
+
 ## version 0.0.9
 
-## Browser windows
+### Browser windows
 Ensure that browser windows are openened correctly on Windows platforms.
 
-## Preflight
+### Preflight
 Check that Docker is installed and running
 
 
 ## version 0.0.8
 
-## Bugfixes
+### Bugfixes
 
 * Fix problem with home folder resolution on Windows
 * Add ipv6 DNS entries for resources
 
 ## version 0.0.7
 
-## Ingress
+### Ingress
 Add three new ingress types `nomad_ingress`, `k8s_ingress`, `container_ingress`, these new type have cluster specific options
 rather than trying to shoehorn all into `ingress`. For now `ingress` exists and is backward compatible.
 

cmd/run.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"fmt"
 	"os"
+	"strconv"
 	"sync"
 	"time"
 
@@ -119,42 +120,42 @@ func newRunCmdFunc(e shipyard.Engine, bp clients.Blueprints, hc clients.HTTP, bc
 				case config.TypeContainer:
 					c := r.(*config.Container)
 					for _, p := range c.Ports {
-						if p.Host != "" && p.OpenInBrowser {
-							browserList = append(browserList, fmt.Sprintf("http://localhost:%s", p.Host))
+						if p.Host != "" && p.OpenInBrowser != "" {
+							browserList = append(browserList, buildBrowserPath(r.Info().Name, p.Host, r.Info().Type, p.OpenInBrowser))
 						}
 					}
 				case config.TypeIngress:
 					c := r.(*config.Ingress)
 					for _, p := range c.Ports {
-						if p.Host != "" && p.OpenInBrowser {
-							browserList = append(browserList, fmt.Sprintf("http://localhost:%s", p.Host))
+						if p.Host != "" && p.OpenInBrowser != "" {
+							browserList = append(browserList, buildBrowserPath(r.Info().Name, p.Host, r.Info().Type, p.OpenInBrowser))
 						}
 					}
 				case config.TypeContainerIngress:
 					c := r.(*config.ContainerIngress)
 					for _, p := range c.Ports {
-						if p.Host != "" && p.OpenInBrowser {
-							browserList = append(browserList, fmt.Sprintf("http://localhost:%s", p.Host))
+						if p.Host != "" && p.OpenInBrowser != "" {
+							browserList = append(browserList, buildBrowserPath(r.Info().Name, p.Host, r.Info().Type, p.OpenInBrowser))
 						}
 					}
 				case config.TypeNomadIngress:
 					c := r.(*config.NomadIngress)
 					for _, p := range c.Ports {
-						if p.Host != "" && p.OpenInBrowser {
-							browserList = append(browserList, fmt.Sprintf("http://localhost:%s", p.Host))
+						if p.Host != "" && p.OpenInBrowser != "" {
+							browserList = append(browserList, buildBrowserPath(r.Info().Name, p.Host, r.Info().Type, p.OpenInBrowser))
 						}
 					}
 				case config.TypeK8sIngress:
 					c := r.(*config.K8sIngress)
 					for _, p := range c.Ports {
-						if p.Host != "" && p.OpenInBrowser {
-							browserList = append(browserList, fmt.Sprintf("http://localhost:%s", p.Host))
+						if p.Host != "" && p.OpenInBrowser != "" {
+							browserList = append(browserList, buildBrowserPath(r.Info().Name, p.Host, r.Info().Type, p.OpenInBrowser))
 						}
 					}
 				case config.TypeDocs:
 					c := r.(*config.Docs)
 					if c.OpenInBrowser {
-						browserList = append(browserList, fmt.Sprintf("http://localhost:%d", c.Port))
+						browserList = append(browserList, buildBrowserPath(r.Info().Name, strconv.Itoa(c.Port), r.Info().Type, ""))
 					}
 				}
 			}
@@ -205,6 +206,15 @@ func newRunCmdFunc(e shipyard.Engine, bp clients.Blueprints, hc clients.HTTP, bc
 	}
 }
 
+func buildBrowserPath(n, p string, t config.ResourceType, path string) string {
+	ty := t
+	if t == config.TypeNomadIngress || t == config.TypeContainerIngress || t == config.TypeK8sIngress {
+		ty = config.TypeIngress
+	}
+
+	return fmt.Sprintf("http://%s.%s.shipyard.run:%s%s", n, ty, p, path)
+}
+
 func bluePrintInState() bool {
 	//load the state
 	sc := config.New()

cmd/run_test.go

@@ -107,18 +107,19 @@ func TestRunOpensBrowserWindowForResources(t *testing.T) {
 	d.OpenInBrowser = true
 
 	i := config.NewIngress("test")
-	i.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: true}}
+	i.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: "/"}}
 
 	c := config.NewContainer("test")
-	c.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: true}}
+	c.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: "/"}}
 
+	// should not be opened
 	d2 := config.NewDocs("test")
 
 	i2 := config.NewIngress("test")
-	i2.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: false}}
+	i2.Ports = []config.Port{config.Port{Host: "8080", OpenInBrowser: ""}}
 
-	c2 := config.NewContainer("test")
-	c2.Ports = []config.Port{config.Port{OpenInBrowser: true}}
+	c2 := config.NewContainer("test2")
+	c2.Ports = []config.Port{config.Port{OpenInBrowser: ""}}
 
 	me.On("Apply", mock.Anything).Return(
 		[]config.Resource{d, i, c, d2, i2, c2},

functional_tests/test_fixtures/nomad/ingress.hcl

@@ -22,7 +22,7 @@ nomad_ingress "nomad-http" {
     local  = 4646
     remote = 4646
     host   = 14646
-    open_in_browser = true
+    open_in_browser = "/"
   }
 
   network  {

pkg/config/port.go

@@ -6,5 +6,5 @@ type Port struct {
 	Remote        string `hcl:"remote" json:"remote"`                                                           // Remote port of the service
 	Host          string `hcl:"host,optional" json:"host,omitempty"`                                            // Host port
 	Protocol      string `hcl:"protocol,optional" json:"protocol,omitempty"`                                    // Protocol tcp, udp
-	OpenInBrowser bool   `hcl:"open_in_browser,optional" json:"open_in_browser" mapstructure:"open_in_browser"` // When a host port is defined open the location in a browser
+	OpenInBrowser string `hcl:"open_in_browser,optional" json:"open_in_browser" mapstructure:"open_in_browser"` // When a host port is defined open this port with the given path in a browser
 }