Merge pull request #44 from cloudfoundry/dk-out-flag

--path flag to pull out values out of manifest

cmd/build_manifest.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"github.com/cppforlife/go-patch/patch"
+
 	boshtpl "github.com/cloudfoundry/bosh-cli/director/template"
 	boshui "github.com/cloudfoundry/bosh-cli/ui"
 )
@@ -20,6 +22,13 @@ func (c BuildManifestCmd) Run(opts BuildManifestOpts) error {
 	ops := opts.OpsFlags.AsOps()
 	evalOpts := boshtpl.EvaluateOpts{ExpectAllKeys: opts.VarErrors}
 
+	if opts.Path != nil {
+		ops = patch.Ops{ops, patch.FindOp{Path: *opts.Path}}
+
+		// Printing YAML indented multiline strings (eg SSH key) is not useful
+		evalOpts.UnescapedMultiline = true
+	}
+
 	bytes, err := tpl.Evaluate(vars, ops, evalOpts)
 	if err != nil {
 		return err

cmd/build_manifest_test.go

@@ -61,6 +61,61 @@ var _ = Describe("BuildManifestCmd", func() {
 			Expect(ui.Blocks).To(Equal([]string{bytes}))
 		})
 
+		It("returns portion of the template if out path is given", func() {
+			opts.Args.Manifest = FileBytesArg{
+				Bytes: []byte("name1: ((name1))\nname2: ((name2))"),
+			}
+
+			opts.VarKVs = []boshtpl.VarKV{
+				{Name: "name1", Value: "val1-from-kv"},
+			}
+
+			opts.VarsFiles = []boshtpl.VarsFileArg{
+				{Vars: boshtpl.Variables(map[string]interface{}{"var": "var-val"})},
+			}
+
+			opts.OpsFiles = []OpsFileArg{
+				{
+					Ops: patch.Ops([]patch.Op{
+						patch.ReplaceOp{Path: patch.MustNewPointerFromString("/name2"), Value: "((var))"},
+					}),
+				},
+			}
+
+			ptr := patch.MustNewPointerFromString("/name2")
+			opts.Path = &ptr
+
+			err := act()
+			Expect(err).ToNot(HaveOccurred())
+			Expect(ui.Blocks).To(Equal([]string{"var-val\n"}))
+		})
+
+		It("returns portion of the template formatting multiline string without YAML indent", func() {
+			opts.Args.Manifest = FileBytesArg{
+				Bytes: []byte(`key: "line1\nline2"`),
+			}
+
+			ptr := patch.MustNewPointerFromString("/key")
+			opts.Path = &ptr
+
+			err := act()
+			Expect(err).ToNot(HaveOccurred())
+			Expect(ui.Blocks).To(Equal([]string{"line1\nline2\n"}))
+		})
+
+		It("returns portion of the template formatting result as regular YAML", func() {
+			opts.Args.Manifest = FileBytesArg{
+				Bytes: []byte("key:\n  subkey:\n    subsubkey: key"),
+			}
+
+			ptr := patch.MustNewPointerFromString("/key")
+			opts.Path = &ptr
+
+			err := act()
+			Expect(err).ToNot(HaveOccurred())
+			Expect(ui.Blocks).To(Equal([]string{"subkey:\n  subsubkey: key\n"}))
+		})
+
 		It("returns error if variables are not found in templated manifest if var-errors flag is set", func() {
 			opts.Args.Manifest = FileBytesArg{
 				Bytes: []byte("name1: ((name1))\nname2: ((name2))"),

cmd/factory_test.go

@@ -269,6 +269,7 @@ var _ = Describe("Factory", func() {
 			boshOpts.ExportRelease = ExportReleaseOpts{}
 			boshOpts.RunErrand = RunErrandOpts{}
 			boshOpts.Logs = LogsOpts{}
+			boshOpts.BuildManifest = BuildManifestOpts{}
 			boshOpts.InitRelease = InitReleaseOpts{}
 			boshOpts.ResetRelease = ResetReleaseOpts{}
 			boshOpts.GenerateJob = GenerateJobOpts{}

cmd/opts.go

@@ -1,6 +1,8 @@
 package cmd
 
 import (
+	"github.com/cppforlife/go-patch/patch"
+
 	boshdir "github.com/cloudfoundry/bosh-cli/director"
 	boshrel "github.com/cloudfoundry/bosh-cli/release"
 )
@@ -272,9 +274,13 @@ type AttachDiskArgs struct {
 
 type BuildManifestOpts struct {
 	Args BuildManifestArgs `positional-args:"true" required:"true"`
+
 	VarFlags
 	OpsFlags
-	VarErrors bool `long:"var-errs" description:"Expect all variables to be found, otherwise error"`
+
+	Path      *patch.Pointer `long:"path"     value-name:"OP-PATH" description:"Extract value out of template (e.g.: /private_key)"`
+	VarErrors bool           `long:"var-errs"                      description:"Expect all variables to be found, otherwise error"`
+
 	cmd
 }
 

cmd/opts_test.go

@@ -1013,6 +1013,14 @@ var _ = Describe("Opts", func() {
 			})
 		})
 
+		Describe("Path", func() {
+			It("contains desired values", func() {
+				Expect(getStructTagForName("Path", opts)).To(Equal(
+					`long:"path" value-name:"OP-PATH" description:"Extract value out of template (e.g.: /private_key)"`,
+				))
+			})
+		})
+
 		Describe("VarErrors", func() {
 			It("contains desired values", func() {
 				Expect(getStructTagForName("VarErrors", opts)).To(Equal(

deps.txt

@@ -22,7 +22,7 @@ github.com/jmespath/go-jmespath:0b12d6b
 github.com/charlievieth/fs/...:1c3b3f1
 github.com/hashicorp/errwrap/...:7554cd9
 github.com/bmatcuk/doublestar/...:044df0a
-github.com/cppforlife/go-patch/patch:661a67c
+github.com/cppforlife/go-patch/patch:a15438b
 github.com/pivotal-golang/s3cli:90561c0
 github.com/golang/protobuf/proto:98fa357
 github.com/aws/aws-sdk-go:1a651d9

director/template/template.go

@@ -17,7 +17,8 @@ type Template struct {
 }
 
 type EvaluateOpts struct {
-	ExpectAllKeys bool
+	ExpectAllKeys      bool
+	UnescapedMultiline bool
 }
 
 func NewTemplate(bytes []byte) Template {
@@ -53,6 +54,12 @@ func (t Template) Evaluate(vars Variables, ops patch.Ops, opts EvaluateOpts) ([]
 		return []byte{}, fmt.Errorf("Expected to find variables: %s", strings.Join(missingVarKeys, ", "))
 	}
 
+	if opts.UnescapedMultiline {
+		if _, ok := obj.(string); ok {
+			return []byte(fmt.Sprintf("%s\n", obj)), nil
+		}
+	}
+
 	bytes, err := yaml.Marshal(obj)
 	if err != nil {
 		return []byte{}, err

director/template/template_test.go

@@ -228,4 +228,16 @@ array:
 		Expect(err).To(HaveOccurred())
 		Expect(err.Error()).To(Equal("Expected to find a map key 'x' for path '/x'"))
 	})
+
+	It("returns raw bytes of a string if UnescapedMultiline is true", func() {
+		template := NewTemplate([]byte("value"))
+
+		result, err := template.Evaluate(Variables{}, patch.Ops{}, EvaluateOpts{})
+		Expect(err).NotTo(HaveOccurred())
+		Expect(result).To(Equal([]byte("value\n")))
+
+		result, err = template.Evaluate(Variables{}, patch.Ops{}, EvaluateOpts{UnescapedMultiline: true})
+		Expect(err).NotTo(HaveOccurred())
+		Expect(result).To(Equal([]byte("value\n")))
+	})
 })