github.com/goldeneggg/goa@v1.3.1/design/definitions_test.go

package design_test

import (
	"path"

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

var _ = Describe("Inherit", func() {
	var child, parent *design.AttributeDefinition

	BeforeEach(func() {
		parent = &design.AttributeDefinition{Type: design.Object{}}
		child = &design.AttributeDefinition{Type: design.Object{}}
	})

	JustBeforeEach(func() {
		child.Inherit(parent)
	})

	Context("with a empty parent", func() {
		const attName = "c"
		BeforeEach(func() {
			child.Type.(design.Object)[attName] = &design.AttributeDefinition{Type: design.String}
		})

		It("does not change", func() {
			obj := child.Type.(design.Object)
			Ω(obj).Should(HaveLen(1))
			Ω(obj).Should(HaveKey(attName))
		})
	})

	Context("with a parent that defines no inherited attribute", func() {
		const (
			attName = "c"
			def     = "default"
		)

		BeforeEach(func() {
			child.Type.(design.Object)[attName] = &design.AttributeDefinition{Type: design.String}
			parent.Type.(design.Object)["other"] = &design.AttributeDefinition{Type: design.String, DefaultValue: def}
		})

		It("does not change", func() {
			obj := child.Type.(design.Object)
			Ω(obj).Should(HaveLen(1))
			Ω(obj).Should(HaveKey(attName))
			Ω(obj[attName].DefaultValue).Should(BeNil())
		})
	})

	Context("with a parent that defines an inherited attribute", func() {
		const (
			attName = "c"
			def     = "default"
		)

		BeforeEach(func() {
			child.Type.(design.Object)[attName] = &design.AttributeDefinition{Type: design.String}
			parent.Type.(design.Object)[attName] = &design.AttributeDefinition{Type: design.String, DefaultValue: def}
		})

		It("inherits the default value", func() {
			obj := child.Type.(design.Object)
			Ω(obj).Should(HaveLen(1))
			Ω(obj).Should(HaveKey(attName))
			Ω(obj[attName].DefaultValue).Should(Equal(def))
		})
	})

	Context("with recursive type definitions", func() {
		BeforeEach(func() {
			po := design.Object{}
			parent = &design.AttributeDefinition{Type: po}
			child = &design.AttributeDefinition{Type: &design.UserTypeDefinition{AttributeDefinition: parent}}
			po["recurse"] = child
		})

		It("does not recurse infinitely", func() {})
	})

})

var _ = Describe("IsRequired", func() {
	var required string
	var attName string

	var attribute *design.AttributeDefinition
	var res bool

	JustBeforeEach(func() {
		integer := &design.AttributeDefinition{Type: design.Integer}
		attribute = &design.AttributeDefinition{
			Type:       design.Object{required: integer},
			Validation: &dslengine.ValidationDefinition{Required: []string{required}},
		}
		res = attribute.IsRequired(attName)
	})

	Context("called on a required field", func() {
		BeforeEach(func() {
			attName = "required"
			required = "required"
		})

		It("returns true", func() {
			Ω(res).Should(BeTrue())
		})
	})

	Context("called on a non-required field", func() {
		BeforeEach(func() {
			attName = "non-required"
			required = "required"
		})

		It("returns false", func() {
			Ω(res).Should(BeFalse())
		})
	})
})

var _ = Describe("IterateHeaders", func() {
	It("works when Parent.Headers is nil", func() {
		// create a Resource with no headers, Action with one header
		resource := &design.ResourceDefinition{}
		action := &design.ActionDefinition{
			Parent: resource,
			Headers: &design.AttributeDefinition{
				Type: design.Object{
					"a": &design.AttributeDefinition{Type: design.String},
				},
			},
		}
		names := []string{}
		// iterator that collects header names
		it := func(name string, _ bool, _ *design.AttributeDefinition) error {
			names = append(names, name)
			return nil
		}
		Ω(action.IterateHeaders(it)).Should(Succeed(), "despite action.Parent.Headers being nil")
		Ω(names).Should(ConsistOf("a"))
	})

})
var _ = Describe("Finalize ActionDefinition", func() {
	Context("with an action with no response", func() {
		var action *design.ActionDefinition

		BeforeEach(func() {
			// create a Resource with responses, Action with no response
			resource := &design.ResourceDefinition{
				Responses: map[string]*design.ResponseDefinition{
					"NotFound": &design.ResponseDefinition{Name: "NotFound", Status: 404},
				},
			}
			action = &design.ActionDefinition{Parent: resource}
		})

		It("does not panic and merges the resource responses", func() {
			Ω(action.Finalize).ShouldNot(Panic())
			Ω(action.Responses).Should(HaveKey("NotFound"))
		})
	})
})

var _ = Describe("FullPath", func() {

	Context("Given a base resource and a resource with an action with a route", func() {
		var resource, parentResource *design.ResourceDefinition
		var action *design.ActionDefinition
		var route *design.RouteDefinition

		var actionPath string
		var resourcePath string
		var parentResourcePath string

		JustBeforeEach(func() {
			showAct := &design.ActionDefinition{}
			showRoute := &design.RouteDefinition{
				Path:   parentResourcePath,
				Parent: showAct,
			}
			showAct.Routes = []*design.RouteDefinition{showRoute}
			parentResource = &design.ResourceDefinition{}
			parentResource.Actions = map[string]*design.ActionDefinition{"show": showAct}
			parentResource.Name = "foo"
			design.Design.Resources = map[string]*design.ResourceDefinition{"foo": parentResource}
			showAct.Parent = parentResource

			action = &design.ActionDefinition{}
			route = &design.RouteDefinition{
				Path:   actionPath,
				Parent: action,
			}
			action.Routes = []*design.RouteDefinition{route}
			resource = &design.ResourceDefinition{}
			resource.Actions = map[string]*design.ActionDefinition{"action": action}
			resource.BasePath = resourcePath
			resource.ParentName = parentResource.Name
			action.Parent = resource
		})

		AfterEach(func() {
			design.Design.Resources = nil
		})

		Context("with relative routes", func() {
			BeforeEach(func() {
				actionPath = "/action"
				resourcePath = "/resource"
				parentResourcePath = "/parent"
			})

			It("FullPath concatenates them", func() {
				Ω(route.FullPath()).Should(Equal(path.Join(parentResourcePath, resourcePath, actionPath)))
			})

			Context("with an action with absolute route", func() {
				BeforeEach(func() {
					actionPath = "//action"
				})

				It("FullPath uses it", func() {
					Ω(route.FullPath()).Should(Equal(actionPath[1:]))
				})
			})

			Context("with n resource with absolute route", func() {
				BeforeEach(func() {
					resourcePath = "//resource"
				})

				It("FullPath uses it", func() {
					Ω(route.FullPath()).Should(Equal(resourcePath[1:] + "/" + actionPath[1:]))
				})
			})
		})

		Context("with trailing slashes", func() {
			BeforeEach(func() {
				actionPath = "/action/"
				resourcePath = "/resource"
				parentResourcePath = "/parent"
			})

			It("Keeps trailing slashes", func() {
				Ω(route.FullPath()).Should(Equal("/parent/resource/action/"))
			})
		})
	})
})

var _ = Describe("AllParams", func() {
	Context("Given a resource with a parent and an action with a route", func() {
		var (
			resource, parent *design.ResourceDefinition
			action           *design.ActionDefinition
			allParams        design.Object
			pathParams       design.Object
		)

		BeforeEach(func() {
			// Parent resource
			{
				baseParams := &design.AttributeDefinition{Type: design.Object{
					"pbasepath":  &design.AttributeDefinition{Type: design.String},
					"pbasequery": &design.AttributeDefinition{Type: design.String},
				}}
				parent = &design.ResourceDefinition{
					Name:                "parent",
					CanonicalActionName: "canonical",
					BasePath:            "/:pbasepath",
					Params:              baseParams,
				}
				canParams := &design.AttributeDefinition{Type: design.Object{
					"canpath":  &design.AttributeDefinition{Type: design.String},
					"canquery": &design.AttributeDefinition{Type: design.String},
				}}
				canonical := &design.ActionDefinition{
					Name:   "canonical",
					Parent: parent,
					Params: canParams,
				}
				croute := &design.RouteDefinition{
					Path:   "/:canpath",
					Parent: canonical,
				}
				canonical.Routes = []*design.RouteDefinition{croute}
				parent.Actions = map[string]*design.ActionDefinition{"canonical": canonical}
			}

			// Resource
			{
				baseParams := &design.AttributeDefinition{Type: design.Object{
					"basepath":  &design.AttributeDefinition{Type: design.String},
					"basequery": &design.AttributeDefinition{Type: design.String},
				}}
				resource = &design.ResourceDefinition{
					Name:       "child",
					ParentName: "parent",
					BasePath:   "/:basepath",
					Params:     baseParams,
				}
			}

			// Action
			{
				params := &design.AttributeDefinition{Type: design.Object{
					"path":     &design.AttributeDefinition{Type: design.String},
					"query":    &design.AttributeDefinition{Type: design.String},
					"basepath": &design.AttributeDefinition{Type: design.String},
				}}
				action = &design.ActionDefinition{
					Name:   "action",
					Parent: resource,
					Params: params,
				}
				route := &design.RouteDefinition{
					Path:   "/:path",
					Parent: action,
				}
				action.Routes = []*design.RouteDefinition{route}
				resource.Actions = map[string]*design.ActionDefinition{"action": action}
			}
			design.Design.Resources = map[string]*design.ResourceDefinition{"resource": resource, "parent": parent}
			design.Design.BasePath = "/:apipath"
			params := design.Object{
				"apipath":  &design.AttributeDefinition{Type: design.String},
				"apiquery": &design.AttributeDefinition{Type: design.String},
			}
			design.Design.Params = &design.AttributeDefinition{Type: params}
		})

		JustBeforeEach(func() {
			allParams = action.AllParams().Type.ToObject()
			pathParams = action.PathParams().Type.ToObject()
			Ω(allParams).ShouldNot(BeNil())
			Ω(pathParams).ShouldNot(BeNil())
		})

		AfterEach(func() {
			design.Design.Params = nil
			design.Design.Resources = nil
			design.Design.BasePath = ""
		})

		It("AllParams returns both path and query parameters of the action and the resource", func() {
			for p := range action.Params.Type.ToObject() {
				Ω(allParams).Should(HaveKey(p))
			}
			for p := range resource.Params.Type.ToObject() {
				Ω(allParams).Should(HaveKey(p))
			}
		})

		It("AllParams returns the path parameters of the action, the resource, the parent resource and the API", func() {
			for _, p := range []string{"path", "basepath", "canpath", "pbasepath", "apipath"} {
				Ω(allParams).Should(HaveKey(p))
			}
		})

		It("AllParams does NOT return the query parameters of the parent resource canonical action or the API", func() {
			for _, p := range []string{"canquery", "pbasequery", "apiquery"} {
				Ω(allParams).ShouldNot(HaveKey(p))
			}
		})

		It("PathParams returns the path parameters recursively", func() {
			Ω(pathParams).Should(HaveLen(5))
			for _, p := range []string{"path", "basepath", "canpath", "pbasepath", "apipath"} {
				Ω(pathParams).Should(HaveKey(p))
			}
		})
	})
})

var _ = Describe("PathParams", func() {
	Context("Given a resource with a nil base params", func() {
		var (
			resource   *design.ResourceDefinition
			pathParams design.Object
		)

		BeforeEach(func() {
			resource = &design.ResourceDefinition{
				Name:     "resource",
				BasePath: "/:basepath",
			}
			design.Design.Resources = map[string]*design.ResourceDefinition{"resource": resource}
		})

		AfterEach(func() {
			design.Design.Resources = nil
		})

		JustBeforeEach(func() {
			pathParams = resource.PathParams().Type.ToObject()
			Ω(pathParams).ShouldNot(BeNil())
		})

		It("returns an empty attribute", func() {
			Ω(pathParams).Should(BeEmpty())
		})
	})

	Context("Given a resource defining a subset of all base path params", func() {
		var (
			resource   *design.ResourceDefinition
			pathParams design.Object
		)

		BeforeEach(func() {
			params := design.Object{"basepath": &design.AttributeDefinition{Type: design.String}}
			resource = &design.ResourceDefinition{
				Name:     "resource",
				BasePath: "/:basepath/:sub",
				Params:   &design.AttributeDefinition{Type: params},
			}
			design.Design.Resources = map[string]*design.ResourceDefinition{"resource": resource}
		})

		JustBeforeEach(func() {
			pathParams = resource.PathParams().Type.ToObject()
			Ω(pathParams).ShouldNot(BeNil())
		})

		AfterEach(func() {
			design.Design.Resources = nil
		})

		It("returns an empty attribute", func() {
			Ω(pathParams).Should(HaveLen(1))
			Ω(pathParams).Should(HaveKey("basepath"))
		})
	})
})

var _ = Describe("IterateSets", func() {

	var api *design.APIDefinition

	BeforeEach(func() {
		api = &design.APIDefinition{}
		api.Name = "Test"
	})

	Context("ResourceDefinition", func() {
		// a function that collects resource definitions for validation
		var valFunc = func(validate func([]*design.ResourceDefinition)) func(s dslengine.DefinitionSet) error {
			return func(s dslengine.DefinitionSet) error {
				if len(s) == 0 {
					return nil
				}

				if _, ok := s[0].(*design.ResourceDefinition); !ok {
					return nil
				}

				resources := make([]*design.ResourceDefinition, len(s))
				for i, res := range s {
					resources[i] = res.(*design.ResourceDefinition)
				}

				validate(resources)

				return nil
			}
		}

		It("should order nested resources", func() {
			inspected := false
			api.Resources = make(map[string]*design.ResourceDefinition)

			api.Resources["V"] = &design.ResourceDefinition{Name: "V", ParentName: "W"}
			api.Resources["W"] = &design.ResourceDefinition{Name: "W", ParentName: "X"}
			api.Resources["X"] = &design.ResourceDefinition{Name: "X", ParentName: "Y"}
			api.Resources["Y"] = &design.ResourceDefinition{Name: "Y", ParentName: "Z"}
			api.Resources["Z"] = &design.ResourceDefinition{Name: "Z"}

			validate := func(s []*design.ResourceDefinition) {
				Ω(s[0].Name).Should(Equal("Z"))
				Ω(s[1].Name).Should(Equal("Y"))
				Ω(s[2].Name).Should(Equal("X"))
				Ω(s[3].Name).Should(Equal("W"))
				Ω(s[4].Name).Should(Equal("V"))
				inspected = true
			}

			api.IterateSets(valFunc(validate))

			Ω(inspected).Should(BeTrue())
		})

		It("should order multiple nested resources", func() {
			inspected := false
			api.Resources = make(map[string]*design.ResourceDefinition)

			api.Resources["A"] = &design.ResourceDefinition{Name: "A"}
			api.Resources["B"] = &design.ResourceDefinition{Name: "B", ParentName: "A"}
			api.Resources["C"] = &design.ResourceDefinition{Name: "C", ParentName: "A"}
			api.Resources["I"] = &design.ResourceDefinition{Name: "I"}
			api.Resources["J"] = &design.ResourceDefinition{Name: "J", ParentName: "K"}
			api.Resources["K"] = &design.ResourceDefinition{Name: "K", ParentName: "I"}
			api.Resources["X"] = &design.ResourceDefinition{Name: "X"}
			api.Resources["Y"] = &design.ResourceDefinition{Name: "Y"}
			api.Resources["Z"] = &design.ResourceDefinition{Name: "Z"}

			validate := func(s []*design.ResourceDefinition) {
				Ω(s[0].Name).Should(Equal("A"))
				Ω(s[1].Name).Should(Equal("B"))
				Ω(s[2].Name).Should(Equal("C"))
				Ω(s[3].Name).Should(Equal("I"))
				Ω(s[4].Name).Should(Equal("K"))
				Ω(s[5].Name).Should(Equal("J"))
				Ω(s[6].Name).Should(Equal("X"))
				Ω(s[7].Name).Should(Equal("Y"))
				Ω(s[8].Name).Should(Equal("Z"))
				inspected = true
			}

			api.IterateSets(valFunc(validate))

			Ω(inspected).Should(BeTrue())
		})
	})

})