@cspeach/cli 1.1.17 → 1.1.19

package/dist/tools/fiori/smoke/app-driver-page.js

@@ -0,0 +1,372 @@
+// cspeach-cli/src/tools/fiori/smoke/app-driver-page.ts
+//
+// L1-5a — the IN-PAGE half of the RecordReplay AppDriver.
+//
+// One module constant: the source of a function that builds the `window.__csp`
+// helper inside the app's page. The Node side (app-driver.ts) calls its methods
+// with ONE JSON argument each. Nothing model-supplied is ever turned into code:
+// the only source that runs in the page is this constant; selectors, values and
+// URLs arrive as JSON data (same rule as L1-3's TABLE_SNAPSHOT_SRC).
+//
+// How the browser is driven (design §3.3): every UI5 interaction goes through
+// the public `sap/ui/test/RecordReplay` API — `waitForUI5` before every read and
+// after every action, `interactWithControl` with CONTROL selectors
+// (controlType / id suffix / binding path) — never CSS class names. It is loaded
+// with `sap.ui.require` from the app's own UI5 (`/resources/sap/ui/test/…`, the
+// same origin the app's bootstrap uses), so no extra library ships with CSPeach.
+//
+// Written as ES5 in a string on purpose: it runs in whatever browser engine and
+// UI5 version the app uses, and a transpiled closure could carry helpers the
+// page does not have.
+import { TABLE_SNAPSHOT_SRC } from './driver.js';
+export const APP_DRIVER_PAGE_SRC = String.raw `function () {
+  var RR = null;
+  var WAIT = { timeout: 60000, interval: 400 };
+
+  function Element() {
+    return (sap.ui.require && sap.ui.require('sap/ui/core/Element')) || (sap.ui.core && sap.ui.core.Element);
+  }
+  function allControls() {
+    var E = Element();
+    return E && E.registry ? E.registry.all() : {};
+  }
+  function escapeRe(s) {
+    return String(s).replace(/[.*+?^$()|[\]{}\\]/g, '\\$&');
+  }
+  function toSelector(sel) {
+    var out = {};
+    if (sel.controlType) out.controlType = sel.controlType;
+    if (sel.id) out.id = sel.id;
+    if (sel.idSuffix) out.id = new RegExp(escapeRe(sel.idSuffix) + '$');
+    if (sel.bindingPath) out.bindingPath = { path: sel.bindingPath };
+    if (sel.properties) out.properties = sel.properties;
+    return out;
+  }
+  function loadRR() {
+    if (RR) return Promise.resolve(RR);
+    return new Promise(function (resolve, reject) {
+      sap.ui.require(['sap/ui/test/RecordReplay'], function (m) { RR = m; resolve(m); }, reject);
+    });
+  }
+  function wait() {
+    return loadRR().then(function (rr) { return rr.waitForUI5(WAIT); });
+  }
+  function visible(c) {
+    var d = c && c.getDomRef ? c.getDomRef() : null;
+    return !!(d && (d.offsetWidth || d.offsetHeight || d.getClientRects().length));
+  }
+  // UI5 1.84 collapses the DynamicPage header once a list report has loaded on
+  // open (1.120 keeps it expanded), hiding the filter bar — Go included. A user
+  // clicks the title to open it; so do we, before every press. No-op when the
+  // header is already expanded.
+  function expandHeaders() {
+    var reg = sap.ui.core.Element && sap.ui.core.Element.registry;
+    var n = 0;
+    if (reg && reg.filter) {
+      reg.filter(function (e) { return e.isA && e.isA('sap.f.DynamicPage'); }).forEach(function (dp) {
+        if (dp.getHeaderExpanded && dp.getHeaderExpanded() === false) { dp.setHeaderExpanded(true); n++; }
+      });
+    }
+    return n;
+  }
+  // Refresh every visible list table's row binding (sap.ui.mdc.Table). Returns
+  // how many were refreshed.
+  function refreshLists() {
+    return wait().then(function () {
+      var n = 0;
+      var all = allControls();
+      for (var id in all) {
+        var t = all[id];
+        if (t && t.isA && t.isA('sap.ui.mdc.Table') && visible(t)) {
+          var b = t.getRowBinding ? t.getRowBinding() : null;
+          if (b && b.refresh) { b.refresh(); n++; }
+        }
+      }
+      return wait().then(function () { return n; });
+    });
+  }
+  function press(sel) {
+    return wait().then(function () {
+      if (expandHeaders() > 0) return wait();
+    }).then(function () {
+      return RR.interactWithControl({ selector: toSelector(sel), interactionType: RR.InteractionType.Press });
+    }).then(wait).then(function () { return true; });
+  }
+  function textOf(c) {
+    try {
+      if (c.getText) return String(c.getText());
+      if (c.getTitle) return String(c.getTitle());
+    } catch (e) { /* fall through */ }
+    var d = c.getDomRef && c.getDomRef();
+    return d ? String(d.innerText || d.textContent || '').replace(/\s+/g, ' ').trim() : '';
+  }
+  // No open error MessageBox and no message popover in error state (design §3.3).
+  function openErrors() {
+    return wait().then(function () {
+      var out = [];
+      var all = allControls();
+      for (var id in all) {
+        var c = all[id];
+        if (!c || !c.isA) continue;
+        if (c.isA('sap.m.Dialog') && c.isOpen && c.isOpen()) {
+          var st = c.getState ? c.getState() : '';
+          var isBox = c.hasStyleClass && (c.hasStyleClass('sapMMessageBoxError') || c.hasStyleClass('sapMMessageBoxWarning'));
+          if (st === 'Error' || isBox) {
+            var parts = [];
+            var content = c.getContent ? c.getContent() : [];
+            for (var i = 0; i < content.length; i++) parts.push(textOf(content[i]));
+            out.push('dialog: ' + (c.getTitle ? c.getTitle() : '') + ' — ' + parts.join(' ').replace(/\s+/g, ' ').trim());
+          }
+        }
+        if ((c.isA('sap.m.MessagePopover') || c.isA('sap.m.MessageView')) && visible(c)) {
+          var items = c.getItems ? c.getItems() : [];
+          for (var j = 0; j < items.length; j++) {
+            var it = items[j];
+            if (it.getType && it.getType() === 'Error') out.push('message: ' + (it.getTitle ? it.getTitle() : textOf(it)));
+          }
+        }
+      }
+      // UI5 1.84 surfaces a failed save only in the message model (the footer's
+      // message indicator), with no dialog — 1.120 also opens a dialog. An error
+      // message in the model is an error the user is shown, on every release.
+      try {
+        var msgs = sap.ui.getCore().getMessageManager().getMessageModel().getData() || [];
+        for (var m = 0; m < msgs.length; m++) {
+          if (msgs[m].getType && msgs[m].getType() === 'Error') out.push('message: ' + msgs[m].getMessage());
+        }
+      } catch (e) { /* no message manager — dialogs and popovers above still count */ }
+      return out;
+    });
+  }
+  function isBusy() {
+    var all = allControls();
+    for (var id in all) {
+      var c = all[id];
+      if (c && c.getBusy && c.getBusy() && visible(c)) return true;
+    }
+    var bi = document.getElementById('sapUiBusyIndicator');
+    return !!(bi && bi.offsetWidth);
+  }
+  // The FE stable id of an object-page field: …::DataField::<Property>::Field(-edit|-display)?
+  function findField(property) {
+    var re = new RegExp('::DataField::' + escapeRe(property) + '::Field(-edit)?$');
+    var all = allControls();
+    var hit = null;
+    for (var id in all) {
+      var c = all[id];
+      if (c && c.isA && c.isA('sap.ui.mdc.Field') && re.test(id) && visible(c)) {
+        if (!hit || /-edit$/.test(id)) hit = c;
+      }
+    }
+    return hit;
+  }
+  function valueHelpOf(field) {
+    // UI5 1.84 names the association fieldHelp (sap.ui.mdc.field.FieldValueHelp);
+    // newer releases name it valueHelp (sap.ui.mdc.ValueHelp).
+    var vhId = (field.getValueHelp && field.getValueHelp()) || (field.getFieldHelp && field.getFieldHelp());
+    if (!vhId) return null;
+    var E = Element();
+    return E.getElementById ? E.getElementById(vhId) : sap.ui.getCore().byId(vhId);
+  }
+  // The list the open value help shows: its content's list binding (MTable /
+  // FixedList — covers the fixed-values dropdown AND the dialog alike).
+  function valueHelpList(vh) {
+    var containers = [vh.getTypeahead && vh.getTypeahead(), vh.getDialog && vh.getDialog()];
+    for (var k = 0; k < containers.length; k++) {
+      var cont = containers[k];
+      if (!cont || !cont.isOpen || !cont.isOpen()) continue;
+      var contents = cont.getContent ? cont.getContent() : [];
+      for (var i = 0; i < contents.length; i++) {
+        var ct = contents[i];
+        var table = ct.getTable ? ct.getTable() : null;
+        var binding = table && table.getBinding ? (table.getBinding('items') || table.getBinding('rows')) : null;
+        if (!binding && ct.getListBinding) binding = ct.getListBinding();
+        // Rows with a binding context, wherever the content keeps them (the
+        // dropdown's sap.m.Table, or the dialog's table inside its layout).
+        var items = cont.findAggregatedObjects(true, function (x) {
+          return x.isA && (x.isA('sap.m.ListItemBase') || x.isA('sap.ui.table.Row')) && !!(x.getBindingContext && x.getBindingContext());
+        });
+        return {
+          container: cont.isA('sap.ui.mdc.valuehelp.Dialog') ? 'dialog' : 'popover',
+          length: binding && binding.getLength ? binding.getLength() : items.length,
+          items: items,
+        };
+      }
+    }
+    // UI5 1.84: sap.ui.mdc.field.FieldValueHelp — one content wrapper holding the
+    // table, shown in a popover (typeahead / fixed values) or a dialog.
+    if (vh.isA && vh.isA('sap.ui.mdc.field.FieldValueHelp') && vh.isOpen && vh.isOpen()) {
+      // 1.84 has one content wrapper; 1.96 adds suggestContent (popover) and
+      // dialogContent (dialog). Take the wrapper of what is open, then content.
+      var okBtn = sap.ui.getCore().byId(vh.getId() + '-ok');
+      var inDialog = !!(okBtn && visible(okBtn));
+      var pick = inDialog
+        ? [vh.getDialogContent && vh.getDialogContent(), vh.getContent && vh.getContent()]
+        : [vh.getSuggestContent && vh.getSuggestContent(), vh.getContent && vh.getContent()];
+      var wrapper = null;
+      for (var w = 0; w < pick.length; w++) { if (pick[w] && pick[w].getTable && pick[w].getTable()) { wrapper = pick[w]; break; } }
+      var tbl = wrapper ? wrapper.getTable() : null;
+      if (!tbl) return null;
+      var lb = wrapper.getListBinding ? wrapper.getListBinding() : (tbl.getBinding && (tbl.getBinding('items') || tbl.getBinding('rows')));
+      var rows = tbl.findAggregatedObjects(true, function (x) {
+        return x.isA && (x.isA('sap.m.ListItemBase') || x.isA('sap.ui.table.Row')) && !!(x.getBindingContext && x.getBindingContext());
+      });
+      return { container: inDialog ? 'dialog' : 'popover', length: lb && lb.getLength ? lb.getLength() : rows.length, items: rows };
+    }
+    return null;
+  }
+  function openValueHelp(arg) {
+    var field;
+    return wait().then(function () {
+      field = findField(arg.property);
+      if (!field) throw new Error('no visible field for ' + arg.property + ' on the page');
+      if (!field.getEditMode || field.getEditMode() === 'Display' || field.getEditMode() === 'ReadOnly') {
+        throw new Error('field ' + arg.property + ' is not editable (' + (field.getEditMode && field.getEditMode()) + ')');
+      }
+      return RR.interactWithControl({
+        selector: { controlType: 'sap.ui.core.Icon', id: new RegExp(escapeRe(field.getId()) + '-inner-vhi$') },
+        interactionType: RR.InteractionType.Press,
+      });
+    }).then(wait).then(function () {
+      var vh = valueHelpOf(field);
+      var list = vh ? valueHelpList(vh) : null;
+      return {
+        valueHelpId: vh ? vh.getId() : null,
+        open: !!(vh && vh.isOpen && vh.isOpen()),
+        container: list ? list.container : null,
+        length: list ? list.length : 0,
+      };
+    });
+  }
+  function pickValueHelpValue(arg) {
+    var field = findField(arg.property);
+    var vh = field ? valueHelpOf(field) : null;
+    var list = vh ? valueHelpList(vh) : null;
+    if (!list) return Promise.reject(new Error('the value help of ' + arg.property + ' is not open'));
+    var target = null;
+    var seen = [];
+    for (var i = 0; i < list.items.length; i++) {
+      var ctx = list.items[i].getBindingContext && list.items[i].getBindingContext();
+      var v = ctx ? ctx.getProperty(arg.keyProperty) : undefined;
+      seen.push(String(v));
+      if (v !== undefined && String(v) === String(arg.value)) { target = list.items[i]; break; }
+    }
+    if (!target) return Promise.reject(new Error('value ' + arg.value + ' not in the value help of ' + arg.property + ' (has: ' + seen.join(', ') + ')'));
+    // A grid-table row (the dialog) is selected by a press on one of its cells.
+    var pressTarget = target.isA('sap.ui.table.Row') && target.getCells().length > 0 ? target.getCells()[0] : target;
+    return press({ id: pressTarget.getId() }).then(function () {
+      // UI5 1.84 FieldValueHelp dialog: a selection is only recorded; the value
+      // is taken when the user presses OK (button id <valueHelpId>-ok). The
+      // popover (typeahead / fixed values) applies it at once.
+      // Detect the dialog by its OK button being on screen: on 1.84 the table is
+      // not parented under the sap.m.Dialog, so walking up does not find it.
+      var ok = vh.isA && vh.isA('sap.ui.mdc.field.FieldValueHelp') ? sap.ui.getCore().byId(vh.getId() + '-ok') : null;
+      if (ok && visible(ok)) return press({ id: ok.getId() });
+      return true;
+    });
+  }
+  // Values the open value help lists for its key property (to choose one).
+  function valueHelpValues(arg) {
+    var field = findField(arg.property);
+    var vh = field ? valueHelpOf(field) : null;
+    var list = vh ? valueHelpList(vh) : null;
+    if (!list) return [];
+    var out = [];
+    for (var i = 0; i < list.items.length; i++) {
+      var ctx = list.items[i].getBindingContext && list.items[i].getBindingContext();
+      if (!ctx) continue;
+      out.push({ key: String(ctx.getProperty(arg.keyProperty)), text: arg.textProperty ? String(ctx.getProperty(arg.textProperty) || '') : '' });
+    }
+    return out;
+  }
+  function fieldText(arg) {
+    return wait().then(function () {
+      var f = findField(arg.property);
+      if (!f) return null;
+      var d = f.getDomRef();
+      var input = d && d.querySelector('input');
+      return input ? String(input.value) : String(d.innerText || d.textContent || '').replace(/\s+/g, ' ').trim();
+    });
+  }
+  // FE's "Discard Draft" opens a popover whose only button confirms (it has no
+  // stable id; its text is translated). Press the ONE button of the ONE open
+  // popover — anything else is refused rather than guessed.
+  function confirmPopover() {
+    return wait().then(function () {
+      var all = allControls();
+      var open = [];
+      for (var id in all) {
+        var c = all[id];
+        if (c && c.isA && c.isA('sap.m.Popover') && c.isOpen && c.isOpen()) open.push(c);
+      }
+      if (open.length !== 1) throw new Error('expected one open popover to confirm, found ' + open.length);
+      var buttons = open[0].findAggregatedObjects(true, function (x) { return x.isA && x.isA('sap.m.Button') && visible(x); });
+      if (buttons.length !== 1) throw new Error('expected one button in the open popover, found ' + buttons.length);
+      return press({ id: buttons[0].getId() });
+    });
+  }
+  function back() {
+    window.history.back();
+    return wait().then(function () { return true; });
+  }
+  // One OData request from INSIDE the page (same origin, same session as the
+  // app). Mutating verbs carry the CSRF token fetched from the service root.
+  var tokens = {};
+  function csrf(serviceRoot) {
+    if (tokens[serviceRoot]) return Promise.resolve(tokens[serviceRoot]);
+    return fetch(serviceRoot, { method: 'GET', credentials: 'same-origin', headers: { 'X-CSRF-Token': 'Fetch', Accept: 'application/json', 'X-CSP-Smoke': '1' } })
+      .then(function (r) { tokens[serviceRoot] = r.headers.get('x-csrf-token') || ''; return tokens[serviceRoot]; });
+  }
+  // Same origin only: a path ('/sap/…'), never a URL, never a protocol-relative '//host'.
+  function isPath(u) {
+    return typeof u === 'string' && u.charAt(0) === '/' && u.charAt(1) !== '/' && u.indexOf('\\') < 0;
+  }
+  function request(arg) {
+    if (!arg || !isPath(arg.url) || !isPath(arg.serviceRoot)) {
+      return Promise.reject(new Error('in-page request refused: url and serviceRoot must be same-origin paths'));
+    }
+    var method = String(arg.method).toUpperCase();
+    if (['GET', 'POST', 'PATCH', 'DELETE'].indexOf(method) < 0) {
+      return Promise.reject(new Error('in-page request refused: method ' + method));
+    }
+    // X-CSP-Smoke marks the smoke's OWN calls: the driver leaves them out of the
+    // app's request log (each step judges its own answers).
+    var headers = { Accept: 'application/json', 'X-CSP-Smoke': '1' };
+    var p = method === 'GET' ? Promise.resolve('') : csrf(arg.serviceRoot);
+    return p.then(function (token) {
+      if (token) headers['X-CSRF-Token'] = token;
+      if (arg.body !== undefined) headers['Content-Type'] = 'application/json';
+      if (arg.ifMatch) headers['If-Match'] = arg.ifMatch;
+      return fetch(arg.url, {
+        method: method,
+        credentials: 'same-origin',
+        headers: headers,
+        body: arg.body === undefined ? undefined : JSON.stringify(arg.body),
+      });
+    }).then(function (r) {
+      return r.text().then(function (text) {
+        var json = null;
+        try { json = text ? JSON.parse(text) : null; } catch (e) { json = null; }
+        return { status: r.status, body: json, text: json ? '' : text.slice(0, 500), etag: r.headers.get('etag') || '' };
+      });
+    });
+  }
+  return {
+    wait: function () { return wait().then(function () { return true; }); },
+    press: press,
+    openErrors: openErrors,
+    isBusy: function () { return isBusy(); },
+    refreshLists: refreshLists,
+    openValueHelp: openValueHelp,
+    pickValueHelpValue: pickValueHelpValue,
+    valueHelpValues: valueHelpValues,
+    fieldText: fieldText,
+    confirmPopover: confirmPopover,
+    // L1-3's table reader (driver.ts), after waitForUI5.
+    tableSnapshot: function (entitySet) {
+      return wait().then(function () { return (${TABLE_SNAPSHOT_SRC})(entitySet); });
+    },
+    back: back,
+    request: request,
+  };
+}`;

package/dist/tools/fiori/smoke/app-driver.js

@@ -0,0 +1,100 @@
+// cspeach-cli/src/tools/fiori/smoke/app-driver.ts
+//
+// L1-5a — the `AppDriver` interface and its lane-1 implementation over
+// `sap/ui/test/RecordReplay` (design §3.3, review F-8 / F-28).
+//
+// The checks that drive an app (fiori_draft_smoke today) are written ONCE,
+// against this interface. Lane 2 implements the same interface for its React
+// apps instead of refactoring the checks.
+//
+// The RecordReplay implementation runs every UI5 interaction inside the page
+// through APP_DRIVER_PAGE_SRC: `waitForUI5` before every read and after every
+// action, control selectors (control type + Fiori Elements stable-id suffix, a
+// row's binding path) — never CSS class names. The only code that reaches the
+// page is the module constant DRIVER_CALL_SRC; the method name (from this file)
+// and its argument travel as JSON.
+import { APP_DRIVER_PAGE_SRC } from './app-driver-page.js';
+/** Fiori Elements V4 stable-id suffixes of the buttons the draft round trip presses. */
+export const FE_ACTION_SUFFIX = {
+    /** Object page header: Edit (creates the draft). */
+    edit: '--fe::StandardAction::Edit',
+    /** Object page footer: Save (= Prepare + Activate). */
+    save: '--fe::FooterBar::StandardAction::Save',
+    /** Object page footer: "Discard Draft" — opens a confirmation popover. */
+    discard: '--fe::FooterBar::StandardAction::Cancel',
+    /** List report filter bar: Go. */
+    go: '-btnSearch',
+};
+/** The single in-page entry: build `window.__csp` once, then call one named method. */
+export const DRIVER_CALL_SRC = 'async function (x) {' +
+    ` if (!window.__csp) window.__csp = (${APP_DRIVER_PAGE_SRC})();` +
+    ' var f = window.__csp[x.m];' +
+    " if (typeof f !== 'function') throw new Error('unknown driver call ' + x.m);" +
+    ' return f(x.a);' +
+    ' }';
+/** Same origin only — the page-side guard says the same; this one stops it earlier. */
+function isSameOriginPath(u) {
+    return typeof u === 'string' && u.startsWith('/') && !u.startsWith('//') && !u.includes('\\');
+}
+export function createRecordReplayDriver(page) {
+    const call = (m, a = null) => page.evalInPage(DRIVER_CALL_SRC, { m, a });
+    const pressSuffix = (idSuffix, controlType = 'sap.m.Button') => call('press', { controlType, idSuffix }).then(() => undefined);
+    return {
+        waitForUI5: () => call('wait').then(() => undefined),
+        isBusy: () => call('isBusy'),
+        openRow: (rowPath) => call('press', { controlType: 'sap.m.ColumnListItem', bindingPath: rowPath }).then(() => undefined),
+        pressAction: async (action) => {
+            if (typeof action === 'object')
+                return pressSuffix(action.idSuffix, action.controlType);
+            if (action === 'go') {
+                // A filter bar in live mode has no Go button (SAP's CAP sample on UI5
+                // 1.152); the row-binding refresh below reloads the list either way.
+                await pressSuffix(FE_ACTION_SUFFIX.go).catch((err) => {
+                    if (!/No controls found/.test(err instanceof Error ? err.message : String(err)))
+                        throw err;
+                });
+            }
+            else {
+                await pressSuffix(FE_ACTION_SUFFIX[action]);
+            }
+            if (action === 'discard')
+                await call('confirmPopover');
+            // FE on UI5 1.108 does not search again when no filter changed, so Go
+            // alone can leave rows created by API off the list. Refresh the list's
+            // row binding too (1.120 already re-fetched on Go — one extra read).
+            if (action === 'go')
+                await call('refreshLists');
+        },
+        setFieldViaValueHelp: async (field, choose) => {
+            const opened = await call('openValueHelp', { property: field.property });
+            const values = await call('valueHelpValues', {
+                property: field.property,
+                keyProperty: field.keyProperty,
+                ...(field.textProperty ? { textProperty: field.textProperty } : {}),
+            });
+            const obs = {
+                open: opened.open,
+                container: opened.container,
+                length: opened.length,
+                values,
+            };
+            if (!opened.open)
+                return obs;
+            const key = choose(values);
+            if (key === undefined)
+                return obs;
+            await call('pickValueHelpValue', { property: field.property, keyProperty: field.keyProperty, value: key });
+            obs.picked = values.find((v) => v.key === key) ?? { key, text: '' };
+            return obs;
+        },
+        cellTexts: (entitySet) => call('tableSnapshot', entitySet).then((r) => r ?? undefined),
+        openErrors: () => call('openErrors'),
+        back: () => call('back').then(() => undefined),
+        request: async (req) => {
+            if (!isSameOriginPath(req.url) || !isSameOriginPath(req.serviceRoot)) {
+                throw new Error(`in-page request refused: "${req.url}" is not a same-origin path`);
+            }
+            return call('request', req);
+        },
+    };
+}