-
-
Notifications
You must be signed in to change notification settings - Fork 428
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
openapi3: add support for extensions on the few types left
Signed-off-by: Pierre Fenoll <pierrefenoll@gmail.com>
- Loading branch information
Showing
39 changed files
with
1,108 additions
and
331 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
#!/bin/bash -eux | ||
set -o pipefail | ||
|
||
maplike=./openapi3/maplike.go | ||
maplike_test=./openapi3/maplike_test.go | ||
|
||
types=() | ||
types+=('*Responses') | ||
types+=('*Callback') | ||
types+=('*Paths') | ||
|
||
value_types=() | ||
value_types+=('*ResponseRef') | ||
value_types+=('*PathItem') | ||
value_types+=('*PathItem') | ||
|
||
names=() | ||
names+=('responses') | ||
names+=('callback') | ||
names+=('paths') | ||
|
||
[[ "${#types[@]}" = "${#value_types[@]}" ]] | ||
[[ "${#types[@]}" = "${#names[@]}" ]] | ||
[[ "${#types[@]}" = "$(git grep -InF ' m map[string]*' -- openapi3/loader.go | wc -l)" ]] | ||
|
||
cat <<EOF >"$maplike" | ||
package openapi3 | ||
import ( | ||
"encoding/json" | ||
"fmt" | ||
"sort" | ||
"strings" | ||
"github.com/go-openapi/jsonpointer" | ||
) | ||
EOF | ||
|
||
|
||
cat <<EOF >"$maplike_test" | ||
package openapi3 | ||
import ( | ||
"testing" | ||
"github.com/stretchr/testify/require" | ||
) | ||
func TestMaplikeMethods(t *testing.T) { | ||
t.Parallel() | ||
EOF | ||
|
||
for i in "${!types[@]}"; do | ||
type=${types[$i]} | ||
value_type=${value_types[$i]} | ||
name=${names[$i]} | ||
|
||
cat <<EOF >>"$maplike" | ||
// Get returns the ${name} for key and the presence bit | ||
func (${name} ${type}) Get(key string) (${value_type}, bool) { | ||
if ${name}.Len() == 0 { | ||
return nil, false | ||
} | ||
v, ok := ${name}.m[key] | ||
return v, ok | ||
} | ||
// Value returns the ${name} for key or nil | ||
func (${name} ${type}) Value(key string) ${value_type} { | ||
if ${name}.Len() == 0 { | ||
return nil | ||
} | ||
return ${name}.m[key] | ||
} | ||
// Set adds or replaces key 'key' of '${name}' with 'value'. | ||
// Note: '${name}' MUST be non-nil | ||
func (${name} ${type}) Set(key string, value ${value_type}) { | ||
if ${name}.m == nil { | ||
${name}.m = make(map[string]${value_type}) | ||
} | ||
${name}.m[key] = value | ||
} | ||
// Len returns the amount of keys in ${name} excluding ${name}.Extensions. | ||
func (${name} ${type}) Len() int { | ||
if ${name} == nil { | ||
return 0 | ||
} | ||
return len(${name}.m) | ||
} | ||
// Map returns ${name} as a 'map'. | ||
// Note: iteration on Go maps is not ordered. | ||
func (${name} ${type}) Map() map[string]${value_type} { | ||
if ${name}.Len() == 0 { | ||
return nil | ||
} | ||
return ${name}.m | ||
} | ||
var _ jsonpointer.JSONPointable = (${type})(nil) | ||
// JSONLookup implements https://github.com/go-openapi/jsonpointer#JSONPointable | ||
func (${name} ${type}) JSONLookup(token string) (interface{}, error) { | ||
v, ok := ${name}.Get(token) | ||
if !ok { | ||
return nil, fmt.Errorf("invalid token reference: %q", token) | ||
} | ||
if v != nil { | ||
if v.Ref != "" { | ||
return &Ref{Ref: v.Ref}, nil | ||
} | ||
return v, nil | ||
} | ||
vv, _, err := jsonpointer.GetForToken(${name}.Extensions, token) | ||
return vv, err | ||
} | ||
// MarshalJSON returns the JSON encoding of ${type#'*'}. | ||
func (${name} ${type#'*'}) MarshalJSON() ([]byte, error) { | ||
m := make(map[string]interface{}, ${name}.Len()+len(${name}.Extensions)) | ||
for k, v := range ${name}.Extensions { | ||
m[k] = v | ||
} | ||
for k, v := range ${name}.Map() { | ||
m[k] = v | ||
} | ||
return json.Marshal(m) | ||
} | ||
// UnmarshalJSON sets ${type#'*'} to a copy of data. | ||
func (${name} ${type}) UnmarshalJSON(data []byte) (err error) { | ||
var m map[string]interface{} | ||
if err = json.Unmarshal(data, &m); err != nil { | ||
return | ||
} | ||
ks := make([]string, 0, len(m)) | ||
for k := range m { | ||
ks = append(ks, k) | ||
} | ||
sort.Strings(ks) | ||
x := ${type#'*'}{ | ||
Extensions: make(map[string]interface{}), | ||
m: make(map[string]${value_type}, len(m)), | ||
} | ||
for _, k := range ks { | ||
v := m[k] | ||
if strings.HasPrefix(k, "x-") { | ||
x.Extensions[k] = v | ||
continue | ||
} | ||
var data []byte | ||
if data, err = json.Marshal(v); err != nil { | ||
return | ||
} | ||
var vv ${value_type#'*'} | ||
if err = vv.UnmarshalJSON(data); err != nil { | ||
return | ||
} | ||
x.m[k] = &vv | ||
} | ||
*${name} = x | ||
return | ||
} | ||
EOF | ||
|
||
cat <<EOF >>"$maplike_test" | ||
t.Run("${type}", func(t *testing.T) { | ||
t.Parallel() | ||
t.Run("nil", func(t *testing.T) { | ||
x := (${type})(nil) | ||
require.Equal(t, 0, x.Len()) | ||
require.Equal(t, (map[string]${value_type})(nil), x.Map()) | ||
require.Equal(t, (${value_type})(nil), x.Value("key")) | ||
require.Panics(t, func() { x.Set("key", &${value_type#'*'}{}) }) | ||
}) | ||
t.Run("nonnil", func(t *testing.T) { | ||
x := &${type#'*'}{} | ||
require.Equal(t, 0, x.Len()) | ||
require.Equal(t, (map[string]${value_type})(nil), x.Map()) | ||
require.Equal(t, (${value_type})(nil), x.Value("key")) | ||
x.Set("key", &${value_type#'*'}{}) | ||
require.Equal(t, 1, x.Len()) | ||
require.Equal(t, map[string]${value_type}{"key": {}}, x.Map()) | ||
require.Equal(t, &${value_type#'*'}{}, x.Value("key")) | ||
}) | ||
}) | ||
EOF | ||
|
||
done | ||
|
||
cat <<EOF >>"$maplike_test" | ||
} | ||
EOF |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.