← All questions

Chaining a created id into a UI assertion: JSON path $.id is undefined in the last response

@hybrid @regression
Scenario: A seeded order appears in the list
  When I seed via POST "/orders" with body:
    """json
    { "sku": "SD-1", "qty": 2 }
    """
  And I save the response JSON path "id" as "orderId"
  And I navigate to the "orders" page
  Then order "{{orderId}}" should show status "Pending"

JSON path $.id is undefined in the last response; cannot save as {{orderId}}.

3 answers

• 32votes✓

  Accepted answer

  The save step reads the last response, and it is telling you that the last response did not have an id at the top level. Two usual causes:

  The body is wrapped. A lot of APIs answer a create with { "data": { "id": 41 } }, and curl makes that easy to skim past. Then the path is data.id:

  gherkinCopy

  And I save the response JSON path "data.id" as "orderId"

  Or something ran in between. Any step that issues a request replaces the last response, so a save that is not immediately after the request it refers to may be reading a different one.

  Do not guess which — read what actually came back. Every request attaches its exchange to the scenario, and the files are in the run directory:

  textCopy

  .sdods/runs/<runId>/<slug>/<fingerprint>/r0/api/NN-n-response.json

  Open that and the path is obvious in about ten seconds.

  FManswered by Fiona McAllister159 · 13 Jun 2024
• 17votes

  Once the save works, the UI half. {{orderId}} is rendered in every {string} argument and doc string, so your Then line is fine as written.

  Inside the page object it is not automatic — you render it yourself:

  tsCopy

  @Then('order {string} should show status {string}')
  async status(order: string, status: string) {
    const id = this.render(order);
    await expect(this.page.getByTestId(`order-${id}`).getByText(status)).toBeVisible();
  }

  this.vars is the merged view: values saved in this scenario over the dataset row over vars from the environment file, in that order. this.render() expands against it.

  RGanswered by Rafa Garrido12,996 · 14 Jun 2024
• 9votes

  For the simple case there is a shared step that skips the page object entirely:

  gherkinCopy

  Then the UI should show the text from JSON path "sku"

  Worth knowing why any of this works at all: there is one merged fixture set, so the API client, the page, the healer and the data provider are all fixtures on the same test. Frameworks that keep a separate test object per layer cannot express this scenario without writing glue.

  A hybrid scenario

  YDanswered by Yusuf Demir201 · 20 Jun 2024