@jahia/cypress 8.3.0 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @jahia/cypress Changelog
 
+## 8.4.0
+
+* Added `addPage` to create a page from a test, so each project no longer needs its own copy. It sets the page template and title, and leaves the page content to the caller: areas, content nodes and extra languages are passed in. (#245)
+
+## 8.3.1
+
+* Fixed CI startup so it fails immediately when an image cannot be pulled, instead of hanging until the job times out. The job log now shows the registry error instead of an unanswered confirmation prompt. (#243)
+
 ## 8.3.0
 
 ### New Features

package/ci.startup.sh

@@ -31,10 +31,19 @@ if [[ "${JAHIA_CLUSTER_ENABLED}" == "true" ||  ${JAHIA_CLUSTER_ENABLED} == true
     export CLUSTER_PROFILE="--profile cluster"
 fi
 
+# Both docker-compose calls below read from /dev/null on purpose. docker-compose v1 answers an
+# unusable image (wrong name, wrong registry, missing docker login) with an interactive
+# confirmation prompt instead of an error. In CI nothing ever answers it, so the job hangs until
+# it times out. With stdin closed the prompt fails immediately and the real registry error is
+# reported, and the exit code is checked so the startup does not silently continue.
 echo "$(date +'%d %B %Y - %k:%M') == Starting environment =="
-docker-compose ${CLUSTER_PROFILE} up -d --renew-anon-volumes $(docker-compose config --services | grep -v "cypress")
+if ! docker-compose ${CLUSTER_PROFILE} up -d --renew-anon-volumes $(docker-compose config --services | grep -v "cypress") < /dev/null; then
+    echo "$(date +'%d %B %Y - %k:%M') == STARTUP FAILURE, unable to start the environment. Check the image names, the registry and the docker login above =="
+    exit 1
+fi
+
 if [[ "$1" != "notests" ]]; then
     docker ps -a
     docker stats --no-stream
-    docker-compose up --abort-on-container-exit cypress
+    docker-compose up --abort-on-container-exit cypress < /dev/null
 fi

package/dist/utils/ContentHelper.d.ts

@@ -0,0 +1,30 @@
+import { ApolloOptions } from '../support';
+export type AddPageOptions = {
+    /** Path or identifier of the node the page is added under. */
+    parentPathOrId: string;
+    /** JCR name of the page node — the last segment of its path. */
+    name: string;
+    /** Value of `j:templateName`. Required: `jnt:page` declares it mandatory. */
+    template: string;
+    /** Value of `jcr:title`. Set without `language`, it is stored unlocalized and read back in every language. */
+    title?: string;
+    /** Language of `title`. */
+    language?: string;
+    /** Extra properties, set alongside the ones this helper derives. */
+    properties?: any[];
+    /** Nodes added under the page, in `addNode`'s `InputJCRNode` shape. */
+    children?: any[];
+    /** Mixins applied to the page node. */
+    mixins?: string[];
+};
+/**
+ * Add a `jnt:page`, deriving `j:templateName` from `template` and `jcr:title` from
+ * `title`/`language`. Everything else — `properties`, `children`, `mixins` — reaches `addNode`
+ * untouched: the helper imposes no page structure, so a caller that needs an area, a text node
+ * or a second title language passes it in.
+ *
+ * @param options the page to add
+ * @param apolloOptions options forwarded to `cy.apollo`
+ * @returns the `addNode` mutation result
+ */
+export declare const addPage: (options: AddPageOptions, apolloOptions?: ApolloOptions) => Cypress.Chainable;

package/dist/utils/ContentHelper.js

@@ -0,0 +1,44 @@
+"use strict";
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addPage = void 0;
+var JCRHelper_1 = require("./JCRHelper");
+/**
+ * Add a `jnt:page`, deriving `j:templateName` from `template` and `jcr:title` from
+ * `title`/`language`. Everything else — `properties`, `children`, `mixins` — reaches `addNode`
+ * untouched: the helper imposes no page structure, so a caller that needs an area, a text node
+ * or a second title language passes it in.
+ *
+ * @param options the page to add
+ * @param apolloOptions options forwarded to `cy.apollo`
+ * @returns the `addNode` mutation result
+ */
+var addPage = function (options, apolloOptions) {
+    if (apolloOptions === void 0) { apolloOptions = {}; }
+    var parentPathOrId = options.parentPathOrId, name = options.name, template = options.template, title = options.title, language = options.language, _a = options.properties, properties = _a === void 0 ? [] : _a, _b = options.children, children = _b === void 0 ? [] : _b, _c = options.mixins, mixins = _c === void 0 ? [] : _c;
+    var pageProperties = __spreadArray(__spreadArray([], properties, true), [{ name: 'j:templateName', type: 'STRING', value: template }], false);
+    if (title !== undefined) {
+        var titleProperty = { name: 'jcr:title', type: 'STRING', value: title };
+        if (language !== undefined) {
+            titleProperty.language = language;
+        }
+        pageProperties.push(titleProperty);
+    }
+    return (0, JCRHelper_1.addNode)({
+        parentPathOrId: parentPathOrId,
+        name: name,
+        primaryNodeType: 'jnt:page',
+        properties: pageProperties,
+        children: children,
+        mixins: mixins
+    }, apolloOptions);
+};
+exports.addPage = addPage;

package/dist/utils/index.d.ts

@@ -9,3 +9,4 @@ export * from './GraphQLHelper';
 export * from './SAMHelper';
 export * from './ExportHelper';
 export * from './Logger';
+export * from './ContentHelper';

package/dist/utils/index.js

@@ -25,3 +25,4 @@ __exportStar(require("./GraphQLHelper"), exports);
 __exportStar(require("./SAMHelper"), exports);
 __exportStar(require("./ExportHelper"), exports);
 __exportStar(require("./Logger"), exports);
+__exportStar(require("./ContentHelper"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "8.3.0",
+  "version": "8.4.0",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts --max-warnings=0"

package/src/utils/ContentHelper.ts

@@ -0,0 +1,56 @@
+import {ApolloOptions} from '../support';
+import {addNode} from './JCRHelper';
+
+export type AddPageOptions = {
+    /** Path or identifier of the node the page is added under. */
+    parentPathOrId: string;
+    /** JCR name of the page node — the last segment of its path. */
+    name: string;
+    /** Value of `j:templateName`. Required: `jnt:page` declares it mandatory. */
+    template: string;
+    /** Value of `jcr:title`. Set without `language`, it is stored unlocalized and read back in every language. */
+    title?: string;
+    /** Language of `title`. */
+    language?: string;
+    /** Extra properties, set alongside the ones this helper derives. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    properties?: any [];
+    /** Nodes added under the page, in `addNode`'s `InputJCRNode` shape. */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    children?: any [];
+    /** Mixins applied to the page node. */
+    mixins?: string [];
+};
+
+/**
+ * Add a `jnt:page`, deriving `j:templateName` from `template` and `jcr:title` from
+ * `title`/`language`. Everything else — `properties`, `children`, `mixins` — reaches `addNode`
+ * untouched: the helper imposes no page structure, so a caller that needs an area, a text node
+ * or a second title language passes it in.
+ *
+ * @param options the page to add
+ * @param apolloOptions options forwarded to `cy.apollo`
+ * @returns the `addNode` mutation result
+ */
+export const addPage = (options: AddPageOptions, apolloOptions: ApolloOptions = {}): Cypress.Chainable => {
+    const {parentPathOrId, name, template, title, language, properties = [], children = [], mixins = []} = options;
+
+    const pageProperties = [...properties, {name: 'j:templateName', type: 'STRING', value: template}];
+    if (title !== undefined) {
+        const titleProperty: Record<string, string> = {name: 'jcr:title', type: 'STRING', value: title};
+        if (language !== undefined) {
+            titleProperty.language = language;
+        }
+
+        pageProperties.push(titleProperty);
+    }
+
+    return addNode({
+        parentPathOrId: parentPathOrId,
+        name: name,
+        primaryNodeType: 'jnt:page',
+        properties: pageProperties,
+        children: children,
+        mixins: mixins
+    }, apolloOptions);
+};

package/src/utils/index.ts

@@ -9,3 +9,4 @@ export * from './GraphQLHelper';
 export * from './SAMHelper';
 export * from './ExportHelper';
 export * from './Logger';
+export * from './ContentHelper';