@sapui5/sap.fe.test 1.108.2 → 1.110.0

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

@@ -1,10 +1,14 @@
 import type { AnyAnnotation, ConvertedMetadata, EntitySet, Property } from "@sap-ux/vocabularies-types";
 import compiler from "@sap/cds-compiler";
 import * as fs from "fs";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+import * as plugin from "@prettier/plugin-xml";
 import * as path from "path";
-import type { RequiredOptions } from "prettier";
+import type { Options } 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";
@@ -17,6 +21,7 @@ import TemplateModel from "sap/fe/core/TemplateModel";
 import type { DataModelObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
 import BindingParser from "sap/ui/base/BindingParser";
 import ManagedObject from "sap/ui/base/ManagedObject";
+import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
 import Component from "sap/ui/core/Component";
 import Control from "sap/ui/core/Control";
 import InvisibleText from "sap/ui/core/InvisibleText";
@@ -32,6 +37,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");
 
@@ -39,28 +60,91 @@ Log.setLevel(1 as any, "sap.ui.core.util.XMLPreprocessor");
 jest.setTimeout(40000);
 
 const nameSpaceMap = {
-	"macros": "sap.fe.macros",
-	"macro": "sap.fe.macros",
-	"macroField": "sap.fe.macros.field",
-	"macrodata": "http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1",
-	"log": "http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1",
-	"unittest": "http://schemas.sap.com/sapui5/preprocessorextension/sap.fe.unittesting/1",
-	"control": "sap.fe.core.controls",
-	"core": "sap.ui.core",
-	"m": "sap.m",
-	"f": "sap.ui.layout.form",
-	"internalMacro": "sap.fe.macros.internal",
-	"mdc": "sap.ui.mdc",
-	"mdcat": "sap.ui.mdc.actiontoolbar",
-	"mdcField": "sap.ui.mdc.field",
-	"mdcTable": "sap.ui.mdc.table",
-	"u": "sap.ui.unified",
-	"macroMicroChart": "sap.fe.macros.microchart",
-	"microChart": "sap.suite.ui.microchart",
-	"macroTable": "sap.fe.macros.table"
+	macros: "sap.fe.macros",
+	macro: "sap.fe.macros",
+	macroField: "sap.fe.macros.field",
+	macrodata: "http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1",
+	log: "http://schemas.sap.com/sapui5/extension/sap.ui.core.CustomData/1",
+	unittest: "http://schemas.sap.com/sapui5/preprocessorextension/sap.fe.unittesting/1",
+	control: "sap.fe.core.controls",
+	core: "sap.ui.core",
+	dt: "sap.ui.dt",
+	m: "sap.m",
+	f: "sap.ui.layout.form",
+	fl: "sap.ui.fl",
+	internalMacro: "sap.fe.macros.internal",
+	mdc: "sap.ui.mdc",
+	mdcat: "sap.ui.mdc.actiontoolbar",
+	mdcField: "sap.ui.mdc.field",
+	mdcTable: "sap.ui.mdc.table",
+	u: "sap.ui.unified",
+	macroMicroChart: "sap.fe.macros.microchart",
+	microChart: "sap.suite.ui.microchart",
+	macroTable: "sap.fe.macros.table"
 };
 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 +160,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 +170,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 +191,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);
 };
 
@@ -118,10 +202,11 @@ export const serializeXML = function (xmlDom: Node) {
 };
 
 export const formatXML = function (xmlString: string) {
-	return format(
-		xmlString,
-		{ parser: "xml", xmlWhitespaceSensitivity: "ignore" } as Partial<RequiredOptions> /* options by the Prettier XML plugin */
-	);
+	return format(xmlString, {
+		parser: "xml",
+		xmlWhitespaceSensitivity: "ignore",
+		plugins: [plugin]
+	} as Options & { xmlWhitespaceSensitivity: "ignore" | "strict" });
 };
 
 /**
@@ -305,13 +390,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 (flexChanges: { [x: string]: object[] }, oMetaModel: MetaModel, resultXML: any) {
+	// prefix Ids
+	[...resultXML.querySelectorAll("[id]")].forEach((node) => {
+		node.id = `${TESTVIEWID}--${node.id}`;
+	});
+	const changes = createFlexibilityChangesObject(TESTVIEWID, flexChanges);
 	const appId = "someComponent";
 	const oManifest = {
 		"sap.app": {
@@ -332,7 +416,8 @@ export const applyFlexChanges = async function (
 			getEntry: function (name: string) {
 				return (oManifest as any)[name];
 			}
-		})
+		}),
+		getLocalId: jest.fn((sId) => sId)
 	} as unknown as AppComponent;
 	//fake changes
 	jest.spyOn(AppStorage, "loadFlexData").mockReturnValue(Promise.resolve(changes));
@@ -342,6 +427,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(flexChanges?.changes?.length ?? 0 + flexChanges?.variantDependentControlChanges?.length ?? 0);
 	return resultXML;
 };
 
@@ -355,8 +444,7 @@ export const getTemplatingResult = async function (
 	sMetadataUrl: string,
 	mBindingContexts: { [x: string]: any; entitySet?: string },
 	mModels: { [x: string]: any },
-	aVariantDependentControlChanges?: any[],
-	createChangesObject?: Function
+	flexChanges?: { [x: string]: object[] }
 ) {
 	const templatedXml = `<root>${xmlInput}</root>`;
 	const parser = new window.DOMParser();
@@ -365,52 +453,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 (flexChanges) {
 		// 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(flexChanges, oMetaModel, resultXML);
 	}
 	return resultXML;
 };
@@ -418,22 +472,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
+	flexChanges?: { [x: string]: object[] }
 ) {
-	const templatedXML = await getTemplatingResult(
-		xmlInput,
-		sMetadataUrl,
-		mBindingContexts,
-		mModels,
-		aVariantDependentControlChanges,
-		createChangesObject
-	);
+	const templatedXML = await getTemplatingResult(xmlInput, sMetadataUrl, mBindingContexts, mModels, flexChanges);
 	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 flexChanges Object with UI changes like 'changes' or 'variantDependentControlChanges'
+ * @returns Templated view as string
+ */
+export async function processView(
+	name: string,
+	sMetadataUrl: string,
+	mBindingContexts: { [x: string]: string },
+	mModels: { [x: string]: any },
+	flexChanges?: { [x: string]: object[] }
+): 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 (flexChanges) {
+		oPreprocessedView = await applyFlexChanges(flexChanges ?? [], oMetaModel, oPreprocessedView);
+	}
+	return {
+		asElement: oPreprocessedView,
+		asString: _removeCommentFromXml(oPreprocessedView?.outerHTML || "")
+	};
+}
+
 /**
  * Process the requested XML fragment with the provided data.
  *
@@ -462,7 +538,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 +548,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[]) {
@@ -504,7 +578,8 @@ export function serializeControl(controlToSerialize: Control | Control[]) {
 			return "})";
 		},
 		middle: function (control: any) {
-			let data = `{id: ${control.getId()}`;
+			const id = control.getId();
+			let data = `{id: ${ManagedObjectMetadata.isGeneratedId(id) ? "__dynamicId" : id}`;
 			for (const oControlKey in control.mProperties) {
 				if (control.mProperties.hasOwnProperty(oControlKey)) {
 					data += `,\n${getTab()} ${oControlKey}: ${control.mProperties[oControlKey]}`;
@@ -520,6 +595,11 @@ export function serializeControl(controlToSerialize: Control | Control[]) {
 					data += `,\n${getTab()} ${oControlKey}: ${control.mAssociations[oControlKey][0]}`;
 				}
 			}
+			for (const oControlKey in control.mEventRegistry) {
+				if (control.mEventRegistry.hasOwnProperty(oControlKey)) {
+					data += `,\n${getTab()} ${oControlKey}: true}`;
+				}
+			}
 			data += ``;
 			return data;
 		},

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

@@ -1,7 +1,8 @@
 /*
- * ! SAP UI development toolkit for HTML5 (SAPUI5)
+ * ! 
+		SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+	
  */
 /* global QUnit */
 sap.ui.define(

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

@@ -1,7 +1,8 @@
 /*
- * ! SAP UI development toolkit for HTML5 (SAPUI5)
+ * ! 
+		SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+	
  */
 sap.ui.define(
 	[

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

@@ -1,7 +1,8 @@
 /*
- * ! SAP UI development toolkit for HTML5 (SAPUI5)
+ * ! 
+		SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+	
  */
 sap.ui.define(["sap/ui/test/OpaBuilder", "sap/ui/test/Opa5", "sap/fe/test/Utils"], function (OpaBuilder, Opa5, Utils) {
 	"use strict";

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

@@ -1,7 +1,8 @@
 /*
- * ! SAP UI development toolkit for HTML5 (SAPUI5)
+ * ! 
+		SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+	
  */
 sap.ui.define(
 	[
@@ -114,6 +115,36 @@ sap.ui.define(
 				.description(Utils.formatMessage("Executing action '{0}' from currently open action menu", vMenuAction));
 		}
 
+		function _getObjectPageSectionSubSectionBuilder(vOpaInstance, SectionSubSectionIdentifier, SectionSubSectionIdPrefix, ControlType) {
+			var SectionSubSectionBuilder = FEBuilder.create(vOpaInstance).hasType(ControlType);
+			if (Utils.isOfType(SectionSubSectionIdentifier, String)) {
+				SectionSubSectionBuilder.hasProperties({ title: SectionSubSectionIdentifier });
+			} else if (SectionSubSectionIdentifier.section) {
+				SectionSubSectionBuilder.hasId(SectionSubSectionIdPrefix + "::" + SectionSubSectionIdentifier.section);
+			} else {
+				throw new Error(
+					"section or sub-section parameters not supported for creating a control id: " + SectionSubSectionIdentifier
+				);
+			}
+			return SectionSubSectionBuilder;
+		}
+		function _getObjectPageSectionBuilder(vOpaInstance, ObjectPageSectionIdentifier, OPSectionIdPrefix) {
+			return _getObjectPageSectionSubSectionBuilder(
+				vOpaInstance,
+				ObjectPageSectionIdentifier,
+				OPSectionIdPrefix,
+				"sap.uxap.ObjectPageSection"
+			);
+		}
+		function _getObjectPageSubSectionBuilder(vOpaInstance, ObjectPageSubSectionIdentifier, OPSubSectionIdPrefix) {
+			return _getObjectPageSectionSubSectionBuilder(
+				vOpaInstance,
+				ObjectPageSubSectionIdentifier,
+				OPSubSectionIdPrefix,
+				"sap.uxap.ObjectPageSubSection"
+			);
+		}
+
 		/**
 		 * Constructs a new ObjectPage instance.
 		 *
@@ -204,7 +235,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 +291,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);
@@ -442,14 +470,14 @@ sap.ui.define(
 							iClickOnMessageButton: function () {
 								return OpaBuilder.create(this)
 
-									.hasType("sap.fe.common.MessageButton")
+									.hasType("sap.fe.macros.messages.MessageButton")
 									.doPress()
 									.description("Clicked on Message Button")
 									.execute();
 							},
 							iCheckMessageButtonTooltip: function (sText) {
 								return OpaBuilder.create(this)
-									.hasType("sap.fe.common.MessageButton")
+									.hasType("sap.fe.macros.messages.MessageButton")
 									.check(function (oControl) {
 										return oControl[0].getTooltip() === sText;
 									}, true)
@@ -528,7 +556,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 +610,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);
@@ -591,17 +621,17 @@ sap.ui.define(
 							iSeeMessageButton: function (messageType, messageButtonText) {
 								var message = {
 									Error: {
-										"type": "Negative"
+										type: "Negative"
 									},
 									Warning: {
-										"type": "Critical"
+										type: "Critical"
 									},
 									Information: {
-										"type": "Neutral"
+										type: "Neutral"
 									}
 								};
 								return OpaBuilder.create(this)
-									.hasType("sap.fe.common.MessageButton")
+									.hasType("sap.fe.macros.messages.MessageButton")
 									.hasProperties({
 										text: messageButtonText,
 										type: message[messageType]["type"]
@@ -685,20 +715,93 @@ sap.ui.define(
 									.description("Object Page is in mode '" + sMode + "'")
 									.execute();
 							},
+							/**
+							 * Checks a section.
+							 * It is checked if a section is already loaded and therefore the data is visible to the user. This function does not check properties of the anchor bar buttons for section selection.
+							 *
+							 * @param {string | sap.fe.test.api.SectionIdentifier} SectionIdentifier The identifier of the section.
+							 * This can either be a string containing the label of the section or an object having the pattern
+							 * <code><pre>
+							 * 	{
+							 *  	section: <section id>
+							 * 	}
+							 * </pre></code>
+							 * @param {object} mState Defines the expected state of the section, e.g. its visibility
+							 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+							 * @public
+							 */
+							iCheckSection: function (SectionIdentifier, mState) {
+								var SectionBuilder = _getObjectPageSectionBuilder(this, SectionIdentifier, OPSectionIdPrefix);
+								return SectionBuilder.hasState(mState)
+									.description(
+										Utils.formatMessage("Checking section '{0}' having state='{1}'", SectionIdentifier, mState)
+									)
+									.execute();
+							},
+							/**
+							 * TODO This function is only here for legacy reasons and therefore private. Use iCheckSection instead.
+							 *
+							 * @param {string} sTitle The name of the section
+							 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+							 * @private
+							 */
 							iSeeSectionWithTitle: function (sTitle) {
-								return OpaBuilder.create(this)
-									.hasType("sap.uxap.ObjectPageSection")
-									.hasProperties({ title: sTitle })
-									.description("Seeing section with title '" + sTitle + "'")
+								return this.iCheckSection(sTitle, { visible: true });
+							},
+
+							/**
+							 * Checks the expected number of sections in an object page.
+							 *
+							 * @param {number} ExpectedNumberOfSections The number of expected sections within the object page.
+							 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+							 * @public
+							 */
+							iCheckNumberOfSections: function (ExpectedNumberOfSections) {
+								return FEBuilder.create(this)
+									.hasId(AnchorBarId)
+									.hasAggregationLength("content", ExpectedNumberOfSections)
+									.description(
+										Utils.formatMessage(
+											"Object Page contains the expected number of {0} sections",
+											ExpectedNumberOfSections
+										)
+									)
 									.execute();
 							},
-							iSeeSubSectionWithTitle: function (sTitle) {
-								return OpaBuilder.create(this)
-									.hasType("sap.uxap.ObjectPageSubSection")
-									.hasProperties({ title: sTitle })
-									.description("Seeing sub-section with title '" + sTitle + "'")
+
+							/**
+							 * Checks a sub-section.
+							 *
+							 * @param {string | sap.fe.test.api.SectionIdentifier} SubSectionIdentifier The identifier of the sub-section to be checked for visibility.
+							 * This can either be a string containing the label of the sub-section or an object having the pattern
+							 * <code><pre>
+							 * 	{
+							 *  	section: <sub-section id>
+							 * 	}
+							 * </pre></code>
+							 * @param {object} mState Defines the expected state of the sub-section, e.g. its visibility
+							 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+							 * @public
+							 */
+							iCheckSubSection: function (SubSectionIdentifier, mState) {
+								var SubSectionBuilder = _getObjectPageSubSectionBuilder(this, SubSectionIdentifier, OPSubSectionIdPrefix);
+								return SubSectionBuilder.hasState(mState)
+									.description(
+										Utils.formatMessage("Checking sub-section '{0}' having state='{1}'", SubSectionIdentifier, mState)
+									)
 									.execute();
 							},
+							/**
+							 * TODO This function is only here for legacy reasons and therefore private. Use iCheckSubSection instead.
+							 *
+							 * @param {string} sTitle The name of the sub-section
+							 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+							 * @private
+							 */
+							iSeeSubSectionWithTitle: function (sTitle) {
+								return this.iCheckSubSection(sTitle, { visible: true });
+							},
+
 							iSeeSectionButtonWithTitle: function (sTitle, mState) {
 								return FEBuilder.create(this)
 									.hasId(AnchorBarId)