template clean up (#447)

David Chung · web-flow · commit be7850439ec4 · 2017-03-25T16:55:36.000-07:00
Signed-off-by: David Chung &lt;david.chung@docker.com&gt;
diff --git a/cmd/cli/event.go b/cmd/cli/event.go
@@ -6,7 +6,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
 	"github.com/docker/infrakit/pkg/rpc/client"
 	event_rpc "github.com/docker/infrakit/pkg/rpc/event"
@@ -193,9 +192,7 @@ func eventCommand(plugins func() discovery.Plugins) *cobra.Command {
 		RunE: func(c *cobra.Command, args []string) error {
 
 			log.Infof("Using %v for rendering view.", templateURL)
-			engine, err := template.NewTemplate(templateURL, template.Options{
-				SocketDir: local.Dir(),
-			})
+			engine, err := template.NewTemplate(templateURL, template.Options{})
 			if err != nil {
 				return err
 			}
diff --git a/cmd/cli/manager.go b/cmd/cli/manager.go
@@ -6,7 +6,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/manager"
 	"github.com/docker/infrakit/pkg/plugin"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
@@ -87,9 +86,7 @@ func managerCommand(plugins func() discovery.Plugins) *cobra.Command {
 		templateURL := args[0]
 
 		log.Infof("Using %v for reading template\n", templateURL)
-		engine, err := template.NewTemplate(templateURL, template.Options{
-			SocketDir: local.Dir(),
-		})
+		engine, err := template.NewTemplate(templateURL, template.Options{})
 		if err != nil {
 			return err
 		}
diff --git a/cmd/cli/plugin.go b/cmd/cli/plugin.go
@@ -11,7 +11,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/launch"
 	"github.com/docker/infrakit/pkg/launch/os"
 	"github.com/docker/infrakit/pkg/plugin"
@@ -59,9 +58,7 @@ func pluginCommand(plugins func() discovery.Plugins) *cobra.Command {
 
 	start.RunE = func(c *cobra.Command, args []string) error {
 
-		configTemplate, err := template.NewTemplate(*configURL, template.Options{
-			SocketDir: local.Dir(),
-		})
+		configTemplate, err := template.NewTemplate(*configURL, template.Options{})
 		if err != nil {
 			return err
 		}
diff --git a/cmd/cli/resource.go b/cmd/cli/resource.go
@@ -6,7 +6,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin"
 	resource_plugin "github.com/docker/infrakit/pkg/rpc/resource"
 	"github.com/docker/infrakit/pkg/spi/resource"
@@ -139,9 +138,7 @@ func resourcePluginCommand(plugins func() discovery.Plugins) *cobra.Command {
 
 func readSpecFromTemplateURL(templateURL string) (*resource.Spec, error) {
 	log.Infof("Reading template from %v", templateURL)
-	engine, err := template.NewTemplate(templateURL, template.Options{
-		SocketDir: local.Dir(),
-	})
+	engine, err := template.NewTemplate(templateURL, template.Options{})
 	if err != nil {
 		return nil, err
 	}
diff --git a/cmd/cli/template.go b/cmd/cli/template.go
@@ -6,7 +6,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/discovery"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	metadata_template "github.com/docker/infrakit/pkg/plugin/metadata/template"
 	"github.com/docker/infrakit/pkg/template"
 	"github.com/spf13/cobra"
@@ -22,9 +21,7 @@ func templateCommand(plugins func() discovery.Plugins) *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 
 			log.Infof("Using %v for reading template\n", templateURL)
-			engine, err := template.NewTemplate(templateURL, template.Options{
-				SocketDir: local.Dir(),
-			})
+			engine, err := template.NewTemplate(templateURL, template.Options{})
 			if err != nil {
 				return err
 			}
diff --git a/examples/flavor/swarm/main.go b/examples/flavor/swarm/main.go
@@ -24,9 +24,7 @@ func init() {
 		})
 }
 
-var defaultTemplateOptions = template.Options{
-	SocketDir: local.Dir(),
-}
+var defaultTemplateOptions = template.Options{}
 
 func main() {
 
diff --git a/examples/instance/vagrant/main.go b/examples/instance/vagrant/main.go
@@ -7,7 +7,6 @@ import (
 
 	log "github.com/Sirupsen/logrus"
 	"github.com/docker/infrakit/pkg/cli"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	"github.com/docker/infrakit/pkg/plugin/metadata"
 	instance_plugin "github.com/docker/infrakit/pkg/rpc/instance"
 	metadata_plugin "github.com/docker/infrakit/pkg/rpc/metadata"
@@ -33,9 +32,7 @@ func main() {
 	templFile := cmd.Flags().String("template", "", "Vagrant Template file, in URL form")
 	cmd.RunE = func(c *cobra.Command, args []string) error {
 
-		opts := template.Options{
-			SocketDir: local.Dir(),
-		}
+		opts := template.Options{}
 
 		var templ *template.Template
 		if *templFile == "" {
diff --git a/pkg/discovery/discovery_test.go b/pkg/discovery/discovery_test.go
@@ -0,0 +1,13 @@
+package discovery
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestErrNotUnixSocket(t *testing.T) {
+	err := ErrNotUnixSocket("no socket!")
+	require.Error(t, err)
+	require.True(t, IsErrNotUnixSocket(err))
+}
diff --git a/pkg/plugin/resource/plugin.go b/pkg/plugin/resource/plugin.go
@@ -7,7 +7,6 @@ import (
 	"strings"
 
 	log "github.com/Sirupsen/logrus"
-	"github.com/docker/infrakit/pkg/discovery/local"
 	plugin_base "github.com/docker/infrakit/pkg/plugin"
 	"github.com/docker/infrakit/pkg/spi/instance"
 	"github.com/docker/infrakit/pkg/spi/resource"
@@ -76,7 +75,7 @@ func (p *plugin) Commit(config resource.Spec, pretend bool) (string, error) {
 			continue
 		}
 
-		template, err := template.NewTemplate("str://"+resourceConfigs[name].properties, template.Options{SocketDir: local.Dir()})
+		template, err := template.NewTemplate("str://"+resourceConfigs[name].properties, template.Options{})
 		if err != nil {
 			return "", fmt.Errorf("Failed to parse template '%s' for resource '%s': %s", resourceConfigs[name].properties, name, err)
 		}
@@ -272,7 +271,7 @@ func getProvisioningOrder(resourceConfigs map[string]resourceConfig) ([]string,
 	}
 
 	for name, resourceConfig := range resourceConfigs {
-		template, err := template.NewTemplate("str://"+resourceConfig.properties, template.Options{SocketDir: local.Dir()})
+		template, err := template.NewTemplate("str://"+resourceConfig.properties, template.Options{})
 		if err != nil {
 			return nil, fmt.Errorf("Failed to parse template for resource '%s': %s", name, err)
 		}
diff --git a/pkg/plugin/resource/plugin_test.go b/pkg/plugin/resource/plugin_test.go
@@ -7,7 +7,6 @@ import (
 	"reflect"
 	"testing"
 
-	"github.com/docker/infrakit/pkg/discovery/local"
 	plugin_base "github.com/docker/infrakit/pkg/plugin"
 	"github.com/docker/infrakit/pkg/plugin/group/util"
 	"github.com/docker/infrakit/pkg/spi/instance"
@@ -377,7 +376,7 @@ func TestGetProvisioningOrder(t *testing.T) {
 
 func TestGetResourceDependencies(t *testing.T) {
 	newTemplate := func(s string) *template.Template {
-		t, err := template.NewTemplate("str://"+s, template.Options{SocketDir: local.Dir()})
+		t, err := template.NewTemplate("str://"+s, template.Options{})
 		if err != nil {
 			panic(err)
 		}
diff --git a/pkg/rpc/server/info_test.go b/pkg/rpc/server/info_test.go
@@ -2,8 +2,8 @@ package server
 
 import (
 	"io/ioutil"
+	"net/http"
 	"path"
-	"path/filepath"
 	"testing"
 
 	rpc_flavor "github.com/docker/infrakit/pkg/rpc/flavor"
@@ -26,15 +26,18 @@ func tempSocket() string {
 
 func TestFetchAPIInfoFromPlugin(t *testing.T) {
 	socketPath := tempSocket()
-	dir := filepath.Dir(socketPath)
-	host := filepath.Base(socketPath)
 
-	url := "unix://" + host + "/info/api.json"
+	url := "unix://" + socketPath
 
 	server, err := StartPluginAtPath(socketPath, rpc_instance.PluginServer(&testing_instance.Plugin{}))
 	require.NoError(t, err)
 
-	buff, err := template.Fetch(url, template.Options{SocketDir: dir}, nil)
+	buff, err := template.Fetch(url, template.Options{
+		CustomizeFetch: func(req *http.Request) {
+			req.URL.Path = "/info/api.json"
+			req.URL.Host = "h"
+		},
+	})
 	require.NoError(t, err)
 
 	decoded, err := template.FromJSON(buff)
@@ -44,8 +47,13 @@ func TestFetchAPIInfoFromPlugin(t *testing.T) {
 	require.NoError(t, err)
 	require.Equal(t, "Instance", result)
 
-	url = "unix://" + host + "/info/functions.json"
-	buff, err = template.Fetch(url, template.Options{SocketDir: dir}, nil)
+	url = "unix://" + socketPath
+	buff, err = template.Fetch(url, template.Options{
+		CustomizeFetch: func(req *http.Request) {
+			req.URL.Path = "/info/functions.json"
+			req.URL.Host = "h"
+		},
+	})
 	require.NoError(t, err)
 
 	server.Stop()
@@ -83,15 +91,18 @@ func (p *exporter) Funcs() []template.Function {
 
 func TestFetchFunctionsFromPlugin(t *testing.T) {
 	socketPath := tempSocket()
-	dir := filepath.Dir(socketPath)
-	host := filepath.Base(socketPath)
 
-	url := "unix://" + host + "/info/functions.json"
+	url := "unix://" + socketPath
 
 	server, err := StartPluginAtPath(socketPath, rpc_flavor.PluginServer(&exporter{&testing_flavor.Plugin{}}))
 	require.NoError(t, err)
 
-	buff, err := template.Fetch(url, template.Options{SocketDir: dir}, nil)
+	buff, err := template.Fetch(url, template.Options{
+		CustomizeFetch: func(req *http.Request) {
+			req.URL.Path = "/info/functions.json"
+			req.URL.Host = "d"
+		},
+	})
 	require.NoError(t, err)
 
 	decoded, err := template.FromJSON(buff)
diff --git a/pkg/template/fetch.go b/pkg/template/fetch.go
@@ -7,11 +7,10 @@ import (
 	"net/http"
 	"net/url"
 	"os"
-	"path/filepath"
 )
 
 // Fetch fetchs content from the given URL string.  Supported schemes are http:// https:// file:// unix://
-func Fetch(s string, opt Options, customize func(*http.Request)) ([]byte, error) {
+func Fetch(s string, opt Options) ([]byte, error) {
 	u, err := url.Parse(s)
 	if err != nil {
 		return nil, err
@@ -21,17 +20,17 @@ func Fetch(s string, opt Options, customize func(*http.Request)) ([]byte, error)
 		return ioutil.ReadFile(u.Path)
 
 	case "http", "https":
-		return doHTTPGet(u, customize, &http.Client{})
+		return doHTTPGet(u, opt.CustomizeFetch, &http.Client{})
 
 	case "unix":
 		// unix: will look for a socket that matches the host name at a
 		// directory path set by environment variable.
-		c, err := socketClient(u, opt.SocketDir)
+		c, err := socketClient(u)
 		if err != nil {
 			return nil, err
 		}
 		u.Scheme = "http"
-		return doHTTPGet(u, customize, c)
+		return doHTTPGet(u, opt.CustomizeFetch, c)
 	}
 
 	return nil, fmt.Errorf("unsupported url:%s", s)
@@ -55,8 +54,8 @@ func doHTTPGet(u *url.URL, customize func(*http.Request), client *http.Client) (
 	return ioutil.ReadAll(resp.Body)
 }
 
-func socketClient(u *url.URL, socketDir string) (*http.Client, error) {
-	socketPath := filepath.Join(socketDir, u.Host)
+func socketClient(u *url.URL) (*http.Client, error) {
+	socketPath := u.Path
 	if f, err := os.Stat(socketPath); err != nil {
 		return nil, err
 	} else if f.Mode()&os.ModeSocket == 0 {
diff --git a/pkg/template/funcs.go b/pkg/template/funcs.go
@@ -181,7 +181,8 @@ func (t *Template) DefaultFuncs() []Function {
 				"Source / evaluate the template at the input location (as URL).",
 				"This will make all of the global variables declared there visible in this template's context.",
 				"Similar to 'source' in bash, sourcing another template means applying it in the same context ",
-				"as the calling template.  The context (e.g. variables) of the calling template as a result can be mutated.",
+				"as the calling template.  The context (e.g. variables) of the calling template as a result can",
+				"be mutated.",
 			},
 			Func: func(p string, opt ...interface{}) (string, error) {
 				headers, context := headersAndContext(opt...)
@@ -193,7 +194,15 @@ func (t *Template) DefaultFuncs() []Function {
 					}
 					loc = buff
 				}
-				sourced, err := NewTemplateCustom(loc, t.options, func(req *http.Request) { setHeaders(req, headers) })
+
+				prev := t.options.CustomizeFetch
+				t.options.CustomizeFetch = func(req *http.Request) {
+					setHeaders(req, headers)
+					if prev != nil {
+						prev(req)
+					}
+				}
+				sourced, err := NewTemplate(loc, t.options)
 				if err != nil {
 					return "", err
 				}
@@ -228,7 +237,16 @@ func (t *Template) DefaultFuncs() []Function {
 					}
 					loc = buff
 				}
-				included, err := NewTemplateCustom(loc, t.options, func(req *http.Request) { setHeaders(req, headers) })
+
+				prev := t.options.CustomizeFetch
+				t.options.CustomizeFetch = func(req *http.Request) {
+					setHeaders(req, headers)
+					if prev != nil {
+						prev(req)
+					}
+				}
+
+				included, err := NewTemplate(loc, t.options)
 				if err != nil {
 					return "", err
 				}
diff --git a/pkg/template/template.go b/pkg/template/template.go
@@ -53,9 +53,8 @@ type Context interface {
 // Options contains parameters for customizing the behavior of the engine
 type Options struct {
 
-	// SocketDir is the directory for locating the socket file for
-	// a template URL of the form unix://socket_file/path/to/resource
-	SocketDir string
+	// CustomizeFetch allows setting of http request header, etc. during fetch
+	CustomizeFetch func(*http.Request)
 }
 
 type defaultValue struct {
@@ -89,25 +88,6 @@ type Void string
 
 const voidValue Void = ""
 
-// NewTemplateCustom fetches the content at the url and allows configuration of the request
-// If the string begins with str:// as scheme, then the rest of the string is interpreted as the body of the template.
-func NewTemplateCustom(s string, opt Options, custom func(*http.Request)) (*Template, error) {
-	var buff []byte
-	contextURL := s
-	// Special case of specifying the entire template as a string; otherwise treat as url
-	if strings.Index(s, "str://") == 0 {
-		buff = []byte(strings.Replace(s, "str://", "", 1))
-		contextURL = defaultContextURL()
-	} else {
-		b, err := Fetch(s, opt, custom)
-		if err != nil {
-			return nil, err
-		}
-		buff = b
-	}
-	return NewTemplateFromBytes(buff, contextURL, opt)
-}
-
 // NewTemplate fetches the content at the url and returns a template.  If the string begins
 // with str:// as scheme, then the rest of the string is interpreted as the body of the template.
 func NewTemplate(s string, opt Options) (*Template, error) {
@@ -118,7 +98,7 @@ func NewTemplate(s string, opt Options) (*Template, error) {
 		buff = []byte(strings.Replace(s, "str://", "", 1))
 		contextURL = defaultContextURL()
 	} else {
-		b, err := Fetch(s, opt, nil)
+		b, err := Fetch(s, opt)
 		if err != nil {
 			return nil, err
 		}

Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,7 @@ func init() {`
`24`	`24`	`})`
`25`	`25`	`}`
`26`	`26`
`27`		`-var defaultTemplateOptions = template.Options{`
`28`		`- SocketDir: local.Dir(),`
`29`		`-}`
	`27`	`+var defaultTemplateOptions = template.Options{}`
`30`	`28`
`31`	`29`	`func main() {`
`32`	`30`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@ import (`
`7`	`7`	`"strings"`
`8`	`8`
`9`	`9`	`log "github.com/Sirupsen/logrus"`
`10`		`- "github.com/docker/infrakit/pkg/discovery/local"`
`11`	`10`	`plugin_base "github.com/docker/infrakit/pkg/plugin"`
`12`	`11`	`"github.com/docker/infrakit/pkg/spi/instance"`
`13`	`12`	`"github.com/docker/infrakit/pkg/spi/resource"`
`@@ -76,7 +75,7 @@ func (p *plugin) Commit(config resource.Spec, pretend bool) (string, error) {`
`76`	`75`	`continue`
`77`	`76`	`}`
`78`	`77`
`79`		`- template, err := template.NewTemplate("str://"+resourceConfigs[name].properties, template.Options{SocketDir: local.Dir()})`
	`78`	`+ template, err := template.NewTemplate("str://"+resourceConfigs[name].properties, template.Options{})`
`80`	`79`	`if err != nil {`
`81`	`80`	`return "", fmt.Errorf("Failed to parse template '%s' for resource '%s': %s", resourceConfigs[name].properties, name, err)`
`82`	`81`	`}`
`@@ -272,7 +271,7 @@ func getProvisioningOrder(resourceConfigs map[string]resourceConfig) ([]string,`
`272`	`271`	`}`
`273`	`272`
`274`	`273`	`for name, resourceConfig := range resourceConfigs {`
`275`		`- template, err := template.NewTemplate("str://"+resourceConfig.properties, template.Options{SocketDir: local.Dir()})`
	`274`	`+ template, err := template.NewTemplate("str://"+resourceConfig.properties, template.Options{})`
`276`	`275`	`if err != nil {`
`277`	`276`	`return nil, fmt.Errorf("Failed to parse template for resource '%s': %s", name, err)`
`278`	`277`	`}`