@sapui5/sap.fe.test 1.130.6 → 1.132.0

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

@@ -10,6 +10,7 @@ import merge from "sap/base/util/merge";
 import uid from "sap/base/util/uid";
 import jsx from "sap/fe/base/jsx-runtime/jsx";
 import AppComponent from "sap/fe/core/AppComponent";
+import PageController from "sap/fe/core/PageController";
 import type TemplateComponent from "sap/fe/core/TemplateComponent";
 import TemplateModel from "sap/fe/core/TemplateModel";
 import { parseXMLString } from "sap/fe/core/buildingBlocks/templating/BuildingBlockTemplateProcessor";
@@ -101,7 +102,8 @@ const nameSpaceMap: Record<string, string> = {
 	valueHelp: "sap.fe.macros.valueHelp",
 	contentSwitcher: "sap.fe.macros.contentSwitcher",
 	filterBar: "sap.fe.macros.filterBar",
-	fbControls: "sap.fe.macros.controls.filterbar"
+	fbControls: "sap.fe.macros.controls.filterbar",
+	draftIndicator: "sap.fe.macros.draftIndicator"
 };
 const reveseNamespaceMap = Object.keys(nameSpaceMap).reduce((reverseMap: Record<string, string>, currentName) => {
 	reverseMap[nameSpaceMap[currentName]] = currentName;
@@ -840,6 +842,188 @@ export function serializeControl(controlToSerialize?: UI5Element | UI5Element[],
 	}
 }
 
+export function serializeControlAsXML(controlToSerialize?: UI5Element | UI5Element[], showCustomStyleClasses = false) {
+	let tabCount = 0;
+	const UID = /uid--id-\d{13}-\d{1,3}/;
+	const CONTROLID = /id-\d{13}-\d{1,3}/;
+	const definedNamespaces: Record<string, boolean> = {};
+
+	function getNamespaceAlias(className: string): string {
+		const namesSplit = className.split(".");
+		const namespace = namesSplit.slice(0, -1);
+		const name = namesSplit[namesSplit.length - 1];
+		let namespaceAlias = namespace[namespace.length - 1];
+		if (reveseNamespaceMap[namespace.join(".")]) {
+			namespaceAlias = reveseNamespaceMap[namespace.join(".")];
+		}
+		if (namespaceAlias === undefined) {
+			namespaceAlias = "test";
+		}
+		return namespaceAlias;
+	}
+
+	function getTab(toAdd = 0) {
+		let tab = "";
+		for (let i = 0; i < tabCount + toAdd; i++) {
+			tab += "\t";
+		}
+		return tab;
+	}
+	const serializeDelegate = {
+		start: function (control: any, sAggregationName: string) {
+			let controlDetail = "";
+			if (sAggregationName) {
+				if (control.getParent()) {
+					const indexInParent = (control.getParent().getAggregation(sAggregationName) as ManagedObject[])?.indexOf?.(control);
+					if (indexInParent > 0) {
+						controlDetail += `\n${getTab()}`;
+					}
+				}
+			}
+			const nameFull = control.getMetadata().getName();
+			const namesSplit = nameFull.split(".");
+			const name = namesSplit[namesSplit.length - 1];
+			const namespaceAlias = getNamespaceAlias(nameFull);
+			controlDetail += `<${namespaceAlias}:${name}\n`;
+			if (!definedNamespaces[namespaceAlias]) {
+				definedNamespaces[namespaceAlias] = true;
+				controlDetail += `${getTab()}xmlns:${namespaceAlias}="${nameSpaceMap[namespaceAlias]}"`;
+			}
+			return controlDetail;
+		},
+		end: function (control: any) {
+			const nameFull = control.getMetadata().getName();
+			const namesSplit = nameFull.split(".");
+			const name = namesSplit[namesSplit.length - 1];
+			const namespaceAlias = getNamespaceAlias(nameFull);
+			let hasAggregation = false;
+			for (const mAggregationsKey in control.mAggregations) {
+				if (
+					(!Array.isArray(control.mAggregations[mAggregationsKey]) &&
+						control.mAggregations[mAggregationsKey] !== null &&
+						control.mAggregations[mAggregationsKey] !== undefined) ||
+					(Array.isArray(control.mAggregations[mAggregationsKey]) && control.mAggregations[mAggregationsKey].length > 0)
+				) {
+					hasAggregation = true;
+				}
+			}
+			if (hasAggregation) {
+				return `</${namespaceAlias}:${name}>`;
+			} else {
+				return `/>`;
+			}
+		},
+		middle: function (control: any) {
+			let id = control.getId();
+			id = typeof id === "string" ? id?.replace?.(CONTROLID, "id") : id;
+			let data = "";
+			if (!ManagedObjectMetadata.isGeneratedId(id)) {
+				data = `id="${id}"`;
+			}
+			let keys = Object.keys(control.mProperties)
+				.concat(Object.keys(control.mBindingInfos))
+				.concat(Object.keys(control.mAssociations))
+				.concat(Object.keys(control.mEventRegistry));
+			keys = keys.sort((a, b) => a.localeCompare(b));
+			const uniqueKeys = new Set(keys);
+			keys = Array.from(uniqueKeys);
+			for (const oControlKey of keys) {
+				if (control.mBindingInfos.hasOwnProperty(oControlKey)) {
+					const bindingDetail = { ...control.mBindingInfos[oControlKey] };
+					if (bindingDetail.bindingString) {
+						data += `\n${getTab()}${oControlKey}="${bindingDetail.bindingString.replace(">", "&gt;")}"`;
+					} else {
+						if (bindingDetail.type?.oOutputFormat) {
+							delete bindingDetail.type.oOutputFormat;
+						}
+
+						if (bindingDetail.binding) {
+							delete bindingDetail.binding;
+						}
+						if (bindingDetail.template) {
+							delete bindingDetail.template;
+						}
+						data += `\n${getTab()}${oControlKey}='${JSON.stringify(bindingDetail)}'`;
+					}
+				} else if (control.mProperties.hasOwnProperty(oControlKey) && control.mProperties[oControlKey] !== undefined) {
+					let propertyValue = control.mProperties[oControlKey];
+					propertyValue = typeof propertyValue === "string" ? propertyValue?.replace?.(UID, "uid--id") : propertyValue;
+					propertyValue = typeof propertyValue === "string" ? propertyValue?.replace?.(CONTROLID, "id") : propertyValue;
+					try {
+						propertyValue = typeof propertyValue === "object" ? JSON.stringify(propertyValue) : propertyValue;
+					} catch (e) {
+						// Stringify may fail for circular references but it's not the end of the world
+					}
+
+					data += `\n${getTab()} ${oControlKey}="${propertyValue}"`;
+				} else if (control.mAssociations.hasOwnProperty(oControlKey)) {
+					let associationValue = control.mAssociations[oControlKey];
+					if (!Array.isArray(associationValue)) {
+						associationValue = [associationValue];
+					}
+					associationValue = associationValue.map((associationValueElement: string) => {
+						return typeof associationValueElement === "string"
+							? associationValueElement?.replace?.(CONTROLID, "id")
+							: associationValueElement;
+					});
+
+					data += `\n${getTab()} ${oControlKey}="${(associationValue?.join?.(",") ?? associationValue) || undefined}"`;
+				} else if (control.mEventRegistry.hasOwnProperty(oControlKey)) {
+					if (control.mEventRegistry[oControlKey][0]?.fFunction?.name) {
+						data += `\n${getTab()} ${oControlKey}="${control.mEventRegistry[oControlKey][0]?.fFunction?.name}"`;
+					} else {
+						data += `\n${getTab()} ${oControlKey}="someEventHandler"`;
+					}
+				}
+			}
+			if (showCustomStyleClasses && control.aCustomStyleClasses?.length > 0) {
+				data += `\n${getTab()} customStyleClasses : ${control.aCustomStyleClasses.join(", ")}`;
+			}
+			data += `\n`;
+			let hasAggregation = false;
+			for (const mAggregationsKey in control.mAggregations) {
+				if (
+					(!Array.isArray(control.mAggregations[mAggregationsKey]) &&
+						control.mAggregations[mAggregationsKey] !== null &&
+						control.mAggregations[mAggregationsKey] !== undefined) ||
+					(Array.isArray(control.mAggregations[mAggregationsKey]) && control.mAggregations[mAggregationsKey].length > 0)
+				) {
+					hasAggregation = true;
+				}
+			}
+			if (hasAggregation) {
+				data += ">";
+			}
+			return data;
+		},
+		startAggregation: function (control: any, sName: string) {
+			const namespaceAlias = getNamespaceAlias(control.getMetadata().getName());
+			let out = `\n${getTab()}<${namespaceAlias}:${sName}>`;
+			tabCount++;
+			out += `\n${getTab()}`;
+			return out;
+		},
+		endAggregation: function (control: any, sName: string) {
+			tabCount--;
+			const namespaceAlias = getNamespaceAlias(control.getMetadata().getName());
+			if (control.mBindingInfos[sName]) {
+				return `\n${getTab()}</${namespaceAlias}:${sName}>\n`;
+			} else {
+				return `\n${getTab()}</${namespaceAlias}:${sName}>\n`;
+			}
+		}
+	};
+	let outXML;
+	if (Array.isArray(controlToSerialize)) {
+		outXML = controlToSerialize.map((controlToRender: UI5Element) => {
+			return new Serializer(controlToRender, serializeDelegate).serialize();
+		});
+	} else {
+		outXML = new Serializer(controlToSerialize, serializeDelegate).serialize();
+	}
+	return formatXML(`<root>${outXML}</root>`);
+}
+
 export function createAwaiter() {
 	let fnResolve!: Function;
 	const myPromise = new Promise((resolve) => {
@@ -911,7 +1095,11 @@ export async function initializeAppComponent(
 	const id = options?.componentId ?? `sap.fe.test.${guid}`;
 	const cdsContent = fs.readFileSync(cdsFile).toString();
 	sap.jest.registerFakeFragment(`/sap/fe/core/mock/${guid}/$metadata?sap-language=EN`, cdsContent);
-
+	class DefaultPageContent extends PageController {
+		render() {
+			return <Page></Page>;
+		}
+	}
 	sap.ui.define(`sap/fe/test/${guid}/Component`, ["sap/fe/core/AppComponent"], function (_AppComponent: AppComponent) {
 		"use strict";
 
@@ -919,6 +1107,7 @@ export async function initializeAppComponent(
 			metadata: {
 				manifest: {
 					"sap.app": {
+						id: `test${guid}`,
 						dataSources: {
 							mainService: {
 								uri: `/sap/fe/core/mock/${guid}/`,
@@ -948,7 +1137,7 @@ export async function initializeAppComponent(
 											...(options?.manifestSettings ?? {}),
 											contextPath: options?.mainContextPath ?? "/Products",
 											viewType: "JSX",
-											viewContent: options?.pageContent ?? (() => <Page></Page>),
+											viewContent: options?.pageContent ?? DefaultPageContent,
 											content: options?.content
 										}
 									}
@@ -1003,3 +1192,11 @@ export async function waitForEvent(control: EventProvider, eventName: string): P
 		});
 	});
 }
+
+/**
+ * Tell the binding parser to keep the binding strings for testing.
+ * @param enabled
+ */
+export function keepBindingStringForTest(enabled: boolean): void {
+	BindingParser._keepBindingStrings = enabled;
+}

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

@@ -293,6 +293,9 @@ sap.ui.define(
 									.clickKPITag(sTitle)
 									.description("Opening card for KPI '" + sTitle + "'")
 									.execute();
+							},
+							iCloseKPICard: function () {
+								return KPIBuilder.create(this).closeKPICard().description("Closing KPI card").execute();
 							}
 						},
 						/**
@@ -464,7 +467,7 @@ sap.ui.define(
 								return OpaBuilder.create(this)
 									.hasType("sap.f.DynamicPageTitle")
 									.has(function (oDynamicPageTitle) {
-										return oDynamicPageTitle.getSnappedContent()[0].getText() === sAppliedFilters;
+										return oDynamicPageTitle.getSnappedContent()[0].getContent().getText() === sAppliedFilters;
 									})
 									.description("The correct text on the collapsed filterbar is displayed")
 									.execute();

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

@@ -585,8 +585,8 @@ sap.ui.define(
 								return OpaBuilder.create(this)
 									.hasType("sap.m.MessageListItem")
 									.hasProperties({
-										title: oMessageInfo.MessageText,
-										groupAnnouncement: oMessageInfo.GroupLabel
+										title: oMessageInfo.MessageText
+										//groupAnnouncement: oMessageInfo.GroupLabel => with openui5/+/6328248 groups are no longer announced
 									})
 									.isDialogElement(true)
 									.description("MessageItem with correct text and group label")
@@ -746,7 +746,7 @@ sap.ui.define(
 							},
 							iSeeBetterLinkWithText: function (sText) {
 								return OpaBuilder.create(this)
-									.hasType("sap.fe.macros.controls.BetterLink")
+									.hasType("sap.fe.macros.controls.TextLink")
 									.hasProperties({ text: sText })
 									.description("Seeing Text with text '" + sText + "'")
 									.execute();