@openui5/sap.ui.mdc 1.102.2 → 1.104.0

package/test/sap/ui/mdc/testutils/opa/filterbar/TestObjects.js

@@ -14,8 +14,11 @@ sap.ui.define([
 ) {
 	"use strict";
 
+	/**
+	 * @namespace onTheMDCFilterBar
+	 */
 	Opa5.createPageObjects({
-		onFilterBar: {
+		onTheMDCFilterBar: {
 			actions: {
 				/**
 				 * OPA5 test action
@@ -33,9 +36,11 @@ sap.ui.define([
 				 * 		Closes the personalization dialog.
 				 * 	</li>
 				 * </ol>
+				 * @memberof onTheMDCFilterBar
+				 * @method iPersonalizeFilter
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code> that is filtered
 				 * @param {Object} oSettings Map containing the settings for the filter personalization. Key is the label of the given group in the <code>FilterBar</code> personalization dialog, and value is an array containing the labels of the <code>FilterField</code>
-				 * @returns
+				 * @returns {Promise} OPA waitFor
 				 */
 				iPersonalizeFilter: function(oFilterBar, oSettings) {
 					return p13nActions.iPersonalizeFilterBar.call(this, oFilterBar, oSettings, filterBarActions.iOpenThePersonalizationDialog);
@@ -56,8 +61,10 @@ sap.ui.define([
 				 * 		Closes the personalization dialog.
 				 * 	</li>
 				 * </ol>
+				 * @memberof onTheMDCFilterBar
+				 * @method iResetThePersonalization
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code>
-				 * @returns
+				 * @returns {Promise} OPA waitFor
 				 */
 				iResetThePersonalization: function(oFilterBar) {
 					return p13nActions.iResetThePersonalization.call(this, oFilterBar, filterBarActions.iOpenThePersonalizationDialog);
@@ -65,8 +72,10 @@ sap.ui.define([
 				/**
 				 * OPA5 test action
 				 * Presses the apply filters button of the <code>FilterBar</code>.
+				 * @memberof onTheMDCFilterBar
+				 * @method iExpectSearch
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code>
-				 * @returns
+				 * @returns {Promise} OPA waitFor
 				 */
 				iExpectSearch: function(oFilterBar) {
 					return filterBarActions.iExpectSearch.call(this, oFilterBar);
@@ -87,9 +96,11 @@ sap.ui.define([
 				 * 		Closes the personalization dialog.
 				 * 	</li>
 				 * </ol>
+				 * @memberof onTheMDCFilterBar
+				 * @method iEnterFilterValue
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code>
 				 * @param {Object} mSettings Map containing the settings for the filter values. Key is the label of the given group in the <code>FilterBar</code> personalization dialog, and value is an object containing the label of the <code>FilterField</code> and the values that are entered
-				 * @returns
+				 * @returns {Promise} OPA waitFor
 				 */
 				iEnterFilterValue: function(oFilterBar, mSettings) {
 					return filterBarActions.iEnterFilterValue.call(this, oFilterBar, mSettings);
@@ -97,17 +108,38 @@ sap.ui.define([
 				/**
 				 * OPA5 test action
 				 * Clears all values of a <code>FilterField</code> with a given label on the <code>FilterBar</code>.
+				 * @memberof onTheMDCFilterBar
+				 * @method iClearFilterValue
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code>
 				 * @param {string} sFilterLabel Label of the <code>FilterField</code>
-				 * @returns
+				 * @returns {Promise} OPA waitFor
 				 */
 				iClearFilterValue: function(oFilterBar, sFilterLabel) {
 					return filterBarActions.iClearFilterValue.call(this, oFilterBar, sFilterLabel);
-				}
-            },
-            assertions: {
+				},
+				/**
+				 * OPA5 test action
+				 * Changes the view of an open <code>sap.ui.mdc.p13n.panels.AdaptFiltersPanel</code> to the given view mode.
+				 * @param {string} sViewMode The view mode
+				 * @returns {Promise} OPA waitFor
+				 */
+				iChangeAdaptFiltersView: function(sViewMode) {
+					return filterBarActions.iChangeAdaptFiltersView.apply(this, arguments);
+				},
 				/**
 				 * OPA5 test action
+				 * Checks if there is a button visible on the application with the adopt filters icon and presses that given button.
+				 * @memberof onTheMDCFilterBar
+				 * @method iPressOnTheAdaptFiltersButton
+				 * @returns {Promise} OPA waitFor
+				 */
+				iPressOnTheAdaptFiltersButton: function() {
+					return filterBarActions.iPressOnTheAdaptFiltersButton.apply(this, arguments);
+				}
+			},
+			assertions: {
+				/**
+				 * OPA5 test assertion
 				 * Checks if given <code>FilterFields</code> are displayed on a given <code>FilterBar</code>.
 				 * Depending on the <code>vSettings</code> type this function can be used in two different ways:
 				 * <ul>
@@ -122,15 +154,49 @@ sap.ui.define([
 				 * 		If the value is an empty array, the given <code>FilterFields</code> doesn't have a value.
 				 *  </li>
 				 * </ul>
+				 * @memberof onTheMDCFilterBar
+				 * @method iShouldSeeFilters
 				 * @param {sap.ui.core.Control | string} oFilterBar Instance / ID of the <code>FilterBar</code>
-				 * @param {string[] | Object} vSettings
-				 * @returns
+				 * @param {string[] | Object} vSettings Settings in which the expected filters are defined
+				 * @returns {Promise} OPA waitFor
 				 */
 				iShouldSeeFilters: function(oFilterBar, vSettings) {
 					return filterBarAssertions.iShouldSeeFilters.call(this, oFilterBar, vSettings);
+				},
+
+				/**
+				 * OPA5 test assertion
+				 * Checks if there is a <code>FilterBar</code> visible on the application.
+				 * @memberof onTheMDCFilterBar
+				 * @method iShouldSeeTheFilterBar
+				 * @returns {Promise} OPA waitFor
+				 */
+				iShouldSeeTheFilterBar: function() {
+					return filterBarAssertions.iShouldSeeTheFilterBar.apply(this, arguments);
+				},
+				/**
+				 * OPA5 test assertion
+				 * Checks if there are <code>FilterFields</code> visible on the application with given labels.
+				 * @memberof onTheMDCFilterBar
+				 * @method iShouldSeeTheFilterFieldsWithLabels
+				 * @param {string[]} aLabelNames Array containing the labels of the expected <code>FilterFields</code>
+				 * @returns {Promise} OPA waitFor
+				 */
+				iShouldSeeTheFilterFieldsWithLabels: function(aLabelNames) {
+					return filterBarAssertions.iShouldSeeTheFilterFieldsWithLabels.apply(this, arguments);
+				},
+				/**
+				 * OPA5 test assertion
+				 * Checks if there is a button visible on the application with the adopt filters icon.
+				 * @memberof onTheMDCFilterBar
+				 * @method iShouldSeeTheAdaptFiltersButton
+				 * @returns {Promise} OPA waitFor
+				 */
+				iShouldSeeTheAdaptFiltersButton: function() {
+					return filterBarAssertions.iShouldSeeTheAdaptFiltersButton.apply(this, arguments);
 				}
 			}
-        }
-    });
+		}
+	});
 
 });

package/test/sap/ui/mdc/testutils/opa/filterbar/waitForAdaptFiltersButton.js

@@ -0,0 +1,47 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"../Utils"
+], function(
+	Opa5,
+	TestUtils
+) {
+	"use strict";
+
+	return function waitForAdaptFiltersButton(oSettings) {
+		oSettings = oSettings || {};
+		var sAdaptFiltersResourceBundleButtonText = TestUtils.getTextFromResourceBundle("sap.ui.mdc", "filterbar.ADAPT");
+		return this.waitFor({
+			controlType: "sap.m.Button",
+			properties: {
+				text: {
+					regex: {
+						source: sAdaptFiltersResourceBundleButtonText + "*",
+						flags: "ig"
+					}
+				}
+			},
+			matchers: {
+				ancestor: {
+					controlType: "sap.ui.mdc.FilterBar",
+					properties: {
+						showAdaptFiltersButton: true
+					}
+				}
+			},
+			actions: oSettings.actions,
+			success: function(aAdaptFiltersButton) {
+				Opa5.assert.strictEqual(aAdaptFiltersButton.length, 1, 'The "Adapt Filters" button was found');
+
+				if (typeof oSettings.success === "function") {
+					var oAdaptFiltersButton = aAdaptFiltersButton[0];
+					oSettings.success.call(this, oAdaptFiltersButton);
+				}
+			},
+			errorMessage: 'The "Adapt Filters" button was not found'
+		});
+	};
+});

package/test/sap/ui/mdc/testutils/opa/filterbar/waitForFilterBar.js

@@ -0,0 +1,28 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5"
+], function(
+	Opa5
+) {
+	"use strict";
+
+	return function waitForFilterBar(oSettings) {
+		oSettings = oSettings || {};
+
+		return this.waitFor({
+			controlType: "sap.ui.mdc.FilterBar",
+			success: function(aFilterBar) {
+				Opa5.assert.strictEqual(aFilterBar.length, 1, "The FilterBar control was found");
+
+				if (typeof oSettings.success === "function") {
+					var oFilterBar = aFilterBar[0];
+					oSettings.success.call(this, oFilterBar);
+				}
+			},
+			errorMessage: "The FilterBar control was not found"
+		});
+	};
+});

package/test/sap/ui/mdc/testutils/opa/filterfield/Actions.js

@@ -0,0 +1,70 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"sap/ui/test/actions/EnterText",
+	"sap/ui/test/actions/Press",
+	"./waitForFilterField",
+	"./waitForFilterFieldValueHelpButton",
+	"sap/ui/events/KeyCodes"
+], function(
+	Opa5,
+	EnterText,
+	Press,
+	waitForFilterField,
+	waitForFilterFieldValueHelpButton,
+	KeyCodes
+) {
+    "use strict";
+
+
+	var Opa5Utils = Opa5.getUtils();
+
+    return {
+		iEnterTextOnTheFilterField: function(sLabelName, sValue, oConfig) {
+			return waitForFilterField.call(this, {
+				properties: {
+					label: sLabelName
+				},
+				actions: new EnterText(oConfig ? {
+					text: sValue
+				} : Object.assign({
+					text: sValue
+				}), oConfig ),
+				success: function(oFilterField) {
+					Opa5.assert.ok(true, 'The text "' + sValue + '" was entered into the filter field');
+				},
+				errorMessage: 'The text "' + sValue + '" could not be entered into the filter field'
+			});
+		},
+
+		iPressKeyOnFilterFieldWithLabel: function(sLabelName, sValue) {
+			return waitForFilterField.call(this, {
+				properties: {
+					label: sLabelName
+				},
+				success: function(oFilterField) {
+					var oContent = oFilterField.getAggregation("_content")[0];
+					Opa5Utils.triggerKeydown(oContent.getDomRef(), KeyCodes[sValue]);
+					Opa5.assert.ok(oContent, "Key '" + sValue + "' pressed on FilterField with label '" + sLabelName + "'");
+				},
+				errorMessage: 'The key "' + sValue + " could not be pressed on the FilterField with label '" + sLabelName + "'"
+			});
+		},
+
+		iPressOnTheFilterFieldValueHelpButton: function(sLabelName) {
+			return waitForFilterFieldValueHelpButton.call(this, {
+				properties: {
+					label: sLabelName
+				},
+				actions: new Press(),
+				success: function(oValueHelpIconButton) {
+					Opa5.assert.ok(oValueHelpIconButton, "The filter field value help button was pressed");
+				},
+				errorMessage: "The filter field value help button could not be press"
+			});
+		}
+	};
+});

package/test/sap/ui/mdc/testutils/opa/filterfield/Assertions.js

@@ -0,0 +1,87 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"sap/ui/test/matchers/Ancestor",
+	"sap/base/util/deepEqual",
+	"./waitForFilterField"
+], function(
+	Opa5,
+	Ancestor,
+	deepEqual,
+	waitForFilterField
+) {
+	"use strict";
+
+	return {
+
+		iShouldSeeTheFilterFieldWithValues: function(sLabelName, oValues) {
+			return waitForFilterField.call(this, {
+				properties: {
+					label: sLabelName
+				},
+				check: function(aFilterFields) {
+					var oFilterField = aFilterFields[0];
+					var aConditions = oValues.conditions || [];
+					return deepEqual(oFilterField.getConditions(), aConditions);
+				},
+				success: onFilterFieldWithExpectedConditionsFound,
+				errorMessage: "The filter field stores the unexpected conditions"
+			});
+
+			function onFilterFieldWithExpectedConditionsFound(oFilterField) {
+				var sConditionMessage = 'The expected conditions are stored for the filter field labeled as "' + sLabelName + '"';
+				Opa5.assert.ok(true, sConditionMessage);
+
+				if (!Array.isArray(oValues.formattedValues)) {
+					return;
+				}
+
+				oValues.formattedValues.forEach(function(sValue) {
+					var sFormattedValueMessage = 'The expected value "' + sValue + '" is displayed into the filter field labeled as "' + sLabelName + '"';
+
+					if (sValue === "") {
+						Opa5.assert.ok(true, sFormattedValueMessage);
+						return;
+					}
+
+					var sControlType;
+
+					switch (oFilterField.getEditMode()) {
+						case "Display":
+							sControlType = "sap.m.Text";
+							break;
+
+						// extend to more edit modes as required
+
+						default:
+							sControlType = "sap.m.Token";
+							break;
+					}
+
+					this.waitFor({
+						controlType: sControlType,
+
+						// If the available space is limited, the MultiInput control
+						// renders the conditions as invisible tokens. Therefore,
+						// to make the test robust, visible and invisible tokens must
+						// be taken into consideration.
+						visible: false, // look for visible and invisible tokens
+
+						properties: {
+							text: sValue
+						},
+						matchers: new Ancestor(oFilterField),
+						success: function() {
+							Opa5.assert.ok(true, sFormattedValueMessage);
+						},
+						errorMessage: 'The filter filed displays the unexpected value "' + sValue + '"'
+					});
+				}, this);
+			}
+		}
+    };
+});
+

package/test/sap/ui/mdc/testutils/opa/filterfield/JSDoc.md

@@ -0,0 +1,63 @@
+<a name="onTheMDCFilterField"></a>
+
+## onTheMDCFilterField : <code>object</code>
+**Kind**: global namespace  
+
+* [onTheMDCFilterField](#onTheMDCFilterField) : <code>object</code>
+    * [.iEnterTextOnTheFilterField(sLabelName, sValue, oConfig)](#onTheMDCFilterField.iEnterTextOnTheFilterField) ⇒ <code>Promise</code>
+    * [.iPressKeyOnFilterFieldWithLabel(sLabelName, sValue)](#onTheMDCFilterField.iPressKeyOnFilterFieldWithLabel) ⇒ <code>Promise</code>
+    * [.iPressOnTheFilterFieldValueHelpButton(sLabelName)](#onTheMDCFilterField.iPressOnTheFilterFieldValueHelpButton) ⇒ <code>Promise</code>
+    * [.iShouldSeeTheFilterFieldWithValues(sLabelName, oValues)](#onTheMDCFilterField.iShouldSeeTheFilterFieldWithValues) ⇒ <code>Promise</code>
+
+<a name="onTheMDCFilterField.iEnterTextOnTheFilterField"></a>
+
+### onTheMDCFilterField.iEnterTextOnTheFilterField(sLabelName, sValue, oConfig) ⇒ <code>Promise</code>
+OPA5 test action
+
+**Kind**: static method of [<code>onTheMDCFilterField</code>](#onTheMDCFilterField)  
+**Returns**: <code>Promise</code> - OPA waitFor  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| sLabelName | <code>string</code> | Label of the given <code>FilterField</code> |
+| sValue | <code>string</code> | Value which is to be entered in the <code>FilterField</code> |
+| oConfig | <code>object</code> | TODO: to be clarified |
+
+<a name="onTheMDCFilterField.iPressKeyOnFilterFieldWithLabel"></a>
+
+### onTheMDCFilterField.iPressKeyOnFilterFieldWithLabel(sLabelName, sValue) ⇒ <code>Promise</code>
+OPA5 test action
+
+**Kind**: static method of [<code>onTheMDCFilterField</code>](#onTheMDCFilterField)  
+**Returns**: <code>Promise</code> - OPA waitFor  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| sLabelName | <code>string</code> | Label of the given <code>FilterField</code> |
+| sValue | <code>string</code> | Value of the Keycode which is to be pressed |
+
+<a name="onTheMDCFilterField.iPressOnTheFilterFieldValueHelpButton"></a>
+
+### onTheMDCFilterField.iPressOnTheFilterFieldValueHelpButton(sLabelName) ⇒ <code>Promise</code>
+OPA5 test action
+
+**Kind**: static method of [<code>onTheMDCFilterField</code>](#onTheMDCFilterField)  
+**Returns**: <code>Promise</code> - OPA waitFor  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| sLabelName | <code>string</code> | Label of the given <code>FilterField</code> |
+
+<a name="onTheMDCFilterField.iShouldSeeTheFilterFieldWithValues"></a>
+
+### onTheMDCFilterField.iShouldSeeTheFilterFieldWithValues(sLabelName, oValues) ⇒ <code>Promise</code>
+OPA5 test assertion
+
+**Kind**: static method of [<code>onTheMDCFilterField</code>](#onTheMDCFilterField)  
+**Returns**: <code>Promise</code> - OPA waitFor  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| sLabelName | <code>string</code> | Label of the given <code>FilterField</code> |
+| oValues | <code>object</code> | Expected values |
+

package/test/sap/ui/mdc/testutils/opa/filterfield/TestObjects.js

@@ -0,0 +1,71 @@
+/*!
+ * ${copyright}
+ */
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"./Actions",
+	"./Assertions"
+], function(
+	Opa5,
+	fieldActions,
+	fieldAssertions
+) {
+	"use strict";
+
+	/**
+	 * @namespace onTheMDCFilterField
+	 */
+	Opa5.createPageObjects({
+		onTheMDCFilterField: {
+			actions: {
+				/**
+				 * OPA5 test action
+				 * @memberof onTheMDCFilterField
+				 * @method iEnterTextOnTheFilterField
+				 * @param {string} sLabelName Label of the given <code>FilterField</code>
+				 * @param {string} sValue Value which is to be entered in the <code>FilterField</code>
+				 * @param {object} oConfig TODO: to be clarified
+				 * @returns {Promise} OPA waitFor
+				 */
+				iEnterTextOnTheFilterField: function(sLabelName, sValue, oConfig) {
+					return fieldActions.iEnterTextOnTheFilterField.apply(this, arguments);
+				},
+				/**
+				 * OPA5 test action
+				 * @memberof onTheMDCFilterField
+				 * @method iPressKeyOnFilterFieldWithLabel
+				 * @param {string} sLabelName Label of the given <code>FilterField</code>
+				 * @param {string} sValue Value of the Keycode which is to be pressed
+				 * @returns {Promise} OPA waitFor
+				 */
+				iPressKeyOnFilterFieldWithLabel: function(sLabelName, sValue) {
+					return fieldActions.iPressKeyOnFilterFieldWithLabel.apply(this, arguments);
+				},
+				/**
+				 * OPA5 test action
+				 * @memberof onTheMDCFilterField
+				 * @method iPressOnTheFilterFieldValueHelpButton
+				 * @param {string} sLabelName Label of the given <code>FilterField</code>
+				 * @returns {Promise} OPA waitFor
+				 */
+				iPressOnTheFilterFieldValueHelpButton: function(sLabelName) {
+					return fieldActions.iPressOnTheFilterFieldValueHelpButton.apply(this, arguments);
+				}
+			},
+			assertions: {
+				/**
+				 * OPA5 test assertion
+				 * @memberof onTheMDCFilterField
+				 * @method iShouldSeeTheFilterFieldWithValues
+				 * @param {string} sLabelName Label of the given <code>FilterField</code>
+				 * @param {object} oValues Expected values
+				 * @returns {Promise} OPA waitFor
+				 */
+				iShouldSeeTheFilterFieldWithValues: function(sLabelName, oValues) {
+					return fieldAssertions.iShouldSeeTheFilterFieldWithValues.call(this, sLabelName, oValues);
+				}
+			}
+		}
+	});
+
+});

package/test/sap/ui/mdc/testutils/opa/filterfield/waitForFilterField.js

@@ -0,0 +1,36 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5"
+], function(
+	Opa5
+) {
+	"use strict";
+
+	return function waitForFilterField(oSettings) {
+		oSettings = oSettings || {};
+
+		return this.waitFor({
+			controlType: "sap.ui.mdc.FilterField",
+			properties: oSettings.properties,
+			// matchers: {
+			// 	ancestor: {
+			// 		controlType: "sap.ui.mdc.FilterBar"
+			// 	}
+			// },
+			actions: oSettings.actions,
+			check: oSettings.check,
+			success: function(aFilterFields) {
+				Opa5.assert.strictEqual(aFilterFields.length, 1, "The filter field was found");
+
+				if (typeof oSettings.success === "function") {
+					var oFilterField = aFilterFields[0];
+					oSettings.success.call(this, oFilterField);
+				}
+			},
+			errorMessage: "The filter field was not found"
+		});
+	};
+});

package/test/sap/ui/mdc/testutils/opa/filterfield/waitForFilterFieldValueHelpButton.js

@@ -0,0 +1,42 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"sap/ui/test/matchers/Ancestor",
+	"./waitForFilterField"
+], function(
+	Opa5,
+	Ancestor,
+	waitForFilterField
+) {
+	"use strict";
+
+	return function waitForFilterFieldValueHelpButton(oSettings) {
+
+		return waitForFilterField.call(this, {
+			properties: oSettings.properties,
+			success: onFilterFieldFound
+		});
+
+		function onFilterFieldFound(oFilterField) {
+			var sValueHelpButtonID = oFilterField.getId() + "-inner-vhi";
+
+			this.waitFor({
+				id: sValueHelpButtonID,
+				controlType: "sap.ui.core.Icon",
+				matchers: new Ancestor(oFilterField),
+				actions: oSettings.actions,
+				success: function(oValueHelpIconButton) {
+					Opa5.assert.ok(oValueHelpIconButton, "The filter field value help button was found");
+
+					if (typeof oSettings.success === "function") {
+						oSettings.success.call(this, oValueHelpIconButton);
+					}
+				},
+				errorMessage: "The filter field value help button could not be found"
+			});
+		}
+	};
+});