Authentication and test updates (#65)

* Added debug details to the Connect-PartnerCenter command. Also, performed minor refactoring on the test framework.

* Consolidated the authentication constants into a single class.

Author: idwilliams-2

src/PartnerCenter.TestFramework/Network/HttpMockHandler.cs

@@ -9,7 +9,6 @@ namespace Microsoft.Store.PartnerCenter.TestFramework.Network
     using System;
     using System.Collections.Generic;
     using System.IO;
-    using System.Linq;
     using System.Net.Http;
     using System.Threading;
     using System.Threading.Tasks;
@@ -77,13 +76,12 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                 {
                     key = matcher.GetMatchingKey(request);
 
-                    if (!records[key].Any())
+                    if(records[key] == null)
                     {
                         throw new ResponseNotFoundException($"Unable to locate a reponse for {key}");
                     }
 
-                    // TODO - We should not be dequeuing the record. It will cause issues with test that make the same call twice
-                    response = records[matcher.GetMatchingKey(request)].Dequeue().GetResponse();
+                    response = records[matcher.GetMatchingKey(request)].GetResponse();
                     response.RequestMessage = request;
 
                     return response;

src/PartnerCenter.TestFramework/Network/HttpResponseRecords.cs

@@ -1,23 +1,19 @@
 // -----------------------------------------------------------------------
-// <copyright file="HttpContentType.cs" company="Microsoft">
+// <copyright file="HttpResponseRecords.cs" company="Microsoft">
 //     Copyright (c) Microsoft Corporation. All rights reserved.
 // </copyright>
 // -----------------------------------------------------------------------
 
 namespace Microsoft.Store.PartnerCenter.TestFramework.Network
 {
     using System.Collections.Generic;
-    using System.Linq;
 
-    /// <summary>
-    /// 
-    /// </summary>
     public sealed class HttpResponseRecords
     {
         /// <summary>
         /// A collection of HTTP operations.
         /// </summary>
-        private readonly Dictionary<string, Queue<HttpResponseRecord>> sessionRecords;
+        private readonly Dictionary<string, HttpResponseRecord> sessionRecords;
 
         /// <summary>
         /// Provides the ability to map a request with it's corresponding response.
@@ -31,10 +27,10 @@ public sealed class HttpResponseRecords
         public HttpResponseRecords(IHttpRecordMatcher matcher)
         {
             this.matcher = matcher;
-            sessionRecords = new Dictionary<string, Queue<HttpResponseRecord>>();
+            sessionRecords = new Dictionary<string, HttpResponseRecord>();
         }
 
-        public Queue<HttpResponseRecord> this[string key]
+        public HttpResponseRecord this[string key]
         {
             get => sessionRecords[key];
             set => sessionRecords[key] = value;
@@ -43,20 +39,17 @@ public Queue<HttpResponseRecord> this[string key]
         /// <summary>
         /// Gets the number of records contained in the collecion.
         /// </summary>
-        public int Count => sessionRecords.Values.Select(q => q.Count).Sum();
+        public int Count => sessionRecords.Count;
 
         /// <summary>
         /// Gets all available records.
         /// </summary>
         /// <returns>All of the available records.</returns>
         public IEnumerable<HttpResponseRecord> GetAllEntities()
         {
-            foreach (Queue<HttpResponseRecord> queues in sessionRecords.Values)
+            foreach (HttpResponseRecord record in sessionRecords.Values)
             {
-                while (queues.Count > 0)
-                {
-                    yield return queues.Dequeue();
-                }
+                yield return record;
             }
         }
 
@@ -66,14 +59,7 @@ public IEnumerable<HttpResponseRecord> GetAllEntities()
         /// <param name="record">The instance of the <see cref="HttpResponseRecord" /> class to be added.</param>
         public void Enqueue(HttpResponseRecord record)
         {
-            string recordKey = matcher.GetMatchingKey(record);
-
-            if (!sessionRecords.ContainsKey(recordKey))
-            {
-                sessionRecords[recordKey] = new Queue<HttpResponseRecord>();
-            }
-
-            sessionRecords[recordKey].Enqueue(record);
+            sessionRecords[matcher.GetMatchingKey(record)] = record;
         }
     }
 }

src/PowerShell/Authentication/AuthenticationConstants.cs

@@ -0,0 +1,24 @@
+// -----------------------------------------------------------------------
+// <copyright file="AccountType.cs" company="Microsoft">
+//     Copyright (c) Microsoft Corporation. All rights reserved.
+// </copyright>
+// -----------------------------------------------------------------------
+
+namespace Microsoft.Store.PartnerCenter.PowerShell.Authentication
+{
+    /// <summary>
+    /// Provides access to common constant values used for authentication.
+    /// </summary>
+    internal static class AuthenticationConstants
+    {
+        /// <summary>
+        /// The common endpoint used during authentication.
+        /// </summary>
+        public const string CommonEndpoint = "common";
+
+        /// <summary>
+        /// The value for the redirect URI.
+        /// </summary>
+        public const string RedirectUriValue = "urn:ietf:wg:oauth:2.0:oob";
+    }
+}

src/PowerShell/Commands/ConnectPartnerCenter.cs

@@ -7,17 +7,19 @@
 namespace Microsoft.Store.PartnerCenter.PowerShell.Commands
 {
     using System;
+    using System.Globalization;
     using System.Management.Automation;
     using System.Text.RegularExpressions;
     using Authentication;
     using Common;
     using Factories;
     using PartnerCenter.Models.Partners;
+    using Properties;
 
     /// <summary>
     /// Cmdlet to log into a Partner Center environment.
     /// </summary>
-    [Cmdlet(VerbsCommunications.Connect, "PartnerCenter",  DefaultParameterSetName = UserParameterSet)]
+    [Cmdlet(VerbsCommunications.Connect, "PartnerCenter", DefaultParameterSetName = UserParameterSet)]
     [OutputType(typeof(PartnerContext))]
     public class ConnectPartnerCenter : PSCmdlet, IModuleAssemblyInitializer
     {
@@ -99,6 +101,8 @@ protected override void ProcessRecord()
             IPartner partnerOperations;
             OrganizationProfile profile;
 
+            WriteDebug(string.Format(CultureInfo.CurrentCulture, Resources.ConnectPartnerCenterBeginProcess, ParameterSetName));
+
             if (ParameterSetName.Equals(AccessTokenParameterSet, StringComparison.InvariantCultureIgnoreCase))
             {
                 account.Id = ApplicationId;
@@ -116,7 +120,7 @@ protected override void ProcessRecord()
                 account.Type = AccountType.User;
             }
 
-            account.Properties[AzureAccountPropertyType.Tenant] = string.IsNullOrEmpty(TenantId) ? "common" : TenantId;
+            account.Properties[AzureAccountPropertyType.Tenant] = string.IsNullOrEmpty(TenantId) ? AuthenticationConstants.CommonEndpoint : TenantId;
 
             PartnerSession.Instance.Context = new PartnerContext
             {
@@ -130,9 +134,7 @@ protected override void ProcessRecord()
                 d => WriteDebug(d),
                 w => WriteWarning(w));
 
-
-            // TODO -- This should be done for both Access Token and User
-            if (PartnerSession.Instance.Context.Account.Type == AccountType.User)
+            if (PartnerSession.Instance.Context.AuthenticationType == AuthenticationTypes.AppPlusUser)
             {
                 partnerOperations = PartnerSession.Instance.ClientFactory.CreatePartnerOperations(d => WriteDebug(d));
                 profile = partnerOperations.Profiles.OrganizationProfile.Get();

src/PowerShell/Commands/NewPartnerAccessToken.cs

@@ -25,16 +25,6 @@ namespace Microsoft.Store.PartnerCenter.PowerShell.Commands
     [OutputType(typeof(AuthenticationResult))]
     public class NewPartnerAccessToken : PSCmdlet
     {
-        /// <summary>
-        /// The common endpoint used during authentication.
-        /// </summary>
-        private const string CommonEndpoint = "common";
-
-        /// <summary>
-        /// The value for the redirect URI.
-        /// </summary>
-        private const string redirectUriValue = "urn:ietf:wg:oauth:2.0:oob";
-
         /// <summary>
         /// The client used to perform HTTP operations.
         /// </summary>
@@ -119,7 +109,7 @@ protected override void ProcessRecord()
                 clientId = ApplicationId;
             }
 
-            account.Properties[AzureAccountPropertyType.Tenant] = string.IsNullOrEmpty(TenantId) ? CommonEndpoint : TenantId;
+            account.Properties[AzureAccountPropertyType.Tenant] = string.IsNullOrEmpty(TenantId) ? AuthenticationConstants.CommonEndpoint : TenantId;
             environment = PartnerEnvironment.PublicEnvironments[Environment];
 
             client = new PartnerServiceClient(httpClient);
@@ -166,14 +156,14 @@ protected override void ProcessRecord()
                 using (WindowsFormsWebAuthenticationDialog dialog = new WindowsFormsWebAuthenticationDialog(null))
                 {
                     authorizationResult = dialog.AuthenticateAAD(
-                        new Uri($"{environment.ActiveDirectoryAuthority}{account.Properties[AzureAccountPropertyType.Tenant]}/oauth2/authorize?resource={HttpUtility.UrlEncode(Resource)}&client_id={clientId}&response_type=code&haschrome=1&redirect_uri={HttpUtility.UrlEncode(redirectUriValue)}&response_mode=form_post&prompt=login"),
-                        new Uri(redirectUriValue));
+                        new Uri($"{environment.ActiveDirectoryAuthority}{account.Properties[AzureAccountPropertyType.Tenant]}/oauth2/authorize?resource={HttpUtility.UrlEncode(Resource)}&client_id={clientId}&response_type=code&haschrome=1&redirect_uri={HttpUtility.UrlEncode(AuthenticationConstants.RedirectUriValue)}&response_mode=form_post&prompt=login"),
+                        new Uri(AuthenticationConstants.RedirectUriValue));
                 }
 
                 authResult = client.AcquireTokenByAuthorizationCodeAsync(
                     authority,
                     resource,
-                    new Uri(redirectUriValue),
+                    new Uri(AuthenticationConstants.RedirectUriValue),
                     authorizationResult.Code,
                     clientId,
                     Credential?.Password.ConvertToString()).GetAwaiter().GetResult();

src/PowerShell/Factories/AuthenticationFactory.cs

@@ -13,17 +13,13 @@ namespace Microsoft.Store.PartnerCenter.PowerShell.Factories
     using System.Security.Claims;
     using Authentication;
     using IdentityModel.Clients.ActiveDirectory;
+    using Properties;
 
     /// <summary>
     /// Factory used to perform authentication operations.
     /// </summary>
     public class AuthenticationFactory : IAuthenticationFactory
     {
-        /// <summary>
-        /// The value for the redirect URI.
-        /// </summary>
-        private const string redirectUriValue = "urn:ietf:wg:oauth:2.0:oob";
-
         /// <summary>
         /// Acquires the security token from the authority.
         /// </summary>
@@ -64,12 +60,30 @@ public AuthenticationToken Authenticate(PartnerContext context, Action<string> d
 
                 context.AuthenticationType = claim == null ? Authentication.AuthenticationTypes.AppOnly : Authentication.AuthenticationTypes.AppPlusUser;
 
+                debugAction(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        Resources.AuthenticateAccessTokenTrace,
+                        expiration.ToString(CultureInfo.CurrentCulture),
+                        context.Account.Properties[AzureAccountPropertyType.Tenant],
+                        context.Account.Properties[AzureAccountPropertyType.UserIdentifier],
+                        claim?.Value));
+
                 return new AuthenticationToken(
                     context.Account.Properties[AzureAccountPropertyType.AccessToken],
                     expiration);
             }
             else if (context.Account.Type == AccountType.ServicePrincipal)
             {
+                debugAction(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        Resources.AuthenticateServicePrincipalTrace,
+                        environment.ActiveDirectoryAuthority,
+                        context.Account.Id,
+                        environment.AzureAdGraphEndpoint,
+                        context.Account.Properties[AzureAccountPropertyType.Tenant]));
+
                 authResult = authContext.AcquireTokenAsync(
                     environment.AzureAdGraphEndpoint,
                     new ClientCredential(
@@ -81,6 +95,13 @@ public AuthenticationToken Authenticate(PartnerContext context, Action<string> d
             else if (!context.Account.Properties.ContainsKey(AzureAccountPropertyType.UserIdentifier))
             {
 #if NETSTANDARD
+                debugAction(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        Resources.AuthenticateDeviceCodeTrace,
+                        context.ApplicationId,
+                        environment.PartnerCenterEndpoint));
+
                 DeviceCodeResult deviceCodeResult = authContext.AcquireDeviceCodeAsync(
                     environment.PartnerCenterEndpoint,
                     context.ApplicationId).ConfigureAwait(false).GetAwaiter().GetResult();
@@ -89,10 +110,19 @@ public AuthenticationToken Authenticate(PartnerContext context, Action<string> d
 
                 authResult = authContext.AcquireTokenByDeviceCodeAsync(deviceCodeResult).ConfigureAwait(false).GetAwaiter().GetResult();
 #else
+                debugAction(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        Resources.AuthenticateAuthorizationCodeTrace,
+                        context.ApplicationId,
+                        environment.ActiveDirectoryAuthority,
+                        AuthenticationConstants.RedirectUriValue,
+                        environment.PartnerCenterEndpoint));
+
                 authResult = authContext.AcquireTokenAsync(
                     environment.PartnerCenterEndpoint,
                     context.ApplicationId,
-                    new Uri(redirectUriValue),
+                    new Uri(AuthenticationConstants.RedirectUriValue),
                     new PlatformParameters(PromptBehavior.Always),
                     UserIdentifier.AnyUser).ConfigureAwait(false).GetAwaiter().GetResult();
 #endif
@@ -104,6 +134,15 @@ public AuthenticationToken Authenticate(PartnerContext context, Action<string> d
             }
             else
             {
+                debugAction(
+                    string.Format(
+                        CultureInfo.CurrentCulture,
+                        Resources.AuthenticateSilentTrace,
+                        context.ApplicationId,
+                        environment.ActiveDirectoryAuthority,
+                        environment.PartnerCenterEndpoint,
+                        context.Account.Id));
+
                 authResult = authContext.AcquireTokenSilentAsync(
                     environment.PartnerCenterEndpoint,
                     context.ApplicationId,