@openui5/sap.ui.mdc 1.92.0 → 1.95.0

package/test/sap/ui/mdc/testutils/opa/TestLibrary.js

@@ -1,10 +1,10 @@
 /*!
  * ${copyright}
  */
-
 sap.ui.define([
 	"sap/ui/test/Opa5",
-	"test-resources/sap/ui/mdc/testutils/opa/table/TestObjects"
+	"test-resources/sap/ui/mdc/testutils/opa/table/TestObjects",
+	"test-resources/sap/ui/mdc/testutils/opa/filterbar/TestObjects"
 ], function() {
 	"use strict";
 });

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

@@ -0,0 +1,250 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"sap/ui/test/matchers/Matcher",
+	"sap/ui/test/matchers/Properties",
+	"sap/ui/test/matchers/Ancestor",
+	"sap/ui/test/matchers/Descendant",
+	"sap/ui/test/matchers/PropertyStrictEquals",
+	"sap/ui/test/actions/Press",
+	"sap/ui/test/actions/EnterText",
+	"./Util",
+	"../p13n/Actions",
+	"../p13n/Util"
+], function(
+	Opa5,
+	Matcher,
+	Properties,
+	Ancestor,
+	Descendant,
+	PropertyStrictEquals,
+	Press,
+	EnterText,
+	FilterBarUtil,
+	p13nActions,
+	p13nUtil
+) {
+	"use strict";
+
+	var iEnterFilterValue = function(oGroupViewItem, mSettings) {
+		// Get sap.m.Panel of GroupViewItem
+		this.waitFor({
+			controlType: "sap.m.Panel",
+			matchers: new Ancestor(oGroupViewItem, true),
+			success: function(aPanels) {
+				var oGroupPanel = aPanels[0];
+				// Get the expand button for the panel
+				this.waitFor({
+					controlType: "sap.m.Button",
+					matchers: new Ancestor(oGroupPanel, true),
+					success: function(aButtons) {
+						var oButton = aButtons[0];
+						// click on expand button
+						if (!oGroupPanel.getExpanded()) {
+							new Press().executeOn(oButton);
+						}
+						this.waitFor({
+							controlType: "sap.m.Toolbar",
+							matchers: new Ancestor(oGroupPanel, true),
+							success: function(aToolbars) {
+								var oToolbar = aToolbars[0];
+								// Get label of the GroupViewItem
+								this.waitFor({
+									controlType: "sap.m.Label",
+									matchers: new Ancestor(oToolbar, true),
+									success: function(aToolbarLabels) {
+										var oToolbarLabel = aToolbarLabels[0];
+										this.waitFor({
+											controlType: "sap.m.List",
+											matchers: new Ancestor(oGroupPanel, true),
+											success: function(aLists) {
+												var oList = aLists[0];
+												// Get CustomListItems inside the GroupViewItem panel
+												this.waitFor({
+													controlType: "sap.m.CustomListItem",
+													matchers: new Ancestor(oList, true),
+													actions: function(oFilterItem) {
+														this.waitFor({
+															controlType: "sap.m.Label",
+															matchers: new Ancestor(oFilterItem, false),
+															success: function(aFilterFieldLabels) {
+																var oFilterFieldLabel = aFilterFieldLabels[0];
+																var sLabelFor = oFilterFieldLabel.getLabelFor();
+																this.waitFor({
+																	controlType: "sap.ui.mdc.filterbar.p13n.FilterGroupLayout",
+																	id: sLabelFor,
+																	success: function(oFilterGroupLayout) {
+																		this.waitFor({
+																			controlType: "sap.ui.mdc.FilterField",
+																			matchers: function(oFilterField) {
+																				if (mSettings[oToolbarLabel.getText()]) {
+																					return oFilterField === oFilterGroupLayout._oFilterField;
+																				}
+																				return false;
+																			},
+																			actions: function (oFilterField) {
+																				var oSettings = mSettings[oToolbarLabel.getText()];
+																				if (oSettings.label === oFilterFieldLabel.getText()) {
+																					oSettings.values.forEach(function(oValue) {
+																						this.waitFor({
+																							controlType: "sap.ui.mdc.field.FieldMultiInput",
+																							matchers: new Ancestor(oFilterField),
+																							actions: new EnterText({
+																								text: oValue,
+																								clearTextFirst: false,
+																								pressEnterKey: true
+																							})
+																						});
+																					}.bind(this));
+																				}
+																			}.bind(this)
+																		});
+																	}
+																});
+															}
+														});
+													}.bind(this),
+													// close group panel
+													success: function() {
+														if (oGroupPanel.getExpanded()) {
+															new Press().executeOn(oButton);
+														}
+													}
+												});
+											}
+										});
+									}
+								});
+							}
+						});
+					}
+				});
+			}
+		});
+	};
+
+    return {
+		iExpectSearch: function(oFilterBar) {
+			var sFilterBarId = typeof oFilterBar === "string" ? oFilterBar : oFilterBar.getId();
+			var sText = FilterBarUtil.texts.go;
+			return this.waitFor({
+				id: sFilterBarId,
+				success: function(oFilterBarInstance) {
+					Opa5.assert.ok(oFilterBarInstance, "Found FilterBar.");
+					if (!oFilterBarInstance.getLiveMode()) {
+						this.waitFor({
+							controlType: "sap.m.Button",
+							matchers: [
+								new Ancestor(oFilterBarInstance, false),
+								new PropertyStrictEquals({
+									name: "text",
+									value: sText
+								})
+							],
+							actions: new Press(),
+							errorMessage: "No '" + sText + "' button found on the FilterBar."
+						});
+					}
+				}
+			});
+		},
+		iEnterFilterValue: function(oFilterBar, mSettings) {
+			var sIcon = p13nUtil.icons.group;
+			return p13nActions.iOpenThePersonalizationDialog.call(this, oFilterBar, {
+				success: function(oP13nDialog) {
+					this.waitFor({
+						controlType: "sap.m.Button",
+						matchers: [
+							new Ancestor(oP13nDialog, false),
+							new PropertyStrictEquals({
+								name: "icon",
+								value: sIcon
+							})
+						],
+						actions: new Press(),
+						success: function() {
+							this.waitFor({
+								controlType: "sap.ui.mdc.p13n.panels.GroupView",
+								matchers: new Ancestor(oP13nDialog, false),
+								success: function(aGroupViews) {
+									var oGroupView = aGroupViews[0];
+									this.waitFor({
+										controlType: "sap.m.VBox",
+										matchers: new Ancestor(oGroupView, true),
+										success: function(aVBoxes) {
+											var oVBox = aVBoxes[0];
+											this.waitFor({
+												controlType: "sap.m.List",
+												matchers: new Ancestor(oVBox, true),
+												success: function(aLists) {
+													var oList = aLists[0];
+													this.waitFor({
+														controlType: "sap.m.CustomListItem",
+														matchers: function(oCustomListItem) {
+															var bAncestor = new Ancestor(oList, true)(oCustomListItem);
+
+															return bAncestor && Object.keys(mSettings).includes(oCustomListItem.getContent()[0].getHeaderToolbar().getContent()[0].getText());
+														},
+														actions: function(oGroupViewItem) {
+															iEnterFilterValue.call(this, oGroupViewItem, mSettings);
+														}.bind(this),
+														success: function() {
+															p13nActions.iPressTheOKButtonOnTheDialog.call(this, oP13nDialog);
+														}
+													});
+												}
+											});
+										}
+									});
+								}
+							});
+						},
+						errorMessage: "No button with icon '" + sIcon + "' found on P13nDialog"
+					});
+				}
+			});
+		},
+		iClearFilterValue: function(oFilterBar, sFilterLabel) {
+			var sFilterBarId = typeof oFilterBar === "string" ? oFilterBar : oFilterBar.getId();
+			return this.waitFor({
+				id: sFilterBarId,
+				success: function(oFilterBarInstance) {
+					this.waitFor({
+						controlType: "sap.ui.mdc.FilterField",
+						matchers: [
+							new PropertyStrictEquals({
+								name: "label",
+								value: sFilterLabel
+							}),
+							new Ancestor(oFilterBarInstance, true)
+						],
+						success: function(aFilterFields) {
+							var oFilterField = aFilterFields[0];
+							this.waitFor({
+								controlType: "sap.m.Token",
+								matchers: new Ancestor(oFilterField, false),
+								actions: function(oToken) {
+									this.waitFor({
+										controlType: "sap.ui.core.Icon",
+										matchers: [
+											new Ancestor(oToken),
+											new PropertyStrictEquals({
+												name: "src",
+												value: FilterBarUtil.icons.decline
+											})
+										],
+										actions: new Press()
+									});
+								}.bind(this)
+							});
+						}
+					});
+				}
+			});
+		}
+    };
+
+});

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

@@ -0,0 +1,91 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"sap/ui/test/matchers/Matcher",
+	"sap/ui/test/matchers/Properties",
+	"sap/ui/test/matchers/Ancestor",
+	"sap/ui/test/matchers/Descendant",
+	"sap/ui/test/matchers/PropertyStrictEquals"
+], function(
+	Opa5,
+	Matcher,
+	Properties,
+	Ancestor,
+	Descendant,
+	PropertyStrictEquals
+) {
+	"use strict";
+
+	//var oMDCBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
+
+    var iShouldSeeFilterField = function(oFilterBarInstance, sLabel, aExpectedConditions) {
+        var vMatchers;
+
+        if (aExpectedConditions) {
+            vMatchers = function(oFilterField) {
+                var bLabelCorrect = oFilterField.getLabel() === sLabel;
+                var bAncestor = new Ancestor(oFilterBarInstance, true)(oFilterField);
+                var aFilterFieldConditions = oFilterField.getConditions();
+                var bConditionsCorrect = aFilterFieldConditions.length === aExpectedConditions.length;
+
+                if (bConditionsCorrect) {
+                    bConditionsCorrect = aFilterFieldConditions.every(function(oFilterFieldCondition) {
+                        return aExpectedConditions.some(function(oExpectedCondition) {
+                            var bOperator = oFilterFieldCondition.operator === oExpectedCondition.operator;
+                            var bValues;
+
+                            bValues = oFilterFieldCondition.values.every(function(oFilterFieldConditionValue) {
+                                return oExpectedCondition.values.includes(oFilterFieldConditionValue);
+                            });
+
+                            return bOperator && bValues;
+                        });
+                    });
+                }
+
+                return bLabelCorrect && bAncestor && bConditionsCorrect;
+            };
+        } else {
+            vMatchers = [
+                new Ancestor(oFilterBarInstance, true),
+                new PropertyStrictEquals({
+                    name: "label",
+                    value: sLabel
+                })
+            ];
+        }
+
+
+        this.waitFor({
+            controlType: "sap.ui.mdc.FilterField",
+            matchers: vMatchers,
+            success: function(aFilterFields) {
+                Opa5.assert.ok(aFilterFields.length === 1, "The FilterField labeled as '" + sLabel + "' found");
+            }
+        });
+    };
+
+    return {
+        iShouldSeeFilters: function(oFilterBar, vSettings) {
+            var sFilterBarId = typeof oFilterBar === "string" ? oFilterBar : oFilterBar.getId();
+			return this.waitFor({
+				id: sFilterBarId,
+				success: function(oFilterBarInstance) {
+                    if (Array.isArray(vSettings)) {
+                        vSettings.forEach(function(sLabel) {
+                            iShouldSeeFilterField.call(this, oFilterBarInstance, sLabel);
+                        }.bind(this));
+                    } else {
+                        for (var sLabel in vSettings) {
+                            iShouldSeeFilterField.call(this, oFilterBarInstance, sLabel, vSettings[sLabel]);
+                        }
+                    }
+                }
+            });
+        }
+    };
+
+});

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

@@ -0,0 +1,137 @@
+/*!
+ * ${copyright}
+ */
+sap.ui.define([
+	"sap/ui/test/Opa5",
+	"./Actions",
+	"./Assertions",
+	"../p13n/Actions"
+], function(
+	Opa5,
+	filterBarActions,
+	filterBarAssertions,
+	p13nActions
+) {
+	"use strict";
+
+	Opa5.createPageObjects({
+		onFilterBar: {
+			actions: {
+				/**
+				 * OPA5 test action
+				 * <ol>
+				 * 	<li>
+				 * 		Opens the personalization dialog of the given <code>FilterBar</code>.
+				 * 	</li>
+				 *  <li>
+				 * 		Navigates to the "Group" tab.
+				 * 	</li>
+				 * 	<li>
+				 * 		Opens all groups and selects / deselects all <code>FilterFields</code> depending on <code>oSettings</code>. Only the labels defined in <code>oSettings</code> will be selected, others will be deselected.
+				 * 	</li>
+				 * 	<li>
+				 * 		Closes the personalization dialog.
+				 * 	</li>
+				 * </ol>
+				 * @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
+				 */
+				iPersonalizeFilter: function(oFilterBar, oSettings) {
+					return p13nActions.iPersonalizeFilterBar.call(this, oFilterBar, oSettings);
+				},
+				/**
+				 * OPA5 test action
+				 * <ol>
+				 * 	<li>
+				 * 		Opens the personalization dialog of the given <code>FilterBar</code>.
+				 * 	</li>
+				 * 	<li>
+				 * 		Presses the reset personalization button.
+				 * 	</li>
+				 * 	<li>
+				 * 		Confirms the reset dialog.
+				 * 	</li>
+				 * 	<li>
+				 * 		Closes the personalization dialog.
+				 * 	</li>
+				 * </ol>
+				 * @param {sap.ui.core.Control | String} oFilterBar Instance / ID of the <code>FilterBar</code>
+				 * @returns
+				 */
+				iResetThePersonalization: function(oFilterBar) {
+					return p13nActions.iResetThePersonalization.call(this, oFilterBar);
+				},
+				/**
+				 * OPA5 test action
+				 * Presses the apply filters button of the <code>FilterBar</code>.
+				 * @param {sap.ui.core.Control | String} oFilterBar Instance / ID of the <code>FilterBar</code>
+				 * @returns
+				 */
+				iExpectSearch: function(oFilterBar) {
+					return filterBarActions.iExpectSearch.call(this, oFilterBar);
+				},
+				/**
+				 * OPA5 test action
+				 * <ol>
+				 * 	<li>
+				 * 		Opens the personalization dialog of the given <code>FilterBar</code>.
+				 * 	</li>
+				 *	<li>
+				 * 		Navigates to the "Group" tab.
+				 *	</li>
+				 * 	<li>
+				 * 		Opens the given groups and enters all values in the <code>FilterFields</code> depending on <code>oSettings</code>.
+				 * 	</li>
+				 * 	<li>
+				 * 		Closes the personalization dialog.
+				 * 	</li>
+				 * </ol>
+				 * @param {sap.ui.core.Control | String} oFilterBar Instance / ID of the <code>FilterBar</code>
+				 * @param {String} sFilterLabel Label of the <code>FilterField</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
+				 */
+				iEnterFilterValue: function(oFilterBar, mSettings) {
+					return filterBarActions.iEnterFilterValue.call(this, oFilterBar, mSettings);
+				},
+				/**
+				 * OPA5 test action
+				 * Clears all values of a <code>FilterField</code> with a given label on the <code>FilterBar</code>.
+				 * @param {sap.ui.core.Control | String} oFilterBar Instance / ID of the <code>FilterBar</code>
+				 * @param {String} sFilterLabel Label of the <code>FilterField</code>
+				 * @returns
+				 */
+				iClearFilterValue: function(oFilterBar, sFilterLabel) {
+					return filterBarActions.iClearFilterValue.call(this, oFilterBar, sFilterLabel);
+				}
+            },
+            assertions: {
+				/**
+				 * OPA5 test action
+				 * 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>
+				 * 	<li>
+				 *		<code>vSettings</code> is an array of strings:
+				 * 		Checks if all given strings are labels for <code>FilterFields</code> on a given <code>FilterBar</code>.
+				 * 	</li>
+				 * 	<li>
+				 *  	<code>vSettings</code> is an object:
+				 * 		Checks for each key in the object if there is a label for a <code>FilterFields</code> of a given <code>FilterBar</code>.
+				 * 		The value of that key is an array containing objects with the operators and values that are expected for the given <code>FilterFields</code>.
+				 * 		If the value is an empty array, the given <code>FilterFields</code> doesn't have a value.
+				 *  </li>
+				 * </ul>
+				 * @param {sap.ui.core.Control | String} oFilterBar Instance / ID of the <code>FilterBar</code>
+				 * @param {String[] | Object} vSettings
+				 * @returns
+				 */
+				iShouldSeeFilters: function(oFilterBar, vSettings) {
+					return filterBarAssertions.iShouldSeeFilters.call(this, oFilterBar, vSettings);
+				}
+			}
+        }
+    });
+
+});

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

@@ -0,0 +1,25 @@
+/*
+* ! ${copyright}
+*/
+sap.ui.define([
+], function() {
+	"use strict";
+
+    var oMDCBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
+    //var oMBundle = sap.ui.getCore().getLibraryResourceBundle("sap.m");
+
+	var Util = {
+
+        texts: {
+            go: oMDCBundle.getText("filterbar.GO")
+        },
+
+        icons: {
+            decline: "sap-icon://decline",
+            valueHelp: "sap-icon://value-help"
+        }
+
+    };
+
+	return Util;
+});