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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
|
package openapi3
import (
"testing"
"github.com/stretchr/testify/require"
)
func oneofSpec(t *testing.T) *T {
t.Helper()
spec := []byte(`
openapi: 3.0.1
paths: {}
info:
version: 1.1.1
title: title
components:
schemas:
Cat:
type: object
properties:
name:
type: string
scratches:
type: boolean
$type:
type: string
enum:
- cat
required:
- name
- scratches
- $type
Dog:
type: object
properties:
name:
type: string
barks:
type: boolean
$type:
type: string
enum:
- dog
required:
- name
- barks
- $type
Animal:
type: object
oneOf:
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Dog"
discriminator:
propertyName: $type
mapping:
cat: "#/components/schemas/Cat"
dog: "#/components/schemas/Dog"
`[1:])
loader := NewLoader()
doc, err := loader.LoadFromData(spec)
require.NoError(t, err)
err = doc.Validate(loader.Context)
require.NoError(t, err)
return doc
}
func oneofNoDiscriminatorSpec(t *testing.T) *T {
t.Helper()
spec := []byte(`
openapi: 3.0.1
paths: {}
info:
version: 1.1.1
title: title
components:
schemas:
Cat:
type: object
properties:
name:
type: string
scratches:
type: boolean
required:
- name
- scratches
Dog:
type: object
properties:
name:
type: string
barks:
type: boolean
required:
- name
- barks
Animal:
type: object
oneOf:
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Dog"
`[1:])
loader := NewLoader()
doc, err := loader.LoadFromData(spec)
require.NoError(t, err)
err = doc.Validate(loader.Context)
require.NoError(t, err)
return doc
}
func TestVisitJSON_OneOf_MissingDescriptorProperty(t *testing.T) {
doc := oneofSpec(t)
err := doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
})
require.ErrorContains(t, err, `input does not contain the discriminator property "$type"`)
}
func TestVisitJSON_OneOf_MissingDescriptorValue(t *testing.T) {
doc := oneofSpec(t)
err := doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
"$type": "snake",
})
require.ErrorContains(t, err, `discriminator property "$type" has invalid value`)
}
func TestVisitJSON_OneOf_MissingField(t *testing.T) {
doc := oneofSpec(t)
err := doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
"$type": "dog",
})
require.ErrorContains(t, err, `doesn't match schema due to: Error at "/barks": property "barks" is missing`)
}
func TestVisitJSON_OneOf_NoDescriptor_MissingField(t *testing.T) {
doc := oneofNoDiscriminatorSpec(t)
err := doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
})
require.ErrorContains(t, err, `doesn't match schema due to: Error at "/scratches": property "scratches" is missing`)
}
func TestVisitJSON_OneOf_BadDiscriminatorType(t *testing.T) {
doc := oneofSpec(t)
err := doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
"scratches": true,
"$type": 1,
})
require.ErrorContains(t, err, `value of discriminator property "$type" is not a string`)
err = doc.Components.Schemas["Animal"].Value.VisitJSON(map[string]interface{}{
"name": "snoopy",
"barks": true,
"$type": nil,
})
require.ErrorContains(t, err, `value of discriminator property "$type" is not a string`)
}
func TestVisitJSON_OneOf_Path(t *testing.T) {
spec := []byte(`
openapi: 3.0.0
paths: {}
info:
version: 1.1.1
title: title
components:
schemas:
Something:
type: object
properties:
first:
type: object
properties:
second:
type: object
properties:
third:
oneOf:
- title: First rule
type: string
minLength: 5
maxLength: 5
- title: Second rule
type: string
minLength: 10
maxLength: 10
`[1:])
loader := NewLoader()
doc, err := loader.LoadFromData(spec)
require.NoError(t, err)
err = doc.Validate(loader.Context)
require.NoError(t, err)
err = doc.Components.Schemas["Something"].Value.VisitJSON(map[string]interface{}{
"first": map[string]interface{}{
"second": map[string]interface{}{
"third": "123456789",
},
},
})
require.ErrorContains(t, err, `Error at "/first/second/third"`)
var sErr *SchemaError
require.ErrorAs(t, err, &sErr)
require.Equal(t, []string{"first", "second", "third"}, sErr.JSONPointer())
}
|