@sapui5/sap.fe.test 1.97.0 → 1.100.0

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

@@ -1,29 +1,28 @@
 import { PhantomUtil } from "sap/fe/macros";
-import { _MetadataRequestor } from "sap/ui/model/odata/v4/lib";
-import { ODataMetaModel } from "sap/ui/model/odata/v4";
-import { XMLPreprocessor } from "sap/ui/core/util";
-import { Log } from "sap/base";
+import _MetadataRequestor from "sap/ui/model/odata/v4/lib/_MetadataRequestor";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import XMLPreprocessor from "sap/ui/core/util/XMLPreprocessor";
+import Log from "sap/base/Log";
 import xpath from "xpath";
 import * as fs from "fs";
 import { compileSources, to } from "@sap/cds-compiler";
 import { format } from "prettier";
-import { BindingParser } from "sap/ui/base";
+import BindingParser from "sap/ui/base/BindingParser";
 import { AnyAnnotation, ConverterOutput, EntitySet, Property } from "@sap-ux/annotation-converter";
 import { DataModelObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
-import { JSONModel } from "sap/ui/model/json";
-import { InvisibleText } from "sap/ui/core";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import InvisibleText from "sap/ui/core/InvisibleText";
 import { ListReportManifestSettings, ObjectPageManifestSettings } from "sap/fe/core/converters/ManifestSettings";
 import { IssueCategory, IssueSeverity } from "sap/fe/core/converters/helpers/IssueManager";
 import { IDiagnostics } from "sap/fe/core/converters/TemplateConverter";
-import { merge } from "sap/base/util";
+import merge from "sap/base/util/merge";
 import * as path from "path";
 import ConverterContext from "sap/fe/core/converters/ConverterContext";
 import SideEffectsFactory from "sap/fe/core/services/SideEffectsServiceFactory";
+import TemplateModel from "sap/fe/core/TemplateModel";
+import Context from "sap/ui/model/Context";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const formatXml = require("xml-formatter");
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore
-import * as TemplateModel from "sap/fe/core/TemplateModel";
 
 Log.setLevel(1 as any, "sap.ui.core.util.XMLPreprocessor");
 jest.setTimeout(40000);
@@ -38,8 +37,11 @@ const nameSpaceMap = {
 	"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"
@@ -105,8 +107,7 @@ export const serializeXML = function(xmlDom: Node) {
  */
 export const compileCDS = function(sCDSUrl: string) {
 	const cdsString = fs.readFileSync(sCDSUrl, "utf-8");
-	const csn = compileSources({ "string.cds": cdsString }, {});
-	const edmxContent = to.edmx(csn, { service: "sap.fe.test.JestService" });
+	const edmxContent = cds2edmx(cdsString, "sap.fe.test.JestService");
 	const dir = path.resolve(sCDSUrl, "..", "gen");
 	const edmxUrl = path.resolve(dir, path.basename(sCDSUrl).replace(".cds", ".xml"));
 
@@ -118,6 +119,22 @@ export const compileCDS = function(sCDSUrl: string) {
 	return edmxUrl;
 };
 
+/**
+ * Compile CDS to EDMX.
+ *
+ * @param cds The CDS model. It must define at least one service.
+ * @param service The fully-qualified name of the service to compile. Defaults to "sap.fe.test.JestService".
+ * @returns The compiled service model as EDMX.
+ */
+export function cds2edmx(cds: string, service: string = "sap.fe.test.JestService") {
+	const csn = compileSources({ "string.cds": cds }, {});
+	const edmx = to.edmx(csn, { service: service, odataForeignKeys: true, odataFormat: "structured", odataContainment: false });
+	if (!edmx) {
+		throw new Error(`Compilation failed. Hint: Make sure that the CDS model defines service ${service}.`);
+	}
+	return edmx;
+}
+
 export const getFakeSideEffectsService = async function(oMetaModel: ODataMetaModel): Promise<any> {
 	const oServiceContext = { scopeObject: {}, scopeType: "", settings: {} };
 	return new SideEffectsFactory().createInstance(oServiceContext).then(function(oServiceInstance: any) {
@@ -165,14 +182,14 @@ export const getConverterContextForTest = function(
 	manifestSettings: ListReportManifestSettings | ObjectPageManifestSettings
 ) {
 	const entitySet = convertedTypes.entitySets.find(es => es.name === manifestSettings.entitySet);
-	const dataModelPath = getDataModelObjectPathForProperty(entitySet as EntitySet, entitySet);
+	const dataModelPath = getDataModelObjectPathForProperty(entitySet as EntitySet, convertedTypes, entitySet);
 	return new ConverterContext(convertedTypes, manifestSettings, getFakeDiagnostics(), merge, dataModelPath);
 };
 const metaModelCache: any = {};
 export const getMetaModel = async function(sMetadataUrl: string) {
 	const oRequestor = _MetadataRequestor.create({}, "4.0", {});
 	if (!metaModelCache[sMetadataUrl]) {
-		const oMetaModel = new ODataMetaModel(oRequestor, sMetadataUrl, undefined, null);
+		const oMetaModel = new (ODataMetaModel as any)(oRequestor, sMetadataUrl, undefined, null);
 		await oMetaModel.fetchEntityContainer();
 		metaModelCache[sMetadataUrl] = oMetaModel;
 	}
@@ -182,6 +199,7 @@ export const getMetaModel = async function(sMetadataUrl: string) {
 
 export const getDataModelObjectPathForProperty = function(
 	entitySet: EntitySet,
+	convertedTypes: ConverterOutput,
 	property?: Property | EntitySet | AnyAnnotation
 ): DataModelObjectPath {
 	const targetPath: DataModelObjectPath = {
@@ -189,7 +207,8 @@ export const getDataModelObjectPathForProperty = function(
 		navigationProperties: [],
 		targetObject: property,
 		targetEntitySet: entitySet,
-		targetEntityType: entitySet.entityType
+		targetEntityType: entitySet.entityType,
+		convertedTypes: convertedTypes
 	};
 	targetPath.contextLocation = targetPath;
 	return targetPath;
@@ -200,15 +219,41 @@ export const evaluateBinding = function(bindingString: string, ...args: any[]) {
 	return bindingElement.formatter.apply(undefined, args);
 };
 
-export const evaluateBindingWithModel = function(bindingString: string | undefined, modelContent: any) {
+type ModelContent = {
+	[name: string]: any;
+};
+
+/**
+ * Evaluate a binding against a model.
+ *
+ * @param bindingString The binding string.
+ * @param modelContent Content of the default model to use for evaluation.
+ * @param namedModelsContent Contents of additional, named models to use.
+ * @returns The evaluated binding.
+ */
+export function evaluateBindingWithModel(
+	bindingString: string | undefined,
+	modelContent: ModelContent,
+	namedModelsContent?: { [modelName: string]: ModelContent }
+): string {
 	const bindingElement = BindingParser.complexParser(bindingString);
-	const jsonModel = new JSONModel(modelContent);
 	const text = new InvisibleText();
 	text.bindProperty("text", bindingElement);
-	text.setModel(jsonModel);
-	text.setBindingContext(jsonModel.createBindingContext("/"));
+
+	const defaultModel = new JSONModel(modelContent);
+	text.setModel(defaultModel);
+	text.setBindingContext(defaultModel.createBindingContext("/") as Context);
+
+	if (namedModelsContent) {
+		for (const [name, content] of Object.entries(namedModelsContent)) {
+			const model = new JSONModel(content);
+			text.setModel(model, name);
+			text.setBindingContext(model.createBindingContext("/") as Context, name);
+		}
+	}
+
 	return text.getText();
-};
+}
 
 export const getTemplatingResult = async function(
 	xmlInput: string,
@@ -275,7 +320,7 @@ export const getTemplatedXML = async function(
  *
  * @param {string} name Fully qualified name of the fragment to be tested.
  * @param {object} testData Test data consisting
- * @returns Tempalted fragment as string
+ * @returns Templated fragment as string
  */
 export async function processFragment(name: string, testData: { [model: string]: object }): Promise<string> {
 	const inputXml = `<root><core:Fragment fragmentName="${name}" type="XML" xmlns:core="sap.ui.core" /></root>`;
@@ -284,14 +329,14 @@ export async function processFragment(name: string, testData: { [model: string]:
 
 	// build model and bindings for given test data
 	const settings = {
-		models: {} as { [name: string]: JSONModel<object> },
+		models: {} as { [name: string]: JSONModel },
 		bindingContexts: {} as { [name: string]: object }
 	};
 	for (const model in testData) {
-		const jsonModel = new JSONModel<object>();
+		const jsonModel = new JSONModel();
 		jsonModel.setData(testData[model]);
 		settings.models[model] = jsonModel;
-		settings.bindingContexts[model] = settings.models[model].createBindingContext("/");
+		settings.bindingContexts[model] = settings.models[model].createBindingContext("/") as Context;
 	}
 
 	// execute the pre-processor
@@ -305,7 +350,10 @@ export async function processFragment(name: string, testData: { [model: string]:
 		}
 	}
 
-	return formatXml(resultDoc.innerHTML, {
+	// 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"
 	});
 }

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

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 /* global QUnit */
 sap.ui.define(
@@ -70,7 +71,9 @@ sap.ui.define(
 			 * @param {object} [mSettings.launchParameters] The URL launch parameters
 			 * @param {boolean} [mSettings.async] If false (default), only one JourneyRunner is executed at a time
 			 * @param {Function[] | string[]} vJourneys The journeys to be executed. If a journey is represented as a string, it will be interpreted
-			 * as a module path to the file that should be loaded. Else it is expected to be a function
+			 * as a module path to the file that should be loaded. Else it is expected to be a function.
+			 * Alternatively, instead of being wrapped in an array, the journeys can also be given as separate parameters: 
+			 * <pre>.run(mSettings, Journey1, Journey2, ...)</pre>
 			 * @returns {object} A <code>Promise</code> that is resolved after all tests have been executed
 			 *
 			 * @function
@@ -86,8 +89,11 @@ sap.ui.define(
 					mSettings = Utils.mergeObjects(this._mInstanceSettings, mSettings);
 				}
 
-				var aJourneys = Utils.getParametersArray(iJourneyParameterIndex, arguments),
-					bAsync = mSettings.async,
+				var aJourneys = Array.prototype.slice.call(arguments, iJourneyParameterIndex); // journey-related parameter(s) as array
+				if (aJourneys && aJourneys.length && Array.isArray(aJourneys[0])) { // if the first journey parameter is an array...
+					aJourneys = aJourneys[0]; // ...then unwrap it, to use this array itself
+				}
+				var bAsync = mSettings.async,
 					pSyncPromise;
 
 				if (bAsync) {

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

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	[
@@ -17,7 +18,8 @@ sap.ui.define(
 		"sap/fe/test/api/FooterAssertionsBase",
 		"sap/fe/test/api/HeaderActionsLR",
 		"sap/fe/test/api/HeaderAssertionsLR",
-		"sap/fe/test/api/KPICardAssertions"
+		"sap/fe/test/api/KPICardAssertions",
+		"sap/fe/test/api/KPICardActions"
 	],
 	function(
 		Utils,
@@ -33,7 +35,8 @@ sap.ui.define(
 		FooterAssertionsBase,
 		HeaderActionsLR,
 		HeaderAssertionsLR,
-		KPICardAssertions
+		KPICardAssertions,
+		KPICardActions
 	) {
 		"use strict";
 
@@ -131,6 +134,9 @@ sap.ui.define(
 									id: sChartId
 								});
 							},
+							onKPICard: function() {
+								return new KPICardActions(KPIBuilder.create(this));
+							},
 							/**
 							 * Returns a {@link sap.fe.test.api.FilterBarActions} instance.
 							 *
@@ -350,7 +356,7 @@ sap.ui.define(
 							},
 							iSeeFlpLink: function(sDescription) {
 								return OpaBuilder.create(this)
-									.hasType("sap.ui.mdc.link.PanelListItem")
+									.hasType("sap.m.Link")
 									.isDialogElement(true)
 									.hasProperties({ text: sDescription })
 									.description("FLP link with text '" + sDescription + "' is present")

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

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! 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,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	[
@@ -39,8 +40,10 @@ sap.ui.define(
 	) {
 		"use strict";
 
-		function getTableId(sNavProperty) {
-			return "fe::table::" + sNavProperty.split("/").join("::") + "::LineItem";
+		function getTableId(sNavProperty, sQualifier) {
+			return sQualifier
+				? "fe::table::" + sNavProperty.split("/").join("::") + "::LineItem::" + sQualifier
+				: "fe::table::" + sNavProperty.split("/").join("::") + "::LineItem";
 		}
 
 		function getChartId(sEntityType) {
@@ -182,7 +185,7 @@ sap.ui.define(
 							 */
 							onTable: function(vTableIdentifier) {
 								if (!Utils.isOfType(vTableIdentifier, String)) {
-									vTableIdentifier = { id: getTableId(vTableIdentifier.property) };
+									vTableIdentifier = { id: getTableId(vTableIdentifier.property, vTableIdentifier.qualifier) };
 								}
 								return this._onTable(vTableIdentifier);
 							},
@@ -297,13 +300,15 @@ sap.ui.define(
 									.execute();
 							},
 							iEnableLink: function(sText) {
-								return OpaBuilder.create(this)
-									.hasType("sap.m.ColumnListItem")
-									.hasAggregationProperties("cells", { text: sText })
-									.isDialogElement()
-									.doPress("selectMulti")
-									.description("The CheckBox for link " + sText + " is selected")
-									.execute();
+								return (
+									OpaBuilder.create(this)
+										.hasType("sap.m.ColumnListItem")
+										//.hasAggregationProperties("cells", { text: sText })
+										.isDialogElement()
+										.doPress("selectMulti")
+										.description("The CheckBox for link " + sText + " is selected")
+										.execute()
+								);
 							},
 							iPressKeyboardShortcutOnSection: function(sShortcut, mProperties) {
 								return this._iPressKeyboardShortcut(undefined, sShortcut, mProperties, "sap.uxap.ObjectPageSection");
@@ -463,7 +468,7 @@ sap.ui.define(
 							 */
 							onTable: function(vTableIdentifier) {
 								if (!Utils.isOfType(vTableIdentifier, String)) {
-									vTableIdentifier = { id: getTableId(vTableIdentifier.property) };
+									vTableIdentifier = { id: getTableId(vTableIdentifier.property, vTableIdentifier.qualifier) };
 								}
 								return this._onTable(vTableIdentifier);
 							},
@@ -641,7 +646,7 @@ sap.ui.define(
 							},
 							iSeeFlpLink: function(sDescription) {
 								return OpaBuilder.create(this)
-									.hasType("sap.ui.mdc.link.PanelListItem")
+									.hasType("sap.m.Link")
 									.isDialogElement(true)
 									.hasProperties({ text: sDescription })
 									.description("FLP link with text '" + sDescription + "' is present")
@@ -814,12 +819,18 @@ sap.ui.define(
 									.hasType("sap.m.MessageView")
 									.check(function(oMessageView) {
 										var messages = oMessageView[0].getItems();
-										return (
+										var bMessageObjectHasExpectedValues =
 											messages[iMessagePosition].getGroupName() === oBoundMessageInfo.GroupLabel &&
 											messages[iMessagePosition].getTitle() === oBoundMessageInfo.MessageText &&
 											messages[iMessagePosition].getSubtitle() === oBoundMessageInfo.SubTitle &&
-											messages[iMessagePosition].getActiveTitle() === oBoundMessageInfo.ActiveTitle
-										);
+											messages[iMessagePosition].getActiveTitle() === oBoundMessageInfo.ActiveTitle;
+										if (oBoundMessageInfo.Description) {
+											return (
+												bMessageObjectHasExpectedValues &&
+												messages[iMessagePosition].getGroupName() === oBoundMessageInfo.GroupLabel
+											);
+										}
+										return bMessageObjectHasExpectedValues;
 									}, true)
 									.isDialogElement(true)
 									.description("MessageItem is correctly displayed")

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

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! 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/Stubs.js

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 /**
  * Actions and assertions to be used with a page hosted in an FCL

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

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

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

@@ -1,6 +1,7 @@
 /*
- * ! SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
  */
 sap.ui.define(
 	[
@@ -131,7 +132,7 @@ sap.ui.define(
 									if (sKey === "T_NEW_OBJECT") {
 										return "New Object";
 									} else {
-										return "(Unnamed Object)";
+										return "Unnamed Object";
 									}
 								});
 							}