Merge pull request #4 from Synthetixio/custom-cmds

feat: add new custom commands
Synthetixio · Dec 1, 2020 · 4341b73 · 4341b73
2 parents 1ff9f78 + 3304ad1
commit 4341b73
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 0 deletions.
diff --git a/support/commands.js b/support/commands.js
@@ -1,6 +1,23 @@
 import '@testing-library/cypress/add-commands';
 import 'cypress-wait-until';
 
+Cypress.Commands.add('getId', name => {
+  if (name.includes('@')) {
+    return cy.get(`${name}`);
+  }
+  return cy.get(`[data-testid="${name}"]`).as(name);
+});
+
+Cypress.Commands.add('getText', selector => {
+  return cy.getId(`${selector}`).invoke('text');
+});
+
+Cypress.Commands.add('waitUntilExist', selector => {
+  cy.waitUntil(() => {
+    return cy.getId(`${selector}`).should('exist');
+  });
+});
+
 Cypress.Commands.add('getDesktopSizes', () => {
   return [
     [1366, 768],

diff --git a/support/index.d.ts b/support/index.d.ts
@@ -1,5 +1,26 @@
 declare namespace Cypress {
   interface Chainable<Subject> {
+    /**
+     * Get element using data-testid and sets an alias for it
+     * @example
+     * cy.getId('dataTestId')
+     * cy.getId('alias')
+     */
+    getId(testid: string): Chainable<Subject>;
+    /**
+     * Get text of element
+     * @example
+     * cy.getText('selector').then(text => cy.log(text))
+     * cy.getText('alias').then(text => cy.log(text))
+     */
+    getText(selector: string): Chainable<Subject>;
+    /**
+     * Waits until element exists
+     * @example
+     * cy.waitUntilExist('selector')
+     * cy.waitUntilExist('alias')
+     */
+    waitUntilExist(selector: string): Chainable<Subject>;
     /**
      * Get the most popular desktop resolutions
      * @example