dev: added simple smoke test for preview environment (CMC-NA) (#15)

.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  "plugins": [
+    "codeceptjs"
+  ],
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es2020": true,
+    "codeceptjs/codeceptjs": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 11
+  },
+  "rules": {
+    "quotes": [
+      "error",
+      "single"
+    ],
+    "semi": [
+      "error",
+      "always"
+    ]
+  }
+};

.gitignore

@@ -20,3 +20,12 @@ bin/main/application.yaml
 *.ipr
 
 .DS_Store
+
+
+# node_modules
+package-lock.json
+node_modules/
+
+# test_output
+output/
+test-results/

Jenkinsfile_CNP

@@ -50,6 +50,8 @@ withPipeline(type, product, component) {
       ./bin/add-roles-preview.sh
       ./bin/import-ccd-definition.sh
     """
+
+    env.URL="https://xui-ucmc-service-pr-${CHANGE_ID}.service.core-compute-preview.internal"
   }
 
   after('functionalTest:preview') {

bin/wait-for.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env bash
+
+set -eu
+
+service_base_urls=${@}
+
+max_health_check_attempts=30
+
+function checkHealth {
+  for service_base_url in ${service_base_urls}; do
+    curl -k --fail --silent --output /dev/null --head ${service_base_url}/health
+    if [ $? -ne 0 ]; then
+      exit 1
+    fi
+  done
+}
+
+until $(checkHealth); do
+  current_health_check_attempt=$((${current_health_check_attempt:-1} + 1))
+
+  if [ ${current_health_check_attempt} -gt ${max_health_check_attempts} ]; then
+    echo -e "\nMax number of attempts reached"
+    exit 1
+  fi
+
+  if [ ${current_health_check_attempt} -eq 2 ]; then
+    printf 'Awaiting healthy services'
+  else
+    printf '.'
+  fi
+
+  sleep 10
+done

build.gradle

@@ -78,10 +78,35 @@ task integration(type: Test) {
   failFast = true
 }
 
-task smoke(type: Test) {
-  description = "Runs Smoke Tests"
-  testClassesDirs = sourceSets.smokeTest.output.classesDirs
-  classpath = sourceSets.smokeTest.runtimeClasspath
+task installDependencies(type: Exec, description: 'Installs Yarn dependencies.') {
+  commandLine '/usr/bin/yarn', '--mutex', 'network', '--frozen-lockfile', '--silent', 'install'
+}
+
+task checkDependenciesIntegrity(type: Exec, description: 'Checks integrity of Yarn dependencies.') {
+  commandLine '/usr/bin/yarn', '--mutex', 'network', '--frozen-lockfile', '--silent', 'check', '--integrity'
+}
+
+task lintUserInterfaceTests(type: Exec, description: 'Runs linting of E2E tests.') {
+  commandLine '/usr/bin/yarn', '--silent', 'lint'
+}
+
+task awaitApplicationReadiness(type: Exec, description: 'Awaits until application is ready.') {
+  commandLine './bin/wait-for.sh', System.env.URL
+}
+
+task runSmokeTests(type: Exec, description: 'Runs smoke tests.') {
+  commandLine '/usr/bin/yarn', '--silent', 'test:smoke'
+}
+
+def inStrictOrder(Task... tasks) {
+  for (int i = 0; i < tasks.size() - 1; i++) {
+    tasks[i + 1].mustRunAfter(tasks[i])
+  }
+  return tasks
+}
+
+task smoke(description: 'Runs the smoke tests.') {
+  dependsOn(inStrictOrder(awaitApplicationReadiness, installDependencies, checkDependenciesIntegrity, lintUserInterfaceTests, runSmokeTests))
 }
 
 checkstyle {

codecept.conf.js

@@ -0,0 +1,45 @@
+/* global process */
+
+exports.config = {
+  tests: './e2e/tests/*_test.js',
+  output: './output',
+  helpers: {
+    Puppeteer: {
+      show: process.env.SHOW_BROWSER_WINDOW || false,
+      windowSize: '1200x900',
+      waitForTimeout: 20000,
+      chrome: {
+        ignoreHTTPSErrors: true,
+        args: process.env.PROXY_SERVER ? [`--proxy-server=${process.env.PROXY_SERVER}`,] : [],
+      },
+    },
+  },
+  include: {
+    I: './e2e/steps_file.js',
+    loginPage: './e2e/pages/login.page.js'
+  },
+  mocha: {
+    reporterOptions: {
+      'codeceptjs-cli-reporter': {
+        stdout: '-',
+        options: {
+          steps: false,
+        },
+      },
+      'mocha-junit-reporter': {
+        stdout: '-',
+        options: {
+          mochaFile: 'test-results/result.xml',
+        },
+      },
+      'mochawesome': {
+        stdout: '-',
+        options: {
+          reportDir: './output',
+          inlineAssets: true,
+          json: false,
+        },
+      },
+    }
+  }
+}

e2e/config.js

@@ -0,0 +1,8 @@
+const defaultPassword = 'Password12';
+
+module.exports = {
+  solicitorUser: {
+    password: defaultPassword,
+    email: '[email protected]'
+  }
+};

e2e/pages/login.page.js

@@ -0,0 +1,17 @@
+const { I } = inject();
+
+module.exports = {
+
+  fields: {
+    username: '#username',
+    password: '#password',
+  },
+  submitButton: 'input[value="Sign in"]',
+
+  signIn(user) {
+    I.waitForElement(this.submitButton);
+    I.fillField(this.fields.username, user.email);
+    I.fillField(this.fields.password, user.password);
+    I.click(this.submitButton);
+  },
+};

e2e/steps.d.ts

@@ -0,0 +1,12 @@
+/// <reference types='codeceptjs' />
+type steps_file = typeof import('./steps_file.js');
+
+declare namespace CodeceptJS {
+  interface SupportObject { I: CodeceptJS.I }
+  interface CallbackOrder { [0]: CodeceptJS.I }
+  interface Methods extends CodeceptJS.Puppeteer {}
+  interface I extends ReturnType<steps_file> {}
+  namespace Translation {
+    interface Actions {}
+  }
+}

e2e/steps_file.js

@@ -0,0 +1,10 @@
+// in this file you can append custom step methods to 'I' object
+
+module.exports = function() {
+  return actor({
+
+    // Define custom steps here, use 'this' to access default methods of I.
+    // It is recommended to place a general 'login' function here.
+
+  });
+};

e2e/tests/smoke_test.js

@@ -0,0 +1,11 @@
+/* global process */
+const config = require('../config.js');
+const baseUrl = process.env.URL || 'http://localhost:3333';
+
+Feature('Smoke tests @smoke-tests');
+
+Scenario('Sign in as solicitor user', (I, loginPage) => {
+  I.amOnPage(baseUrl);
+  loginPage.signIn(config.solicitorUser);
+  I.see('Case List');
+});

jsconfig.json

@@ -0,0 +1,5 @@
+{
+  "compilerOptions": {
+    "allowJs": true
+  }
+}

package.json

@@ -0,0 +1,25 @@
+{
+  "name": "ucmc-service",
+  "version": "1.0.0",
+  "description": "Civil Unspecified e2e tests",
+  "scripts": {
+    "lint": "eslint e2e",
+    "test": "npx codeceptjs run --steps",
+    "test:smoke": "MOCHAWESOME_REPORTFILENAME=smoke npx codeceptjs run --grep @smoke-tests --reporter mocha-multi"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn lint"
+    }
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "codeceptjs": "^2.6.6",
+    "eslint": "^7.3.1",
+    "eslint-plugin-codeceptjs": "^1.3.0",
+    "husky": "^4.2.5",
+    "mocha-multi": "^1.1.3",
+    "mochawesome": "^6.1.1",
+    "puppeteer": "^4.0.1"
+  }
+}