kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

test(cypress): fix tests flakiness by stubbing httpbin.org requests (#8410)

Browse Source 
Closes #8409
This commit is contained in:
Vladimír Gorej
2023-02-23 16:15:44 +01:00
committed by GitHub
parent 61642927b6
commit 21cfda392f
3 changed files with 129 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
test/e2e-cypress/tests/bugs/6183.js
View File

@@ -1,5 +1,29 @@
describe("When trying it out", () => {
it("should render the response headers as comma separated lists", () => {
cy.intercept(
{
method: "GET",
url: /^\/response-headers/,
hostname: "httpbin.org",
},
{
body: {
"Access-Control-Expose-Headers": "X-Header1, X-Header2, X-Header3, Access-Control-Expose-Headers",
"Content-Length": "289",
"Content-Type": "application/json",
"X-Header1": "value1,value2",
"X-Header2": "value3,value4",
"X-Header3": ["value5", "value6"]
},
headers: {
"access-control-expose-headers": "X-Header1,X-Header2,X-Header3,Access-Control-Expose-Headers",
"content-type": "application/json",
"x-header1": "value1,value2",
"x-header2": "value3,value4",
"x-header3": "value5,value6",
}
})
cy.visit("/?url=/documents/bugs/6183.yaml")
.get("#operations-default-get_response_headers")
.click()

6
test/e2e-cypress/tests/features/oas3-multiple-media-type.js
View File

@@ -8,6 +8,12 @@ describe("OpenAPI 3.0 Multiple Media Types with different schemas", () => {
const mediaTypeJson = "application/json"
beforeEach(() => {
cy.intercept({
method: "POST",
url: "/post",
hostname: "httpbin.org",
}, {})
cy.visit(
"/?url=/documents/features/oas3-multiple-media-type.yaml"
)

147
test/e2e-cypress/tests/features/oas3-request-body-required.js
View File

@@ -4,44 +4,59 @@
describe("OpenAPI 3.0 Validation for Required Request Body and Request Body Fields", () => {
describe("Request Body required bug/5181", () => {
it("on execute, if empty value, SHOULD render class 'invalid' and should NOT render cURL component", () => {
cy.visit(
"/?url=/documents/bugs/5181.yaml"
beforeEach(() => {
cy.intercept(
{
method: "POST",
url: "/anything/foos",
hostname: "httpbin.org",
},
{}
)
})
it("on execute, if empty value, SHOULD render class 'invalid' and should NOT render cURL component", () => {
cy.visit("/?url=/documents/bugs/5181.yaml")
.get("#operations-default-post_foos")
.click()
// Expand Try It Out
.get(".try-out__btn")
.click()
// get input
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input"
)
.should("not.have.class", "invalid")
// Execute
.get(".execute.opblock-control__btn")
.click()
// class "invalid" should now exist (and render red, which we won't check)
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input"
)
.should("have.class", "invalid")
// cURL component should not exist
.get(".responses-wrapper .curl-command")
.should("not.exist")
})
it("on execute, if value exists, should NOT render class 'invalid' and SHOULD render cURL component", () => {
cy.visit(
"/?url=/documents/bugs/5181.yaml"
)
cy.visit("/?url=/documents/bugs/5181.yaml")
.get("#operations-default-post_foos")
.click()
// Expand Try It Out
.get(".try-out__btn")
.click()
// get input
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input"
)
.type("abc")
// Execute
.get(".execute.opblock-control__btn")
.click()
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(1) > .parameters-col_description input"
)
.should("not.have.class", "invalid")
// cURL component should exist
.get(".responses-wrapper .curl-command")
@@ -51,45 +66,49 @@ describe("OpenAPI 3.0 Validation for Required Request Body and Request Body Fiel
describe("Request Body required fields - application/json", () => {
it("on execute, if empty value, SHOULD render class 'invalid' and should NOT render cURL component", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
// Expand Try It Out
.get(".try-out__btn")
.click()
// get and clear textarea
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("not.have.class", "invalid")
.clear()
// Execute
.get(".execute.opblock-control__btn")
.click()
// class "invalid" should now exist (and render red, which we won't check)
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("have.class", "invalid")
// cURL component should not exist
.get(".responses-wrapper .curl-command")
.should("not.exist")
})
it("on execute, if value exists, even if just single space, should NOT render class 'invalid' and SHOULD render cURL component that contains the single space", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
// Expand Try It Out
.get(".try-out__btn")
.click()
// get, clear, then modify textarea
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.clear()
.type(" ")
// Execute
.get(".execute.opblock-control__btn")
.click()
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("not.have.class", "invalid")
// cURL component should exist
.get(".responses-wrapper .curl-command")
@@ -106,50 +125,60 @@ describe("OpenAPI 3.0 Validation for Required Request Body and Request Body Fiel
*/
describe("Request Body required fields - application/x-www-form-urlencoded", () => {
it("on execute, if empty value, SHOULD render class 'invalid' and should NOT render cURL component", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
.get(".opblock-section .opblock-section-request-body .body-param-content-type > select")
.get(
".opblock-section .opblock-section-request-body .body-param-content-type > select"
)
.select("application/x-www-form-urlencoded")
// Expand Try It Out
.get(".try-out__btn")
.click()
// get and clear input populated from example value
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.clear()
// Execute
.get(".execute.opblock-control__btn")
.click()
// class "invalid" should now exist (and render red, which we won't check)
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.should("have.class", "invalid")
// cURL component should not exist
.get(".responses-wrapper .curl-command")
.should("not.exist")
})
it("on execute, if all values exist, even if array exists but is empty, should NOT render class 'invalid' and SHOULD render cURL component", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
.get(".opblock-section .opblock-section-request-body .body-param-content-type > select")
.get(
".opblock-section .opblock-section-request-body .body-param-content-type > select"
)
.select("application/x-www-form-urlencoded")
// Expand Try It Out
.get(".try-out__btn")
.click()
// add item to get input
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description button")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description button"
)
.click()
// Execute
.get(".execute.opblock-control__btn")
.click()
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.should("have.value", "doggie")
.should("not.have.class", "invalid")
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description input"
)
.should("have.value", "string")
.should("not.have.class", "invalid")
// cURL component should exist
@@ -160,58 +189,76 @@ describe("OpenAPI 3.0 Validation for Required Request Body and Request Body Fiel
describe("Request Body: switching between Content Types", () => {
it("after application/json 'invalid' error, on switch content type to application/x-www-form-urlencoded, SHOULD be free of errors", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
// Expand Try It Out
.get(".try-out__btn")
.click()
// get and clear textarea
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("not.have.class", "invalid")
.clear()
// Execute
.get(".execute.opblock-control__btn")
.click()
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("have.class", "invalid")
// switch content type
.get(".opblock-section .opblock-section-request-body .body-param-content-type > select")
.get(
".opblock-section .opblock-section-request-body .body-param-content-type > select"
)
.select("application/x-www-form-urlencoded")
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.should("not.have.class", "invalid")
// add item to get input, just an extra confirmation of non-invalid class
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description button")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description button"
)
.click()
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(4) > .parameters-col_description input"
)
.should("not.have.class", "invalid")
})
it("after application/x-www-form-urlencoded 'invalid' error, on switch content type to application/json, SHOULD be free of errors", () => {
cy.visit(
"/?url=/documents/features/petstore-only-pet.openapi.yaml"
)
cy.visit("/?url=/documents/features/petstore-only-pet.openapi.yaml")
.get("#operations-pet-addPet")
.click()
.get(".opblock-section .opblock-section-request-body .body-param-content-type > select")
.get(
".opblock-section .opblock-section-request-body .body-param-content-type > select"
)
.select("application/x-www-form-urlencoded")
// Expand Try It Out
.get(".try-out__btn")
.click()
// get and clear input
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.clear()
// Execute
.get(".execute.opblock-control__btn")
.click()
// class "invalid" should now exist (and render red, which we won't check)
.get(".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input")
.get(
".opblock-body .opblock-section .opblock-section-request-body .parameters:nth-child(2) > .parameters-col_description input"
)
.should("have.class", "invalid")
// switch content type
.get(".opblock-section .opblock-section-request-body .body-param-content-type > select")
.get(
".opblock-section .opblock-section-request-body .body-param-content-type > select"
)
.select("application/json")
.get(".opblock-body .opblock-section .opblock-section-request-body .body-param textarea")
.get(
".opblock-body .opblock-section .opblock-section-request-body .body-param textarea"
)
.should("not.have.class", "invalid")
})
})