Possible resolution to #281 - Needs cross-browser testing

This might also need some tidy-up!

Author: craigfowler

CSF.Screenplay.Selenium/Actions/SetTheElementValue.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using CSF.Screenplay.Selenium.Elements;
+using OpenQA.Selenium;
+using static CSF.Screenplay.Selenium.PerformableBuilder;
+
+namespace CSF.Screenplay.Selenium.Actions
+{
+    /// <summary>
+    /// An action that sets the value of a web element using JavaScript.
+    /// </summary>
+    public class SetTheElementValue : ISingleElementPerformable
+    {
+        readonly object value;
+
+        /// <inheritdoc/>
+        public ReportFragment GetReportFragment(Actor actor, Lazy<SeleniumElement> element, IFormatsReportFragment formatter)
+            => formatter.Format("{Actor} uses JavaScript to set the value of {Element} to {Value}", actor, element.Value, value);
+
+        /// <inheritdoc/>
+        public ValueTask PerformAsAsync(ICanPerform actor, IWebDriver webDriver, Lazy<SeleniumElement> element, CancellationToken cancellationToken = default)
+        {
+            return actor.PerformAsync(ExecuteAScript(Scripts.SetElementValue, element.Value, value), cancellationToken);
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SetTheElementValue"/> class.
+        /// </summary>
+        /// <param name="value">The value to set on the element.</param>
+        public SetTheElementValue(object value)
+        {
+            this.value = value;
+        }
+    }
+}

CSF.Screenplay.Selenium/Builders/SetTheValueBuilder.cs

@@ -0,0 +1,29 @@
+using CSF.Screenplay.Selenium.Actions;
+using CSF.Screenplay.Selenium.Elements;
+
+namespace CSF.Screenplay.Selenium
+{
+    /// <summary>
+    /// Builds actions for setting values in Selenium web elements.
+    /// </summary>
+    public class SetTheValueBuilder
+    {
+        readonly ITarget target;
+
+        /// <summary>
+        /// Gets a performable, to set the target element to the value specified in this method.
+        /// </summary>
+        /// <param name="value">The new value for the element</param>
+        /// <returns>A performable</returns>
+        public IPerformable To(object value) => SingleElementPerformableAdapter.From(new SetTheElementValue(value), target);
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SetTheValueBuilder"/> class with the specified target.
+        /// </summary>
+        /// <param name="target">The target web element for which to build value-setting actions.</param>
+        public SetTheValueBuilder(ITarget target)
+        {
+            this.target = target ?? throw new System.ArgumentNullException(nameof(target));
+        }
+    }
+}

CSF.Screenplay.Selenium/PerformableBuilder.elementPerformables.cs

@@ -160,5 +160,19 @@ public static FromTargetActionBuilder SelectTheOptionWithValue(string optionValu
         /// <param name="target">The target element whose contents will be cleared.</param>
         /// <returns>A performable action</returns>
         public static IPerformable ClearTheContentsOf(ITarget target) => SingleElementPerformableAdapter.From(new ClearTheContents(), target);
+
+        /// <summary>
+        /// Gets a builder for an action which sets the value of an element programatically, using JavaScript.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// It is advised to use this technique and others like it sparingly, particularly when using Screenplay/Selenium for testing. Whilst
+        /// it is possible to set values and update the web page's state via JavaScript, this does not properly mimic the manner in which a real
+        /// human being would interact with the page.
+        /// </para>
+        /// </remarks>
+        /// <param name="target">The target HTML element, to have its value updated.</param>
+        /// <returns>A builder with which to choose the new value</returns>
+        public static SetTheValueBuilder SetTheValueOf(ITarget target) => new SetTheValueBuilder(target);
     }
 }

CSF.Screenplay.Selenium/Resources/ScriptResources.cs

@@ -12,6 +12,10 @@ static class ScriptResources
         /// <summary>Gets a short JavaScript for <see cref="Actions.ClearLocalStorage"/>.</summary>
         internal static string ClearLocalStorage => resourceManager.GetString("ClearLocalStorage");
 
+        /// <summary>Gets a short JavaScript that returns the value of <c>document.readyState</c>.</summary>
         internal static string GetDocReadyState => resourceManager.GetString("GetDocReadyState");
+
+        /// <summary>Gets a short JavaScript which sets the <c>value</c> of an HTML element.</summary>
+        internal static string SetElementValue = resourceManager.GetString("SetElementValue");
     }
 }

CSF.Screenplay.Selenium/Resources/ScriptResources.restext

@@ -1,2 +1,3 @@
 ClearLocalStorage = localStorage.clear()
-GetDocReadyState = return document.readyState
+GetDocReadyState = return document.readyState
+SetElementValue = arguments[0].value = arguments[1]

CSF.Screenplay.Selenium/Scripts.cs

@@ -1,3 +1,5 @@
+using CSF.Screenplay.Selenium.Elements;
+
 namespace CSF.Screenplay.Selenium
 {
     /// <summary>
@@ -15,7 +17,6 @@ public static class Scripts
         /// <summary>
         /// Gets a <see cref="NamedScript"/> which clears the Local Storage of the browser, for the current domain.
         /// </summary>
-        /// <returns>A named script.</returns>
         public static NamedScript ClearLocalStorage
             => new NamedScript(Resources.ScriptResources.ClearLocalStorage, "clear the local storage");
 
@@ -28,5 +29,11 @@ public static NamedScript ClearLocalStorage
         /// </remarks>
         public static NamedScriptWithResult<string> GetTheDocumentReadyState
             => new NamedScriptWithResult<string>(Resources.ScriptResources.GetDocReadyState, "get the readiness of the current page");
+
+        /// <summary>
+        /// Gets a <see cref="NamedScript{T1, T2}"/> which sets the <c>value</c> of a specified HTML element.
+        /// </summary>
+        public static NamedScript<SeleniumElement, object> SetElementValue
+            => new NamedScript<SeleniumElement, object>(Resources.ScriptResources.SetElementValue, "set the element's value");
     }
 }

CSF.Screenplay.Selenium/Tasks/EnterTheDate.cs

@@ -51,7 +51,7 @@ public ValueTask PerformAsAsync(ICanPerform actor, CancellationToken cancellatio
         {
             var browseTheWeb = actor.GetAbility<BrowseTheWeb>();
             if(browseTheWeb.WebDriver.HasQuirk(BrowserQuirks.CannotSetInputTypeDateWithSendKeys))
-                throw new NotImplementedException("This has yet to be written, see #281");
+                return actor.PerformAsync(SetTheValueOf(target).To(date.HasValue ? date.Value.ToString("yyyy-MM-dd") : null));
 
             if(!date.HasValue)
                 return actor.PerformAsync(ClearTheContentsOf(target), cancellationToken);