@sapui5/sap.fe.test 1.108.1 → 1.109.0

package/src/sap/fe/test/JestTemplatingHelper.ts

@@ -5,6 +5,7 @@ import * as path from "path";
 import type { RequiredOptions } from "prettier";
 import { format } from "prettier";
 import Log from "sap/base/Log";
+import LoaderExtensions from "sap/base/util/LoaderExtensions";
 import merge from "sap/base/util/merge";
 import AppComponent from "sap/fe/core/AppComponent";
 import { registerBuildingBlock } from "sap/fe/core/buildingBlocks/BuildingBlockRuntime";
@@ -32,6 +33,22 @@ import MetaModel from "sap/ui/model/MetaModel";
 import _MetadataRequestor from "sap/ui/model/odata/v4/lib/_MetadataRequestor";
 import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
 import xpath from "xpath";
+import { createFlexibilityChangesObject } from "./JestFlexibilityHelper";
+
+type PreProcessorSettingsType = {
+	models: {
+		[name: string]: JSONModel | ODataMetaModel;
+	};
+	bindingContexts: {
+		[name: string]: Context | undefined;
+	};
+};
+
+type JestTemplatedView = {
+	asElement: Element | undefined;
+	asString: string;
+};
+
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const formatXml = require("xml-formatter");
 
@@ -61,6 +78,67 @@ const nameSpaceMap = {
 };
 const select = xpath.useNamespaces(nameSpaceMap);
 
+function _getTemplatedSelector(xmldom: Node, selector: string): string {
+	/**
+	 * if a root element has been added during the templating by our Jest Templating methods
+	 * the root element is added to the selector path.
+	 */
+	const rootPath = "/root";
+	return `${xmldom.nodeName === "root" && !selector.startsWith(rootPath) ? rootPath : ""}${selector}`;
+}
+
+async function _buildPreProcessorSettings(
+	sMetadataUrl: string,
+	mBindingContexts: { [x: string]: string },
+	mModels: { [x: string]: any }
+): Promise<PreProcessorSettingsType> {
+	const oMetaModel = await getMetaModel(sMetadataUrl);
+
+	// To ensure our macro can use #setBindingContext we ensure there is a pre existing JSONModel for converterContext
+	// if not already passed to teh templating
+	if (!mModels.hasOwnProperty("converterContext")) {
+		mModels = Object.assign(mModels, { "converterContext": new TemplateModel({}, oMetaModel) });
+	}
+
+	Object.keys(mModels).forEach(function (sModelName) {
+		if (mModels[sModelName] && mModels[sModelName].isTemplateModel) {
+			mModels[sModelName] = new TemplateModel(mModels[sModelName].data, oMetaModel);
+		}
+	});
+
+	const settings: any = {
+		models: Object.assign(
+			{
+				metaModel: oMetaModel
+			},
+			mModels
+		),
+		bindingContexts: {}
+	};
+
+	//Inject models and bindingContexts
+	Object.keys(mBindingContexts).forEach(function (sKey) {
+		/* Assert to make sure the annotations are in the test metadata -> avoid misleading tests */
+		expect(typeof oMetaModel.getObject(mBindingContexts[sKey])).toBeDefined();
+		const oModel = mModels[sKey] || oMetaModel;
+		settings.bindingContexts[sKey] = oModel.createBindingContext(mBindingContexts[sKey]); //Value is sPath
+		settings.models[sKey] = oModel;
+	});
+	return settings;
+}
+
+function _removeCommentFromXml(xml: string): string {
+	return formatXml(xml, {
+		filter: (node: any) => node.type !== "Comment"
+	});
+}
+
+function _loadResourceView(viewName: string): Element {
+	const name = viewName.replace(/\./g, "/") + ".view.xml";
+	const view = LoaderExtensions.loadResource(name);
+	return view.documentElement;
+}
+
 export const registerMacro = function (macroMetadata: any) {
 	registerBuildingBlock(macroMetadata);
 };
@@ -76,7 +154,7 @@ export const runXPathQuery = function (selector: string, xmldom: Node | undefine
 
 expect.extend({
 	toHaveControl(xmldom, selector) {
-		const nodes = runXPathQuery(`/root${selector}`, xmldom);
+		const nodes = runXPathQuery(_getTemplatedSelector(xmldom, selector), xmldom);
 		return {
 			message: () => {
 				const outputXml = serializeXML(xmldom);
@@ -86,7 +164,7 @@ expect.extend({
 		};
 	},
 	toNotHaveControl(xmldom, selector) {
-		const nodes = runXPathQuery(`/root${selector}`, xmldom);
+		const nodes = runXPathQuery(_getTemplatedSelector(xmldom, selector), xmldom);
 		return {
 			message: () => {
 				const outputXml = serializeXML(xmldom);
@@ -107,7 +185,7 @@ export const formatBuildingBlockXML = function (xmlString: string | string[]) {
 };
 
 export const getControlAttribute = function (controlSelector: string, attributeName: string, xmlDom: Node) {
-	const selector = `string(/root${controlSelector}/@${attributeName})`;
+	const selector = `string(${_getTemplatedSelector(xmlDom, controlSelector)}/@${attributeName})`;
 	return runXPathQuery(selector, xmlDom);
 };
 
@@ -305,13 +383,12 @@ export function evaluateBindingWithModel(
 
 const TESTVIEWID = "testViewId";
 
-export const applyFlexChanges = async function (
-	aVariantDependentControlChanges: any[],
-	oMetaModel: MetaModel,
-	resultXML: any,
-	createChangesObject: Function
-) {
-	const changes = createChangesObject(TESTVIEWID, aVariantDependentControlChanges);
+const applyFlexChanges = async function (aVariantDependentControlChanges: any[], oMetaModel: MetaModel, resultXML: any) {
+	// prefix Ids
+	[...resultXML.querySelectorAll("[id]")].forEach((node) => {
+		node.id = `${TESTVIEWID}--${node.id}`;
+	});
+	const changes = createFlexibilityChangesObject(TESTVIEWID, aVariantDependentControlChanges);
 	const appId = "someComponent";
 	const oManifest = {
 		"sap.app": {
@@ -342,6 +419,10 @@ export const applyFlexChanges = async function (
 		componentId: appId
 	});
 	resultXML = await XmlPreprocessor.process(resultXML, { name: "Test Fragment", componentId: appId, id: TESTVIEWID });
+
+	//Assert that all changes have been applied
+	const changesApplied = getChangesFromXML(resultXML);
+	expect(changesApplied.length).toBe(aVariantDependentControlChanges.length);
 	return resultXML;
 };
 
@@ -355,8 +436,7 @@ export const getTemplatingResult = async function (
 	sMetadataUrl: string,
 	mBindingContexts: { [x: string]: any; entitySet?: string },
 	mModels: { [x: string]: any },
-	aVariantDependentControlChanges?: any[],
-	createChangesObject?: Function
+	aVariantDependentControlChanges?: any[]
 ) {
 	const templatedXml = `<root>${xmlInput}</root>`;
 	const parser = new window.DOMParser();
@@ -365,52 +445,18 @@ export const getTemplatingResult = async function (
 	// if not already passed to teh templating
 
 	const oMetaModel = await getMetaModel(sMetadataUrl);
-	if (!mModels.hasOwnProperty("converterContext")) {
-		mModels = Object.assign(mModels, { "converterContext": new TemplateModel({}, oMetaModel) });
-	}
-
-	Object.keys(mModels).forEach(function (sModelName) {
-		if (mModels[sModelName] && mModels[sModelName].isTemplateModel) {
-			mModels[sModelName] = new TemplateModel(mModels[sModelName].data, oMetaModel);
-		}
-	});
-
-	const oPreprocessorSettings: any = {
-		models: Object.assign(
-			{
-				metaModel: oMetaModel
-			},
-			mModels
-		),
-		bindingContexts: {}
-	};
-
-	//Inject models and bindingContexts
-	Object.keys(mBindingContexts).forEach(function (sKey) {
-		/* Assert to make sure the annotations are in the test metadata -> avoid misleading tests */
-		expect(typeof oMetaModel.getObject(mBindingContexts[sKey])).toBeDefined();
-		const oModel = mModels[sKey] || oMetaModel;
-		oPreprocessorSettings.bindingContexts[sKey] = oModel.createBindingContext(mBindingContexts[sKey]); //Value is sPath
-		oPreprocessorSettings.models[sKey] = oModel;
-	});
+	const oPreprocessorSettings = await _buildPreProcessorSettings(sMetadataUrl, mBindingContexts, mModels);
 
 	//This context for macro testing
 	if (oPreprocessorSettings.models["this"]) {
 		oPreprocessorSettings.bindingContexts["this"] = oPreprocessorSettings.models["this"].createBindingContext("/");
 	}
 
-	let resultXML = await XMLPreprocessor.process(xmlDoc.firstElementChild!, { name: "Test Fragment" }, oPreprocessorSettings);
+	let resultXML = (await XMLPreprocessor.process(xmlDoc.firstElementChild!, { name: "Test Fragment" }, oPreprocessorSettings)) as any;
 
-	if (aVariantDependentControlChanges && createChangesObject) {
-		// prefix Ids
-		[...resultXML.querySelectorAll("[id]")].forEach((node) => {
-			node.id = `${TESTVIEWID}--${node.id}`;
-		});
+	if (aVariantDependentControlChanges) {
 		// apply flex changes
-		resultXML = await applyFlexChanges(aVariantDependentControlChanges, oMetaModel, resultXML, createChangesObject);
-		//Assert that all changes have been applied
-		const changesApplied = getChangesFromXML(resultXML);
-		expect(changesApplied.length).toBe(aVariantDependentControlChanges.length);
+		resultXML = await applyFlexChanges(aVariantDependentControlChanges, oMetaModel, resultXML);
 	}
 	return resultXML;
 };
@@ -418,22 +464,44 @@ export const getTemplatingResult = async function (
 export const getTemplatedXML = async function (
 	xmlInput: string,
 	sMetadataUrl: string,
-	mBindingContexts: { [x: string]: any; entitySet?: string },
+	mBindingContexts: { [x: string]: string },
 	mModels: { [x: string]: any },
-	aVariantDependentControlChanges?: any[],
-	createChangesObject?: Function
+	aVariantDependentControlChanges?: any[]
 ) {
-	const templatedXML = await getTemplatingResult(
-		xmlInput,
-		sMetadataUrl,
-		mBindingContexts,
-		mModels,
-		aVariantDependentControlChanges,
-		createChangesObject
-	);
+	const templatedXML = await getTemplatingResult(xmlInput, sMetadataUrl, mBindingContexts, mModels, aVariantDependentControlChanges);
 	return serializeXML(templatedXML);
 };
 
+/**
+ * Process the requested view with the provided data.
+ *
+ * @param name Fully qualified name of the view to be tested.
+ * @param sMetadataUrl Url of the metadata.
+ * @param mBindingContexts Map of the bindingContexts to set on the models.
+ * @param mModels Map of the models.
+ * @param aVariantDependentControlChanges
+ * @returns Templated view as string
+ */
+export async function processView(
+	name: string,
+	sMetadataUrl: string,
+	mBindingContexts: { [x: string]: string },
+	mModels: { [x: string]: any },
+	aVariantDependentControlChanges?: any[]
+): Promise<JestTemplatedView> {
+	const oMetaModel = await getMetaModel(sMetadataUrl);
+	const oViewDocument = _loadResourceView(name);
+	const oPreprocessorSettings = await _buildPreProcessorSettings(sMetadataUrl, mBindingContexts, mModels);
+	let oPreprocessedView = await XMLPreprocessor.process(oViewDocument, { name: name }, oPreprocessorSettings);
+	if (aVariantDependentControlChanges) {
+		oPreprocessedView = await applyFlexChanges(aVariantDependentControlChanges || [], oMetaModel, oPreprocessedView);
+	}
+	return {
+		asElement: oPreprocessedView,
+		asString: _removeCommentFromXml(oPreprocessedView?.outerHTML || "")
+	};
+}
+
 /**
  * Process the requested XML fragment with the provided data.
  *
@@ -462,7 +530,7 @@ export async function processFragment(name: string, testData: { [model: string]:
 	const resultDoc = await XMLPreprocessor.process(inputDoc.firstElementChild, { name }, settings);
 
 	// exclude nested fragments from test snapshots
-	const fragments = resultDoc.getElementsByTagName("core:Fragment");
+	const fragments = resultDoc.getElementsByTagName("core:Fragment") as any;
 	if (fragments?.length > 0) {
 		for (const fragment of fragments) {
 			fragment.innerHTML = "";
@@ -472,9 +540,7 @@ export async function processFragment(name: string, testData: { [model: string]:
 	// Keep the fragment result as child of root node when fragment generates multiple root controls
 	const xmlResult = resultDoc.children.length > 1 ? resultDoc.outerHTML : resultDoc.innerHTML;
 
-	return formatXml(xmlResult, {
-		filter: (node: any) => node.type !== "Comment"
-	});
+	return _removeCommentFromXml(xmlResult);
 }
 
 export function serializeControl(controlToSerialize: Control | Control[]) {

package/src/sap/fe/test/ObjectPage.js

@@ -204,7 +204,7 @@ sap.ui.define(
 							 * @param {sap.fe.test.api.FilterBarIdentifier | string} vFilterBarIdentifier The identifier of the filterbar
 							 * @returns {sap.fe.test.api.FilterBarActions} The available filter bar actions
 							 * @function
-							 * @alias sap.fe.test.ListReport.actions#onFilterBar
+							 * @alias sap.fe.test.ObjectPage.actions#onFilterBar
 							 * @public
 							 */
 							onFilterBar: function (vFilterBarIdentifier) {
@@ -260,12 +260,9 @@ sap.ui.define(
 										vFormIdentifier.fullSubSectionId = ViewId + "--" + vFormIdentifier.id;
 									}
 									if (vFormIdentifier.fieldGroup) {
-										if (vFormIdentifier.isHeaderFacet) {
-											vFormIdentifier.fieldGroupId =
-												OPFormContainerHeaderFacetsIdPrefix + "::" + vFormIdentifier.fieldGroup;
-										} else {
-											vFormIdentifier.fieldGroupId = OPFormContainerIdPrefix + "::" + vFormIdentifier.fieldGroup;
-										}
+										vFormIdentifier.fieldGroupId = vFormIdentifier.isHeaderFacet
+											? OPFormContainerHeaderFacetsIdPrefix + "::" + vFormIdentifier.fieldGroup
+											: OPFormContainerIdPrefix + "::" + vFormIdentifier.fieldGroup;
 									}
 								}
 								return new FormActions(_getFormBuilder(this, vFormIdentifier), vFormIdentifier);
@@ -528,7 +525,7 @@ sap.ui.define(
 							 * @param {sap.fe.test.api.FilterBarIdentifier | string} vFilterBarIdentifier The identifier of the filterbar
 							 * @returns {sap.fe.test.api.FilterBarAssertions} The available filter bar assertions
 							 * @function
-							 * @alias sap.fe.test.ListReport.assertions#onFilterBar
+							 * @alias sap.fe.test.ObjectPage.assertions#onFilterBar
 							 * @public
 							 */
 							onFilterBar: function (vFilterBarIdentifier) {
@@ -582,7 +579,9 @@ sap.ui.define(
 										vFormIdentifier.fullSubSectionId = ViewId + "--" + vFormIdentifier.id;
 									}
 									if (vFormIdentifier.fieldGroup) {
-										vFormIdentifier.fieldGroupId = OPFormContainerIdPrefix + "::" + vFormIdentifier.fieldGroup;
+										vFormIdentifier.fieldGroupId = vFormIdentifier.isHeaderFacet
+											? OPFormContainerHeaderFacetsIdPrefix + "::" + vFormIdentifier.fieldGroup
+											: OPFormContainerIdPrefix + "::" + vFormIdentifier.fieldGroup;
 									}
 								}
 								return new FormAssertions(_getFormBuilder(this, vFormIdentifier), vFormIdentifier);

package/src/sap/fe/test/api/FormAPI.js

@@ -21,6 +21,7 @@ sap.ui.define(
 		 * @typedef {object} FormIdentifier
 		 * @property {string} section The facet ID
 		 * @property {string} fieldGroup The fieldgroup ID
+		 * @property {boolean} [isHeaderFacet] Is it about the editable header facet
 		 * @name sap.fe.test.api.FormIdentifier
 		 * @public
 		 */

package/src/sap/fe/test/builder/MdcTableBuilder.js

@@ -57,7 +57,7 @@ sap.ui.define(
 		};
 
 		var TableBuilder = function () {
-			return FEBuilder.apply(this, arguments).hasType("sap.ui.mdc.Table");
+			return FEBuilder.apply(this, arguments).hasType("sap.ui.mdc.Table").hasProperties({ busy: false });
 		};
 
 		function _isGridTable(oMdcTable) {
@@ -1078,6 +1078,15 @@ sap.ui.define(
 							oCellControl = oCellControl.getCondition() ? oCellControl.getContentTrue() : oCellControl.getContentFalse();
 						}
 
+						// Collaboration case: the field is wrapped in a HBox with an avatar
+						if (
+							oCellControl.isA("sap.m.HBox") &&
+							oCellControl.getItems().length === 2 &&
+							oCellControl.getItems()[1].isA("sap.m.Avatar")
+						) {
+							oCellControl = oCellControl.getItems()[0];
+						}
+
 						if (vCellAction.executeOn) {
 							vCellAction.executeOn(oCellControl);
 						} else {

package/src/sap/fe/test/library.js

@@ -21,7 +21,7 @@ sap.ui.define(["sap/ui/core/Core", "sap/ui/core/library"], function (Core, _libr
     controls: [],
     elements: [],
     // eslint-disable-next-line no-template-curly-in-string
-    version: "1.108.1",
+    version: "1.109.0",
     noLibraryCSS: true
   });
   return thisLib;