github.com/blp1526/goa@v1.4.0/goagen/gen_client/cli_generator_test.go

package genclient_test

import (
	"bytes"
	"html/template"
	"io/ioutil"
	"os"
	"path/filepath"
	"strings"

	"github.com/goadesign/goa/design"
	"github.com/goadesign/goa/dslengine"
	"github.com/goadesign/goa/goagen/codegen"
	"github.com/goadesign/goa/goagen/gen_client"
	"github.com/goadesign/goa/version"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
	"github.com/onsi/gomega/gexec"
)

var _ = Describe("Generate", func() {
	var testgenPackagePath = filepath.FromSlash("github.com/goadesign/goa/goagen/gen_client/test_")

	var outDir string
	var files []string
	var genErr error

	BeforeEach(func() {
		gopath := filepath.SplitList(os.Getenv("GOPATH"))[0]
		outDir = filepath.Join(gopath, "src", testgenPackagePath)
		err := os.MkdirAll(outDir, 0777)
		Ω(err).ShouldNot(HaveOccurred())
		os.Args = []string{"goagen", "--out=" + outDir, "--design=foo", "--version=" + version.String()}
	})

	JustBeforeEach(func() {
		files, genErr = genclient.Generate()
	})

	AfterEach(func() {
		os.RemoveAll(outDir)
		delete(codegen.Reserved, "client")
	})

	Context("with a dummy API", func() {
		BeforeEach(func() {
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
			}
		})

		It("generates a dummy app", func() {
			Ω(genErr).Should(BeNil())
			Ω(files).Should(HaveLen(8))
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "testapi-cli", "main.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(len(strings.Split(content, "\n"))).Should(BeNumerically(">=", 16))
			_, err = gexec.Build(filepath.Join(testgenPackagePath, "tool", "testapi-cli"))
			Ω(err).ShouldNot(HaveOccurred())
		})

		Context("generated commands.go", func() {
			var commandHeader string

			funcs := template.FuncMap{
				"sep": func() string { return string(os.PathSeparator) },
			}

			BeforeEach(func() {
				data := map[string]string{
					"outDir":  outDir,
					"design":  "foo",
					"tmpDir":  testgenPackagePath,
					"version": version.String(),
					"title":   "CLI Commands",
				}

				// Generate Headers
				clientHeaderT, err := template.New("context").Funcs(funcs).Parse(clientHeaderTmpl)
				Ω(err).ShouldNot(HaveOccurred())
				var b bytes.Buffer
				err = clientHeaderT.Execute(&b, data)
				Ω(err).ShouldNot(HaveOccurred())
				commandHeader = b.String()
			})

			It("generates \"generated by\" header", func() {
				Ω(genErr).Should(BeNil())
				c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
				content := string(c)
				Ω(err).ShouldNot(HaveOccurred())
				Ω(content).Should(HavePrefix(commandHeader))
			})
		})
	})

	Context("with an action with two parameters", func() {
		BeforeEach(func() {
			codegen.TempCount = 0
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
				Resources: map[string]*design.ResourceDefinition{
					"foo": {
						Name: "foo",
						Actions: map[string]*design.ActionDefinition{
							"show": {
								Name: "show",
								Params: &design.AttributeDefinition{
									Type: design.Object{
										"nicID":     &design.AttributeDefinition{Type: design.String},
										"ipAddress": &design.AttributeDefinition{Type: design.String},
									},
								},
								Routes: []*design.RouteDefinition{
									{
										Verb: "GET",
										Path: "/nics/:nicID/add/:ipAddress",
									},
								},
							},
						},
					},
				},
			}
			fooRes := design.Design.Resources["foo"]
			showAct := fooRes.Actions["show"]
			showAct.Parent = fooRes
			showAct.Routes[0].Parent = showAct
		})

		It("generate the correct command path formatting code", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(`path = fmt.Sprintf("/nics/%v/add/%v", url.QueryEscape(cmd.NicID), url.QueryEscape(cmd.IPAddress)`))
		})
	})

	Context("with a resource name with underscores characters", func() {
		BeforeEach(func() {
			codegen.TempCount = 0
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
				Resources: map[string]*design.ResourceDefinition{
					"foo_test": {
						Name: "foo_test",
						Actions: map[string]*design.ActionDefinition{
							"show": {
								Name: "show",
								Params: &design.AttributeDefinition{
									Type: design.Object{
										"nicID":     &design.AttributeDefinition{Type: design.String},
										"ipAddress": &design.AttributeDefinition{Type: design.String},
									},
								},
								Routes: []*design.RouteDefinition{
									{
										Verb: "GET",
										Path: "/nics/:nicID/add/:ipAddress",
									},
								},
							},
						},
					},
				},
			}
			fooRes := design.Design.Resources["foo_test"]
			showAct := fooRes.Actions["show"]
			showAct.Parent = fooRes
			showAct.Routes[0].Parent = showAct
		})

		It("generate the correct command path formatting code", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring("foo-test"))
		})
	})

	Context("with an action with an integer parameter with no default value", func() {
		BeforeEach(func() {
			codegen.TempCount = 0
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
				Resources: map[string]*design.ResourceDefinition{
					"foo": {
						Name: "foo",
						Actions: map[string]*design.ActionDefinition{
							"show": {
								Name: "show",
								QueryParams: &design.AttributeDefinition{
									Type: design.Object{
										"param":       &design.AttributeDefinition{Type: design.Integer},
										"time":        &design.AttributeDefinition{Type: design.DateTime},
										"uuid":        &design.AttributeDefinition{Type: design.UUID},
										"any":         &design.AttributeDefinition{Type: design.Any},
										"bool":        &design.AttributeDefinition{Type: design.Boolean},
										"number":      &design.AttributeDefinition{Type: design.Number},
										"boolReq":     &design.AttributeDefinition{Type: design.Boolean},
										"timeArray":   &design.AttributeDefinition{Type: &design.Array{ElemType: &design.AttributeDefinition{Type: design.DateTime}}},
										"uuidArray":   &design.AttributeDefinition{Type: &design.Array{ElemType: &design.AttributeDefinition{Type: design.UUID}}},
										"anyArray":    &design.AttributeDefinition{Type: &design.Array{ElemType: &design.AttributeDefinition{Type: design.Any}}},
										"boolArray":   &design.AttributeDefinition{Type: &design.Array{ElemType: &design.AttributeDefinition{Type: design.Boolean}}},
										"numberArray": &design.AttributeDefinition{Type: &design.Array{ElemType: &design.AttributeDefinition{Type: design.Number}}},
									},
									Validation: &dslengine.ValidationDefinition{Required: []string{"boolReq"}},
								},
								Routes: []*design.RouteDefinition{
									{
										Verb: "GET",
										Path: "",
									},
								},
							},
						},
					},
				},
			}
			fooRes := design.Design.Resources["foo"]
			showAct := fooRes.Actions["show"]
			showAct.Parent = fooRes
			showAct.Routes[0].Parent = showAct
		})

		It("generate the correct handling for special type DateTime", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = timeVal(cmd.Time)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.Time, "))
		})
		It("generate the correct handling for special type DateTime Array", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = timeArray(cmd.TimeArray)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringSliceVar(&cmd.TimeArray, "))
		})
		It("generate the correct handling for special type Number", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = float64Val(cmd.Number)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.Number, "))
		})
		It("generate the correct handling for special type Number Array", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = float64Array(cmd.NumberArray)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringSliceVar(&cmd.NumberArray, "))
		})
		It("generate the correct handling for special type Boolean", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = boolVal(cmd.Bool)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.Bool, "))
		})
		It("generate the correct handling for special type Boolean Array", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = boolArray(cmd.BoolArray)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringSliceVar(&cmd.BoolArray, "))
		})
		It("generate the correct handling for special type required Boolean", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = boolVal(cmd.BoolReq)"))
			Ω(content).Should(ContainSubstring(", *tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.BoolReq, "))
		})
		It("generate the correct handling for special type UUID", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = uuidVal(cmd.UUID)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.UUID, "))
		})
		It("generate the correct handling for special type UUID Array", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = uuidArray(cmd.UUIDArray)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringSliceVar(&cmd.UUIDArray, "))
		})
		It("generate the correct handling for special type Any", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = jsonVal(cmd.Any)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringVar(&cmd.Any, "))
		})
		It("generate the correct handling for special type Any Array", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring(", err = jsonArray(cmd.AnyArray)"))
			Ω(content).Should(ContainSubstring(", tmp"))
			Ω(content).Should(ContainSubstring("cc.Flags().StringSliceVar(&cmd.AnyArray, "))
		})

		It("generates the correct command flag initialization code", func() {
			Ω(genErr).Should(BeNil())
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(len(strings.Split(content, "\n"))).Should(BeNumerically(">=", 3))
			Ω(content).Should(ContainSubstring("var param int"))
			Ω(content).Should(ContainSubstring("var time_ string"))
			Ω(content).Should(ContainSubstring(".Flags()"))
			_, err = gexec.Build(filepath.Join(testgenPackagePath, "tool", "testapi-cli"))
			Ω(err).ShouldNot(HaveOccurred())

		})

		Context("with an action with a multiline description", func() {
			const multiline = "multi\nline"

			BeforeEach(func() {
				design.Design.Resources["foo"].Actions["show"].Description = multiline
			})

			It("properly escapes the multi-line string used in the short description", func() {
				Ω(genErr).Should(BeNil())
				Ω(files).Should(HaveLen(9))
				c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
				content := string(c)
				Ω(err).ShouldNot(HaveOccurred())
				Ω(content).Should(ContainSubstring(multiline))
			})
		})

		Context("with an action with a description containing backticks", func() {
			const pre = "pre"
			const post = "post"

			BeforeEach(func() {
				design.Design.Resources["foo"].Actions["show"].Description = pre + "`" + post
			})

			It("properly escapes the multi-line string used in the short description", func() {
				Ω(genErr).Should(BeNil())
				Ω(files).Should(HaveLen(9))
				c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
				content := string(c)
				Ω(err).ShouldNot(HaveOccurred())
				Ω(content).Should(ContainSubstring(pre + "` + \"`\" + `" + post))
			})
		})
	})
	Context("with an action with a special typed UUID path param", func() {
		BeforeEach(func() {
			codegen.TempCount = 0
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
				Resources: map[string]*design.ResourceDefinition{
					"foo": {
						Name: "foo",
						Actions: map[string]*design.ActionDefinition{
							"show": {
								Name: "show",
								Params: &design.AttributeDefinition{
									Type: design.Object{
										"id": &design.AttributeDefinition{Type: design.UUID},
									},
									Validation: &dslengine.ValidationDefinition{Required: []string{"id"}},
								},
								Routes: []*design.RouteDefinition{
									{
										Verb: "GET",
										Path: "resource/:id",
									},
								},
							},
						},
					},
				},
			}
			fooRes := design.Design.Resources["foo"]
			showAct := fooRes.Actions["show"]
			showAct.Parent = fooRes
			showAct.Routes[0].Parent = showAct
		})

		It("generates direct access to Command field when resolving path", func() {
			Ω(genErr).Should(BeNil())
			Ω(files).Should(HaveLen(9))
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "cli", "commands.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring("path = fmt.Sprintf(\"/resource/%v\", cmd.ID)"))
		})
	})

	Context("with an action with security configured", func() {
		BeforeEach(func() {
			codegen.TempCount = 0
			securitySchemeDef := &design.SecuritySchemeDefinition{
				SchemeName: "jwt-1",
				Kind:       design.JWTSecurityKind,
			}
			design.Design = &design.APIDefinition{
				Name:        "testapi",
				Title:       "dummy API with no resource",
				Description: "I told you it's dummy",
				Consumes:    design.DefaultEncoders,
				SecuritySchemes: []*design.SecuritySchemeDefinition{
					securitySchemeDef,
				},
				Resources: map[string]*design.ResourceDefinition{
					"foo": {
						Name: "foo",
						Actions: map[string]*design.ActionDefinition{
							"show": {
								Name: "show",
								QueryParams: &design.AttributeDefinition{
									Type: design.Object{
										"param": &design.AttributeDefinition{Type: design.Integer},
										"time":  &design.AttributeDefinition{Type: design.DateTime},
									},
								},
								Routes: []*design.RouteDefinition{
									{
										Verb: "GET",
										Path: "",
									},
								},
								Security: &design.SecurityDefinition{
									Scheme: securitySchemeDef,
								},
							},
						},
					},
				},
			}
			fooRes := design.Design.Resources["foo"]
			showAct := fooRes.Actions["show"]
			showAct.Parent = fooRes
			showAct.Routes[0].Parent = showAct
		})

		It("generates registers the signer flags from main", func() {
			Ω(genErr).Should(BeNil())
			Ω(files).Should(HaveLen(9))
			c, err := ioutil.ReadFile(filepath.Join(outDir, "tool", "testapi-cli", "main.go"))
			content := string(c)
			Ω(err).ShouldNot(HaveOccurred())
			Ω(content).Should(ContainSubstring("jwt1Signer := newJWT1Signer()"))
			Ω(content).Should(ContainSubstring("c.SetJWT1Signer(jwt1Signer)"))
		})
	})
})