-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: correctly serialises security schemes in OpenAPI plugin.
- Loading branch information
1 parent
253560f
commit 4928932
Showing
4 changed files
with
272 additions
and
2 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
89 changes: 89 additions & 0 deletions
89
plugin/openapi/src/test/java/io/gatehill/imposter/plugin/openapi/SecuritySchemesTest.kt
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,89 @@ | ||
| /* | ||
| * Copyright (c) 2016-2021. | ||
| * | ||
| * This file is part of Imposter. | ||
| * | ||
| * "Commons Clause" License Condition v1.0 | ||
| * | ||
| * The Software is provided to you by the Licensor under the License, as | ||
| * defined below, subject to the following condition. | ||
| * | ||
| * Without limiting other conditions in the License, the grant of rights | ||
| * under the License will not include, and the License does not grant to | ||
| * you, the right to Sell the Software. | ||
| * | ||
| * For purposes of the foregoing, "Sell" means practicing any or all of | ||
| * the rights granted to you under the License to provide to third parties, | ||
| * for a fee or other consideration (including without limitation fees for | ||
| * hosting or consulting/support services related to the Software), a | ||
| * product or service whose value derives, entirely or substantially, from | ||
| * the functionality of the Software. Any license notice or attribution | ||
| * required by the License must also include this Commons Clause License | ||
| * Condition notice. | ||
| * | ||
| * Software: Imposter | ||
| * | ||
| * License: GNU Lesser General Public License version 3 | ||
| * | ||
| * Licensor: Peter Cornish | ||
| * | ||
| * Imposter is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Lesser General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * Imposter is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public License | ||
| * along with Imposter. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
| package io.gatehill.imposter.plugin.openapi | ||
|
|
||
| import com.jayway.restassured.RestAssured | ||
| import com.jayway.restassured.http.ContentType | ||
| import io.gatehill.imposter.server.BaseVerticleTest | ||
| import io.gatehill.imposter.util.HttpUtil | ||
| import io.vertx.ext.unit.TestContext | ||
| import org.hamcrest.Matchers.equalTo | ||
| import org.hamcrest.Matchers.notNullValue | ||
| import org.junit.Before | ||
| import org.junit.Test | ||
|
|
||
| /** | ||
| * Tests that security schemes are serialised correctly. | ||
| * | ||
| * @author Pete Cornish | ||
| */ | ||
| class SecuritySchemesTest : BaseVerticleTest() { | ||
| override val pluginClass = OpenApiPluginImpl::class.java | ||
|
|
||
| @Before | ||
| @Throws(Exception::class) | ||
| override fun setUp(testContext: TestContext) { | ||
| super.setUp(testContext) | ||
| RestAssured.baseURI = "http://$host:$listenPort" | ||
| } | ||
|
|
||
| override val testConfigDirs = listOf( | ||
| "/openapi3/security-schemes" | ||
| ) | ||
|
|
||
| /** | ||
| * Expects that securityScheme type is serialised correctly. | ||
| */ | ||
| @Test | ||
| fun testExampleRefReturned() { | ||
| RestAssured.given() | ||
| .log().ifValidationFails() | ||
| .accept(ContentType.JSON) | ||
| .`when`()[OpenApiPluginImpl.COMBINED_SPECIFICATION_PATH] | ||
| .then() | ||
| .log().ifValidationFails() | ||
| .statusCode(HttpUtil.HTTP_OK) | ||
| .body("components.securitySchemes.httpBasic", notNullValue()) | ||
| .body("components.securitySchemes.httpBasic.type", equalTo("http")) | ||
| } | ||
| } |
2 changes: 2 additions & 0 deletions
2
plugin/openapi/src/test/resources/openapi3/security-schemes/imposter-config.yaml
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,2 @@ | ||
| plugin: openapi | ||
| specFile: spec.yaml |
175 changes: 175 additions & 0 deletions
175
plugin/openapi/src/test/resources/openapi3/security-schemes/spec.yaml
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,175 @@ | ||
| openapi: "3.0.0" | ||
| info: | ||
| title: Simple API overview | ||
| version: 2.0.0 | ||
| paths: | ||
| /: | ||
| get: | ||
| operationId: listVersionsv2 | ||
| summary: List API versions | ||
| responses: | ||
| '200': | ||
| description: |- | ||
| 200 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| foo: | ||
| value: | ||
| { | ||
| "versions": [ | ||
| { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "status": "EXPERIMENTAL", | ||
| "updated": "2013-07-23T11:33:21Z", | ||
| "id": "v3.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v3/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| '300': | ||
| description: |- | ||
| 300 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| foo: | ||
| value: | | ||
| { | ||
| "versions": [ | ||
| { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "status": "EXPERIMENTAL", | ||
| "updated": "2013-07-23T11:33:21Z", | ||
| "id": "v3.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v3/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| /v2: | ||
| get: | ||
| operationId: getVersionDetailsv2 | ||
| summary: Show API version details | ||
| responses: | ||
| '200': | ||
| description: |- | ||
| 200 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| foo: | ||
| value: | ||
| { | ||
| "version": { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "media-types": [ | ||
| { | ||
| "base": "application/xml", | ||
| "type": "application/vnd.openstack.compute+xml;version=2" | ||
| }, | ||
| { | ||
| "base": "application/json", | ||
| "type": "application/vnd.openstack.compute+json;version=2" | ||
| } | ||
| ], | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | ||
| "type": "application/pdf", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| '203': | ||
| description: |- | ||
| 203 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| foo: | ||
| value: | ||
| { | ||
| "version": { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "media-types": [ | ||
| { | ||
| "base": "application/xml", | ||
| "type": "application/vnd.openstack.compute+xml;version=2" | ||
| }, | ||
| { | ||
| "base": "application/json", | ||
| "type": "application/vnd.openstack.compute+json;version=2" | ||
| } | ||
| ], | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://23.253.228.211:8774/v2/", | ||
| "rel": "self" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | ||
| "type": "application/pdf", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| components: | ||
| securitySchemes: | ||
| httpBasic: | ||
| type: "http" | ||
| scheme: "basic" |