Merge pull request #50 from square/deanpapastrat/add-puppeteer-tests

Add Puppeteer test for credit-card only case

.eslintrc.js

@@ -26,6 +26,8 @@ module.exports = {
         '.eslintrc.js',
         '.template-lintrc.js',
         'ember-cli-build.js',
+        'jest-puppeteer.config.js',
+        'jest.config.js',
         'index.js',
         'testem.js',
         'blueprints/*/index.js',
@@ -50,6 +52,20 @@ module.exports = {
       rules: Object.assign({}, require('eslint-plugin-node').configs.recommended.rules, {
         // add your custom rules and overrides for node files here
       })
+    },
+    {
+      env: {
+        jest: true,
+      },
+      files: [
+        'tests/browser/**/*.js'
+      ],
+      globals: {
+        page: true,
+        browser: true,
+        context: true,
+        jestPuppeteer: true,
+      }
     }
   ]
 };

.travis.yml

@@ -46,6 +46,10 @@ jobs:
       script:
         - yarn test
 
+    - name: "End-to-End Test"
+      script:
+        - yarn browser-test
+
     # we recommend new addons test the current and previous LTS
     # as well as latest stable release (bonus points to beta/canary)
     - stage: "Additional Tests"

jest-puppeteer.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+  server: {
+    command: 'yarn ember server -lr false -path ./dist',
+    port: 4200,
+    launchTimeout: 60000,
+    debug: true
+  },
+  launch: {
+    args: ['--no-sandbox', '--disable-setuid-sandbox'],
+    headless: true
+  },
+  exitOnPageError: false
+}

jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/w1/y3mprcx54db_69hywbgj8lg00000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: null,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  preset: 'jest-puppeteer',
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  roots: [
+    "./tests/browser"
+  ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: null,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package.json

@@ -18,7 +18,8 @@
     "lint:js": "eslint .",
     "start": "ember serve",
     "test": "ember test",
-    "test:all": "ember try:each"
+    "test:all": "ember try:each",
+    "browser-test": "ember build -dev --suppress-sizes=true && jest --runInBand"
   },
   "dependencies": {
     "broccoli-funnel": "^2.0.0",
@@ -54,7 +55,10 @@
     "ember-try": "^1.0.0",
     "eslint-plugin-ember": "^6.2.0",
     "eslint-plugin-node": "^9.0.0",
+    "jest": "^24.9.0",
+    "jest-puppeteer": "^4.3.0",
     "loader.js": "^4.7.0",
+    "puppeteer": "^1.20.0",
     "qunit-dom": "^0.9.0"
   },
   "engines": {

tests/browser/basic.test.js

@@ -0,0 +1,79 @@
+describe('Card-Only Payment Form', () => {
+  beforeAll(async () => {
+    await page.goto('http://localhost:4200');
+    jest.setTimeout(30000);
+  });
+
+  it('can get a nonce', async () => {
+    await page.goto('http://localhost:4200/testing/card-only');
+    await page.waitFor('iframe.square-payment-form--styled--light__input');
+
+    const [
+      ccInputFrame,
+      expDateInputFrame,
+      cvvInputFrame,
+      postalCodeInputFrame
+    ] = await page.$$('iframe.square-payment-form--styled--light__input');
+
+    // Allow iframes to fully load.
+    await page.waitFor(1000);
+
+    await ccInputFrame.focus('input');
+    await page.keyboard.type('4111 1111 1111 1111');
+
+    await expDateInputFrame.focus('input');
+    await page.keyboard.type('12/24');
+
+    await cvvInputFrame.focus('input');
+    await page.keyboard.type('123');
+
+    await postalCodeInputFrame.focus('input');
+    await page.keyboard.type('12345');
+
+    await page.click('button.square-payment-form--styled__button--charge')
+    await page.waitFor('.nonce-response');
+
+    const errorsHandle = await page.$('.nonce-response__errors');
+    const nonceHandle = await page.$('.nonce-response__nonce');
+    const cardDataHandle = await page.$('.nonce-response__card-data');
+    const billingContactHandle = await page.$('.nonce-response__billing-contact');
+    const shippingContactHandle = await page.$('.nonce-response__shipping-contact');
+    const shippingOptionHandle = await page.$('.nonce-response__shipping-option');
+    const verificationTokenHandle = await page.$('.nonce-response__verification-token');
+
+    await expect(
+      await errorsHandle.evaluate(node => node.innerText)
+    ).toBe('null');
+
+    await expect(
+      await nonceHandle.evaluate(node => node.innerText)
+    ).toMatch('cnon:');
+
+    await expect(
+      await cardDataHandle.evaluate(node => node.innerText)
+    ).toMatch(`{
+  "digital_wallet_type": "NONE",
+  "card_brand": "VISA",
+  "last_4": "1111",
+  "exp_month": 12,
+  "exp_year": 2024,
+  "billing_postal_code": "12345"
+}`);
+
+    await expect(
+      await billingContactHandle.evaluate(node => node.innerText)
+    ).toMatch('');
+
+    await expect(
+      await shippingContactHandle.evaluate(node => node.innerText)
+    ).toMatch('');
+
+    await expect(
+      await shippingOptionHandle.evaluate(node => node.innerText)
+    ).toMatch('');
+
+    await expect(
+      await verificationTokenHandle.evaluate(node => node.innerText)
+    ).toMatch('');
+  });
+});

tests/dummy/app/controllers/testing/card-only.js

@@ -0,0 +1,19 @@
+import Controller from '@ember/controller';
+
+export default Controller.extend({
+  nonceResponse: null,
+
+  actions: {
+    handleCardNonceResponse(errors, nonce, cardData, billingContact, shippingContact, shippingOption, verificationToken) {
+      this.set('nonceResponse', {
+        errors: JSON.stringify(errors, null, '  '),
+        nonce,
+        cardData: JSON.stringify(cardData, null, '  '),
+        billingContact: JSON.stringify(billingContact, null, '  '),
+        shippingContact: JSON.stringify(shippingContact, null, '  '),
+        shippingOption: JSON.stringify(shippingOption, null, '  '),
+        verificationToken
+      });
+    }
+  }
+});

tests/dummy/app/router.js

@@ -7,6 +7,10 @@ const Router = AddonDocsRouter.extend({
 });
 
 Router.map(function() {
+  this.route('testing', function() {
+    this.route('card-only');
+  });
+
   this.route('examples', function() {
     this.route('light');
     this.route('dark');

tests/dummy/app/templates/testing/card-only.hbs

@@ -0,0 +1,20 @@
+<SquarePaymentFormStyled
+  @acceptCreditCards={{true}}
+  @applicationId="sandbox-sq0idb-TsZm7fSKPzmM1HRI9zDfAQ"
+  @locationId="TC4Z3ZEBKRXRH"
+  @style="light"
+  @onCardNonceResponseReceived={{action "handleCardNonceResponse"}}
+/>
+
+{{#if nonceResponse}}
+  <div class="nonce-response">
+    <h3>Results</h3>
+    <pre class="nonce-response__errors">{{nonceResponse.errors}}</pre>
+    <pre class="nonce-response__nonce">{{nonceResponse.nonce}}</pre>
+    <pre class="nonce-response__card-data">{{nonceResponse.cardData}}</pre>
+    <pre class="nonce-response__billing-contact">{{nonceResponse.billingContact}}</pre>
+    <pre class="nonce-response__shipping-contact">{{nonceResponse.shippingContact}}</pre>
+    <pre class="nonce-response__shipping-option">{{nonceResponse.shippingOption}}</pre>
+    <pre class="nonce-response__verification-token">{{nonceResponse.verificationToken}}</pre>
+  </div>
+{{/if}}