Device Code Flow Selenium tests (#718)

Author: bgavrilMS

LibsNoSamples.sln

@@ -25,6 +25,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Identity.Test.Sid
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Microsoft.Identity.Client.Ref", "src\Microsoft.Identity.Client.Ref\Microsoft.Identity.Client.Ref.csproj", "{528C5488-C0D8-45C3-BEAC-3E52C22631C9}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "ref", "ref", "{528F34D9-FF6B-4AAE-8367-182EC19DAB5F}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.Identity.Test.Core.UIAutomation", "tests\Microsoft.Identity.Test.Core.UIAutomation\Microsoft.Identity.Test.Core.UIAutomation.csproj", "{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -59,6 +63,10 @@ Global
 		{528C5488-C0D8-45C3-BEAC-3E52C22631C9}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{528C5488-C0D8-45C3-BEAC-3E52C22631C9}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{528C5488-C0D8-45C3-BEAC-3E52C22631C9}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -69,6 +77,8 @@ Global
 		{30287EC8-BD85-41CC-BDCB-9DBF9EFBCC98} = {5D231979-0A13-456D-B9F9-CED41F935FD9}
 		{E22918A8-8FE6-47D2-B65E-34436918C5D7} = {5D231979-0A13-456D-B9F9-CED41F935FD9}
 		{D3033A40-F2C2-4495-BC9F-C3C6D497D1CC} = {5D231979-0A13-456D-B9F9-CED41F935FD9}
+		{528C5488-C0D8-45C3-BEAC-3E52C22631C9} = {528F34D9-FF6B-4AAE-8367-182EC19DAB5F}
+		{3DC6EC76-D350-4D43-B206-A4CEC8AA36D4} = {5D231979-0A13-456D-B9F9-CED41F935FD9}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {6C88EF77-AF03-4F82-B666-1831DABAA119}

tests/Microsoft.Identity.Test.Common/TestCategories.cs

@@ -0,0 +1,41 @@
+//----------------------------------------------------------------------
+//
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// 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.
+//
+//------------------------------------------------------------------------------
+
+namespace Microsoft.Identity.Test.Common
+{
+    public static class TestCategories
+    {
+        /// <summary>
+        /// Tests under this category use a Selenium driven browser (Chrome) to automate the web ui.
+        /// When run in the lab, the browser is configured to run headless.
+        /// For debugging, consider running with the actual browser. 
+        /// </summary>
+        public const string Selenium = "Selenium";
+        public const string LabAccess = "LabAccess";
+
+    }
+}

tests/Microsoft.Identity.Test.LabInfrastructure/LabUser.cs

@@ -79,6 +79,22 @@ public LabUser() { }
         [JsonProperty("b2cProvider")]
         public B2CIdentityProvider B2CIdentityProvider { get; set; }
 
+
+        private string _password = null;
+
+        public string Password
+        {
+            get
+            {
+                if (_password == null)
+                {
+                    _password = LabUserHelper.GetUserPassword(this);
+                }
+
+                return _password;
+            }
+        }
+
         public void InitializeHomeUser()
         {
             HomeUser = new LabUser();

tests/Microsoft.Identity.Test.LabInfrastructure/LabUserHelper.cs

@@ -26,6 +26,7 @@
 //------------------------------------------------------------------------------
 
 using System;
+using System.Diagnostics;
 
 namespace Microsoft.Identity.Test.LabInfrastructure
 {

tests/Microsoft.Identity.Test.Unit.net45/AuthorityAliasesTests.cs

@@ -62,7 +62,7 @@ internal void TestInitialize(MockHttpManager httpManager)
         [Description("Test authority migration")]
         public void AuthorityMigration_IntegrationTest()
         {
-            // make sure that for all network calls "preferred_cache" enironment is used
+            // make sure that for all network calls "preferred_cache" environment is used
             // (it is taken from metadata in instance discovery response),
             // except very first network call - instance discovery
 

tests/Microsoft.Identity.Test.Unit.net45/Integration/DeviceCodeFlowIntegrationTest.cs

@@ -0,0 +1,146 @@
+//------------------------------------------------------------------------------
+//
+// Copyright (c) Microsoft Corporation.
+// All rights reserved.
+//
+// This code is licensed under the MIT License.
+//
+// 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 System.Diagnostics;
+using System.Net;
+using System.Threading.Tasks;
+using Microsoft.Identity.Client;
+using Microsoft.Identity.Test.Common;
+using Microsoft.Identity.Test.Core.UIAutomation;
+using Microsoft.Identity.Test.LabInfrastructure;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium;
+
+namespace Microsoft.Identity.Test.Unit.Integration
+{
+    // Important: do not install a NuGet package with the Chrome driver as it is a security risk.
+    // Instead, install the Chrome driver on the test machine
+
+    // Note: these tests require permission to a KeyVault Microsoft account;
+    // Please ignore them if you are not a Microsoft FTE, they will run as part of the CI build
+    [TestClass]
+    [TestCategory(TestCategories.Selenium)]
+    [TestCategory(TestCategories.LabAccess)]
+    public class DeviceCodeFlow
+    {
+        private static readonly string[] Scopes = { "User.Read" };
+        private SeleniumWrapper _seleniumWrapper;
+
+        #region MSTest Hooks
+        /// <summary>
+        /// Initialized by MSTest (do not make private or readonly)
+        /// </summary>
+        public TestContext TestContext { get; set; }
+
+        [ClassInitialize]
+        public static void ClassInitialize(TestContext context)
+        {
+            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
+        }
+
+        [TestInitialize]
+        public void TestInitialize()
+        {
+            TestCommon.ResetState();
+            _seleniumWrapper = new SeleniumWrapper();
+        }
+
+        [TestCleanup]
+        public void Cleanup()
+        {
+            _seleniumWrapper?.Dispose();
+        }
+        #endregion
+
+        [TestMethod]
+        [Timeout(1 * 60 * 1000)] // 1 min timeout
+        public async Task DeviceCodeFlowTestAsync()
+        {            
+            LabResponse labResponse = LabUserHelper.GetDefaultUser();
+
+            Trace.WriteLine("Calling AcquireTokenWithDeviceCodeAsync");
+            PublicClientApplication pca = new PublicClientApplication(labResponse.AppId);
+            var result = await pca.AcquireTokenWithDeviceCodeAsync(Scopes, deviceCodeResult =>
+            {
+                RunAutomatedDeviceCodeFlow(deviceCodeResult, labResponse.User);
+
+                return Task.FromResult(0);
+            }).ConfigureAwait(false);
+
+            Trace.WriteLine("Running asserts");
+
+            Assert.IsNotNull(result);
+            Assert.IsTrue(!string.IsNullOrEmpty(result.AccessToken));
+        }
+
+        private void RunAutomatedDeviceCodeFlow(DeviceCodeResult deviceCodeResult, LabUser user)
+        {
+            IWebDriver driver = _seleniumWrapper.Driver;
+            try
+            {
+                Trace.WriteLine("Browser is open. Navigating to the Device Code url and entering the code");
+
+                driver.Navigate().GoToUrl(deviceCodeResult.VerificationUrl);
+                driver.FindElement(By.Id("code")).SendKeys(deviceCodeResult.UserCode);
+
+                IWebElement continueBtn = _seleniumWrapper.WaitForElementToBeVisibleAndEnabled(By.Id("continueBtn"));
+                continueBtn?.Click();
+
+                PerformLogin(user);
+
+                Trace.WriteLine("Authentication complete");
+
+            }
+            catch (Exception ex)
+            {
+                Trace.WriteLine("Browser automation failed " + ex);
+                _seleniumWrapper.SaveScreenshot(TestContext);
+                throw;
+            }
+        }
+
+        private void PerformLogin(LabUser user)
+        {
+            UserInformationFieldIds fields = new UserInformationFieldIds();
+            fields.DetermineFieldIds(user);
+
+            IWebDriver driver = _seleniumWrapper.Driver;
+
+            Trace.WriteLine("Logging in ... Entering username");
+            driver.FindElement(By.Id(CoreUiTestConstants.WebUPNInputID)).SendKeys(user.Upn); 
+
+            Trace.WriteLine("Logging in ... Clicking next after username");
+            driver.FindElement(By.Id(fields.SignInButtonId)).Click(); 
+
+            Trace.WriteLine("Logging in ... Entering password");
+            _seleniumWrapper.WaitForElementToBeVisibleAndEnabled(By.Id(fields.PasswordInputId)).SendKeys(user.Password); 
+
+            Trace.WriteLine("Logging in ... Clicking next after password");
+            _seleniumWrapper.WaitForElementToBeVisibleAndEnabled(By.Id(fields.SignInButtonId)).Click(); 
+        }
+    }
+}

tests/Microsoft.Identity.Test.Unit.net45/Microsoft.Identity.Test.Unit.net45.csproj

@@ -30,10 +30,16 @@
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.9.0" />
     <PackageReference Include="MSTest.TestAdapter" Version="1.3.1" />
     <PackageReference Include="MSTest.TestFramework" Version="1.3.1" />
+    <PackageReference Include="StrongNamer" Version="0.0.8" />
     <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="5.2.4" />
     <!-- This reference is a workaround for a bug in .net46
     https://stackoverflow.com/questions/45563560/could-not-load-file-or-assembly-system-net-http-version-4-1-1-1-net-standard-->
     <PackageReference Include="System.Net.Http" Version="4.3.3" />
+    <PackageReference Include="Selenium.WebDriver" Version="3.141.0" />
+    
+    <Compile Include="../Microsoft.Identity.Test.Core.UIAutomation/UserInformationFieldIds.cs" LinkBase="Integration"></Compile>
+    <Compile Include="../Microsoft.Identity.Test.Core.UIAutomation/CoreUiTestConstants.cs" LinkBase="Integration"></Compile>
+    
 
     <Compile Remove="Resources\**" />
     <EmbeddedResource Remove="Resources\**" />

tests/Microsoft.Identity.Test.Unit.net45/SeleniumWrapper.cs

@@ -0,0 +1,98 @@
+using OpenQA.Selenium;
+using System;
+using System.IO;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using OpenQA.Selenium.Chrome;
+using OpenQA.Selenium.Support.UI;
+using System.Diagnostics;
+
+namespace Microsoft.Identity.Test.Unit
+{
+    public class SeleniumWrapper : IDisposable
+    {
+        public SeleniumWrapper()
+        {
+            ChromeOptions chromeOptions = new ChromeOptions();
+
+            // ~2x faster, no visual rendering
+            // remove when debugging to see the UI automation
+            chromeOptions.AddArguments("headless");
+
+            Driver = new ChromeDriver(chromeOptions);
+            Driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(5);
+        }
+
+        public IWebDriver Driver { get; }
+
+        private int _picNumber = 1;
+
+        public void SaveScreenshot(TestContext testContext, string name = "failure")
+        {
+            Screenshot ss = ((ITakesScreenshot)Driver).GetScreenshot();
+            string picName = name + _picNumber++ + ".png";
+            #if DESKTOP // Can't attach a file on netcore because mstest doesn't support it
+            string failurePicturePath = Path.Combine(testContext.TestResultsDirectory, picName);
+            #else
+            string failurePicturePath = Path.Combine(Directory.GetCurrentDirectory(), picName);
+            #endif
+
+            Trace.WriteLine($"Saving picture to {failurePicturePath}");
+            ss.SaveAsFile(failurePicturePath, ScreenshotImageFormat.Png);
+
+#if DESKTOP // Can't attach a file to the logs on netcore because mstest doesn't support it
+            testContext.AddResultFile(failurePicturePath);
+#endif
+        }
+
+        public IWebElement WaitForElementToBeVisibleAndEnabled(By by)
+        {
+            WebDriverWait webDriverWait = new WebDriverWait(Driver, TimeSpan.FromSeconds(10));
+            IWebElement continueBtn = webDriverWait.Until(dr =>
+            {
+                try
+                {
+                    var elementToBeDisplayed = Driver.FindElement(by);
+                    if (elementToBeDisplayed.Displayed && elementToBeDisplayed.Enabled)
+                    {
+                        return elementToBeDisplayed;
+                    }
+                    return null;
+                }
+                catch (StaleElementReferenceException)
+                {
+                    return null;
+                }
+                catch (NoSuchElementException)
+                {
+                    return null;
+                }
+            });
+            return continueBtn;
+        }
+
+        #region IDisposable Support
+        private bool _disposedValue; // To detect redundant calls
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (!_disposedValue)
+            {
+                if (disposing)
+                {
+                    // dispose managed state (managed objects).
+                    Driver?.Dispose();
+                }
+
+                _disposedValue = true;
+            }
+        }
+
+        // This code added to correctly implement the disposable pattern.
+        public void Dispose()
+        {
+            // Do not change this code. Put cleanup code in Dispose(bool disposing) above.
+            Dispose(true);
+        }
+        #endregion
+    }
+}