github.com/brycereitano/goa@v0.0.0-20170315073847-8ffa6c85e265/goagen/codegen/types_test.go

package codegen_test

import (
	"fmt"
	"strings"

	. "github.com/goadesign/goa/design"
	. "github.com/goadesign/goa/design/apidsl"
	"github.com/goadesign/goa/dslengine"
	"github.com/goadesign/goa/goagen/codegen"
	. "github.com/onsi/ginkgo"
	. "github.com/onsi/gomega"
)

var _ = Describe("code generation", func() {
	BeforeEach(func() {
		codegen.TempCount = 0
	})

	Describe("Goify", func() {
		Context("given a string with an initialism", func() {
			var str, goified, expected string
			var firstUpper bool
			JustBeforeEach(func() {
				goified = codegen.Goify(str, firstUpper)
			})

			Context("with first upper false", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "blue_id"
					expected = "blueID"
				})
				It("creates a lowercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper false normal identifier", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "blue"
					expected = "blue"
				})
				It("creates an uppercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper false and UUID", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "blue_uuid"
					expected = "blueUUID"
				})
				It("creates an uppercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper true", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "blue_id"
					expected = "BlueID"
				})
				It("creates an uppercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper true and UUID", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "blue_uuid"
					expected = "BlueUUID"
				})
				It("creates an uppercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper true normal identifier", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "blue"
					expected = "Blue"
				})
				It("creates an uppercased camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper false normal identifier", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "Blue"
					expected = "blue"
				})
				It("creates a lowercased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with first upper true normal identifier", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "Blue"
					expected = "Blue"
				})
				It("creates an uppercased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})
			Context("with invalid identifier", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "Blue%50"
					expected = "Blue50"
				})
				It("creates an uppercased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

			Context("with invalid identifier firstupper false", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "Blue%50"
					expected = "blue50"
				})
				It("creates an uppercased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

			Context("with only UUID and firstupper false", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "UUID"
					expected = "uuid"
				})
				It("creates a lowercased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

			Context("with consecutives invalid identifiers", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "[[fields___type]]"
					expected = "fieldsType"
				})
				It("creates a camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

			Context("with consecutives invalid identifiers", func() {
				BeforeEach(func() {
					firstUpper = true
					str = "[[fields___type]]"
					expected = "FieldsType"
				})
				It("creates a camelcased string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

			Context("with all invalid identifiers", func() {
				BeforeEach(func() {
					firstUpper = false
					str = "[["
					expected = ""
				})
				It("creates an empty string", func() {
					Ω(goified).Should(Equal(expected))
				})
			})

		})

	})

	Describe("GoTypeDef", func() {
		Context("given an attribute definition with fields", func() {
			var att *AttributeDefinition
			var object Object
			var required *dslengine.ValidationDefinition
			var st string

			JustBeforeEach(func() {
				att = new(AttributeDefinition)
				att.Type = object
				if required != nil {
					att.Validation = required
				}
				st = codegen.GoTypeDef(att, 0, true, false)
			})

			Context("of primitive types", func() {
				BeforeEach(func() {
					object = Object{
						"foo": &AttributeDefinition{Type: Integer},
						"bar": &AttributeDefinition{Type: String},
						"baz": &AttributeDefinition{Type: DateTime},
						"qux": &AttributeDefinition{Type: UUID},
					}
					required = nil
				})

				It("produces the struct go code", func() {
					expected := "struct {\n" +
						"	Bar *string `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n" +
						"	Baz *time.Time `form:\"baz,omitempty\" json:\"baz,omitempty\" xml:\"baz,omitempty\"`\n" +
						"	Foo *int `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n" +
						"	Qux *uuid.UUID `form:\"qux,omitempty\" json:\"qux,omitempty\" xml:\"qux,omitempty\"`\n" +
						"}"
					Ω(st).Should(Equal(expected))
				})

				Context("using struct tags metadata", func() {
					tn1 := "struct:tag:foo"
					tv11 := "bar"
					tv12 := "baz"
					tn2 := "struct:tag:foo2"
					tv21 := "bar2"

					BeforeEach(func() {
						object["foo"].Metadata = dslengine.MetadataDefinition{
							tn1: []string{tv11, tv12},
							tn2: []string{tv21},
						}
					})

					It("produces the struct tags", func() {
						expected := fmt.Sprintf("struct {\n"+
							"	Bar *string `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n"+
							"	Baz *time.Time `form:\"baz,omitempty\" json:\"baz,omitempty\" xml:\"baz,omitempty\"`\n"+
							"	Foo *int `%s:\"%s,%s\" %s:\"%s\"`\n"+
							"	Qux *uuid.UUID `form:\"qux,omitempty\" json:\"qux,omitempty\" xml:\"qux,omitempty\"`\n"+
							"}", tn1[11:], tv11, tv12, tn2[11:], tv21)
						Ω(st).Should(Equal(expected))
					})
				})

				Context("using struct field name metadata", func() {
					BeforeEach(func() {
						object["foo"].Metadata = dslengine.MetadataDefinition{
							"struct:field:name": []string{"serviceName", "unused"},
						}
					})

					It("produces the struct tags", func() {
						expected := "struct {\n" +
							"	Bar *string `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n" +
							"	Baz *time.Time `form:\"baz,omitempty\" json:\"baz,omitempty\" xml:\"baz,omitempty\"`\n" +
							"	ServiceName *int `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n" +
							"	Qux *uuid.UUID `form:\"qux,omitempty\" json:\"qux,omitempty\" xml:\"qux,omitempty\"`\n" +
							"}"
						Ω(st).Should(Equal(expected))
					})
				})

				Context("using struct field type metadata", func() {
					BeforeEach(func() {
						object["foo"].Metadata = dslengine.MetadataDefinition{
							"struct:field:type": []string{"[]byte"},
						}
					})

					It("produces the struct tags", func() {
						expected := "struct {\n" +
							"	Bar *string `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n" +
							"	Baz *time.Time `form:\"baz,omitempty\" json:\"baz,omitempty\" xml:\"baz,omitempty\"`\n" +
							"	Foo []byte `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n" +
							"	Qux *uuid.UUID `form:\"qux,omitempty\" json:\"qux,omitempty\" xml:\"qux,omitempty\"`\n" +
							"}"
						Ω(st).Should(Equal(expected))
					})
				})
			})

			Context("of hash of primitive types", func() {
				BeforeEach(func() {
					elemType := &AttributeDefinition{Type: Integer}
					keyType := &AttributeDefinition{Type: Integer}
					hash := &Hash{KeyType: keyType, ElemType: elemType}
					object = Object{
						"foo": &AttributeDefinition{Type: hash},
					}
					required = nil
				})

				It("produces the struct go code", func() {
					Ω(st).Should(Equal("struct {\n\tFoo map[int]int `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n}"))
				})
			})

			Context("of array of primitive types", func() {
				BeforeEach(func() {
					elemType := &AttributeDefinition{Type: Integer}
					array := &Array{ElemType: elemType}
					object = Object{
						"foo": &AttributeDefinition{Type: array},
					}
					required = nil
				})

				It("produces the struct go code", func() {
					Ω(st).Should(Equal("struct {\n\tFoo []int `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n}"))
				})
			})

			Context("of hash of objects", func() {
				BeforeEach(func() {
					elem := Object{
						"elemAtt": &AttributeDefinition{Type: Integer},
					}
					key := Object{
						"keyAtt": &AttributeDefinition{Type: String},
					}
					elemType := &AttributeDefinition{Type: elem}
					keyType := &AttributeDefinition{Type: key}
					hash := &Hash{KeyType: keyType, ElemType: elemType}
					object = Object{
						"foo": &AttributeDefinition{Type: hash},
					}
					required = nil
				})

				It("produces the struct go code", func() {
					expected := "struct {\n" +
						"	Foo map[*struct {\n" +
						"		KeyAtt *string `form:\"keyAtt,omitempty\" json:\"keyAtt,omitempty\" xml:\"keyAtt,omitempty\"`\n" +
						"	}]*struct {\n" +
						"		ElemAtt *int `form:\"elemAtt,omitempty\" json:\"elemAtt,omitempty\" xml:\"elemAtt,omitempty\"`\n" +
						"	} `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n" +
						"}"
					Ω(st).Should(Equal(expected))
				})
			})

			Context("of array of objects", func() {
				BeforeEach(func() {
					obj := Object{
						"bar": &AttributeDefinition{Type: Integer},
					}
					elemType := &AttributeDefinition{Type: obj}
					array := &Array{ElemType: elemType}
					object = Object{
						"foo": &AttributeDefinition{Type: array},
					}
					required = nil
				})

				It("produces the struct go code", func() {
					expected := "struct {\n" +
						"	Foo []*struct {\n" +
						"		Bar *int `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n" +
						"	} `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n" +
						"}"
					Ω(st).Should(Equal(expected))
				})

				Context("that are required", func() {
					BeforeEach(func() {
						required = &dslengine.ValidationDefinition{
							Required: []string{"foo"},
						}
					})

					It("produces the struct go code", func() {
						expected := "struct {\n" +
							"	Foo []*struct {\n" +
							"		Bar *int `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n" +
							"	} `form:\"foo\" json:\"foo\" xml:\"foo\"`\n" +
							"}"
						Ω(st).Should(Equal(expected))
					})
				})
			})

			Context("that are required", func() {
				BeforeEach(func() {
					object = Object{
						"foo": &AttributeDefinition{Type: Integer},
					}
					required = &dslengine.ValidationDefinition{
						Required: []string{"foo"},
					}
				})

				It("produces the struct go code", func() {
					expected := "struct {\n" +
						"	Foo int `form:\"foo\" json:\"foo\" xml:\"foo\"`\n" +
						"}"
					Ω(st).Should(Equal(expected))
				})
			})

		})

		Context("given an array", func() {
			var elemType *AttributeDefinition
			var source string

			JustBeforeEach(func() {
				array := &Array{ElemType: elemType}
				att := &AttributeDefinition{Type: array}
				source = codegen.GoTypeDef(att, 0, true, false)
			})

			Context("of primitive type", func() {
				BeforeEach(func() {
					elemType = &AttributeDefinition{Type: Integer}
				})

				It("produces the array go code", func() {
					Ω(source).Should(Equal("[]int"))
				})

			})

			Context("of object type", func() {
				BeforeEach(func() {
					object := Object{
						"foo": &AttributeDefinition{Type: Integer},
						"bar": &AttributeDefinition{Type: String},
					}
					elemType = &AttributeDefinition{Type: object}
				})

				It("produces the array go code", func() {
					Ω(source).Should(Equal("[]*struct {\n\tBar *string `form:\"bar,omitempty\" json:\"bar,omitempty\" xml:\"bar,omitempty\"`\n\tFoo *int `form:\"foo,omitempty\" json:\"foo,omitempty\" xml:\"foo,omitempty\"`\n}"))
				})
			})
		})

	})
})

var _ = Describe("GoTypeTransform", func() {
	var source, target *UserTypeDefinition
	var targetPkg, funcName string

	var transform string

	BeforeEach(func() {
		dslengine.Reset()
	})
	JustBeforeEach(func() {
		err := dslengine.Run()
		Ω(err).ShouldNot(HaveOccurred())
		transform, _ = codegen.GoTypeTransform(source, target, targetPkg, funcName)
	})

	Context("transforming simple objects", func() {
		const attName = "att"
		BeforeEach(func() {
			source = Type("Source", func() {
				Attribute(attName)
			})
			target = Type("Target", func() {
				Attribute(attName)
			})
			funcName = "Transform"
		})

		It("generates a simple assignment", func() {
			Ω(transform).Should(Equal(`func Transform(source *Source) (target *Target) {
	target = new(Target)
	target.Att = source.Att
	return
}
`))
		})
	})

	Context("transforming objects with attributes with map key metadata", func() {
		const mapKey = "key"
		BeforeEach(func() {
			source = Type("Source", func() {
				Attribute("foo", func() {
					Metadata(codegen.TransformMapKey, mapKey)
				})
			})
			target = Type("Target", func() {
				Attribute("bar", func() {
					Metadata(codegen.TransformMapKey, mapKey)
				})
			})
			funcName = "Transform"
		})

		It("generates a simple assignment", func() {
			Ω(transform).Should(Equal(`func Transform(source *Source) (target *Target) {
	target = new(Target)
	target.Bar = source.Foo
	return
}
`))
		})
	})

	Context("transforming objects with array attributes", func() {
		const attName = "att"
		BeforeEach(func() {
			source = Type("Source", func() {
				Attribute(attName, ArrayOf(Integer))
			})
			target = Type("Target", func() {
				Attribute(attName, ArrayOf(Integer))
			})
			funcName = "Transform"
		})

		It("generates a simple assignment", func() {
			Ω(transform).Should(Equal(`func Transform(source *Source) (target *Target) {
	target = new(Target)
	target.Att = make([]int, len(source.Att))
	for i, v := range source.Att {
		target.Att[i] = source.Att[i]
	}
	return
}
`))
		})
	})

	Context("transforming objects with hash attributes", func() {
		const attName = "att"
		BeforeEach(func() {
			elem := Type("elem", func() {
				Attribute("foo", Integer)
				Attribute("bar")
			})
			source = Type("Source", func() {
				Attribute(attName, HashOf(String, elem))
			})
			target = Type("Target", func() {
				Attribute(attName, HashOf(String, elem))
			})
			funcName = "Transform"
		})

		It("generates a simple assignment", func() {
			Ω(transform).Should(Equal(`func Transform(source *Source) (target *Target) {
	target = new(Target)
	target.Att = make(map[string]*Elem, len(source.Att))
	for k, v := range source.Att {
		var tk string
		tk = k
		var tv *Elem
		tv = new(Elem)
		tv.Bar = v.Bar
		tv.Foo = v.Foo
		target.Att[tk] = tv
	}
	return
}
`))
		})
	})

	Context("transforming objects with recursive attributes", func() {
		const attName = "att"
		BeforeEach(func() {
			inner := Type("inner", func() {
				Attribute("foo", Integer)
			})
			outer := Type("outer", func() {
				Attribute("in", inner)
			})
			array := Type("array", func() {
				Attribute("elem", ArrayOf(outer))
			})
			hash := Type("hash", func() {
				Attribute("elem", HashOf(Integer, outer))
			})
			source = Type("Source", func() {
				Attribute("outer", outer)
				Attribute("array", array)
				Attribute("hash", hash)
			})
			target = Type("Target", func() {
				Attribute("outer", outer)
				Attribute("array", array)
				Attribute("hash", hash)
			})
			funcName = "Transform"
		})

		It("generates the proper assignments", func() {
			Ω(transform).Should(Equal(`func Transform(source *Source) (target *Target) {
	target = new(Target)
	target.Array = new(Array)
	target.Array.Elem = make([]*Outer, len(source.Array.Elem))
	for i, v := range source.Array.Elem {
		target.Array.Elem[i] = new(Outer)
		target.Array.Elem[i].In = new(Inner)
		target.Array.Elem[i].In.Foo = source.Array.Elem[i].In.Foo
	}
	target.Hash = new(Hash)
	target.Hash.Elem = make(map[int]*Outer, len(source.Hash.Elem))
	for k, v := range source.Hash.Elem {
		var tk int
		tk = k
		var tv *Outer
		tv = new(Outer)
		tv.In = new(Inner)
		tv.In.Foo = v.In.Foo
		target.Hash.Elem[tk] = tv
	}
	target.Outer = new(Outer)
	target.Outer.In = new(Inner)
	target.Outer.In.Foo = source.Outer.In.Foo
	return
}
`))
		})
	})
})

var _ = Describe("GoTypeDesc", func() {
	Context("With a type with a description", func() {
		var description string
		var ut *UserTypeDefinition

		var desc string

		BeforeEach(func() {
			description = "foo"
		})

		JustBeforeEach(func() {
			ut = &UserTypeDefinition{AttributeDefinition: &AttributeDefinition{Description: description}}
			desc = codegen.GoTypeDesc(ut, false)
		})

		It("uses the description", func() {
			Ω(desc).Should(Equal(description))
		})

		Context("containing newlines", func() {
			BeforeEach(func() {
				description = "foo\nbar"
			})

			It("escapes the new lines", func() {
				Ω(desc).Should(Equal(strings.Replace(description, "\n", "\n// ", -1)))
			})
		})
	})
})