Merge pull request #123 from thebiggive/REG-34-donation-funds-test

REG-34: Stop skipping credit donation test

Author: bdsl

.circleci/config.yml

@@ -25,7 +25,7 @@ jobs:
           paths:
             - ~/.cache
       - run: yarn lint
-      - run: yarn tsc || echo "Typescript errors found, not failing build"
+      - run: yarn tsc
       - run: yarn test:testingbot-all
       # - run: yarn test:testingbot-chrome
       # - run: yarn test:testingbot-edge

features/donation-with-credits.feature

@@ -1,4 +1,3 @@
-@skip()
 Feature: Existing donor: credit donation completes successfully
 
     As a donor who doesn't have access to a card that can be used to donate via Big Give's platform
@@ -18,7 +17,7 @@ Feature: Existing donor: credit donation completes successfully
         Then I should see my populated first name is "RegressionTest"
         And I should see my populated surname is "User"
         And I should see my populated email is "[email protected]"
-        And I should see "Your credit balance will be applied against this donation. No further funds will be taken." instead of asking for my bank details.
+        And I should see "Your donation funds balance will be applied against this donation. No further funds will be taken." instead of asking for my bank details.
         When I continue through this step with no changes
         And I choose a preference for charity and TBG communications
         And I press Donate

pages/DonateStartPage.js

@@ -68,7 +68,7 @@ export default class DonateStartPage {
      * while keeping the step definitions simple.
      *
      * @param {string} selector Element selector.
-     * @returns {any} click() result on success.
+     * @returns {Promise<any>} click() result on success.
      */
     async clickActiveSelector(selector) {
         let bestButton;
@@ -93,7 +93,7 @@ export default class DonateStartPage {
      *
      * @param {string} selector Element selector.
      * @param {string} inputValue The new value.
-     * @returns {any} setValue() result on success.
+     * @returns {Promise<any>} setValue() result on success.
      */
     async inputSelectorValue(selector, inputValue) {
         return inputSelectorValue(selector, inputValue);

pages/PledgeFormPage.js

@@ -21,7 +21,7 @@ export default class PledgeFormPage {
     /**
      * Get the input field corresponding to the given label text.
      * @param {string} label    Full or partial label text. No single quotes.
-     * @returns {string}   Input selector
+     * @returns {Promise<string>}   Input selector
      */
     async getCommunitiesInputForLabel(label) {
         return `//label[contains(text(), '${label}')]//..//input`;
@@ -32,7 +32,7 @@ export default class PledgeFormPage {
      * seems to put the label text in an inner <span>.
      *
      * @param {string} label    Full or partial label text. No single quotes.
-     * @returns {string}   Select selector
+     * @returns {Promise<string>}   Select selector
      */
     async getCommunitiesSelectForLabel(label) {
         return `//span[contains(text(), '${label}')]//..//..//select`;

steps/donation.js

@@ -29,9 +29,10 @@ BeforeAll(() => {
 // Steps
 Given(
     /^that I am on my chosen ([a-zA-Z]+)-enabled charity's Donate page$/,
+    // eslint-disable-next-line no-unused-vars
     async (psp) => {
         page.nextStepIndex = 0;
-        await page.open(psp);
+        await page.open();
         await page.checkReady();
     }
 );

steps/hooks.js

@@ -7,13 +7,13 @@ before(async (scenario) => {
 after(async (scenarioResult) => {
     // Here it is added to a failed step, but each time you call
     // `browser.saveScreenshot()` it will automatically be added to the report
-    if (scenarioResult.result.status !== 'passed') {
+    if (scenarioResult.result.status !== 'PASSED') {
         // It will add the screenshot to the JSON
         await console.warn('WARNING: Step Failed - screenshot being taken...');
 
         const datetime = encodeURIComponent((new Date()).toISOString());
         const filePath = `build/failure-${datetime}.png`;
         await browser.saveScreenshot(filePath);
     }
-    return scenarioResult.status;
+    return scenarioResult.result.status;
 });

support/action.js

@@ -23,7 +23,7 @@ export async function clickSelector(selector, options = {}) {
 /**
  * Click an element that we have already tested for existence and clickability.
  *
- * @param {Element} element The element.
+ * @param {HTMLElement} element The element.
  * @param {string} originalSelector Text used to look it up, for info log.
  */
 export async function clickElement(element, originalSelector) {
@@ -92,7 +92,7 @@ export async function leaveStripeIframe() {
  * get element text
  *
  * @param {string} selector of content
- * @returns {string} element text
+ * @returns {Promise<string>} element text
  */
 export async function getSelectorText(selector) {
     if (!(await checkIfElementExists(selector))) {

support/check.js

@@ -4,7 +4,7 @@ import { WAIT_SECONDS } from './constants';
  * Check if element exists
  *
  * @param {string} selector to be checked
- * @param {int} seconds to wait
+ * @param {number} seconds to wait
  * @returns {Promise<boolean>} True if element exists or false if element doesn't exist
  */
 export async function checkIfElementExists(selector, seconds = WAIT_SECONDS) {
@@ -17,7 +17,7 @@ export async function checkIfElementExists(selector, seconds = WAIT_SECONDS) {
  * Checks whether a non-required selector is already present on the page.
  *
  * @param {string} selector DOM selector to seek
- * @return {boolean} Whether element exists
+ * @return {Promise<boolean>} Whether element exists
  */
 export async function elementExists(selector) {
     return $(selector).isDisplayed();
@@ -27,7 +27,7 @@ export async function elementExists(selector) {
  * Assert URL
  *
  * @param {string} url to be asserted
- * @param {int} seconds to wait
+ * @param {number} seconds to wait
  * @return {Promise<boolean>} return if url matched
  */
 export async function checkUrl(url, seconds = WAIT_SECONDS) {
@@ -46,7 +46,7 @@ export async function checkUrl(url, seconds = WAIT_SECONDS) {
  * Assert URL Regex
  *
  * @param {string} url to be asserted
- * @param {int} seconds to wait
+ * @param {number} seconds to wait
  * @return {Promise<boolean>} return if url match regex
  */
 export async function checkUrlMatch(url, seconds = WAIT_SECONDS) {
@@ -65,7 +65,7 @@ export async function checkUrlMatch(url, seconds = WAIT_SECONDS) {
  * Check webpage title
  *
  * @param {string} title of webpage
- * @param {int} seconds to wait
+ * @param {number} seconds to wait
  * @return {Promise<boolean>} return if title matched
  */
 export async function checkTitle(title, seconds = WAIT_SECONDS) {
@@ -83,10 +83,10 @@ export async function checkTitle(title, seconds = WAIT_SECONDS) {
 /**
  * Check a specific element contains certain text.
  *
- * @param {Element} element Already-located element.
+ * @param {WebdriverIO.Element} element Already-located element.
  * @param {string} content Expected content.
- * @param {int} seconds Number of seconds to wait.
- * @returns {any} `waitUntil()` result.
+ * @param {number} seconds Number of seconds to wait.
+ * @returns {Promise<any>} `waitUntil()` result.
  */
 async function checkText(element, content, seconds = WAIT_SECONDS) {
     return browser.waitUntil(
@@ -110,7 +110,7 @@ async function checkText(element, content, seconds = WAIT_SECONDS) {
  *
  * @param {string} selector of content
  * @param {string} content text
- * @param {int} seconds to wait
+ * @param {number} seconds to wait
  * @return {Promise<boolean>} return if text exist
  */
 export async function checkSelectorContent(selector, content, seconds = WAIT_SECONDS) {
@@ -130,8 +130,8 @@ export async function checkSelectorContent(selector, content, seconds = WAIT_SEC
  *
  * @param {string} selector DOM element selector.
  * @param {string} content text
- * @param {int} seconds to wait
- * @returns {any} `waitUntil()` result, assuming 1+ elements visible.
+ * @param {number} seconds to wait
+ * @returns {Promise<any>} `waitUntil()` result, assuming 1+ elements visible.
  */
 export async function checkVisibleSelectorContent(selector, content, seconds = WAIT_SECONDS) {
     console.log(`CHECK: First visible element "${selector}" contains content "${content}"`);

support/constants.js

@@ -1,3 +1,3 @@
 // Allow for future constants by not exporting `default`.
 // eslint-disable-next-line import/prefer-default-export
-export const WAIT_SECONDS = process.env.WAIT_SECONDS || 20;
+export const WAIT_SECONDS = Number(process.env.WAIT_SECONDS || 20);

support/mailtrap.js

@@ -1,5 +1,10 @@
 const axios = require('axios');
 
+if (!('create' in axios && typeof axios.create === 'function')) {
+    // workaround for TS error;
+    throw new Error('Missing axios create function');
+}
+
 const mailtrapClient = axios.create({
     baseURL: 'https://mailtrap.io',
     headers: {
@@ -11,7 +16,7 @@ const mailtrapClient = axios.create({
  * Makes an authenticated GET call to Mailtrap.io's API.
  *
  * @param {string} path         Request path
- * @param {array} responseType  Deserialised response data
+ * @param {string} responseType  Deserialised response data
  */
 async function mailtrapGet(path, responseType) {
     const response = await mailtrapClient.get(path, { responseType });
@@ -22,7 +27,7 @@ async function mailtrapGet(path, responseType) {
  * Get the latest Mailtrap inbox message, if any.
  *
  * @param {string} toEmailAddress Only find emails addressed to this account
- * @returns {array}     Up to {{count}} messages, if available.
+ * @returns {Promise<array>}     Up to {{count}} messages, if available.
  */
 async function getLatestMessages(toEmailAddress) {
     if (typeof toEmailAddress !== 'string') {
@@ -50,7 +55,7 @@ async function getLatestMessages(toEmailAddress) {
  * @param {string} searchText   Expected text to find anywhere in HTML
  * @param {string} toEmailAddress Only find emails addressed to this account
  *              (or an account that starts with this)
- * @returns {boolean}       Whether the expected text was found.
+ * @returns {Promise<boolean>}       Whether the expected text was found.
  */
 export async function checkAnEmailBodyContainsText(searchText, toEmailAddress) {
     const messages = await getLatestMessages(toEmailAddress);
@@ -82,7 +87,7 @@ export async function checkAnEmailBodyContainsText(searchText, toEmailAddress) {
  *
  * @param {string} searchText   Text to expect in latest subject line.
  * @param {string} toEmailAddress Only find emails addressed to this account
- * @returns {void}
+ * @returns {Promise<void>} Promise that resolves when check is done.
  */
 export async function checkAnEmailSubjectContainsText(searchText, toEmailAddress) {
     const messages = await getLatestMessages(toEmailAddress);