WIP: feat(cypress): Added cypress and integration test for the close button. (#118)

* feat(cypress): Added cypress and integration test for the close button.

* feat(cypress): Added code for cypress ci in package.json.

* feat(github-actions): Added code for cypress integration tests.

* fix(github actions): Added github actions.

Author: dlabaj

.github/workflows/build-lint-test.yml

@@ -157,3 +157,43 @@ jobs:
         run: npm run build:docs
       - name: A11y tests
         run: npm run serve:docs & npm run test:a11y
+  test_cypress:
+    runs-on: ubuntu-latest
+    env:
+      GH_PR_NUM: ${{ github.event.number }}
+    needs: build
+    steps:
+      - uses: actions/checkout@v2
+      # Yes, we really want to checkout the PR
+      - run: |
+          if [[ ! -z "${GH_PR_NUM}" ]]; then 
+            echo "Checking out PR"
+            git fetch origin pull/$GH_PR_NUM/head:tmp
+            git checkout tmp
+          fi
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - uses: actions/cache@v2
+        id: npm-cache
+        name: Cache npm deps
+        with:
+          path: |
+           node_modules
+           **/node_modules
+           ~/.cache/Cypress
+          key: ${{ runner.os }}-yarn-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('package-lock.json') }}
+      - run: npm install --frozen-lockfile
+        if: steps.npm-cache.outputs.cache-hit != 'true'
+      - uses: actions/cache@v2
+        id: dist
+        name: Cache dist
+        with:
+          path: |
+            packages/*/dist
+            packages/react-styles/css
+          key: ${{ runner.os }}-dist-14-${{ secrets.CACHE_VERSION }}-${{ hashFiles('package-lock.json', 'package.json', 'packages/*/*', '!packages/*/dist', '!packages/*/node_modules') }}
+      - name: Build dist
+        run: npm run build
+      - name: Run integration tests
+        run: npm run cypress:run:ci

cypress.config.ts

@@ -0,0 +1,14 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    viewportHeight: 1024,
+    viewportWidth: 1400,
+    screenshotOnRunFailure: false,
+    reporter: "junit",
+    reporterOptions: {
+      mochaFile: "results/my-test-output-[hash].xml",
+      toConsole: true
+    },
+  },
+});

cypress/e2e/CloseButton.spec.cy.ts

@@ -0,0 +1,13 @@
+describe('Test the close button', () => {
+  it('passes', () => {
+    cy.visit('http://localhost:8006/extensions/component-groups/about-component-groups', { onBeforeLoad: (win) => {cy.stub(win.console, 'log').as('consoleLog');}, });
+    cy.wait(1000);
+    cy.get('a[href="/extensions/component-groups/closebutton"]').click();
+    cy.wait(1000);
+
+    cy.get('[data-test-id="close-button-example"]').click();
+    cy.wait(1000);
+    cy.get('@consoleLog').should('be.calledWith', 'Close button clicked');
+    
+  })
+})

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "[email protected]",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/support/commands.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

cypress/support/e2e.ts

@@ -0,0 +1,20 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands'
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')