(Add Documentation for) Passing API return values between given/when/then

Hi,

I’m using cypress-cucumber-preprocessor to e2e test an API, and am having trouble using cy.request due to it naturally needing to be chained.

In Cypress I would normally do

cy.request('/test').its('status').should(...) etc 

In the example given you use cy.visit, and I assume this stores it in the cy object? What is the best way to do this? Or is this not the correct way of thinking? Currently I am doing this:

/* global cy, then, when, given */

const testEndpoint = '/test'
let response

given('I have access to the test endpoint', () => {
  // expect(true).to.be.equal(true)
})

when('I request the GET /test endpoint', () => {
  response = cy.request(testEndpoint)
})

then(`I get a {int} response code`, (responseCode) => {
  response.its('status').should('eq', responseCode)
})

whilst this works this is obviously not great, and when I want to split out the then into its own shared file etc it will become a nightmare!

Many thanks

[PointmanDev]

You can use everything that’s in Cypress with this library.

If I was doing this in a single function, I’d use the “Cy.as” syntax and then wait for it. I think you should be able to do this across steps in the same scenario, though.

E.G.

given('I have access to the test endpoint', () => {
  // expect(true).to.be.equal(true)
})

when('I request the GET /test endpoint', () => {
  cy.server()
  cy.route('GET', '/test').as('loginResponse');  // using "AS" here instead of a local variable.
  cy.request(testEndpoint)

})

then(`I get a {int} response code`, (responseCode) => {
    cy.wait('@loginResponse').then((xhr) => {
        expect(xhr.status).to.equal(responseCode);
     })
});

[twilczek]

@OllyNuralAND We have prepared an example of how to share context between given, when, then steps. You can see it here: https://github.com/TheBrainFamily/cypress-cucumber-preprocessor/pull/74 Note that we alias the input in When step as addNewItemInput and we use this reference in Then step to make sure it’s empty.