Generator: recast key to string for maps

Author: Anaethelion

internal/build/cmd/generate/commands/gentests/model.go

@@ -34,14 +34,12 @@ var reNumber = regexp.MustCompile(`^\d+$`)
 var reBaseFilename = regexp.MustCompile(`rest-api-spec/test/\w+/(.*$)`)
 
 // TestPayload represents a single raw section (`---`) from the YAML file.
-//
 type TestPayload struct {
 	Filepath string
 	Payload  interface{}
 }
 
 // TestSuite represents a group of tests (a "section") in one file.
-//
 type TestSuite struct {
 	Dir      string
 	Filepath string
@@ -56,7 +54,6 @@ type TestSuite struct {
 }
 
 // Test represents a single named test.
-//
 type Test struct {
 	Name     string
 	Filepath string
@@ -75,11 +72,9 @@ type Test struct {
 type Steps []Step
 
 // Step represents an Action or an Assertion.
-//
 type Step interface{}
 
 // Action represents an API action (`do`).
-//
 type Action struct {
 	payload interface{}
 
@@ -90,21 +85,18 @@ type Action struct {
 }
 
 // Assertion represents a test assertion (`is_true`, `match`, etc).
-//
 type Assertion struct {
 	payload interface{}
 
 	operation string
 }
 
 // Stash represents the registry for `set` operations.
-//
 type Stash struct {
 	payload interface{}
 }
 
 // NewTestSuite returns a test group from the payloads.
-//
 func NewTestSuite(fpath string, payloads []TestPayload) TestSuite {
 	ts := TestSuite{
 		Dir:      strings.Title(filepath.Base(filepath.Dir(fpath))),
@@ -227,7 +219,6 @@ func NewTestSuite(fpath string, payloads []TestPayload) TestSuite {
 }
 
 // NewAction returns a new action from the payload.
-//
 func NewAction(payload interface{}) Action {
 	defer func() {
 		if r := recover(); r != nil {
@@ -260,19 +251,16 @@ func NewAction(payload interface{}) Action {
 }
 
 // NewAssertion returns a new assertion from the payload.
-//
 func NewAssertion(operation string, payload interface{}) Assertion {
 	return Assertion{operation: operation, payload: payload}
 }
 
 // NewStash returns a new stash from the payload.
-//
 func NewStash(payload interface{}) Stash {
 	return Stash{payload: payload}
 }
 
 // Name returns a human name for the test suite.
-//
 func (ts TestSuite) Name() string {
 	var b strings.Builder
 	for _, v := range strings.Split(ts.Dir, ".") {
@@ -287,7 +275,6 @@ func (ts TestSuite) Name() string {
 }
 
 // Filename returns a suitable filename for the test suite.
-//
 func (ts TestSuite) Filename() string {
 	var b strings.Builder
 
@@ -305,13 +292,11 @@ func (ts TestSuite) Filename() string {
 }
 
 // SkipEsVersion returns true if the test suite should be skipped.
-//
 func (ts TestSuite) SkipEsVersion(minmax string) bool {
 	return skipVersion(minmax)
 }
 
 // BaseFilename extracts and returns the test filename in form of `foo/bar/10_qux.yml`.
-//
 func (t Test) BaseFilename() string {
 	parts := reBaseFilename.FindStringSubmatch(t.Filepath)
 	if len(parts) < 1 {
@@ -321,14 +306,12 @@ func (t Test) BaseFilename() string {
 }
 
 // SkipEsVersion returns true if the test should be skipped.
-//
 func (t Test) SkipEsVersion(minmax string) bool {
 	return skipVersion(minmax)
 }
 
 // ContainsAssertion returns true when the set of steps
 // contain an assertion, or a specific assertion.
-//
 func (s Steps) ContainsAssertion(keys ...string) bool {
 	for _, step := range s {
 		if a, ok := step.(Assertion); ok {
@@ -357,7 +340,6 @@ func (s Steps) ContainsAssertion(keys ...string) bool {
 }
 
 // ContainsCatch returns true when the set of steps contains the "catch" clause.
-//
 func (s Steps) ContainsCatch(keys ...string) bool {
 	for _, step := range s {
 		if a, ok := step.(Action); ok {
@@ -370,7 +352,6 @@ func (s Steps) ContainsCatch(keys ...string) bool {
 }
 
 // ContainsStash returns true when the set of steps contains the "set" clause.
-//
 func (s Steps) ContainsStash(keys ...string) bool {
 	for _, step := range s {
 		if _, ok := step.(Stash); ok {
@@ -381,13 +362,11 @@ func (s Steps) ContainsStash(keys ...string) bool {
 }
 
 // Method returns the API method name for the action.
-//
 func (a Action) Method() string {
 	return utils.NameToGo(a.method)
 }
 
 // Request returns the API request name for the action.
-//
 func (a Action) Request() string {
 	var rParts []string
 	parts := strings.Split(a.method, ".")
@@ -398,7 +377,6 @@ func (a Action) Request() string {
 }
 
 // Params returns a map of parameters for the action.
-//
 func (a Action) Params() map[string]interface{} {
 	var kk string
 	out := make(map[string]interface{})
@@ -434,7 +412,6 @@ func (a Action) Params() map[string]interface{} {
 // Condition returns the condition for the assertion.
 //
 // TODO: Evaulate https://godoc.org/github.com/google/go-cmp/cmp
-//
 func (a Assertion) Condition() string {
 	var (
 		output string
@@ -714,7 +691,18 @@ default:
 					// We cannot reliably serialize to json and compare the json outputs: YAML responses are parsed as
 					// a map[interface{}]interface{} that encoding/json fails to marshall
 					// See https://play.golang.org/p/jhcXwg5dIrn
-					expectedPayload := fmt.Sprintf("%#v", val)
+					expectedPayload := func(val interface{}) string {
+						expectedOutput := make(map[string]interface{})
+						if cast, ok := val.(map[interface{}]interface{}); ok {
+							for k, v := range cast {
+								expectedOutput[fmt.Sprintf("%v", k)] = v
+							}
+						} else {
+							expectedOutput = val.(map[string]interface{})
+						}
+						return fmt.Sprintf("%#v", expectedOutput)
+					}(val)
+
 					expectedPayload = strings.ReplaceAll(expectedPayload, "map[interface {}]interface {}", "map[string]interface {}")
 					output = `		actual = fmt.Sprintf("%v",` + escape(subject) + `)
 				expected = fmt.Sprintf("%v",` + expectedPayload + `)
@@ -748,7 +736,6 @@ default:
 }
 
 // Error returns an error handling for the failed assertion.
-//
 func (a Assertion) Error() string {
 	var (
 		output string
@@ -810,7 +797,6 @@ func (a Assertion) Error() string {
 }
 
 // Key returns the stash key as a string.
-//
 func (s Stash) Key() string {
 	vals := utils.MapValues(s.payload)
 	if len(vals) < 1 {
@@ -821,7 +807,6 @@ func (s Stash) Key() string {
 }
 
 // Value return the stash value as a string.
-//
 func (s Stash) FirstValue() string {
 	vals := utils.MapKeys(s.payload)
 	if len(vals) < 1 {
@@ -832,7 +817,6 @@ func (s Stash) FirstValue() string {
 }
 
 // ExpandedValue returns the stash value in a container as a string.
-//
 func (s Stash) ExpandedValue() string {
 	vals := utils.MapKeys(s.payload)
 	if len(vals) < 1 {
@@ -845,7 +829,6 @@ func (s Stash) ExpandedValue() string {
 // expand "unwraps" a field name like `foo.bar.0.baz` into a proper Go structure
 //
 // See https://github.com/elastic/elasticsearch/tree/master/rest-api-spec/src/main/resources/rest-api-spec/test#dot-notation
-//
 func expand(s string, format ...string) string {
 	var (
 		b bytes.Buffer
@@ -906,7 +889,6 @@ func expand(s string, format ...string) string {
 }
 
 // catchnil returns a condition which expands the input and checks if any part is not nil.
-//
 func catchnil(input string) string {
 	var output string
 
@@ -932,7 +914,6 @@ func catchnil(input string) string {
 }
 
 // escape replaces unsafe characters in strings
-//
 func escape(s interface{}) string {
 	if s, ok := s.(string); ok {
 		// s = strings.Replace(s, `"`, `'`, -1)
@@ -945,7 +926,6 @@ func escape(s interface{}) string {
 
 // skipVersion parses minmax string and returns
 // true when EsVersion is in the range.
-//
 func skipVersion(minmax string) bool {
 	versions := strings.Split(minmax, "-")
 	if len(versions) < 2 {