Skip to content

Commit

Permalink
feat(assertions): add "Then I see location"
Browse files Browse the repository at this point in the history
  • Loading branch information
remarkablemark committed Feb 3, 2024
1 parent 561a0fa commit 2099ce9
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/assertions/location/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from './hash';
export * from './location';
export * from './search';
61 changes: 61 additions & 0 deletions src/assertions/location/location.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
import { DataTable, Then } from '@badeball/cypress-cucumber-preprocessor';

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

/**
* Then I see location:
*
* ```gherkin
* Then I see location
* | hash | {string} |
* | host | {string} |
* | hostname | {string} |
* | href | {string} |
* | origin | {string} |
* | pathname | {string} |
* | port | {string} |
* | protocol | {string} |
* | search | {string} |
* ```
*
* @example
*
* Make assertions about every location property:
*
* ```gherkin
* Then I see location
* | hash | #hash |
* | host | localhost:8081 |
* | hostname | localhost |
* | href | http://localhost:8081/commands/querying?key=value#hash |
* | origin | http://localhost:8081 |
* | pathname | /commands/querying |
* | port | 8081 |
* | protocol | http: |
* | search | ?key=value |
* ```
*
* Check location for query params and pathname:
*
* ```gherkin
* Then I see location
* | search | ?key=value |
* | pathname | /commands/querying |
* ```
*
* @see
*
* - {@link Then_I_see_hash | Then I see hash}
* - {@link Then_I_see_search | Then I see search}
*/
export function Then_I_see_location(location: DataTable) {
const loc = getOptions(location);

if (typeof loc?.port === 'number') {
loc.port = String(loc.port);
}

cy.location().should('include', loc);
}

Then('I see location', Then_I_see_location);

0 comments on commit 2099ce9

Please sign in to comment.