CPS-562: E2E test Basic Structure

.eslintignore

@@ -0,0 +1,4 @@
+node_modules
+.eslintrc.js
+gulp-tasks/jest-helper/environments/e2e-test-environment.js
+gulp-tasks/jest-helper/global/teardown.js

.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+  extends: ['standard-with-typescript', 'plugin:jsdoc/recommended'],
+  parserOptions: {
+    project: './tsconfig.json'
+  },
+  settings: {
+    jsdoc: {
+      mode: 'typescript'
+    }
+  },
+  rules: {
+    '@typescript-eslint/semi': ['error', 'always'],
+    'jsdoc/require-param-type': 0,
+    'jsdoc/require-returns-type': 0,
+    'jsdoc/require-jsdoc': [1, {
+      contexts: [
+        'ClassDeclaration', 'FunctionExpression', 'FunctionDeclaration',
+        'ArrowFunctionExpression', 'MethodDefinition', 'ClassExpression',
+        'FunctionExpression', 'TSInterfaceDeclaration', 'TSMethodSignature'
+      ]
+    }]
+  }
+}

.github/workflows/endtoend.yml

@@ -0,0 +1,130 @@
+name: End to End Tests
+
+on:
+  workflow_dispatch:
+    inputs:
+      civicase_branch:
+        description: CiviCase Branch/Tag Name
+        default: master
+        required: true
+      civiawards_branch:
+        description: CiviAwards Branch/Tag Name
+        default: master
+        required: true
+      civiprospect_branch:
+        description: CiviProspect Branch/Tag Name
+        default: master
+        required: true
+      shoreditch_branch:
+        description: Shoreditch Branch/Tag Name
+        default: master
+        required: true
+      civicrm_version:
+        description: CiviCRM Version
+        default: 5.35 # change this to the current civicrm version in use
+        required: true
+
+jobs:
+  run-backstop-tests:
+    runs-on: ubuntu-latest
+    container: compucorp/civicrm-buildkit:1.1.0-php7.2-chrome
+
+    env:
+      SITE_FOLDER: site
+      SITE_URL: http://localhost:7979
+      CIVICRM_EXTENSIONS_DIR: web/sites/all/modules/civicrm/tools/extensions
+      DRUPAL_MODULES_DIR: web/sites/all/modules
+      E2E_DIR: cases-product-suite-e2e-tests
+      DRUPAL_THEME_DIR: web/sites/all/themes
+      SITE_NAME: drupal-clean
+
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+        - 3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+
+      - name: Config mysql database as per CiviCRM requirement
+        run: echo "SET GLOBAL sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''));" | mysql -u root --password=root --host=mysql
+
+      - name: Config amp
+        run : |
+          amp config:set --db_type=mysql_dsn --mysql_dsn='mysql://root:root@mysql:3306' --httpd_type=apache24 --httpd_restart_command='sudo /usr/sbin/apache2ctl graceful' --perm_type=worldWritable --hosts_type=file
+          echo "IncludeOptional $HOME/.amp/apache.d/*.conf" >> /etc/apache2/apache2.conf
+          /usr/sbin/apache2ctl restart
+
+      - name: Install Missing Dependencies
+        run : |
+          sudo apt-get update
+          sudo apt-get install -y libxshmfence-dev
+
+      - name: Build Reference Drupal site -> CiviCRM - ${{ github.event.inputs.civicrm_version }}
+        run: |
+          civibuild create drupal-clean --civi-ver ${{ github.event.inputs.civicrm_version }} --cms-ver 7.74 --web-root $GITHUB_WORKSPACE/${{ env.SITE_FOLDER }} --url ${{ env.SITE_URL }}
+          chmod -R 777 $GITHUB_WORKSPACE/${{ env.SITE_FOLDER }}
+
+      - name: Installing CiviCase - ${{ github.event.inputs.civicase_branch }}, CiviAwards - ${{ github.event.inputs.civiawards_branch }}, CiviProspects - ${{ github.event.inputs.civiprospect_branch }}, Shoreditch - ${{ github.event.inputs.shoreditch_branch }}
+        working-directory: ${{ env.SITE_FOLDER }}/${{ env.CIVICRM_EXTENSIONS_DIR }}
+        run: |
+          git clone https://github.com/compucorp/uk.co.compucorp.civicase.git --branch ${{ github.event.inputs.civicase_branch }}
+          git clone https://github.com/compucorp/uk.co.compucorp.civiawards.git --branch ${{ github.event.inputs.civiawards_branch }}
+          git clone https://github.com/compucorp/uk.co.compucorp.civicrm.prospect.git --branch ${{ github.event.inputs.civiprospect_branch }}
+          git clone https://github.com/civicrm/org.civicrm.shoreditch.git --branch ${{ github.event.inputs.shoreditch_branch }}
+          cv en shoreditch civicase civiawards prospect
+          drush en civicrmtheme -y
+          drush en bootstrap -y
+          drush vset theme_default bootstrap
+
+      - name: Generate CSS files for Shoreditch
+        working-directory: ${{ env.SITE_FOLDER }}/${{ env.CIVICRM_EXTENSIONS_DIR }}/org.civicrm.shoreditch
+        run: |
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          nvm install
+          nvm use
+          npm install
+          npx gulp sass
+          drush cc all && drush cc civicrm
+
+      - name: Installing Shoreditch Companion Theme
+        working-directory: ${{ env.SITE_FOLDER }}/${{ env.DRUPAL_THEME_DIR }}
+        run: |
+          git clone https://github.com/compucorp/shoreditch-companion-d7-theme.git depth=1
+          drush en -y shoreditch_companion_d7_theme
+          drush vset civicrmtheme_theme_admin shoreditch_companion_d7_theme
+
+          drush sql-query "UPDATE block SET status = 0 WHERE theme='shoreditch_companion_d7_theme' AND module='civicrm' AND delta IN ('1', '2', '3', '4', '5');" -y
+          drush sql-query "UPDATE block SET status = 0 WHERE theme='shoreditch_companion_d7_theme' AND module='search' AND delta='form';" -y
+          drush sql-query "UPDATE block SET status = 0 WHERE theme='shoreditch_companion_d7_theme' AND module='system' AND delta IN ('navigation', 'powered-by');" -y
+
+          drush cc all && drush cc civicrm
+
+      - name: Install E2E Test Suite
+        run: |
+          git clone https://github.com/compucorp/cases-product-suite-e2e-tests.git --branch master
+          cd ${{ env.E2E_DIR }}
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          nvm install
+          nvm use
+          npm install
+
+      - name: Setup data and site-config.json and run E2E tests
+        working-directory: ${{ env.E2E_DIR }}
+        run: |
+          cp site-config.json.sample site-config.json
+          sed -i 's+<url>+${{ env.SITE_URL }}+' site-config.json
+          sed -i 's+<path-to-site-root>+'"$GITHUB_WORKSPACE"'/${{ env.SITE_FOLDER }}/web+' site-config.json
+          sed -i 's+<site_name>+${{ env.SITE_NAME }}+' site-config.json
+          [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
+          nvm use
+          npx gulp test
+
+      - uses: actions/upload-artifact@v2
+        if: ${{ always() }}
+        with:
+          name: e2e-report
+          path: ${{ env.E2E_DIR }}/test-report

.github/workflows/linters.yml

@@ -0,0 +1,30 @@
+name: Linters
+
+on: pull_request
+
+env:
+  GITHUB_BASE_REF: ${{ github.base_ref }}
+
+jobs:
+  run-linters:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set Correct NodeJS version
+      shell: bash -l {0}
+      run: |
+        nvm install
+        nvm use
+
+    - name: Run npm install
+      run: npm i
+
+    - name: Fetch target branch
+      run: git fetch -n origin ${GITHUB_BASE_REF}
+
+    - name: Run eslint linter
+      if: ${{ always() }}
+      run: git diff --diff-filter=d origin/${GITHUB_BASE_REF} --name-only -- '*.ts' | xargs -r  npx eslint --max-warnings=0 . -c .eslintrc.js

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+cookies
+site-config.json
+test-report

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.lintstagedrc

@@ -0,0 +1,5 @@
+{
+  "*.ts": [
+    "npx eslint --max-warnings=0 . -c .eslintrc.js"
+  ]
+}

.npmrc

@@ -0,0 +1 @@
+engine-strict=true

.nvmrc

@@ -0,0 +1 @@
+14.16.0

gulp-tasks/jest-helper/environments/e2e-test-environment.js

@@ -0,0 +1,33 @@
+// Jest has issues with Environment Files written in TS
+// https://github.com/facebook/jest/issues/5164
+const NodeEnvironment = require('jest-environment-node');
+
+class E2ETestEnvironment extends NodeEnvironment {
+  constructor (config, context) {
+    super(config, context);
+
+    this.global.hasTestFailures = false;
+  }
+
+  async handleTestEvent (event, state) {
+    if (event.name === 'test_fn_failure') {
+      var testName = this.getTestName(event.test, []).reverse();
+      testName.shift();
+
+      this.global.failureScreenshotFileName = testName.join('_').replace(/ /g,'_');
+      this.global.hasTestFailures = true;
+    }
+  }
+
+  getTestName (test, name) {
+    name.push([test.name]);
+
+    if (test.parent) {
+      this.getTestName(test.parent, name);
+    }
+
+    return name;
+  }
+}
+
+module.exports = E2ETestEnvironment;

gulp-tasks/jest-helper/global/teardown.js

@@ -0,0 +1,11 @@
+// Jest has issues with Global Setup/TearDown Files written in TS
+// https://github.com/facebook/jest/issues/5164
+
+const execSync = require('child_process').execSync;
+const fs = require('fs');
+
+module.exports = async function () {
+  var config = JSON.parse(fs.readFileSync('site-config.json'));
+
+  execSync('drush en session_limit -y', { encoding: 'utf8', cwd: config.root });
+};

gulp-tasks/jest.ts

@@ -0,0 +1,26 @@
+import * as jest from 'jest-cli';
+import ConfigService from '../src/services/utils/configs.service';
+import BrowserService from '../src/services/utils/browser.service';
+import UserRole from '../src/services/utils/user-role.service';
+import changeDrupalModuleState from '../src/services/utils/change-drupal-module-state.service';
+import cleanUpReports from '../src/services/utils/clean-up-reports.service';
+
+export default jestTask;
+
+/**
+ * @returns promise
+ */
+async function jestTask (): Promise<void> {
+  ConfigService.touchSiteConfigFile();
+
+  cleanUpReports();
+  changeDrupalModuleState('session_limit', false);
+
+  UserRole.createUsersWithRoles();
+
+  const browser = new BrowserService();
+
+  await browser.writeCookies();
+
+  await jest.run(['--runInBand']);
+}

gulpfile.ts

@@ -0,0 +1,6 @@
+import * as gulp from 'gulp';
+import jestTask from './gulp-tasks/jest';
+
+gulp.task('test', async function () {
+  await jestTask();
+});

jest.config.ts

@@ -0,0 +1,22 @@
+import type { Config } from '@jest/types';
+
+const config: Config.InitialOptions = {
+  preset: 'jest-playwright-preset',
+  testMatch: ['**/tests/**/(*.)spec.ts'],
+  transform: {
+    '^.+\\.ts$': 'ts-jest'
+  },
+  globalTeardown: '<rootDir>/gulp-tasks/jest-helper/global/teardown.js',
+  testRunner: 'jest-circus/runner',
+  testEnvironment: './gulp-tasks/jest-helper/environments/e2e-test-environment',
+  reporters: [
+    'default',
+    ['./node_modules/jest-html-reporter', {
+      pageTitle: 'Cases Product Suite E2E Test Report',
+      includeFailureMsg: true,
+      outputPath: './test-report/test-report.html'
+    }]
+  ]
+};
+
+export default config;