1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
|
/*
Copyright 2022 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package spec
import (
"testing"
"github.com/stretchr/testify/require"
jsontesting "k8s.io/kube-openapi/pkg/util/jsontesting"
)
func TestResponsesRoundtrip(t *testing.T) {
cases := []jsontesting.RoundTripTestCase{
{
// Show at least one field from each embededd struct sitll allows
// roundtrips successfully
Name: "UnmarshalEmbedded",
JSON: `{
"default": {
"$ref": "/components/some/ref.foo"
},
"x-framework": "swagger-go"
}`,
Object: &Responses{
VendorExtensible: VendorExtensible{
Extensions: Extensions{
"x-framework": "swagger-go",
},
},
ResponsesProps: ResponsesProps{
Default: &Response{
Refable: Refable{Ref: MustCreateRef("/components/some/ref.foo")},
},
},
},
},
{
Name: "Decode Ref Object",
Object: &Responses{
VendorExtensible: VendorExtensible{Extensions: map[string]interface{}{
"x-<vBŤç,ʡËdSS暙ɑɮ": "鄲兴ȑʦ衈覻鋕嚮峡jw逓:鮕虫F迢.",
"x-h": "",
"x-岡ʍ": "Đɻ/nnjo鿻曑Œ TĀyĢ",
"x-绅ƄȆ疩ã[魑銒;苎#砠zPȺ5Aù": "閲ljǠyư"},
},
ResponsesProps: ResponsesProps{
Default: &Response{
ResponseProps: ResponseProps{Description: "梱bȿF)渽Ɲō-%x"},
},
StatusCodeResponses: map[int]Response{
200: {
Refable: Refable{Ref: MustCreateRef("Cat")},
},
},
},
},
},
{
Name: "Default Full Object",
Object: &Responses{
VendorExtensible: VendorExtensible{Extensions: map[string]interface{}{
"x-<vBŤç,ʡËdSS暙ɑɮ": "鄲兴ȑʦ衈覻鋕嚮峡jw逓:鮕虫F迢.",
"x-h": "",
"x-岡ʍ": "Đɻ/nnjo鿻曑Œ TĀyĢ",
"x-绅ƄȆ疩ã[魑銒;苎#砠zPȺ5Aù": "閲ljǠyư"},
},
ResponsesProps: ResponsesProps{
Default: &Response{
Refable: Refable{Ref: MustCreateRef("Dog")},
},
StatusCodeResponses: map[int]Response{
200: {
ResponseProps: ResponseProps{
Description: "梱bȿF)渽Ɲō-%x",
Headers: map[string]Header{
"a header": header,
},
Schema: &Schema{
VendorExtensible: VendorExtensible{Extensions: map[string]interface{}{"x-framework": "go-swagger"}},
SchemaProps: SchemaProps{
Ref: MustCreateRef("Cat"),
Type: []string{"string"},
Format: "date",
Description: "the description of this schema",
Title: "the title",
Default: "blah",
Maximum: float64Ptr(100),
ExclusiveMaximum: true,
ExclusiveMinimum: true,
Minimum: float64Ptr(5),
MaxLength: int64Ptr(100),
MinLength: int64Ptr(5),
Pattern: "\\w{1,5}\\w+",
MaxItems: int64Ptr(100),
MinItems: int64Ptr(5),
UniqueItems: true,
MultipleOf: float64Ptr(5),
Enum: []interface{}{"hello", "world"},
MaxProperties: int64Ptr(5),
MinProperties: int64Ptr(1),
Required: []string{"id", "name"},
Items: &SchemaOrArray{Schema: &Schema{SchemaProps: SchemaProps{Type: []string{"string"}}}},
AllOf: []Schema{{SchemaProps: SchemaProps{Type: []string{"string"}}}},
Properties: map[string]Schema{
"id": {SchemaProps: SchemaProps{Type: []string{"integer"}, Format: "int64"}},
"name": {SchemaProps: SchemaProps{Type: []string{"string"}}},
},
AdditionalProperties: &SchemaOrBool{Allows: true, Schema: &Schema{SchemaProps: SchemaProps{
Type: []string{"integer"},
Format: "int32",
}}},
},
SwaggerSchemaProps: SwaggerSchemaProps{
Discriminator: "not this",
ReadOnly: true,
ExternalDocs: &ExternalDocumentation{
Description: "the documentation etc",
URL: "http://readthedocs.org/swagger",
},
Example: []interface{}{
map[string]interface{}{
"id": float64(1),
"name": "a book",
},
map[string]interface{}{
"id": float64(2),
"name": "the thing",
},
},
},
},
Examples: map[string]interface{}{
"example1": "example text",
},
},
},
},
},
},
},
{
// Show we cannot decode a string into something expecting object
Name: "FailDecodeDefault",
JSON: `{"x-extension":"an extension","default":"wrong type object"}`,
ExpectedUnmarshalError: "unmarshal JSON string into Go value of type struct",
},
}
for _, tcase := range cases {
t.Run(tcase.Name, func(t *testing.T) {
require.NoError(t, tcase.RoundTripTest(&Responses{}))
})
}
}
|