[Feature] Add multichoice combobox +semver: feature (#233)

* [Feature] Add multichoice combobox +semver: feature

* Implement MultiChoiceBox tests, fixed logic in ComboBox and documentation

* Fix bug in ComboBox selectByContains method, and coding issues.
Add localization values for logging

* add cookies dialog waiting

* Make multichoise box tests non-parallelizable to reduce web resource load

* remove textbox highlighting from test

* stabilize LocationForm

Author: mialeska

Aquality.Selenium/src/Aquality.Selenium/Aquality.Selenium.xml

@@ -3,6 +3,7 @@
 using Aquality.Selenium.Elements.Interfaces;
 using OpenQA.Selenium;
 using OpenQA.Selenium.Support.UI;
+using System;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -68,38 +69,35 @@ public IList<string> Values
         public void SelectByContainingText(string text)
         {
             LogElementAction("loc.combobox.select.by.text", text);
-            DoWithRetry(() =>
-            {
-                var select = new SelectElement(GetElement());
-                foreach (var element in select.Options)
-                {
-                    var elementText = element.Text;
-                    if (elementText.ToLower().Contains(text.ToLower()))
-                    {
-                        select.SelectByText(elementText);
-                        return;
-                    }
-                }
-                throw new InvalidElementStateException($"Failed to select option that contains text {text}");
-            });
+            ApplyFunctionToOptionsThatContain(element => element.Text, (select, option) => select.SelectByText(option), text);
         }
 
         public void SelectByContainingValue(string value)
         {
             LogElementAction("loc.selecting.value", value);
+            ApplyFunctionToOptionsThatContain(
+                element => element.GetAttribute(Attributes.Value), (select, option) => select.SelectByValue(option), value);
+        }
+
+        protected void ApplyFunctionToOptionsThatContain(Func<IWebElement, string> getValueFunction, Action<SelectElement, string> selectFunction, string value)
+        {
             DoWithRetry(() =>
             {
                 var select = new SelectElement(GetElement());
+                var isSelected = false;
                 foreach (var element in select.Options)
                 {
-                    var elementValue = element.GetAttribute(Attributes.Value);
+                    var elementValue = getValueFunction(element);
                     if (elementValue.ToLower().Contains(value.ToLower()))
                     {
-                        select.SelectByValue(elementValue);
-                        return;
+                        selectFunction(select, elementValue);
+                        isSelected = true;
                     }
                 }
-                throw new InvalidElementStateException($"Failed to select option that contains value {value}");
+                if (!isSelected)
+                {
+                    throw new InvalidElementStateException($"Failed to find option that contains [{value}]");
+                }
             });
         }
 

Aquality.Selenium/src/Aquality.Selenium/Elements/ComboBox.cs

@@ -47,6 +47,11 @@ public IComboBox GetComboBox(By locator, string name, ElementState state = Eleme
             return ResolveSupplier<IComboBox>()(locator, name, state);
         }
 
+        public IMultiChoiceBox GetMultiChoiceBox(By locator, string name, ElementState state = ElementState.Displayed)
+        {
+            return ResolveSupplier<IMultiChoiceBox>()(locator, name, state);
+        }
+
         public ILabel GetLabel(By locator, string name, ElementState state = ElementState.Displayed)
         {
             return ResolveSupplier<ILabel>()(locator, name, state);
@@ -105,6 +110,7 @@ protected override IDictionary<Type, Type> ElementTypesMap
                     { typeof(IButton), typeof(Button) },
                     { typeof(ICheckBox), typeof(CheckBox) },
                     { typeof(IComboBox), typeof(ComboBox) },
+                    { typeof(IMultiChoiceBox), typeof(MultiChoiceBox) },
                     { typeof(ILabel), typeof(Label) },
                     { typeof(ILink), typeof(Link) },
                     { typeof(IRadioButton), typeof(RadioButton) },

Aquality.Selenium/src/Aquality.Selenium/Elements/ElementFactory.cs

@@ -36,6 +36,15 @@ public interface IElementFactory : ICoreElementFactory
         /// <returns>Instance of element that implements IComboBox interface</returns>
         IComboBox GetComboBox(By locator, string name, ElementState state = ElementState.Displayed);
 
+        /// <summary>
+        /// Creates element that implements IMultiChoiceBox interface.
+        /// </summary>
+        /// <param name="locator">Element locator</param>
+        /// <param name="name">Element name</param>
+        /// <param name="state">Element state</param>
+        /// <returns>Instance of element that implements IMultiChoiceBox interface</returns>
+        IMultiChoiceBox GetMultiChoiceBox(By locator, string name, ElementState state = ElementState.Displayed);
+
         /// <summary>
         /// Creates element that implements ILabel interface.
         /// </summary>

Aquality.Selenium/src/Aquality.Selenium/Elements/Interfaces/IElementFactory.cs

@@ -0,0 +1,62 @@
+using System.Collections.Generic;
+
+namespace Aquality.Selenium.Elements.Interfaces
+{
+    /// <summary>
+    /// Describes behavior of MultiChoice ComboBox UI element.
+    /// </summary>
+    public interface IMultiChoiceBox : IComboBox
+    {
+        /// <summary>
+        /// Gets value of all selected options.
+        /// </summary>
+        /// <value>Selected values.</value>
+        IList<string> SelectedValues { get; }
+
+        /// <summary>
+        /// Gets text of all selected options.
+        /// </summary>
+        /// <value>Selected texts.</value>
+        IList<string> SelectedTexts { get; }
+
+        /// <summary>
+        /// Select all options
+        /// </summary>
+        void SelectAll();
+                
+        /// <summary>
+        /// De-select all options
+        /// </summary>
+        void DeselectAll();
+
+        /// <summary>
+        /// De-select selected option by index
+        /// </summary>
+        /// <param name="index">Number of selected option.</param>
+        void DeselectByIndex(int index);
+
+        /// <summary>
+        /// De-select selected option by value.
+        /// </summary>
+        /// <param name="value">Option value.</param>
+        void DeselectByValue(string value);
+
+        /// <summary>
+        /// De-select selected option by containing value.
+        /// </summary>
+        /// <param name="value">Partial option's value.</param>
+        void DeselectByContainingValue(string value);
+
+        /// <summary>
+        /// De-select selected option by visible text.
+        /// </summary>
+        /// <param name="text">Text to be deselected.</param>
+        void DeselectByText(string text);
+
+        /// <summary>
+        /// De-select selected option by containing visible text.
+        /// </summary>
+        /// <param name="text">Partial option's text.</param>
+        void DeselectByContainingText(string text);
+    }
+}

Aquality.Selenium/src/Aquality.Selenium/Elements/Interfaces/IMultiChoiceBox.cs

@@ -0,0 +1,93 @@
+using Aquality.Selenium.Core.Elements;
+using Aquality.Selenium.Elements.Interfaces;
+using OpenQA.Selenium;
+using OpenQA.Selenium.Support.UI;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace Aquality.Selenium.Elements
+{
+    /// <summary>
+    /// Defines MultiChoiceBox UI element.
+    /// </summary>
+    public class MultiChoiceBox : ComboBox, IMultiChoiceBox
+    {
+        private const string LocDeselectingValue = "loc.deselecting.value";
+
+        protected internal MultiChoiceBox(By locator, string name, ElementState state) : base(locator, name, state)
+        {
+        }
+
+        protected override string ElementType => LocalizationManager.GetLocalizedMessage("loc.multichoicebox");
+
+        public IList<string> SelectedValues
+        {
+            get
+            {
+                LogElementAction("loc.combobox.getting.selected.value");
+                var values = DoWithRetry(() => new SelectElement(GetElement()).AllSelectedOptions.Select(option => option.GetAttribute(Attributes.Value)).ToList());
+                LogElementAction("loc.combobox.selected.value", string.Join(", ", values.Select(value => $"'{value}'")));
+                return values;
+            }
+        }
+
+        public IList<string> SelectedTexts
+        {
+            get
+            {
+                LogElementAction("loc.combobox.getting.selected.text");
+                var texts = DoWithRetry(() => new SelectElement(GetElement()).AllSelectedOptions.Select(option => option.Text).ToList());
+                LogElementAction("loc.combobox.selected.text", string.Join(", ", texts.Select(value => $"'{value}'")));
+                return texts;
+            }
+        }
+
+        public void DeselectAll()
+        {
+            LogElementAction("loc.multichoicebox.deselect.all");
+            DoWithRetry(() => new SelectElement(GetElement()).DeselectAll());
+        }
+
+        public void DeselectByContainingText(string text)
+        {
+            LogElementAction("loc.multichoicebox.deselect.by.text", text);
+            ApplyFunctionToOptionsThatContain(element => element.Text,
+                    (select, option) => select.DeselectByText(option),
+                    text);
+        }
+
+        public void DeselectByContainingValue(string value)
+        {
+            LogElementAction(LocDeselectingValue, value);
+            ApplyFunctionToOptionsThatContain(element => element.GetAttribute(Attributes.Value),
+                    (select, option) => select.DeselectByValue(option),
+                    value);
+        }
+
+        public void DeselectByIndex(int index)
+        {
+            LogElementAction(LocDeselectingValue, $"#{index}");
+            DoWithRetry(() => new SelectElement(GetElement()).DeselectByIndex(index));
+        }
+
+        public void DeselectByText(string text)
+        {
+            LogElementAction("loc.multichoicebox.deselect.by.text", text);
+            DoWithRetry(() => new SelectElement(GetElement()).DeselectByText(text));
+        }
+
+        public void DeselectByValue(string value)
+        {
+            LogElementAction(LocDeselectingValue, value);
+            DoWithRetry(() => new SelectElement(GetElement()).DeselectByValue(value));
+        }
+
+        public void SelectAll()
+        {
+            LogElementAction("loc.multichoicebox.select.all");
+            ApplyFunctionToOptionsThatContain(element => element.GetAttribute(Attributes.Value),
+                    (select, value) => select.SelectByValue(value),
+                    string.Empty);
+        }
+    }
+}

Aquality.Selenium/src/Aquality.Selenium/Elements/MultiChoiceBox.cs

@@ -41,6 +41,10 @@
   "loc.combobox.get.text.js": "Атрымліваем выбраны тэкст праз JavaScript",
   "loc.combobox.texts": "Спіс тэкстаў опцыяў: [{0}]",
   "loc.combobox.values": "Спіс значэнняў: [{0}]",
+  "loc.multichoicebox": "Камбабокс з мульцівыбарам",
+  "loc.multichoicebox.select.all": "Выбіраем усе значэнні",
+  "loc.multichoicebox.deselect.all": "Адмяняем выбар усіх значэнняў",
+  "loc.multichoicebox.deselect.by.text": "Адмяняем выбар значэння з тэкстам '{0}'",
   "loc.el.getattr": "Атрымліваем атрыбут '{0}'",
   "loc.el.attr.value": "Значэнне атрыбута '{0}': [{1}]",
   "loc.el.attr.set": "Задаем значэнне атрыбута '{0}': [{1}]",
@@ -64,6 +68,7 @@
   "loc.scrolling.center.js": "Пракручваем старонку да цэнтра элемента праз JavaScript",
   "loc.scrolling.js": "Пракручваем старонку праз JavaScript",
   "loc.selecting.value": "Выбіраем значэнне - '{0}'",
+  "loc.deselecting.value": "Адмяняем выбар значэння - '{0}'",
   "loc.send.text": "Задаем тэкст - '{0}'",
   "loc.setting.value": "Задаем значэнне - '{0}'",
   "loc.text.clearing": "Ачышчаем",

Aquality.Selenium/src/Aquality.Selenium/Resources/Localization/be.json

@@ -41,6 +41,10 @@
   "loc.combobox.get.text.js": "Getting selected text via JavaScript",
   "loc.combobox.texts": "Option texts: [{0}]",
   "loc.combobox.values": "Option values: [{0}]",
+  "loc.multichoicebox": "Multi-choice ComboBox",
+  "loc.multichoicebox.select.all": "Select all",
+  "loc.multichoicebox.deselect.all": "Deselect all",
+  "loc.multichoicebox.deselect.by.text": "Deselecting value by text '{0}'",
   "loc.el.getattr": "Getting attribute '{0}'",
   "loc.el.attr.value": "Value of attribute '{0}': [{1}]",
   "loc.el.attr.set": "Setting value of attribute '{0}': [{1}]",
@@ -64,6 +68,7 @@
   "loc.scrolling.center.js": "Scrolling to the center via JavaScript",
   "loc.scrolling.js": "Scrolling via JavaScript",
   "loc.selecting.value": "Selecting value - '{0}'",
+  "loc.deselecting.value": "Deselecting value - '{0}'",
   "loc.send.text": "Setting text - '{0}'",
   "loc.setting.value": "Setting value - '{0}'",
   "loc.text.clearing": "Clearing",