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
|
// Copyright 2015 go-swagger maintainers
//
// 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_test
import (
"encoding/json"
"path/filepath"
"regexp"
"strings"
"testing"
"github.com/go-openapi/spec"
"github.com/go-openapi/swag"
"github.com/stretchr/testify/assert"
)
// mimics what the go-openapi/load does
var yamlLoader = swag.YAMLDoc
func loadOrFail(t *testing.T, path string) *spec.Swagger {
raw, erl := yamlLoader(path)
if erl != nil {
t.Logf("can't load fixture %s: %v", path, erl)
t.FailNow()
return nil
}
swspec := new(spec.Swagger)
if err := json.Unmarshal(raw, swspec); err != nil {
t.FailNow()
return nil
}
return swspec
}
// Test unitary fixture for dev and bug fixing
func Test_Issue1429(t *testing.T) {
prevPathLoader := spec.PathLoader
defer func() {
spec.PathLoader = prevPathLoader
}()
spec.PathLoader = yamlLoader
path := filepath.Join("fixtures", "bugs", "1429", "swagger.yaml")
// load and full expand
sp := loadOrFail(t, path)
err := spec.ExpandSpec(sp, &spec.ExpandOptions{RelativeBase: path, SkipSchemas: false})
if !assert.NoError(t, err) {
t.FailNow()
return
}
//bbb, _ := json.MarshalIndent(sp, "", " ")
//t.Log(string(bbb))
// assert well expanded
if !assert.Truef(t, (sp.Paths != nil && sp.Paths.Paths != nil), "expected paths to be available in fixture") {
t.FailNow()
return
}
for _, pi := range sp.Paths.Paths {
for _, param := range pi.Get.Parameters {
if assert.NotNilf(t, param.Schema, "expected param schema not to be nil") {
// all param fixtures are body param with schema
// all $ref expanded
assert.Equal(t, "", param.Schema.Ref.String())
}
}
for code, response := range pi.Get.Responses.StatusCodeResponses {
// all response fixtures are with StatusCodeResponses, but 200
if code == 200 {
assert.Nilf(t, response.Schema, "expected response schema to be nil")
continue
}
if assert.NotNilf(t, response.Schema, "expected response schema not to be nil") {
assert.Equal(t, "", response.Schema.Ref.String())
}
}
}
for _, def := range sp.Definitions {
assert.Equal(t, "", def.Ref.String())
}
// reload and SkipSchemas: true
sp = loadOrFail(t, path)
err = spec.ExpandSpec(sp, &spec.ExpandOptions{RelativeBase: path, SkipSchemas: true})
if !assert.NoError(t, err) {
t.FailNow()
return
}
// assert well resolved
if !assert.Truef(t, (sp.Paths != nil && sp.Paths.Paths != nil), "expected paths to be available in fixture") {
t.FailNow()
return
}
for _, pi := range sp.Paths.Paths {
for _, param := range pi.Get.Parameters {
if assert.NotNilf(t, param.Schema, "expected param schema not to be nil") {
// all param fixtures are body param with schema
if param.Name == "plainRequest" {
// this one is expanded
assert.Equal(t, "", param.Schema.Ref.String())
continue
}
if param.Name == "nestedBody" {
// this one is local
assert.True(t, strings.HasPrefix(param.Schema.Ref.String(), "#/definitions/"))
continue
}
if param.Name == "remoteRequest" {
assert.Contains(t, param.Schema.Ref.String(), "remote/remote.yaml#/")
continue
}
assert.Contains(t, param.Schema.Ref.String(), "responses.yaml#/")
}
}
for code, response := range pi.Get.Responses.StatusCodeResponses {
// all response fixtures are with StatusCodeResponses, but 200
if code == 200 {
assert.Nilf(t, response.Schema, "expected response schema to be nil")
continue
}
if code == 204 {
assert.Contains(t, response.Schema.Ref.String(), "remote/remote.yaml#/")
continue
}
if code == 404 {
assert.Equal(t, "", response.Schema.Ref.String())
continue
}
assert.Containsf(t, response.Schema.Ref.String(), "responses.yaml#/", "expected remote ref at resp. %d", code)
}
}
for _, def := range sp.Definitions {
assert.Contains(t, def.Ref.String(), "responses.yaml#/")
}
}
func Test_MoreLocalExpansion(t *testing.T) {
prevPathLoader := spec.PathLoader
defer func() {
spec.PathLoader = prevPathLoader
}()
spec.PathLoader = yamlLoader
path := filepath.Join("fixtures", "local_expansion", "spec2.yaml")
// load and full expand
sp := loadOrFail(t, path)
err := spec.ExpandSpec(sp, &spec.ExpandOptions{RelativeBase: path, SkipSchemas: false})
if !assert.NoError(t, err) {
t.FailNow()
return
}
// asserts all $ref expanded
jazon, _ := json.MarshalIndent(sp, "", " ")
assert.NotContains(t, jazon, `"$ref"`)
//t.Log(string(jazon))
}
func Test_Issue69(t *testing.T) {
// this checks expansion for the dapperbox spec (circular ref issues)
path := filepath.Join("fixtures", "bugs", "69", "dapperbox.json")
// expand with relative path
// load and expand
sp := loadOrFail(t, path)
err := spec.ExpandSpec(sp, &spec.ExpandOptions{RelativeBase: path, SkipSchemas: false})
if !assert.NoError(t, err) {
t.FailNow()
return
}
// asserts all $ref expanded
jazon, _ := json.MarshalIndent(sp, "", " ")
// assert all $ref maches "$ref": "#/definitions/something"
rex := regexp.MustCompile(`"\$ref":\s*"(.+)"`)
m := rex.FindAllStringSubmatch(string(jazon), -1)
if assert.NotNil(t, m) {
for _, matched := range m {
subMatch := matched[1]
assert.True(t, strings.HasPrefix(subMatch, "#/definitions/"),
"expected $ref to be inlined, got: %s", matched[0])
}
}
}
|