Merge branch 'release/1.0.0' into production

craigfowler · craigfowler · commit 734ce4cbcae6 · 2019-03-27T19:23:27.000Z
diff --git a/.travis.yml b/.travis.yml
@@ -68,8 +68,9 @@ matrix:
     - env:
       - WebDriver_Platform="macOS 10.13"
       - WebDriver_BrowserName="Safari"
-      - WebDriver_BrowserVersion="11.0"
+      - WebDriver_BrowserVersion="11.1"
     - env:
+      - WebDriver_Platform="macOS 10.13"
       - WebDriver_BrowserName="Safari"
       - WebDriver_BrowserVersion="latest"
 
diff --git a/CSF.Screenplay.Selenium.BrowserFlags.Tests/CSF.Screenplay.Selenium.BrowserFlags.Tests.csproj b/CSF.Screenplay.Selenium.BrowserFlags.Tests/CSF.Screenplay.Selenium.BrowserFlags.Tests.csproj
@@ -8,7 +8,7 @@
     <RootNamespace>CSF.Screenplay.Selenium.Tests</RootNamespace>
     <AssemblyName>CSF.Screenplay.Selenium.BrowserFlags.Tests</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <ReleaseVersion>0.5.0-beta</ReleaseVersion>
+    <ReleaseVersion>1.0.0</ReleaseVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
diff --git a/CSF.Screenplay.Selenium.BrowserFlags/CSF.Screenplay.Selenium.BrowserFlags.csproj b/CSF.Screenplay.Selenium.BrowserFlags/CSF.Screenplay.Selenium.BrowserFlags.csproj
@@ -8,7 +8,7 @@
     <RootNamespace>CSF.Screenplay.Selenium</RootNamespace>
     <AssemblyName>CSF.Screenplay.Selenium.BrowserFlags</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <ReleaseVersion>0.5.0-beta</ReleaseVersion>
+    <ReleaseVersion>1.0.0</ReleaseVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
diff --git a/CSF.Screenplay.Selenium.BrowserFlags/CSF.Screenplay.Selenium.BrowserFlags.nuspec b/CSF.Screenplay.Selenium.BrowserFlags/CSF.Screenplay.Selenium.BrowserFlags.nuspec
@@ -2,10 +2,10 @@
 <package>
   <metadata>
     <id>CSF.Screenplay.Selenium.BrowserFlags</id>
-    <version>0.5.0-beta</version>
+    <version>1.0.0</version>
     <title>CSF.Screenplay.Selenium.BrowserFlags</title>
     <authors>CSF Software Ltd</authors>
-    <licenseUrl>https://opensource.org/licenses/MIT</licenseUrl>
+    <license type="expression">MIT</license>
     <projectUrl>https://github.com/csf-dev/CSF.Screenplay.Selenium</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>An assembly containing 'browser flags definitions' for CSF.Screenplay.Selenium. This indicates the quirks and behaviours of various popular web browsers which are compatible with Selenium WebDriver.</description>
diff --git a/CSF.Screenplay.Selenium.BrowserFlags/Properties/AssemblyInfo.cs b/CSF.Screenplay.Selenium.BrowserFlags/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("0.5.0.0")]
+[assembly: AssemblyVersion("1.0.0.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.
diff --git a/CSF.Screenplay.Selenium.JavaScriptWorkarounds/CSF.Screenplay.Selenium.JavaScriptWorkarounds.csproj b/CSF.Screenplay.Selenium.JavaScriptWorkarounds/CSF.Screenplay.Selenium.JavaScriptWorkarounds.csproj
@@ -8,7 +8,7 @@
     <RootNamespace>CSF.Screenplay.Selenium</RootNamespace>
     <AssemblyName>CSF.Screenplay.Selenium.JavaScriptWorkarounds</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <ReleaseVersion>0.5.0-beta</ReleaseVersion>
+    <ReleaseVersion>1.0.0</ReleaseVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
diff --git a/CSF.Screenplay.Selenium.JavaScriptWorkarounds/Properties/AssemblyInfo.cs b/CSF.Screenplay.Selenium.JavaScriptWorkarounds/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("0.5.0.0")]
+[assembly: AssemblyVersion("1.0.0.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.
diff --git a/CSF.Screenplay.Selenium.Tests/CSF.Screenplay.Selenium.Tests.csproj b/CSF.Screenplay.Selenium.Tests/CSF.Screenplay.Selenium.Tests.csproj
@@ -8,7 +8,7 @@
     <RootNamespace>CSF.Screenplay.Selenium.Tests</RootNamespace>
     <AssemblyName>CSF.Screenplay.Selenium.Tests</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <ReleaseVersion>0.5.0-beta</ReleaseVersion>
+    <ReleaseVersion>1.0.0</ReleaseVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
diff --git a/CSF.Screenplay.Selenium.Tests/Waits/WaitUntilVisibleTests.cs b/CSF.Screenplay.Selenium.Tests/Waits/WaitUntilVisibleTests.cs
@@ -43,5 +43,38 @@ public void Wait_UntilVisible_raises_exception_if_we_dont_wait_long_enough(ICast
         When(joe).AttemptsTo(Wait.ForAtMost(2).Seconds().OrUntil(PageThree.DelayedLinkOne).IsVisible());
       });
     }
+
+    [Test,Screenplay]
+    [Description("If the actor's default wait time is not long enough for the element to appear then an exception is raised.")]
+    public void Wait_UntilVisible_raises_exception_if_actors_default_wait_time_is_not_long_enough(ICast cast, BrowseTheWeb browseTheWeb)
+    {
+      var joe = cast.Get("Joe");
+      joe.IsAbleTo(browseTheWeb);
+      joe.IsAbleTo(ChooseADefaultWaitTime.Of(TimeSpan.FromSeconds(2)));
+
+      Given(joe).WasAbleTo(OpenTheirBrowserOn.ThePage<PageThree>());
+
+      When(joe).AttemptsTo(Click.On(PageThree.DelayedButtonOne));
+
+      Assert.Throws<GivenUpWaitingException>(() => {
+        When(joe).AttemptsTo(Wait.Until(PageThree.DelayedLinkOne).IsVisible());
+      });
+    }
+
+    [Test,Screenplay]
+    [Description("If the actor's default wait time is sufficient for the element to appear then no exception is raised.")]
+    public void Wait_UntilVisible_does_not_raise_exception_if_actors_default_wait_time_is_long_enough(ICast cast, BrowseTheWeb browseTheWeb)
+    {
+      var joe = cast.Get("Joe");
+      joe.IsAbleTo(browseTheWeb);
+      joe.IsAbleTo(ChooseADefaultWaitTime.Of(TimeSpan.FromSeconds(5)));
+
+      Given(joe).WasAbleTo(OpenTheirBrowserOn.ThePage<PageThree>());
+
+      When(joe).AttemptsTo(Click.On(PageThree.DelayedButtonOne));
+      When(joe).AttemptsTo(Wait.Until(PageThree.DelayedLinkOne).IsVisible());
+
+      Then(joe).ShouldSee(TheText.Of(PageThree.DelayedLinkOne)).Should().Be("This link appears!");
+    }
   }
 }
diff --git a/CSF.Screenplay.Selenium.sln b/CSF.Screenplay.Selenium.sln
@@ -72,6 +72,6 @@ Global
 		{87454F03-FBB3-4506-9055-551297445891} = {ED939EED-BD26-4C3C-9089-48E04DD01CD8}
 	EndGlobalSection
 	GlobalSection(MonoDevelopProperties) = preSolution
-		version = 0.5.0-beta
+		version = 1.0.0
 	EndGlobalSection
 EndGlobal
diff --git a/CSF.Screenplay.Selenium/Abilities/ChooseADefaultWaitTime.cs b/CSF.Screenplay.Selenium/Abilities/ChooseADefaultWaitTime.cs
@@ -0,0 +1,62 @@
+﻿//
+// SetADefaultWaitTime.cs
+//
+// Author:
+//       Craig Fowler <craig@csf-dev.com>
+//
+// Copyright (c) 2019 Craig Fowler
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+using System;
+using CSF.Screenplay.Abilities;
+
+namespace CSF.Screenplay.Selenium.Abilities
+{
+  /// <summary>
+  /// An ability which allows an actor to specify/choose a default amount of time to wait.
+  /// This default waiting-time applies to all web-driver-wait scenarios where no waiting time has been specified.
+  /// Actors without this ability use a hard-coded default of ten seconds for waits.
+  /// </summary>
+  public class ChooseADefaultWaitTime : Ability
+  {
+    readonly TimeSpan timeout;
+
+    /// <summary>
+    /// Gets the wait timeout.
+    /// </summary>
+    /// <value>The timeout.</value>
+    public TimeSpan Timeout => timeout;
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="ChooseADefaultWaitTime"/> class.
+    /// </summary>
+    /// <param name="timeout">Timeout.</param>
+    public ChooseADefaultWaitTime(TimeSpan timeout)
+    {
+      this.timeout = timeout;
+    }
+
+    /// <summary>
+    /// Static builder function to get a new instance of this ability.
+    /// </summary>
+    /// <returns>An instance of the ability.</returns>
+    /// <param name="timeout">Timeout.</param>
+    public static ChooseADefaultWaitTime Of(TimeSpan timeout) => new ChooseADefaultWaitTime(timeout);
+  }
+}
diff --git a/CSF.Screenplay.Selenium/Builders/Wait.cs b/CSF.Screenplay.Selenium/Builders/Wait.cs
@@ -13,8 +13,6 @@ namespace CSF.Screenplay.Selenium.Builders
   /// </summary>
   public class Wait
   {
-    static readonly IProvidesTimespan DefaultTimeout = new TimespanWrapper(TimeSpan.FromSeconds(4));
-
     IProvidesTimespan timespanProvider;
     ITarget target;
 
@@ -57,11 +55,7 @@ public static Wait Until(ITarget target)
       if(target == null)
         throw new ArgumentNullException(nameof(target));
       
-      return new Wait
-      {
-        target = target,
-        timespanProvider = DefaultTimeout,
-      };
+      return new Wait { target = target };
     }
 
     /// <summary>
@@ -72,20 +66,20 @@ public static Wait Until(ITarget target)
     /// <param name="conditionName">A name for the condition.</param>
     public static IPerformable Until(Func<IWebDriver,bool> expectedCondition, string conditionName)
     {
-      return new WaitForACondition(expectedCondition, conditionName, DefaultTimeout.GetTimespan());
+      return new WaitForACondition(expectedCondition, conditionName, null);
     }
 
     /// <summary>
     /// Gets a 'wait' performable which completes once the page has finished loading, using the default timeout.
     /// </summary>
     /// <returns>The performable.</returns>
-    public static IPerformable UntilThePageLoads() => new WaitUntilThePageLoads(DefaultTimeout.GetTimespan());
+    public static IPerformable UntilThePageLoads() => new WaitUntilThePageLoads(null);
 
     /// <summary>
     /// Gets a 'wait' performable which completes once the page has finished loading.
     /// </summary>
     /// <returns>The performable.</returns>
-    public IPerformable OrUntilThePageLoads() => new WaitUntilThePageLoads(timespanProvider.GetTimespan());
+    public IPerformable OrUntilThePageLoads() => new WaitUntilThePageLoads(timespanProvider?.GetTimespan());
 
     /// <summary>
     /// Gets a wait builder for a given target.
@@ -173,7 +167,7 @@ ITargettedWait GetTargettedWait<T>(IQuery<T> query, Func<T,bool> predicate)
       if(target == null)
         throw new InvalidOperationException("You must choose a target.");
 
-      return new TargettedWait<T>(target, query, predicate, timespanProvider.GetTimespan());
+      return new TargettedWait<T>(target, query, predicate, timespanProvider?.GetTimespan());
     }
   }
 }
diff --git a/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.csproj b/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.csproj
@@ -8,7 +8,7 @@
     <RootNamespace>CSF.Screenplay.Selenium</RootNamespace>
     <AssemblyName>CSF.Screenplay.Selenium</AssemblyName>
     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
-    <ReleaseVersion>0.5.0-beta</ReleaseVersion>
+    <ReleaseVersion>1.0.0</ReleaseVersion>
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -210,6 +210,9 @@
     <Compile Include="ITracksWebDriverCreation.cs" />
     <Compile Include="Builders\Matches.cs" />
     <Compile Include="Builders\MatcherBuilderExtensions.cs" />
+    <Compile Include="ScreenplayConstants.cs" />
+    <Compile Include="Abilities\ChooseADefaultWaitTime.cs" />
+    <Compile Include="Waits\GetDuration.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />
diff --git a/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.nuspec b/CSF.Screenplay.Selenium/CSF.Screenplay.Selenium.nuspec
@@ -2,10 +2,10 @@
 <package>
   <metadata>
     <id>CSF.Screenplay.Selenium</id>
-    <version>0.5.0-beta</version>
+    <version>1.0.0</version>
     <title>CSF.Screenplay.Selenium</title>
     <authors>CSF Software Ltd</authors>
-    <licenseUrl>https://opensource.org/licenses/MIT</licenseUrl>
+    <license type="expression">MIT</license>
     <projectUrl>https://github.com/csf-dev/CSF.Screenplay.Selenium</projectUrl>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>Extension to CSF.Screenplay, providing an ability, actions and tasks for Selenium WebDriver for web UI testing using the Screenplay pattern</description>
@@ -15,9 +15,9 @@
       <dependency id="CSF.Utils" version="[6.1.1,7.0.0)" />
       <dependency id="Selenium.WebDriver" version="[3.4.0,4.0.0)" />
       <dependency id="Selenium.Support" version="[3.4.0,4.0.0)" />
-      <dependency id="CSF.Screenplay" version="0.14.0-beta" />
+      <dependency id="CSF.Screenplay" version="[1.0.0,2.0.0)" />
       <dependency id="CSF.WebDriverExtras" version="[1.0.3,2.0.0)" />
-      <dependency id="CSF.Screenplay.Selenium.BrowserFlags" version="0.5.0-beta" />
+      <dependency id="CSF.Screenplay.Selenium.BrowserFlags" version="[1.0.0,2.0.0)" />
     </dependencies>
   </metadata>
   <files>
diff --git a/CSF.Screenplay.Selenium/Properties/AssemblyInfo.cs b/CSF.Screenplay.Selenium/Properties/AssemblyInfo.cs
@@ -17,7 +17,7 @@
 // The form "{Major}.{Minor}.*" will automatically update the build and revision,
 // and "{Major}.{Minor}.{Build}.*" will update just the revision.
 
-[assembly: AssemblyVersion("0.5.0.0")]
+[assembly: AssemblyVersion("1.0.0.0")]
 
 // The following attributes are used to specify the signing key for the assembly, 
 // if desired. See the Mono documentation for more information about signing.
diff --git a/CSF.Screenplay.Selenium/ScreenplayConstants.cs b/CSF.Screenplay.Selenium/ScreenplayConstants.cs
@@ -0,0 +1,33 @@
+﻿//
+// ScreenplayConstant.cs
+//
+// Author:
+//       Craig Fowler <craig@csf-dev.com>
+//
+// Copyright (c) 2019 Craig Fowler
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+using System;
+namespace CSF.Screenplay.Selenium
+{
+  static class ScreenplayConstants
+  {
+    public static readonly TimeSpan DefaultWait = TimeSpan.FromSeconds(10);
+  }
+}
diff --git a/CSF.Screenplay.Selenium/Waits/GetDuration.cs b/CSF.Screenplay.Selenium/Waits/GetDuration.cs
@@ -0,0 +1,50 @@
+﻿//
+// GetWaitDuration.cs
+//
+// Author:
+//       Craig Fowler <craig@csf-dev.com>
+//
+// Copyright (c) 2019 Craig Fowler
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+using System;
+using CSF.Screenplay.Actors;
+using CSF.Screenplay.Selenium.Abilities;
+
+namespace CSF.Screenplay.Selenium.Waits
+{
+  static class GetDuration
+  {
+    public static TimeSpan ToWait(TimeSpan? specifiedWaitTime, INamed actor)
+      => ToWait(specifiedWaitTime, actor as IPerformer);
+
+    public static TimeSpan ToWait(TimeSpan? specifiedWaitTime, IPerformer actor)
+      => specifiedWaitTime ?? GetActorWaitTime(actor) ?? GetDefaultWaitTime();
+
+    static TimeSpan GetDefaultWaitTime() => ScreenplayConstants.DefaultWait;
+
+    static TimeSpan? GetActorWaitTime(IPerformer actor)
+    {
+      if(actor == null) return null;
+      if(!actor.HasAbility<ChooseADefaultWaitTime>()) return null;
+      var ability = actor.GetAbility<ChooseADefaultWaitTime>();
+      return ability.Timeout;
+    }
+  }
+}
diff --git a/CSF.Screenplay.Selenium/Waits/TargettedWait.cs b/CSF.Screenplay.Selenium/Waits/TargettedWait.cs
diff --git a/CSF.Screenplay.Selenium/Waits/WaitForACondition.cs b/CSF.Screenplay.Selenium/Waits/WaitForACondition.cs
diff --git a/CSF.Screenplay.Selenium/Waits/WaitUntilThePageLoads.cs b/CSF.Screenplay.Selenium/Waits/WaitUntilThePageLoads.cs
diff --git a/CSF.Screenplay.WebTestWebsite/CSF.Screenplay.WebTestWebsite.csproj b/CSF.Screenplay.WebTestWebsite/CSF.Screenplay.WebTestWebsite.csproj
