cypress-cucumber-steps/src/assertions/cookie.ts

Cypress Cucumber step definitions

import { DataTable, Then } from '@badeball/cypress-cucumber-preprocessor';

import { getOptions } from '../utils';

/**
 * Then I see cookie:
 *
 * ```gherkin
 * Then I see cookie {string}
 * ```
 *
 * Assert cookie with name **_exists_**.
 *
 * @example
 *
 * ```gherkin
 * Then I see cookie "my-session-cookie"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/getcookie#Arguments):
 *
 * ```gherkin
 * Then I see cookie "my-session-cookie"
 *   | domain | example.com |
 *   | log | true |
 *   | timeout | 3000 |
 * ```
 *
 * @see
 *
 * - {@link Then_I_see_cookie_has_value | Then I see cookie has value}
 * - {@link Then_I_do_not_see_cookie | Then I do not see cookie}
 */
export function Then_I_see_cookie(name: string, options?: DataTable) {
  cy.getCookie(name, getOptions(options)).should('exist');
}

Then('I see cookie {string}', Then_I_see_cookie);

/**
 * Then I see cookie has value:
 *
 * ```gherkin
 * Then I see cookie {string} has value {string}
 * ```
 *
 * Assert cookie value has exact match.
 *
 * @example
 *
 * ```gherkin
 * Then I see cookie "name" has value "value"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/getcookie#Arguments):
 *
 * ```gherkin
 * Then I see cookie "name" has value "value"
 *   | domain | example.com |
 *   | log | true |
 *   | timeout | 3000 |
 * ```
 *
 * @see
 *
 * - {@link Then_I_see_cookie_contains_value | Then I see cookie contains value}
 */
export function Then_I_see_cookie_has_value(
  name: string,
  value: string,
  options?: DataTable,
) {
  cy.getCookie(name, getOptions(options)).should(
    'have.property',
    'value',
    value,
  );
}

Then('I see cookie {string} has value {string}', Then_I_see_cookie_has_value);

/**
 * Then I see cookie contains value:
 *
 * ```gherkin
 * Then I see cookie {string} contains value {string}
 * ```
 *
 * Assert cookie value has partial match.
 *
 * @example
 *
 * ```gherkin
 * Then I see cookie "name" contains value "value"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/getcookie#Arguments):
 *
 * ```gherkin
 * Then I see cookie "name" contains value "value"
 *   | domain | example.com |
 *   | log | true |
 *   | timeout | 3000 |
 * ```
 *
 * @see
 *
 * - {@link Then_I_see_cookie_has_value | Then I see cookie has value}
 */
export function Then_I_see_cookie_contains_value(
  name: string,
  value: string,
  options?: DataTable,
) {
  cy.getCookie(name, getOptions(options)).should((cookie) => {
    expect(cookie?.value).to.contains(value);
  });
}

Then(
  'I see cookie {string} contains value {string}',
  Then_I_see_cookie_contains_value,
);

/**
 * Then I do not see cookie:
 *
 * ```gherkin
 * Then I do not see cookie {string}
 * ```
 *
 * Assert cookie with name **_does not exist_**.
 *
 * @example
 *
 * ```gherkin
 * Then I do not see cookie "my-session-cookie"
 * ```
 *
 * With [options](https://docs.cypress.io/api/commands/getcookie#Arguments):
 *
 * ```gherkin
 * Then I do not see cookie "my-session-cookie"
 *   | domain | example.com |
 *   | log | true |
 *   | timeout | 3000 |
 * ```
 *
 * @see
 *
 * - {@link Then_I_see_cookie | Then I see cookie}
 */
export function Then_I_do_not_see_cookie(name: string, options?: DataTable) {
  cy.getCookie(name, getOptions(options)).should('not.exist');
}

Then('I do not see cookie {string}', Then_I_do_not_see_cookie);