@sapui5/sap.fe.test 1.101.1 → 1.102.2

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

@@ -0,0 +1,174 @@
+/*
+ * ! SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(
+	["./DialogAssertions", "sap/ui/test/OpaBuilder", "sap/fe/test/builder/FEBuilder", "sap/fe/test/Utils"],
+	function (DialogAssertions, OpaBuilder, FEBuilder, Utils) {
+		"use strict";
+
+		/**
+		 * Constructs a new DialogMassEditAssertions instance.
+		 *
+		 * @param {sap.fe.test.builder.DialogBuilder} oDialogBuilder The {@link sap.fe.test.builder.DialogBuilder} instance used to interact with the UI
+		 * @param {string} [vDialogDescription] Description (optional) of the dialog to be used for logging messages
+		 * @returns {sap.fe.test.api.DialogMassEditAssertions} The new instance
+		 * @extends sap.fe.test.api.DialogAssertions
+		 * @alias sap.fe.test.api.DialogMassEditAssertions
+		 * @class
+		 * @hideconstructor
+		 * @private
+		 */
+		var DialogMassEditAssertions = function (oDialogBuilder, vDialogDescription) {
+			return DialogAssertions.call(this, oDialogBuilder, vDialogDescription, 0);
+		};
+		DialogMassEditAssertions.prototype = Object.create(DialogAssertions.prototype);
+		DialogMassEditAssertions.prototype.constructor = DialogMassEditAssertions;
+		DialogMassEditAssertions.prototype.isAction = false;
+
+		/**
+		 * A mass edit field identifier
+		 *
+		 * @typedef {object} MassEditFieldIdentifier
+		 * @property {string} property The name of the property
+		 * @name sap.fe.test.api.MassEditFieldIdentifier
+		 * @private
+		 */
+
+		/**
+		 * A mass edit field value
+		 *
+		 * @typedef {object} MassEditValue
+		 * @property {string} dropDownText The dropdown text for the selection
+		 * @property {string} rawText The raw text for the selection
+		 * @name sap.fe.test.api.MassEditValue
+		 * @private
+		 */
+
+		/**
+		 * Check the value of the defined filter field.
+		 *
+		 * @param {string | sap.fe.test.api.MassEditFieldIdentifier} vMassEditFieldIdentifier The identifier for the mass edit field
+		 * @param {string | sap.fe.test.api.MassEditValue} vMassEditValue The new target value
+		 * @param {object} [mState] The state of the mass edit field
+		 * @param {object} [mProperties] The Properties of the mass edit field
+		 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+		 * @private
+		 */
+		DialogMassEditAssertions.prototype.iCheckField = function (vMassEditFieldIdentifier, vMassEditValue, mState, mProperties) {
+			var that = this,
+				sProperty = Utils.isOfType(vMassEditFieldIdentifier, String) ? vMassEditFieldIdentifier : vMassEditFieldIdentifier.property,
+				vValue =
+					vMassEditValue &&
+					(Utils.isOfType(vMassEditValue, String) ? vMassEditValue : vMassEditValue.rawText || vMassEditValue.dropDownText),
+				fieldRegEx = new RegExp("^MED(.*)" + sProperty + "$", "gi");
+			var sControlType;
+
+			var vTest = FEBuilder.create(this.getOpaInstance()).isDialogElement();
+			var vIdMatcher = FEBuilder.Matchers.id(fieldRegEx);
+			var vMatcher = [FEBuilder.Matchers.states(mState), vIdMatcher];
+			if (mState && mState.visible === false) {
+				// two possibilities for non-visible action: either visible property is false, or the control wasn't rendered at all
+				vMatcher = OpaBuilder.Matchers.some(vMatcher, OpaBuilder.Matchers.not(vIdMatcher));
+				vTest = vTest.has(vMatcher);
+			} else {
+				vTest = vTest
+					.has(vMatcher)
+					.hasProperties(mProperties)
+					.check(function (aSelect) {
+						sControlType = aSelect && aSelect[0] && aSelect[0].getMetadata().getName();
+						return (
+							aSelect.length === 1 &&
+							(sControlType === "sap.m.ComboBox" || sControlType === "sap.fe.core.controls.MassEditSelect")
+						);
+					})
+					.success(function (aSelect) {
+						var oSelect = aSelect[0],
+							oRet = OpaBuilder.create().hasId(oSelect.getId());
+
+						if (sControlType === "sap.m.ComboBox") {
+							oRet = oRet.hasProperties({ value: vValue });
+						} else if (sControlType === "sap.fe.core.controls.MassEditSelect") {
+							oRet = oRet.has(function (oSelectControl) {
+								return oSelectControl.getSelectedItem() ? oSelectControl.getSelectedItem().getText() === vValue : false;
+							});
+						}
+
+						return oRet
+							.description(
+								Utils.formatMessage(
+									"Value selection '{3}' found for '{0}' in mass edit dialog '{1}'",
+									sProperty,
+									that.getIdentifier(),
+									vValue.toString()
+								)
+							)
+							.execute();
+					})
+					.description(
+						Utils.formatMessage("Mass edit dropdown for '{0}' found in dialog '{1}'", sProperty, that.getIdentifier())
+					);
+			}
+
+			return that.prepareResult(vTest.execute());
+		};
+
+		/**
+		 * Check the suggestions of the defined filter field.
+		 *
+		 * @param {string | sap.fe.test.api.MassEditFieldIdentifier} vMassEditFieldIdentifier The identifier for the mass edit field
+		 * @param {string | sap.fe.test.api.MassEditValue} vMassEditValue The new target value
+		 * @param {object} [mState] The state of the mass edit field
+		 * @param {object} [mProperties] The Properties of the mass edit field
+		 * @param {boolean} [bExists] Should the suggestion exist. Default is true
+		 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+		 * @private
+		 */
+		DialogMassEditAssertions.prototype.iCheckFieldSuggestions = function (
+			vMassEditFieldIdentifier,
+			vMassEditValue,
+			mState,
+			mProperties,
+			bExists
+		) {
+			var that = this,
+				sProperty = Utils.isOfType(vMassEditFieldIdentifier, String) ? vMassEditFieldIdentifier : vMassEditFieldIdentifier.property,
+				vValue =
+					vMassEditValue &&
+					(Utils.isOfType(vMassEditValue, String) ? vMassEditValue : vMassEditValue.dropDownText || vMassEditValue.rawText),
+				fieldRegEx = new RegExp("^MED(.*)" + sProperty + "$", "gi");
+
+			return that.prepareResult(
+				FEBuilder.create(this.getOpaInstance())
+					.isDialogElement()
+					.hasId(fieldRegEx)
+					.hasState(mState)
+					.hasProperties(mProperties)
+					.check(function (aSelect) {
+						var oRet = false,
+							oSelect = aSelect && aSelect[0],
+							sControlType = aSelect && aSelect[0] && aSelect[0].getMetadata().getName();
+
+						if (
+							aSelect.length === 1 &&
+							(sControlType === "sap.m.ComboBox" || sControlType === "sap.fe.core.controls.MassEditSelect")
+						) {
+							var aItems = oSelect.getItems(),
+								iIndex = (aItems || []).findIndex(function (oItem) {
+									return oItem.getText() === vValue;
+								}),
+								bFound = iIndex != -1;
+
+							oRet = (bExists !== false) === bFound;
+						}
+						return oRet;
+					})
+					.description(Utils.formatMessage("Mass edit dropdown for '{0}' found in dialog '{1}'", sProperty, that.getIdentifier()))
+					.execute()
+			);
+		};
+
+		return DialogMassEditAssertions;
+	}
+);

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

@@ -5,7 +5,7 @@
  */
 sap.ui.define(
 	[],
-	function() {
+	function () {
 		"use strict";
 
 		/**
@@ -69,7 +69,16 @@ sap.ui.define(
 			 * @type {string}
 			 * @public
 			 */
-			Create: "Create"
+			Create: "Create",
+			/**
+			 * A dialog used for mass edit
+			 *
+			 * @name sap.fe.test.api.DialogType.MassEdit
+			 * @constant
+			 * @type {string}
+			 * @private
+			 */
+			MassEdit: "MassEdit"
 		};
 	},
 	true

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

@@ -12,7 +12,7 @@ sap.ui.define(
 		"sap/fe/test/builder/MacroFieldBuilder",
 		"./APIHelper"
 	],
-	function(HeaderAPI, Utils, OpaBuilder, FEBuilder, FieldBuilder, APIHelper) {
+	function (HeaderAPI, Utils, OpaBuilder, FEBuilder, FieldBuilder, APIHelper) {
 		"use strict";
 
 		/**
@@ -26,7 +26,7 @@ sap.ui.define(
 		 * @hideconstructor
 		 * @public
 		 */
-		var HeaderAssertions = function(oHeaderBuilder, vHeaderDescription) {
+		var HeaderAssertions = function (oHeaderBuilder, vHeaderDescription) {
 			this._sObjectPageLayoutId = vHeaderDescription.id;
 			this._sHeaderId = vHeaderDescription.headerId;
 			this._sHeaderContentId = vHeaderDescription.headerContentId;
@@ -48,7 +48,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckAction = function(vActionIdentifier, mState) {
+		HeaderAssertions.prototype.iCheckAction = function (vActionIdentifier, mState) {
 			var oOverflowToolbarBuilder = this.createOverflowToolbarBuilder(this._sObjectPageLayoutId);
 			return this.prepareResult(
 				oOverflowToolbarBuilder
@@ -66,7 +66,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckEdit = function(mState) {
+		HeaderAssertions.prototype.iCheckEdit = function (mState) {
 			return this.iCheckAction({ service: "StandardAction", action: "Edit", unbound: true }, mState);
 		};
 
@@ -78,7 +78,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckDelete = function(mState) {
+		HeaderAssertions.prototype.iCheckDelete = function (mState) {
 			return this.iCheckAction({ service: "StandardAction", action: "Delete", unbound: true }, mState);
 		};
 
@@ -90,7 +90,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckRelatedApps = function(mState) {
+		HeaderAssertions.prototype.iCheckRelatedApps = function (mState) {
 			return this.iCheckAction({ service: "fe", action: "RelatedApps", unbound: true }, mState);
 		};
 
@@ -102,7 +102,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckMenuAction = function(vAction) {
+		HeaderAssertions.prototype.iCheckMenuAction = function (vAction) {
 			return this.prepareResult(APIHelper.createMenuActionCheckBuilder(vAction).execute());
 		};
 
@@ -115,15 +115,15 @@ sap.ui.define(
 		 *
 		 * @ui5-restricted
 		 */
-		HeaderAssertions.prototype.iCheckNumberOfHeaderContentItems = function(iNumberOfItems, bIncludeHidden) {
+		HeaderAssertions.prototype.iCheckNumberOfHeaderContentItems = function (iNumberOfItems, bIncludeHidden) {
 			var oHeaderContentBuilder = this.getObjectPageDynamicHeaderContentBuilder(this._sHeaderContentId);
 
 			return this.prepareResult(
 				oHeaderContentBuilder
-					.has(function(oOPHeaderContent) {
+					.has(function (oOPHeaderContent) {
 						var aItems = oOPHeaderContent.getContent()[0].getItems();
 						if (!bIncludeHidden) {
-							aItems = aItems.filter(function(oControl) {
+							aItems = aItems.filter(function (oControl) {
 								return oControl.getVisible();
 							});
 						}
@@ -151,7 +151,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckFieldInFieldGroup = function(vFieldIdentifier, vValue, mState) {
+		HeaderAssertions.prototype.iCheckFieldInFieldGroup = function (vFieldIdentifier, vValue, mState) {
 			var aArguments = Utils.parseArguments([Object, [Array, String], Object], arguments),
 				sFieldId =
 					(vFieldIdentifier.targetAnnotation
@@ -184,7 +184,7 @@ sap.ui.define(
 		 *
 		 * @ui5-restricted
 		 */
-		HeaderAssertions.prototype.iCheckDataPoint = function(sTitle, sValue) {
+		HeaderAssertions.prototype.iCheckDataPoint = function (sTitle, sValue) {
 			var oHeaderContentBuilder = this.getObjectPageDynamicHeaderContentBuilder(this._sHeaderContentId);
 
 			return this.prepareResult(
@@ -194,7 +194,7 @@ sap.ui.define(
 							OpaBuilder.create(this)
 								.hasType("sap.m.ObjectNumber")
 								.hasProperties({ number: sValue })
-								.has(function(oObjectNumber) {
+								.has(function (oObjectNumber) {
 									return oObjectNumber.getParent();
 								})
 								.hasAggregationProperties("items", { text: sTitle })
@@ -216,24 +216,18 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckTitle = function(sTitle, sDescription) {
+		HeaderAssertions.prototype.iCheckTitle = function (sTitle, sDescription) {
 			var oHeaderTitleBuilder = this.getObjectPageDynamicHeaderTitleBuilder(this._sObjectPageLayoutId);
 			return this.prepareResult(
 				oHeaderTitleBuilder
 					.hasConditional(
 						sTitle !== undefined,
-						OpaBuilder.Matchers.childrenMatcher(
-							OpaBuilder.create(this)
-								.hasType("sap.m.Title")
-								.hasProperties({ text: sTitle })
-						)
+						OpaBuilder.Matchers.childrenMatcher(OpaBuilder.create(this).hasType("sap.m.Title").hasProperties({ text: sTitle }))
 					)
 					.hasConditional(
 						sDescription !== undefined,
 						OpaBuilder.Matchers.childrenMatcher(
-							OpaBuilder.create(this)
-								.hasType("sap.m.Label")
-								.hasProperties({ text: sDescription })
+							OpaBuilder.create(this).hasType("sap.m.Label").hasProperties({ text: sDescription })
 						)
 					)
 					.description(
@@ -253,7 +247,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckPaginatorDown = function(mState) {
+		HeaderAssertions.prototype.iCheckPaginatorDown = function (mState) {
 			return this.prepareResult(
 				this.createPaginatorBuilder(
 					OpaBuilder.Matchers.properties({ icon: "sap-icon://navigation-down-arrow" }),
@@ -273,7 +267,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckPaginatorUp = function(mState) {
+		HeaderAssertions.prototype.iCheckPaginatorUp = function (mState) {
 			return this.prepareResult(
 				this.createPaginatorBuilder(
 					OpaBuilder.Matchers.properties({ icon: "sap-icon://navigation-up-arrow" }),
@@ -294,7 +288,7 @@ sap.ui.define(
 		 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
 		 * @ui5-restricted
 		 */
-		HeaderAssertions.prototype.iCheckMicroChart = function(vMicroChartIdentifier, sUoMLabel) {
+		HeaderAssertions.prototype.iCheckMicroChart = function (vMicroChartIdentifier, sUoMLabel) {
 			var oOpaBuilder = OpaBuilder.create(this.getOpaInstance());
 
 			if (!Utils.isOfType(vMicroChartIdentifier, String)) {
@@ -349,7 +343,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckHeaderFacet = function(vFacetIdentifier, mState) {
+		HeaderAssertions.prototype.iCheckHeaderFacet = function (vFacetIdentifier, mState) {
 			var aArguments = Utils.parseArguments([[Object, String], Object], arguments),
 				oHeaderContentBuilder = this.getObjectPageDynamicHeaderContentBuilder(this._sHeaderContentId),
 				sId = new RegExp("fe::HeaderFacetContainer::" + vFacetIdentifier.facetId + "$");
@@ -362,13 +356,7 @@ sap.ui.define(
 
 			return this.prepareResult(
 				oHeaderContentBuilder
-					.has(
-						OpaBuilder.Matchers.childrenMatcher(
-							FEBuilder.create(this.getOpaInstance())
-								.hasId(sId)
-								.hasState(mState)
-						)
-					)
+					.has(OpaBuilder.Matchers.childrenMatcher(FEBuilder.create(this.getOpaInstance()).hasId(sId).hasState(mState)))
 					.description(Utils.formatMessage("Checking Header Facet '{0}' with state='{1}'", aArguments[0], aArguments[1]))
 					.execute()
 			);
@@ -390,7 +378,7 @@ sap.ui.define(
 		 *
 		 * @ui5-restricted
 		 */
-		HeaderAssertions.prototype.iCheckBreadCrumb = function(sLink) {
+		HeaderAssertions.prototype.iCheckBreadCrumb = function (sLink) {
 			var oFEBuilder = FEBuilder.create(this.getOpaInstance()).hasId(this._sBreadCrumbId);
 
 			if (sLink !== undefined && sLink.length > 0) {
@@ -416,7 +404,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckSaveAsTile = function(mState) {
+		HeaderAssertions.prototype.iCheckSaveAsTile = function (mState) {
 			var oOverflowToolbarBuilder = this.createOverflowToolbarBuilder(this._sObjectPageLayoutId),
 				sShareId = "fe::Share";
 
@@ -442,7 +430,7 @@ sap.ui.define(
 		 *
 		 * @public
 		 */
-		HeaderAssertions.prototype.iCheckSendEmail = function(mState) {
+		HeaderAssertions.prototype.iCheckSendEmail = function (mState) {
 			var oOverflowToolbarBuilder = this.createOverflowToolbarBuilder(this._sObjectPageLayoutId),
 				sShareId = "fe::Share";
 
@@ -471,7 +459,7 @@ sap.ui.define(
 		 *
 		 * @private
 		 */
-		HeaderAssertions.prototype.iCheckLink = function(vLinkIdentifier, mState) {
+		HeaderAssertions.prototype.iCheckLink = function (vLinkIdentifier, mState) {
 			// TODO this function needs to aligned with onForm().iCheckLink - for now vLinkIdentifier must be the link text!
 			var aArguments = Utils.parseArguments([String, Object], arguments),
 				oHeaderContentBuilder = this.getObjectPageDynamicHeaderContentBuilder(this._sHeaderContentId);
@@ -479,10 +467,7 @@ sap.ui.define(
 				oHeaderContentBuilder
 					.has(
 						OpaBuilder.Matchers.childrenMatcher(
-							FEBuilder.create()
-								.hasType("sap.m.Link")
-								.hasProperties({ text: vLinkIdentifier })
-								.hasState(aArguments[1])
+							FEBuilder.create().hasType("sap.m.Link").hasProperties({ text: vLinkIdentifier }).hasState(aArguments[1])
 						)
 					)
 					.description(Utils.formatMessage("Checking link '{0}' with state='{1}'", aArguments[0], aArguments[1]))
@@ -490,6 +475,56 @@ sap.ui.define(
 			);
 		};
 
+		/**
+		 * Checks the number of users collaborating in the draft.
+		 *
+		 * @param {number} iExpectedNumber The expected number of users
+		 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+		 *
+		 * @ui5-restricted
+		 */
+		HeaderAssertions.prototype.iCheckNumberOfCollaboratingUsers = function (iExpectedNumber) {
+			var objectPageBuilder = FEBuilder.create(this.getOpaInstance()).hasId(this._sObjectPageLayoutId);
+
+			return this.prepareResult(
+				objectPageBuilder
+					.hasChildren(
+						FEBuilder.create(this)
+							.hasType("sap.uxap.ObjectPageDynamicHeaderTitle")
+							.hasChildren(
+								FEBuilder.create(this)
+									.hasType("sap.m.Avatar")
+									.checkNumberOfMatches(iExpectedNumber + 1) // +1 because of avatar to add a user
+							)
+					)
+					.description(Utils.formatMessage("Checking number of collaborating user: {0}", iExpectedNumber))
+					.execute()
+			);
+		};
+
+		/**
+		 * Checks if a collaborating user is present.
+		 *
+		 * @param {string} sInitials The initials of the user (displayed in the avatar)
+		 * @returns {object} The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+		 *
+		 * @ui5-restricted
+		 */
+		HeaderAssertions.prototype.iCheckCollaboratingUser = function (sInitials) {
+			var objectPageBuilder = FEBuilder.create(this.getOpaInstance()).hasId(this._sObjectPageLayoutId);
+
+			return this.prepareResult(
+				objectPageBuilder
+					.hasChildren(
+						FEBuilder.create(this)
+							.hasType("sap.uxap.ObjectPageDynamicHeaderTitle")
+							.hasChildren(FEBuilder.create(this).hasType("sap.m.Avatar").hasProperties({ initials: sInitials }))
+					)
+					.description(Utils.formatMessage("Checking collaborating user with initials '{0}'", sInitials))
+					.execute()
+			);
+		};
+
 		return HeaderAssertions;
 	}
 );