@jahia/cypress 3.13.0 → 3.14.1

package/ci.build.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+# This script can be used to manually build the docker images necessary to run the tests
+# It should be executed from the tests folder
+
+echo " ci.build.sh == Build test image"
+
+BASEDIR=$(dirname $(readlink -f $0))
+
+source $BASEDIR/set-env.sh
+
+# It assumes that you previously built the module you're going to be testing
+#   and that the modules artifacts are located one level up
+
+if [ ! -d ./artifacts ]; then
+  mkdir -p ./artifacts
+fi
+
+if [[ -e ../target ]]; then
+  cp ../target/*-SNAPSHOT.jar ./artifacts/
+fi
+
+if [ -d ./jahia-module ]; then
+  cd jahia-module
+  mvn clean install
+  cp target/*-SNAPSHOT.jar ../artifacts/
+  cd ..
+fi
+
+
+docker build -t ${TESTS_IMAGE} .

package/ci.startup.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+# This script controls the startup of the container environment
+# It can be used as an alternative to having docker-compose up started by the CI environment
+
+BASEDIR=$(dirname $(readlink -f $0))
+
+source $BASEDIR/set-env.sh
+
+echo " ci.startup.sh == Printing the most important environment variables"
+echo " MANIFEST: ${MANIFEST}"
+echo " TESTS_IMAGE: ${TESTS_IMAGE}"
+echo " JAHIA_IMAGE: ${JAHIA_IMAGE}"
+echo " JAHIA_CLUSTER_ENABLED: ${JAHIA_CLUSTER_ENABLED}"
+
+echo "$(date +'%d %B %Y - %k:%M') [LICENSE] == Check if license exists in env variable (JAHIA_LICENSE) =="
+if [[ -z ${JAHIA_LICENSE} ]]; then
+    echo "$(date +'%d %B %Y - %k:%M') [LICENSE] == Jahia license does not exist, checking if there is a license file in /tmp/license.xml =="
+    if [[ -f /tmp/license.xml ]]; then
+        echo "$(date +'%d %B %Y - %k:%M') [LICENSE] ==  License found in /tmp/license.xml, base64ing it"
+        export JAHIA_LICENSE=$(base64 -i /tmp/license.xml)
+    else
+        echo "$(date +'%d %B %Y - %k:%M') [LICENSE]  == STARTUP FAILURE, unable to find license =="
+        exit 1
+    fi
+fi
+
+echo "$(date +'%d %B %Y - %k:%M') == Cluster enabled: ${JAHIA_CLUSTER_ENABLED} =="
+if [[ "${JAHIA_CLUSTER_ENABLED}" == "true" ]]; then
+    export CLUSTER_PROFILE="--profile cluster"
+fi
+
+echo "$(date +'%d %B %Y - %k:%M') == Starting environment =="
+docker-compose up -d --renew-anon-volumes ${CLUSTER_PROFILE}
+if [[ "$1" != "notests" ]]; then
+    docker ps -a
+    docker stats --no-stream
+    docker-compose up --abort-on-container-exit cypress
+fi

package/dist/page-object/baseComponent.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="cypress" />
 import Chainable = Cypress.Chainable;
+import Chainer = Cypress.Chainer;
 export declare type ComponentType<Component> = {
     new (p: Chainable<JQuery>, assertion?: (s: JQuery) => void): Component;
     defaultSelector: string;
@@ -12,5 +13,5 @@ export declare class BaseComponent {
     assertion?: (s: JQuery) => void;
     constructor(element: Chainable<JQuery>, assertion?: (s: JQuery) => void);
     get(): Chainable<JQuery>;
-    should(arg: any, ...others: any[]): Chainable<JQuery<HTMLElement>>;
+    should: Chainer<JQuery>;
 }

package/dist/page-object/baseComponent.js

@@ -8,6 +8,15 @@ exports.__esModule = true;
 exports.BaseComponent = void 0;
 var BaseComponent = /** @class */ (function () {
     function BaseComponent(element, assertion) {
+        var _this = this;
+        this.should = function (arg) {
+            var _a;
+            var others = [];
+            for (var _i = 1; _i < arguments.length; _i++) {
+                others[_i - 1] = arguments[_i];
+            }
+            return (_a = cy.get('@component' + _this.id, { log: false })).should.apply(_a, __spreadArray([arg], others));
+        };
         this.id = BaseComponent.count++;
         this.element = element.as('component' + this.id);
         this.assertion = assertion;
@@ -18,15 +27,6 @@ var BaseComponent = /** @class */ (function () {
         }
         return cy.get('@component' + this.id, { log: false });
     };
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    BaseComponent.prototype.should = function (arg) {
-        var _a;
-        var others = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            others[_i - 1] = arguments[_i];
-        }
-        return (_a = cy.get('@component' + this.id, { log: false })).should.apply(_a, __spreadArray([arg], others));
-    };
     BaseComponent.defaultSelector = '';
     BaseComponent.count = 0;
     return BaseComponent;

package/dist/support/login.d.ts

@@ -3,7 +3,9 @@ declare global {
     namespace Cypress {
         interface Chainable<Subject> {
             login(username?: string, password?: string): Chainable<Cypress.Response<any>>;
+            loginAndStoreSession(username?: string, password?: string): Chainable<Cypress.Response<any>>;
         }
     }
 }
 export declare const login: (username?: string, password?: string) => void;
+export declare const loginAndStoreSession: (username?: string, password?: string) => void;

package/dist/support/login.js

@@ -1,7 +1,7 @@
 "use strict";
 /* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-namespace */
 exports.__esModule = true;
-exports.login = void 0;
+exports.loginAndStoreSession = exports.login = void 0;
 /// <reference types="cypress" />
 var login = function (username, password) {
     if (username === void 0) { username = 'root'; }
@@ -27,3 +27,15 @@ var login = function (username, password) {
     });
 };
 exports.login = login;
+var loginAndStoreSession = function (username, password) {
+    if (username === void 0) { username = 'root'; }
+    if (password === void 0) { password = Cypress.env('SUPER_USER_PASSWORD'); }
+    cy.session('session-' + username, function () {
+        cy.login(username, password); // Edit in chief
+    }, {
+        validate: function () {
+            cy.request('/start').its('status').should('eq', 200);
+        }
+    });
+};
+exports.loginAndStoreSession = loginAndStoreSession;

package/env.debug.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# This script can be used to warmup the environment and execute the tests
+# It is used by the docker image at startup
+
+BASEDIR=$(dirname $(readlink -f $0))
+
+bash $BASEDIR/env.provision.sh
+
+source $BASEDIR/set-env.sh
+
+if [[ -z "${CYPRESS_CONFIGURATION_FILE}" ]]; then
+  CYPRESS_CONFIGURATION_FILE=cypress.config.ts
+fi
+
+yarn e2e:debug --config-file "${CYPRESS_CONFIGURATION_FILE}"

package/env.provision.sh

@@ -0,0 +1,92 @@
+#!/bin/bash
+# This script can be used to warmup the environment and execute the tests
+# It is used by the docker image at startup
+
+BASEDIR=$(dirname $(readlink -f $0))
+
+source $BASEDIR/set-env.sh
+
+#!/usr/bin/env bash
+START_TIME=$SECONDS
+
+echo "$(date +'%d %B %Y - %k:%M') == Printing the most important environment variables"
+echo " MANIFEST: ${MANIFEST}"
+echo " TESTS_IMAGE: ${TESTS_IMAGE}"
+echo " JAHIA_IMAGE: ${JAHIA_IMAGE}"
+echo " JAHIA_CLUSTER_ENABLED: ${JAHIA_CLUSTER_ENABLED}"
+echo " MODULE_ID: ${MODULE_ID}"
+echo " JAHIA_URL: ${JAHIA_URL}"
+echo " JAHIA_HOST: ${JAHIA_HOST}"
+echo " JAHIA_PORT: ${JAHIA_PORT}"
+echo " JAHIA_USERNAME: ${JAHIA_USERNAME}"
+echo " JAHIA_PASSWORD: ${JAHIA_PASSWORD}"
+echo " JAHIA_USERNAME_TOOLS: ${JAHIA_USERNAME_TOOLS}"
+echo " JAHIA_PASSWORD_TOOLS: ${JAHIA_PASSWORD_TOOLS}"
+echo " SUPER_USER_PASSWORD: ${SUPER_USER_PASSWORD}"
+echo " TIMEZONE: ${TIMEZONE}"
+echo "$(date +'%d %B %Y - %k:%M') ==  Using Node version: $(node -v)"
+echo "$(date +'%d %B %Y - %k:%M') ==  Using yarn version: $(yarn -v)"
+
+echo "$(date +'%d %B %Y - %k:%M') ==  Waiting for Jahia to startup"
+
+while [[ $(curl -s -o /dev/null -w ''%{http_code}'' ${JAHIA_URL}/cms/login) -ne 200 ]];
+do
+  echo "$(date +'%d %B %Y - %k:%M') == Jahia is not available at ${JAHIA_URL}/cms/login, will try in 5 seconds"
+  ELAPSED_TIME=$(($SECONDS - $START_TIME))
+  if [[ ELAPSED_TIME -gt 300 ]]; then
+    echo "$(date +'%d %B %Y - %k:%M') == Exiting, Jahia failed to start after 300 seconds"
+    exit 1
+  fi
+  sleep 5;
+done
+
+ELAPSED_TIME=$(($SECONDS - $START_TIME))
+echo "$(date +'%d %B %Y - %k:%M') == Jahia became alive in ${ELAPSED_TIME} seconds"
+
+mkdir -p ./run-artifacts
+mkdir -p ./results
+
+# Copy manifest file
+# If the file doesn't exist, we assume it is a URL and we download it locally
+if [[ -e ${MANIFEST} ]]; then
+  cp ${MANIFEST} ./run-artifacts
+else
+  echo "$(date +'%d %B %Y - %k:%M') == Downloading: ${MANIFEST}"
+  curl ${MANIFEST} --output ./run-artifacts/curl-manifest
+  MANIFEST="curl-manifest"
+fi
+
+echo "$(date +'%d %B %Y - %k:%M') == Executing manifest: ${MANIFEST} =="
+curl -u root:${SUPER_USER_PASSWORD} -X POST ${JAHIA_URL}/modules/api/provisioning --form script="@./run-artifacts/${MANIFEST};type=text/yaml" $(find assets -type f | sed -E 's/^(.+)$/--form file=\"@\1\"/' | xargs)
+echo
+if [[ $? -eq 1 ]]; then
+  echo "$(date +'%d %B %Y - %k:%M') == PROVISIONING FAILURE - EXITING SCRIPT, NOT RUNNING THE TESTS"
+  echo "failure" > ./results/test_failure
+  exit 1
+fi
+
+if [[ -d artifacts/ ]]; then
+  cd artifacts/
+  echo "$(date +'%d %B %Y - %k:%M') == Content of the artifacts/ folder"
+  ls -lah
+  echo "$(date +'%d %B %Y - %k:%M') [MODULE_INSTALL] == Will start submitting files"
+  for file in $(ls -1 *-SNAPSHOT.jar | sort -n)
+  do
+    echo "$(date +'%d %B %Y - %k:%M') [MODULE_INSTALL] == Submitting module from: $file =="
+    curl -u root:${SUPER_USER_PASSWORD} -X POST ${JAHIA_URL}/modules/api/provisioning --form script='[{"installAndStartBundle":"'"$file"'", "forceUpdate":true}]' --form file=@$file
+    echo
+    echo "$(date +'%d %B %Y - %k:%M') [MODULE_INSTALL] == Module submitted =="
+  done
+  cd ..
+fi
+
+if [[ -d scripts/ ]]; then
+  cd ./scripts
+  for file in $(ls -1 script-* | sort -n)
+  do
+    echo "$(date +'%d %B %Y - %k:%M') [SCRIPT] == Submitting script: $file =="
+    curl -u root:${SUPER_USER_PASSWORD} -X POST ${JAHIA_URL}/modules/api/provisioning --form script='[{"executeScript":"'"$file"'"}]' --form file=@$file
+    echo "$(date +'%d %B %Y - %k:%M') [SCRIPT] == Script executed =="
+  done
+  cd ..
+fi

package/env.run.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# This script can be used to warmup the environment and execute the tests
+# It is used by the docker image at startup
+
+BASEDIR=$(dirname $(readlink -f $0))
+
+bash $BASEDIR/env.provision.sh
+
+source $BASEDIR/set-env.sh
+
+echo "$(date +'%d %B %Y - %k:%M') == Fetching the list of installed modules =="
+npx --yes @jahia/jahia-reporter@latest utils:modules \
+  --moduleId="${MODULE_ID}" \
+  --jahiaUrl="${JAHIA_URL}" \
+  --jahiaPassword="${SUPER_USER_PASSWORD}" \
+  --filepath="results/installed-jahia-modules.json"
+echo "$(date +'%d %B %Y - %k:%M') == Modules fetched =="
+INSTALLED_MODULE_VERSION=$(cat results/installed-jahia-modules.json | jq '.module.version')
+if [[ $INSTALLED_MODULE_VERSION == "UNKNOWN" ]]; then
+  echo "$(date +'%d %B %Y - %k:%M') ERROR: Unable to detect module: ${MODULE_ID} on the remote system "
+  echo "$(date +'%d %B %Y - %k:%M') ERROR: The Script will exit"
+  echo "$(date +'%d %B %Y - %k:%M') ERROR: Tests will NOT run"
+  echo "failure" > ./results/test_failure
+  exit 1
+fi
+
+echo "$(date +'%d %B %Y - %k:%M') == Run tests =="
+mkdir -p ./results/reports
+rm -rf ./results/reports
+
+if [[ -z "${CYPRESS_CONFIGURATION_FILE}" ]]; then
+  CYPRESS_CONFIGURATION_FILE=cypress.config.ts
+fi
+
+echo "$(date +'%d %B %Y - %k:%M') == Running Cypress with configuration file ${CYPRESS_CONFIGURATION_FILE} =="
+
+yarn e2e:ci --config-file "${CYPRESS_CONFIGURATION_FILE}"
+
+if [[ $? -eq 0 ]]; then
+  echo "$(date +'%d %B %Y - %k:%M') == Full execution successful =="
+  echo "success" > ./results/test_success
+  yarn report:merge; yarn report:html
+  exit 0
+else
+  echo "$(date +'%d %B %Y - %k:%M') == One or more failed tests =="
+  echo "failure" > ./results/test_failure
+  yarn report:merge; yarn report:html
+  exit 1
+fi

package/package.json

@@ -1,10 +1,16 @@
 {
   "name": "@jahia/cypress",
-  "version": "3.13.0",
+  "version": "3.14.1",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"
   },
+  "bin": {
+    "ci.build": "./ci.build.sh",
+    "ci.startup": "./ci.startup.sh",
+    "env.run": "./env.run.sh",
+    "env.debug": "./env.debug.sh"
+  },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "license": "MIT",

package/set-env.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+if [[ -f .env ]]; then
+  source .env
+  export $(cat .env | sed 's/=.*//g'| xargs)
+else
+  source .env.example
+  export $(cat .env.example | sed 's/=.*//g'| xargs)
+fi

package/src/custom.d.ts

@@ -1,4 +1,3 @@
 interface String {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    replaceAll(input: string, output : string): any;
+    replaceAll(input: string, output : string): string;
 }

package/src/page-object/baseComponent.ts

@@ -1,4 +1,5 @@
 import Chainable = Cypress.Chainable;
+import Chainer = Cypress.Chainer;
 
 export type ComponentType<Component> = { new(p: Chainable<JQuery>, assertion?: (s: JQuery) => void): Component, defaultSelector: string };
 
@@ -24,8 +25,7 @@ export class BaseComponent {
         return cy.get('@component' + this.id, {log: false});
     }
 
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    should(arg, ...others) {
+    should: Chainer<JQuery> = (arg, ...others) => {
         return cy.get('@component' + this.id, {log: false}).should(arg, ...others);
     }
 }

package/src/support/login.ts

@@ -8,6 +8,7 @@ declare global {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         interface Chainable<Subject> {
             login(username?: string, password?: string): Chainable<Cypress.Response<any>>
+            loginAndStoreSession(username?: string, password?: string): Chainable<Cypress.Response<any>>
         }
     }
 }
@@ -35,3 +36,12 @@ export const login = (username = 'root', password: string = Cypress.env('SUPER_U
     });
 };
 
+export const loginAndStoreSession = (username = 'root', password: string = Cypress.env('SUPER_USER_PASSWORD')): void => {
+    cy.session('session-' + username, () => {
+        cy.login(username, password); // Edit in chief
+    }, {
+        validate() {
+            cy.request('/start').its('status').should('eq', 200);
+        }
+    });
+};