| /* |
| Copyright 2017 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 aggregator |
| |
| import ( |
| "encoding/json" |
| "fmt" |
| "testing" |
| |
| "github.com/ghodss/yaml" |
| "github.com/go-openapi/spec" |
| "github.com/stretchr/testify/assert" |
| ) |
| |
| type DebugSpec struct { |
| *spec.Swagger |
| } |
| |
| func (d DebugSpec) String() string { |
| bytes, err := json.MarshalIndent(d.Swagger, "", " ") |
| if err != nil { |
| return fmt.Sprintf("DebugSpec.String failed: %s", err) |
| } |
| return string(bytes) |
| } |
| func TestFilterSpecs(t *testing.T) { |
| var spec1, spec1_filtered *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec1_filtered) |
| |
| ast := assert.New(t) |
| FilterSpecByPaths(spec1, []string{"/test"}) |
| ast.Equal(DebugSpec{spec1_filtered}, DebugSpec{spec1}) |
| } |
| |
| func TestFilterSpecsWithUnusedDefinitions(t *testing.T) { |
| var spec1, spec1Filtered *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| Unused: |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| Unused: |
| type: "object" |
| `), &spec1Filtered) |
| |
| ast := assert.New(t) |
| FilterSpecByPaths(spec1, []string{"/test"}) |
| ast.Equal(DebugSpec{spec1Filtered}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsSimple(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsEmptyDefinitions(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| responses: |
| 405: |
| description: "Invalid input" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| responses: |
| 405: |
| description: "Invalid input" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsEmptyPaths(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test2" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| Test2: |
| type: "object" |
| properties: |
| other: |
| $ref: "#/definitions/Other" |
| Other: |
| type: "string" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsReuseModel(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsRenameModel(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "This Test has a description" |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| tags: |
| - "test" |
| summary: "Test API" |
| operationId: "addTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test" |
| responses: |
| 405: |
| description: "Invalid input" |
| $ref: "#/definitions/InvalidInput" |
| /othertest: |
| post: |
| tags: |
| - "test2" |
| summary: "Test2 API" |
| operationId: "addTest2" |
| consumes: |
| - "application/json" |
| produces: |
| - "application/xml" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "test2 object" |
| required: true |
| schema: |
| $ref: "#/definitions/Test_v2" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| status: |
| type: "string" |
| description: "Status" |
| Test_v2: |
| description: "This Test has a description" |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| InvalidInput: |
| type: "string" |
| format: "string" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsRenameModelWithExistingV2InDestination(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /testv2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| definitions: |
| Test: |
| type: "object" |
| Test_v2: |
| description: "This is an existing Test_v2 in destination schema" |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "This Test has a description" |
| type: "object" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /testv2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v3" |
| definitions: |
| Test: |
| type: "object" |
| Test_v2: |
| description: "This is an existing Test_v2 in destination schema" |
| type: "object" |
| Test_v3: |
| description: "This Test has a description" |
| type: "object" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestMergeSpecsRenameModelWithExistingV2InSource(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /testv2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| definitions: |
| Test: |
| description: "This Test has a description" |
| type: "object" |
| Test_v2: |
| description: "This is an existing Test_v2 in source schema" |
| type: "object" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /testv2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v3" |
| definitions: |
| Test: |
| type: "object" |
| Test_v2: |
| description: "This is an existing Test_v2 in source schema" |
| type: "object" |
| Test_v3: |
| description: "This Test has a description" |
| type: "object" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| // This tests if there are three specs, where the first two use the same object definition, |
| // while the third one uses its own. |
| // We expect the merged schema to contain two versions of the object, not three |
| func TestTwoMergeSpecsFirstTwoSchemasHaveSameDefinition(t *testing.T) { |
| var spec1, spec2, spec3, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "spec1 and spec2 use the same object definition, while spec3 doesn't" |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "spec1 and spec2 use the same object definition, while spec3 doesn't" |
| type: "object" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test3: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "spec3 has its own definition (the description doesn't match)" |
| type: "object" |
| `), &spec3) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /test2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /test3: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| definitions: |
| Test: |
| description: "spec1 and spec2 use the same object definition, while spec3 doesn't" |
| type: "object" |
| Test_v2: |
| description: "spec3 has its own definition (the description doesn't match)" |
| type: "object" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| if !ast.NoError(MergeSpecs(spec1, spec3)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| // This tests if there are three specs, where the last two use the same object definition, |
| // while the first one uses its own. |
| // We expect the merged schema to contain two versions of the object, not three |
| func TestTwoMergeSpecsLastTwoSchemasHaveSameDefinition(t *testing.T) { |
| var spec1, spec2, spec3, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "spec2 and spec3 use the same object definition, while spec1 doesn't" |
| type: "object" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /othertest2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| description: "spec2 and spec3 use the same object definition, while spec1 doesn't" |
| type: "object" |
| `), &spec3) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /othertest: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| /othertest2: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test_v2" |
| definitions: |
| Test: |
| type: "object" |
| Test_v2: |
| description: "spec2 and spec3 use the same object definition, while spec1 doesn't" |
| type: "object" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| if !ast.NoError(MergeSpecs(spec1, spec3)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
| |
| func TestSafeMergeSpecsSimple(t *testing.T) { |
| var fooSpec, barSpec, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &fooSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /bar: |
| post: |
| summary: "Bar API" |
| operationId: "barTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "bar object" |
| required: true |
| schema: |
| $ref: "#/definitions/Bar" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Bar: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &barSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| /bar: |
| post: |
| summary: "Bar API" |
| operationId: "barTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "bar object" |
| required: true |
| schema: |
| $ref: "#/definitions/Bar" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| Bar: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &expected) |
| |
| ast := assert.New(t) |
| actual, err := CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| if !ast.NoError(MergeSpecsFailOnDefinitionConflict(actual, barSpec)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{actual}) |
| } |
| |
| func TestSafeMergeSpecsReuseModel(t *testing.T) { |
| var fooSpec, barSpec, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &fooSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /refoo: |
| post: |
| summary: "Refoo API" |
| operationId: "refooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &barSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| /refoo: |
| post: |
| summary: "Refoo API" |
| operationId: "refooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &expected) |
| |
| ast := assert.New(t) |
| actual, err := CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| if !ast.NoError(MergeSpecsFailOnDefinitionConflict(actual, barSpec)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{actual}) |
| } |
| |
| func TestSafeMergeSpecsReuseModelFails(t *testing.T) { |
| var fooSpec, barSpec, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &fooSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /refoo: |
| post: |
| summary: "Refoo API" |
| operationId: "refooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| new_field: |
| type: "string" |
| `), &barSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| /refoo: |
| post: |
| summary: "Refoo API" |
| operationId: "refooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &expected) |
| |
| ast := assert.New(t) |
| actual, err := CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| ast.Error(MergeSpecsFailOnDefinitionConflict(actual, barSpec)) |
| } |
| |
| func TestMergeSpecsIgnorePathConflicts(t *testing.T) { |
| var fooSpec, barSpec, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &fooSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Should be ignored" |
| /bar: |
| post: |
| summary: "Bar API" |
| operationId: "barTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "bar object" |
| required: true |
| schema: |
| $ref: "#/definitions/Bar" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Bar: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &barSpec) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| /bar: |
| post: |
| summary: "Bar API" |
| operationId: "barTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "bar object" |
| required: true |
| schema: |
| $ref: "#/definitions/Bar" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| Bar: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &expected) |
| |
| ast := assert.New(t) |
| actual, err := CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| if !ast.Error(MergeSpecs(actual, barSpec)) { |
| return |
| } |
| actual, err = CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| if !ast.NoError(MergeSpecsIgnorePathConflict(actual, barSpec)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{actual}) |
| } |
| |
| func TestMergeSpecsIgnorePathConflictsAllConflicting(t *testing.T) { |
| var fooSpec *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /foo: |
| post: |
| summary: "Foo API" |
| operationId: "fooTest" |
| parameters: |
| - in: "body" |
| name: "body" |
| description: "foo object" |
| required: true |
| schema: |
| $ref: "#/definitions/Foo" |
| responses: |
| 200: |
| description: "OK" |
| definitions: |
| Foo: |
| type: "object" |
| properties: |
| id: |
| type: "integer" |
| format: "int64" |
| `), &fooSpec) |
| |
| ast := assert.New(t) |
| foo2Spec, err := CloneSpec(fooSpec) |
| actual, err := CloneSpec(fooSpec) |
| if !ast.NoError(err) { |
| return |
| } |
| if !ast.NoError(MergeSpecsIgnorePathConflict(actual, foo2Spec)) { |
| return |
| } |
| ast.Equal(DebugSpec{fooSpec}, DebugSpec{actual}) |
| } |
| |
| func TestMergeSpecReplacesAllPossibleRefs(t *testing.T) { |
| var spec1, spec2, expected *spec.Swagger |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| foo: |
| $ref: "#/definitions/TestProperty" |
| TestProperty: |
| type: "object" |
| `), &spec1) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test2: |
| post: |
| parameters: |
| - name: "test2" |
| schema: |
| $ref: "#/definitions/Test2" |
| - name: "test3" |
| schema: |
| $ref: "#/definitions/Test3" |
| - name: "test4" |
| schema: |
| $ref: "#/definitions/Test4" |
| - name: "test5" |
| schema: |
| $ref: "#/definitions/Test5" |
| definitions: |
| Test2: |
| $ref: "#/definitions/TestProperty" |
| Test3: |
| type: "object" |
| properties: |
| withRef: |
| $ref: "#/definitions/TestProperty" |
| withAllOf: |
| type: "object" |
| allOf: |
| - $ref: "#/definitions/TestProperty" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty" |
| withAnyOf: |
| type: "object" |
| anyOf: |
| - $ref: "#/definitions/TestProperty" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty" |
| withOneOf: |
| type: "object" |
| oneOf: |
| - $ref: "#/definitions/TestProperty" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty" |
| withNot: |
| type: "object" |
| not: |
| $ref: "#/definitions/TestProperty" |
| patternProperties: |
| "prefix.*": |
| $ref: "#/definitions/TestProperty" |
| additionalProperties: |
| $ref: "#/definitions/TestProperty" |
| definitions: |
| SomeDefinition: |
| $ref: "#/definitions/TestProperty" |
| Test4: |
| type: "array" |
| items: |
| $ref: "#/definitions/TestProperty" |
| additionalItems: |
| $ref: "#/definitions/TestProperty" |
| Test5: |
| type: "array" |
| items: |
| - $ref: "#/definitions/TestProperty" |
| - $ref: "#/definitions/TestProperty" |
| TestProperty: |
| description: "This TestProperty is different from the one in spec1" |
| type: "object" |
| `), &spec2) |
| |
| yaml.Unmarshal([]byte(` |
| swagger: "2.0" |
| paths: |
| /test: |
| post: |
| parameters: |
| - name: "body" |
| schema: |
| $ref: "#/definitions/Test" |
| /test2: |
| post: |
| parameters: |
| - name: "test2" |
| schema: |
| $ref: "#/definitions/Test2" |
| - name: "test3" |
| schema: |
| $ref: "#/definitions/Test3" |
| - name: "test4" |
| schema: |
| $ref: "#/definitions/Test4" |
| - name: "test5" |
| schema: |
| $ref: "#/definitions/Test5" |
| definitions: |
| Test: |
| type: "object" |
| properties: |
| foo: |
| $ref: "#/definitions/TestProperty" |
| TestProperty: |
| type: "object" |
| Test2: |
| $ref: "#/definitions/TestProperty_v2" |
| Test3: |
| type: "object" |
| properties: |
| withRef: |
| $ref: "#/definitions/TestProperty_v2" |
| withAllOf: |
| type: "object" |
| allOf: |
| - $ref: "#/definitions/TestProperty_v2" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty_v2" |
| withAnyOf: |
| type: "object" |
| anyOf: |
| - $ref: "#/definitions/TestProperty_v2" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty_v2" |
| withOneOf: |
| type: "object" |
| oneOf: |
| - $ref: "#/definitions/TestProperty_v2" |
| - type: object |
| properties: |
| test: |
| $ref: "#/definitions/TestProperty_v2" |
| withNot: |
| type: "object" |
| not: |
| $ref: "#/definitions/TestProperty_v2" |
| patternProperties: |
| "prefix.*": |
| $ref: "#/definitions/TestProperty_v2" |
| additionalProperties: |
| $ref: "#/definitions/TestProperty_v2" |
| definitions: |
| SomeDefinition: |
| $ref: "#/definitions/TestProperty_v2" |
| Test4: |
| type: "array" |
| items: |
| $ref: "#/definitions/TestProperty_v2" |
| additionalItems: |
| $ref: "#/definitions/TestProperty_v2" |
| Test5: |
| type: "array" |
| items: |
| - $ref: "#/definitions/TestProperty_v2" |
| - $ref: "#/definitions/TestProperty_v2" |
| TestProperty_v2: |
| description: "This TestProperty is different from the one in spec1" |
| type: "object" |
| `), &expected) |
| |
| ast := assert.New(t) |
| if !ast.NoError(MergeSpecs(spec1, spec2)) { |
| return |
| } |
| ast.Equal(DebugSpec{expected}, DebugSpec{spec1}) |
| } |
