feat: allow bypassing/streamlining of login using browser profiles

README.md

@@ -54,6 +54,7 @@ Installing the NuGet package creates a _power-apps-bindings.yml_ file in your pr
 
 ```yaml
 url: SPECFLOW_POWERAPPS_URL # mandatory
+useProfiles: false # defaults to false if not provided
 browserOptions: # optional - will use default EasyRepro options if not set
   browserType: Chrome
   headless: true
@@ -73,6 +74,9 @@ users: # mandatory
 
 The URL, driversPath, usernames, passwords, and application user details will be set from environment variable (if found). Otherwise, the value from the config file will be used. The browserOptions node supports anything in the EasyRepro `BrowserOptions` class.
 
+#### User Profiles
+Setting the `useProfiles` property to true causes the solution to create and use a unique [profile](https://support.google.com/chrome/answer/2364824?co=GENIE.Platform%3DDesktop&hl=en) for each user listed in the config file. This currently only works in Chrome & Firefox and attempting to use it with Edge or IE will cause an exception to be thrown. By using profiles test runs for the same user will not be required to re-authenticate, this saves time during test runs. [To take full advantage of this you will need to have the "Stay Signed In" prompt enabled.](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/keep-me-signed-in)
+
 ### Writing feature files
 
 You can use the predefined step bindings to write your tests.

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Capgemini.PowerApps.SpecFlowBindings.csproj

@@ -63,6 +63,7 @@
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+    <PackageReference Include="Polly" Version="7.2.2" />
     <PackageReference Include="Selenium.Support" Version="3.141.0" />
     <PackageReference Include="Selenium.WebDriver" Version="3.141.0" />
     <PackageReference Include="SpecFlow" Version="3.5.14" />

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Configuration/BrowserOptionsWithProfileSupport.cs

@@ -0,0 +1,43 @@
+namespace Capgemini.PowerApps.SpecFlowBindings.Configuration
+{
+    using System.IO;
+    using Microsoft.Dynamics365.UIAutomation.Browser;
+    using OpenQA.Selenium.Chrome;
+    using OpenQA.Selenium.Firefox;
+
+    /// <summary>
+    /// Extends the EasyRepro <see cref="BrowserOptions"/> class with additonal support for chrome profiles.
+    /// </summary>
+    public class BrowserOptionsWithProfileSupport : BrowserOptions
+    {
+        /// <summary>
+        /// Gets or sets the directory to use as the user profile.
+        /// </summary>
+        public string ProfileDirectory { get; set; }
+
+        /// <inheritdoc/>
+        public override ChromeOptions ToChrome()
+        {
+            var options = base.ToChrome();
+            if (!string.IsNullOrEmpty(this.ProfileDirectory))
+            {
+                options.AddArgument($"--user-data-dir={this.ProfileDirectory}");
+            }
+
+            return options;
+        }
+
+        /// <inheritdoc/>
+        public override FirefoxOptions ToFireFox()
+        {
+            var options = base.ToFireFox();
+            if (!string.IsNullOrEmpty(this.ProfileDirectory))
+            {
+                this.ProfileDirectory = this.ProfileDirectory.EndsWith("firefox") ? this.ProfileDirectory : Path.Combine(this.ProfileDirectory, "firefox");
+                options.AddArgument($"-profile \"{this.ProfileDirectory}\"");
+            }
+
+            return options;
+        }
+    }
+}

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Configuration/TestConfiguration.cs

@@ -4,7 +4,6 @@
     using System.Collections.Generic;
     using System.Configuration;
     using System.Linq;
-    using Microsoft.Dynamics365.UIAutomation.Browser;
     using YamlDotNet.Serialization;
 
     /// <summary>
@@ -18,13 +17,13 @@ public class TestConfiguration
         public const string FileName = "power-apps-bindings.yml";
 
         private const string GetUserException = "Unable to retrieve user configuration. Please ensure a user with the given alias exists in the config.";
-
+        private string profilesBasePath;
         /// <summary>
         /// Initializes a new instance of the <see cref="TestConfiguration"/> class.
         /// </summary>
         public TestConfiguration()
         {
-            this.BrowserOptions = new BrowserOptions();
+            this.BrowserOptions = new BrowserOptionsWithProfileSupport();
         }
 
         /// <summary>
@@ -33,11 +32,23 @@ public TestConfiguration()
         [YamlMember(Alias = "url")]
         public string Url { private get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to use profiles.
+        /// </summary>
+        [YamlMember(Alias = "useProfiles")]
+        public bool UseProfiles { get; set; } = false;
+
+        /// <summary>
+        /// Gets or sets the base path where the user profiles are stored.
+        /// </summary>
+        [YamlMember(Alias = "profilesBasePath")]
+        public string ProfilesBasePath { get => ConfigHelper.GetEnvironmentVariableIfExists(this.profilesBasePath); set => this.profilesBasePath = value; }
+
         /// <summary>
         /// Gets or sets the browser options to use for running tests.
         /// </summary>
         [YamlMember(Alias = "browserOptions")]
-        public BrowserOptions BrowserOptions { get; set; }
+        public BrowserOptionsWithProfileSupport BrowserOptions { get; set; }
 
         /// <summary>
         /// Gets or sets users that tests can be run as.
@@ -63,17 +74,23 @@ public Uri GetTestUrl()
         /// <summary>
         /// Retrieves the configuration for a user.
         /// </summary>
-        /// <param name="userAlias">The alias of the user.</param>
+        /// <param name="userAliasOrUsername">The alias or username of the user.</param>
         /// <returns>The user configuration.</returns>
-        public UserConfiguration GetUser(string userAlias)
+        public UserConfiguration GetUser(string userAliasOrUsername)
         {
             try
             {
-                return this.Users.First(u => u.Alias == userAlias);
+                UserConfiguration user = this.Users.FirstOrDefault(u => u.Alias == userAliasOrUsername);
+                if (user != null)
+                {
+                    return user;
+                }
+
+                return this.Users.First(u => u.Username == userAliasOrUsername);
             }
             catch (Exception ex)
             {
-                throw new ConfigurationErrorsException($"{GetUserException} User: {userAlias}", ex);
+                throw new ConfigurationErrorsException($"{GetUserException} User: {userAliasOrUsername}", ex);
             }
         }
     }

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Extensions/BrowserTypeExtensions.cs

@@ -0,0 +1,34 @@
+namespace Capgemini.PowerApps.SpecFlowBindings.Extensions
+{
+    using Microsoft.Dynamics365.UIAutomation.Browser;
+
+    /// <summary>
+    /// Provides extension methods on <see cref="BrowserType"/>.
+    /// </summary>
+    public static class BrowserTypeExtensions
+    {
+        /// <summary>
+        /// Determines if the given browser type supports profiles.
+        /// </summary>
+        /// <param name="type">The <see cref="BrowserType"/> to check.</param>
+        /// <returns>true if the browser supports profiles otherwise false.</returns>
+        public static bool SupportsProfiles(this BrowserType type)
+        {
+            switch (type)
+            {
+                case BrowserType.IE:
+                    return false;
+                case BrowserType.Chrome:
+                    return true;
+                case BrowserType.Firefox:
+                    return true;
+                case BrowserType.Edge:
+                    return false;
+                case BrowserType.Remote:
+                    return false;
+                default:
+                    return false;
+            }
+        }
+    }
+}

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Hooks/AfterScenarioHooks.cs

@@ -1,8 +1,12 @@
 namespace Capgemini.PowerApps.SpecFlowBindings.Hooks
 {
+    using Capgemini.PowerApps.SpecFlowBindings.Configuration;
+    using Microsoft.Dynamics365.UIAutomation.Browser;
+    using OpenQA.Selenium;
+    using Polly;
+    using System;
     using System.IO;
     using System.Reflection;
-    using OpenQA.Selenium;
     using TechTalk.SpecFlow;
 
     /// <summary>
@@ -52,6 +56,7 @@ public void ScreenshotFailedScenario()
             {
                 var rootFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
                 var screenshotsFolder = Path.Combine(rootFolder, "screenshots");
+                Console.WriteLine(screenshotsFolder);
 
                 if (!Directory.Exists(screenshotsFolder))
                 {
@@ -64,5 +69,39 @@ public void ScreenshotFailedScenario()
                     ScreenshotImageFormat.Jpeg);
             }
         }
+
+        /// <summary>
+        /// Deletes the user profiles used for this scenario.
+        /// </summary>
+        [AfterScenario(Order = 0)]
+        public void CleanUpProfileDirectory()
+        {
+            Client.Browser.BrowserDisposing += new EventHandler<EventArgs>(this.TryCleanupProfile);
+        }
+
+        private void TryCleanupProfile(object sender, EventArgs e)
+        {
+            BrowserOptionsWithProfileSupport options = (sender as InteractiveBrowser).Options as BrowserOptionsWithProfileSupport;
+            var retryPolicy = Policy
+                .Handle<UnauthorizedAccessException>()
+                .Or<IOException>()
+                .WaitAndRetry(new[]
+                {
+                        3.Seconds(),
+                        5.Seconds(),
+                        10.Seconds(),
+                        15.Seconds(),
+                });
+            var fallbackPolicy = Policy
+                .Handle<UnauthorizedAccessException>()
+                .Or<IOException>()
+                .Fallback(() =>
+                {
+                    // Give up trying to delete the profile folder.
+                    Console.WriteLine("Failed to clean up user data dir as the browser has not exited after 33 seconds.");
+                });
+            var retryWithFallback = fallbackPolicy.Wrap(retryPolicy);
+            retryWithFallback.Execute(() => new DirectoryInfo(options.ProfileDirectory).Delete(true));
+        }
     }
 }

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Hooks/BeforeRunHooks.cs

@@ -0,0 +1,42 @@
+namespace Capgemini.PowerApps.SpecFlowBindings.Hooks
+{
+    using System.IO;
+    using Capgemini.PowerApps.SpecFlowBindings.Configuration;
+    using Capgemini.PowerApps.SpecFlowBindings.Steps;
+    using TechTalk.SpecFlow;
+
+    /// <summary>
+    /// Hooks that run before the start of each run.
+    /// </summary>
+    [Binding]
+    public class BeforeRunHooks : PowerAppsStepDefiner
+    {
+        /// <summary>
+        /// Creates a new folder for the scenario and copies the session/cookies information from previous runs
+        /// </summary>
+        [BeforeTestRun]
+        public static void BaseProfileSetup()
+        {
+            if (!TestConfig.UseProfiles)
+            {
+                return;
+            }
+
+            foreach (var username in UserProfileDirectories.Keys)
+            {
+                var profileDirectory = UserProfileDirectories[username];
+                if (Directory.GetDirectories(profileDirectory).Length == 0)
+                {
+                    var baseDirectory = Path.Combine(profileDirectory, "base");
+                    Directory.CreateDirectory(baseDirectory);
+
+                    TestConfig.BrowserOptions.ProfileDirectory = baseDirectory;
+
+                    UserConfiguration user = TestConfig.GetUser(username);
+                    LoginSteps.Login(Driver, TestConfig.GetTestUrl(), user.Username, user.Password);
+                    Quit();
+                }
+            }
+        }
+    }
+}

bindings/src/Capgemini.PowerApps.SpecFlowBindings/PowerAppsStepDefiner.cs

@@ -1,10 +1,13 @@
 namespace Capgemini.PowerApps.SpecFlowBindings
 {
     using System;
+    using System.Collections.Generic;
     using System.Configuration;
     using System.IO;
+    using System.Linq;
     using System.Reflection;
     using Capgemini.PowerApps.SpecFlowBindings.Configuration;
+    using Capgemini.PowerApps.SpecFlowBindings.Extensions;
     using Microsoft.Dynamics365.UIAutomation.Api.UCI;
     using Microsoft.Identity.Client;
     using OpenQA.Selenium;
@@ -32,6 +35,8 @@ public abstract class PowerAppsStepDefiner
         [ThreadStatic]
         private static XrmApp xrmApp;
 
+        private static Dictionary<string, string> userProfileDirectories;
+
         /// <summary>
         /// Gets access token used to authenticate as the application user configured for testing.
         /// </summary>
@@ -116,6 +121,47 @@ protected static ITestDriver TestDriver
             }
         }
 
+        /// <summary>
+        /// Gets the directories for the chrome profiles if the brower type is chrome.
+        /// </summary>
+        protected static Dictionary<string, string> UserProfileDirectories
+        {
+            get
+            {
+                if (!testConfig.BrowserOptions.BrowserType.SupportsProfiles())
+                {
+                    throw new NotSupportedException($"The {testConfig.BrowserOptions.BrowserType} does not support profiles.");
+                }
+
+                if (userProfileDirectories != null)
+                {
+                    return userProfileDirectories;
+                }
+
+                var directoriesDictionary = new Dictionary<string, string>();
+
+                var basePath = string.IsNullOrEmpty(TestConfig.ProfilesBasePath) ? Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location) : TestConfig.ProfilesBasePath;
+                string profilesDir = Path.Combine(basePath, "profiles");
+                Directory.CreateDirectory(profilesDir);
+
+                foreach (var username in TestConfig.Users.Select(u => u.Username).ToList())
+                {
+                    if (directoriesDictionary.ContainsKey(username))
+                    {
+                        continue;
+                    }
+
+                    var userProfileDir = Path.Combine(profilesDir, username);
+                    Directory.CreateDirectory(userProfileDir);
+
+                    directoriesDictionary.Add(username, userProfileDir);
+                }
+
+                userProfileDirectories = directoriesDictionary;
+                return userProfileDirectories;
+            }
+        }
+
         /// <summary>
         /// Performs any cleanup necessary when quitting the WebBrowser.
         /// </summary>