feat: allow bypassing/streamlining of login using browser profiles

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

@@ -0,0 +1,42 @@
+namespace Capgemini.PowerApps.SpecFlowBindings.Configuration
+{
+    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}\\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>
@@ -24,7 +23,7 @@ public class TestConfiguration
         /// </summary>
         public TestConfiguration()
         {
-            this.BrowserOptions = new BrowserOptions();
+            this.BrowserOptions = new BrowserOptionsWithProfileSupport();
         }
 
         /// <summary>
@@ -33,11 +32,17 @@ 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 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.

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/PowerAppsStepDefiner.cs

@@ -1,10 +1,12 @@
 namespace Capgemini.PowerApps.SpecFlowBindings
 {
     using System;
+    using System.Collections.Generic;
     using System.Configuration;
     using System.IO;
     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 +34,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>
@@ -73,6 +77,11 @@ protected static TestConfiguration TestConfig
                             testConfig.BrowserOptions.DriversPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
                         }
                     }
+
+                    if (testConfig.UseProfiles && testConfig.BrowserOptions.BrowserType.SupportsProfiles())
+                    {
+                        GenerateUserProfiles(testConfig.Users);
+                    }
                 }
 
                 return testConfig;
@@ -116,6 +125,22 @@ 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())
+                {
+                    return userProfileDirectories;
+                }
+
+                throw new ArgumentException($"The {testConfig.BrowserOptions.BrowserType} does not support profiles.");
+            }
+        }
+
         /// <summary>
         /// Performs any cleanup necessary when quitting the WebBrowser.
         /// </summary>
@@ -152,5 +177,37 @@ private static IConfidentialClientApplication GetApp()
 
             return app;
         }
+
+        /// <summary>
+        /// Creates a directory for each user to store information specific to a chrome profile.
+        /// </summary>
+        /// <param name="users">List of user to create profile directories for.</param>
+        private static void GenerateUserProfiles(List<UserConfiguration> users)
+        {
+            userProfileDirectories = new Dictionary<string, string>();
+            string profilesDir = $"{Directory.GetCurrentDirectory()}\\profiles";
+            CreateDirectoryIfNotExists(profilesDir);
+
+            foreach (var user in users)
+            {
+                if (userProfileDirectories.ContainsKey(user.Username))
+                {
+                    continue;
+                }
+
+                var userProfileDir = $"{profilesDir}\\{user.Username}";
+                CreateDirectoryIfNotExists(userProfileDir);
+
+                userProfileDirectories.Add(user.Username, userProfileDir);
+            }
+        }
+
+        private static void CreateDirectoryIfNotExists(string directoryPath)
+        {
+            if (!Directory.Exists(directoryPath))
+            {
+                Directory.CreateDirectory(directoryPath);
+            }
+        }
     }
 }

bindings/src/Capgemini.PowerApps.SpecFlowBindings/Steps/LoginSteps.cs

@@ -1,5 +1,8 @@
 namespace Capgemini.PowerApps.SpecFlowBindings.Steps
 {
+    using System;
+    using Capgemini.PowerApps.SpecFlowBindings.Extensions;
+    using Microsoft.Dynamics365.UIAutomation.Api.UCI;
     using Microsoft.Dynamics365.UIAutomation.Browser;
     using OpenQA.Selenium;
     using TechTalk.SpecFlow;
@@ -20,6 +23,12 @@ public static void GivenIAmLoggedInToTheAppAs(string appName, string userAlias)
         {
             var user = TestConfig.GetUser(userAlias);
 
+            if (TestConfig.UseProfiles && TestConfig.BrowserOptions.BrowserType.SupportsProfiles())
+            {
+                TestConfig.BrowserOptions.ProfileDirectory = UserProfileDirectories[user.Username];
+                ForgetExistingAccounts(TestConfig.GetTestUrl());
+            }
+
             XrmApp.OnlineLogin.Login(
                 TestConfig.GetTestUrl(),
                 user.Username.ToSecureString(),
@@ -38,5 +47,18 @@ private static void CloseTeachingBubbles()
                 closeButton.Click();
             }
         }
+
+        // This logic is only required as there is currently a defect in Easy Repro which causes it to not handle the "Pick and Account" dialog
+        // This can be removed when the PR into EasyRepro is merged. https://github.com/microsoft/EasyRepro/pull/1143
+        private static void ForgetExistingAccounts(Uri orgUrl)
+        {
+            Client.Browser.Driver.Navigate().GoToUrl(orgUrl);
+
+            foreach (var existingAccountMenuButton in Driver.FindElements(By.ClassName("tile-menu")))
+            {
+                existingAccountMenuButton.Click();
+                Driver.FindElement(By.Id("forgetLink")).Click();
+            }
+        }
     }
 }

bindings/src/Capgemini.PowerApps.SpecFlowBindings/content/power-apps-bindings.yml

@@ -1,4 +1,5 @@
 url: 
+useProfiles: false
 browserOptions: 
   browserType:
 users: 

bindings/tests/Capgemini.PowerApps.SpecFlowBindings.UiTests/power-apps-bindings.yml

@@ -1,4 +1,5 @@
 url: POWERAPPS_SPECFLOW_BINDINGS_TEST_URL
+useProfiles: true
 browserOptions:
   browserType: Chrome
   headless: true