dceky 1.0.5-beta.ky-declarations.13 → 1.0.5

package/src/commands/getAttribute.ts

@@ -0,0 +1,58 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the attribute of an element
+       * @author Allison Zhang
+       * @param opts options object
+       * @param opts.selector the CSS selector of the element
+       * @param opts.attribute the attribute to retrieve
+       * @returns the attribute of the element
+       */
+      getAttribute(
+        opts: {
+          selector: string,
+          attribute: string,
+        },
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getAttribute = () => {
+  Cypress.Commands.add('getAttribute', (
+    opts: {
+      selector: string,
+      attribute: string,
+    },
+  ) => {
+    const {
+      selector,
+      attribute,
+    } = opts;
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', attribute)
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getAttribute;

package/src/commands/getClassName.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the class attribute of an element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the element
+       * @returns the class of the element, if multiple classes exist, they are space-separated
+       */
+      getClassName(
+        selector: string,
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getClassName = () => {
+  Cypress.Commands.add('getClassName', (selector: string) => {
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', 'class')
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getClassName;

package/src/commands/getCurrentDateInfo.ts

@@ -0,0 +1,57 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the current day
+       * @author Allison Zhang
+       * @returns the current month as a number (1-31)
+       */
+      getCurrentDateInfo(): Chainable<{
+        minute: number,
+        hour: number,
+        day: number,
+        month: number,
+        year: number,
+        dateString: string,
+      }>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getCurrentDateInfo = () => {
+  Cypress.Commands.add('getCurrentDateInfo', () => {
+    const current = new Date();
+    const dateInfo: {
+      minute: number,
+      hour: number,
+      day: number,
+      month: number,
+      year: number,
+      dateString: string,
+    } = {
+      minute: current.getMinutes(),
+      hour: current.getHours(),
+      day: current.getDate(),
+      month: current.getMonth() + 1,
+      year: current.getFullYear(),
+      dateString: current.toDateString(),
+    };
+    return cy.wrap(dateInfo);
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getCurrentDateInfo;

package/src/commands/getId.ts

@@ -0,0 +1,44 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the id of an element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the element
+       * @returns the id of the element
+       */
+      getId(
+        selector: string,
+      ): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getId = () => {
+  Cypress.Commands.add('getId', (selector: string) => {
+    return (
+      cy
+        .get(selector)
+        .invoke('attr', 'id')
+        .then((attr) => {
+          return attr;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getId;

package/src/commands/getJSON.ts

@@ -12,7 +12,6 @@ declare global {
        * @author Allison Zhang
        * @param url the URL to fetch the JSON data from
        * @returns the JSON data
-       * @example cy.getJSON('https://api.example.com/data').then((data) => { ... })
        */
       getJSON(
         url: string,
@@ -31,9 +30,6 @@ const getJSON = () => {
       cy
         .request(url)
         .its('body')
-        .then((body) => {
-          return body;
-        })
     );
   });
 };

package/src/commands/getSpecialChars.ts

@@ -0,0 +1,34 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Generate all printable special characters for Cypress tests
+       * @author Allison Zhang
+       * @returns a string containing all special characters
+       */
+      getSpecialChars(): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getSpecialChars = () => {
+  Cypress.Commands.add('getSpecialChars', () => {
+    return cy.wrap('!"#$%&\'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~€‚ƒ„…†‡ˆ‰Š‹ŒŽ‘’“”•–—˜™š›œžŸ¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿ≤≥≠÷…£¢∞§¶•º');
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getSpecialChars;

package/src/commands/getTitle.ts

@@ -0,0 +1,39 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the current title of the page
+       * @author Gardenia Liu
+       */
+      getTitle(): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const getTitle = () => {
+  Cypress.Commands.add('getTitle', () => {
+    return (
+      cy
+        .title()
+        .then((title) => {
+          return title;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default getTitle;

package/src/commands/index.ts

@@ -4,15 +4,27 @@ import assertHasClass from './assertHasClass';
 import assertNumElements from './assertNumElements';
 import extractDataFromClass from './extractDataFromClass';
 import extractDataFromClassByContents from './extractDataFromClassByContents';
+import genTextOfLength from './genTextOfLength';
+import getAttribute from './getAttribute';
+import getClassName from './getClassName';
+import getCurrentDateInfo from './getCurrentDateInfo';
+import getId from './getId';
 import getJSON from './getJSON';
 import getNumElements from './getNumElements';
+import getSpecialChars from './getSpecialChars';
+import getTitle from './getTitle';
 import handleHarvardKey from './handleHarvardKey';
 import launchAs from './launchAs';
 import launchLTIUsingToken from './launchLTIUsingToken';
+import listSelectLabels from './listSelectLabels';
+import listSelectValues from './listSelectValues';
 import navigateToHref from './navigateToHref';
+import padWithZeros from './padWithZeros';
 import runScript from './runScript';
 import typeInto from './typeInto';
-import visitCanvasGETEndpoint from './visitCanvasGETEndpoint';
+import uniquify from './uniquify';
+import visitCanvasEndpoint from './visitCanvasEndpoint';
+import waitForAtLeastOneElementPresent from './waitForAtLeastOneElementPresent';
 import waitForElementVisible from './waitForElementVisible';
 
 /**
@@ -24,18 +36,30 @@ const commands = () => {
   assertDoesNotHaveClass();
   assertHasClass();
   assertNumElements();
+  extractDataFromClass();
+  extractDataFromClassByContents();
+  genTextOfLength();
+  getAttribute();
+  getClassName();
+  getCurrentDateInfo();
+  getId();
+  getJSON();
   getNumElements();
+  getSpecialChars();
+  getTitle();
   handleHarvardKey();
   launchAs();
   launchLTIUsingToken();
+  listSelectLabels();
+  listSelectValues();
   navigateToHref();
+  padWithZeros();
   runScript();
   typeInto();
-  visitCanvasGETEndpoint();
+  uniquify();
+  visitCanvasEndpoint();
+  waitForAtLeastOneElementPresent();
   waitForElementVisible();
-  extractDataFromClass();
-  extractDataFromClassByContents();
-  getJSON();
 };
 
 export default commands;

package/src/commands/launchLTIUsingToken.ts

@@ -59,9 +59,13 @@ const launchLTIUsingToken = () => {
       cy.log(`Launch LTI app "${appName}" in course ${courseId} using access token`);
 
       // Get the external tools for the course
-      cy.visitCanvasGETEndpoint({
-        path: `/courses/${courseId}/external_tools`,
+      cy.visitCanvasEndpoint({
+        method: 'GET',
+        path: `/api/v1/courses/${courseId}/external_tools`,
         accessToken,
+        params: {
+          per_page: 200,
+        },
       }).then((externalTools: { [key: string]: any }[]) => {
         cy.log(`Found ${externalTools.length} external tools`);
 
@@ -93,9 +97,13 @@ const launchLTIUsingToken = () => {
         }
 
         // Get a sessionless launch URL
-        cy.visitCanvasGETEndpoint({
-          path: `/courses/${courseId}/external_tools/sessionless_launch?id=${toolId}`,
+        cy.visitCanvasEndpoint({
+          method: 'GET',
+          path: `/api/v1/courses/${courseId}/external_tools/sessionless_launch?id=${toolId}`,
           accessToken,
+          params: {
+            per_page: 200,
+          },
         }).then((sessionlessLaunchInfo) => {
           const launchURL = sessionlessLaunchInfo.url;
           cy.log(`Launching LTI app at: ${launchURL}`);

package/src/commands/listSelectLabels.ts

@@ -0,0 +1,47 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the labels of all the options within a select element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the select element
+       * @returns an array of strings representing the labels of the options
+       */
+      listSelectLabels(
+        selector: string,
+      ): Chainable<String[]>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const listSelectLabels = () => {
+  Cypress.Commands.add('listSelectLabels', (selector: string) => {
+    const labels: string[] = [];
+    return (
+      cy
+        .get(`${selector} option`)
+        .each((option) => {
+          labels.push(option.attr('label') || option.text());
+        })
+        .then(() => {
+          return labels;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default listSelectLabels;

package/src/commands/listSelectValues.ts

@@ -0,0 +1,50 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Get the values of all the options within a select element
+       * @author Allison Zhang
+       * @param selector the CSS selector of the select element
+       * @returns an array of strings representing the values of the options
+       */
+      listSelectValues(
+        selector: string,
+      ): Chainable<String[]>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const listSelectValues = () => {
+  Cypress.Commands.add('listSelectValues', (selector: string) => {
+    const vals: string[] = [];
+    return (
+      cy
+        .get(`${selector} option`)
+        .each((option) => {
+          cy.wrap(option).invoke('attr', 'value')
+            .then((value) => {
+              vals.push(value || option.text());
+            });
+        })
+        .then(() => {
+          return vals;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default listSelectValues;

package/src/commands/padWithZeros.ts

@@ -0,0 +1,53 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Pads a number with leading zeros to a user-defined length.
+       * @author Allison Zhang
+       * @param opts options object
+       * @param opts.length the desired total length of the output string, must be larger than the length of the number
+       * @param opts.number the number to be padded with leading zeros
+       * @returns padded string with leading zeros
+       */
+      padWithZeros(opts: {
+        length: number,
+        number: number,
+      }): Chainable<string>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const padWithZeros = () => {
+  Cypress.Commands.add('padWithZeros', (opts: { length: number, number: number }) => {
+    const {
+      length,
+      number,
+    } = opts;
+    return (
+      cy
+        .then(() => {
+          let numberString = number.toString();
+          while (numberString.length < length) {
+            numberString = `0${numberString}`;
+          }
+          return numberString;
+        })
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default padWithZeros;

package/src/commands/uniquify.ts

@@ -0,0 +1,49 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Makes a string unique by appending a timestamp and a counter.
+       * @author Allison Zhang
+       * @param text the original string
+       * @returns the uniquified string
+       */
+      uniquify(text: string): string;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Helpers -------------- */
+/*----------------------------------------*/
+
+let uniqueCounter = 1;
+
+const shorten = (num: number): string => {
+  return Number(num).toString(36);
+};
+
+const id = shorten(Math.floor(Math.random() * 10000));
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const uniquify = () => {
+  Cypress.Commands.add('uniquify', (text: string) => {
+    const thisCounter = uniqueCounter;
+    uniqueCounter += 1;
+    return `${text} [${shorten(Number.parseInt(`${Date.now()}${thisCounter}${id}`, 10))}]`;
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default uniquify;

package/src/commands/visitCanvasEndpoint.ts

@@ -0,0 +1,75 @@
+/// <reference types="cypress" />
+
+/*----------------------------------------*/
+/* ---------------- Type ---------------- */
+/*----------------------------------------*/
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Send a request to a Canvas API endpoint.
+       * @author Allison Zhang
+       * @param opts options object
+       * @param opts.method the HTTP method (e.g., 'GET', 'POST', 'DELETE')
+       * @param opts.path the API endpoint path excluding 'https://canvas.harvard.edu', (e.g., '/api/v1/courses/123')
+       * @param opts.accessToken the access token for authentication
+       * @param opts.params the request params (if any)
+       * @returns Cypress chainable containing the Canvas API response body
+       */
+      visitCanvasEndpoint(
+        opts: {
+          method: string,
+          path: string,
+          accessToken: string,
+          params?: { [k: string]: any },
+        },
+      ): Chainable<any>;
+    }
+  }
+}
+
+/*----------------------------------------*/
+/* --------------- Command -------------- */
+/*----------------------------------------*/
+
+const visitCanvasEndpoint = () => {
+  Cypress.Commands.add('visitCanvasEndpoint', (
+    opts: {
+      method: string,
+      path: string,
+      accessToken: string,
+      params: {
+        [k: string]: any
+      }
+    },
+  ) => {
+    const {
+      method,
+      path,
+      accessToken,
+      params,
+    } = opts;
+    cy.log(`Visiting Canvas ${method} endpoint`);
+    cy.log(`Canvas API: ${path}`);
+
+    return (
+      cy
+        .request({
+          method,
+          url: `https://canvas.harvard.edu${path}`,
+          body: {
+            ...(params || {}),
+            access_token: accessToken,
+          },
+        })
+        .its('body')
+    );
+  });
+};
+
+/*----------------------------------------*/
+/* --------------- Export --------------- */
+/*----------------------------------------*/
+
+export default visitCanvasEndpoint;