[Identity] Fix SharedTokenCacheCredential default behavior. (#28309)

* Fix SharedTokenCacheCredential default behavior * revert live test * revert inadvertant regional test update * adding stcc cache test * update API spec
Azure · Apr 28, 2022 · 3d85c0a · 3d85c0a
1 parent 57955d8
commit 3d85c0a
Show file tree

Hide file tree

Showing 8 changed files with 127 additions and 1 deletion.
diff --git a/...Azure.Identity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.net461.cs b/...Azure.Identity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.net461.cs
@@ -7,5 +7,6 @@ public InteractiveBrowserCredentialBrokerOptions() { }
     public partial class SharedTokenCacheCredentialBrokerOptions : Azure.Identity.SharedTokenCacheCredentialOptions
     {
         public SharedTokenCacheCredentialBrokerOptions() { }
+        public SharedTokenCacheCredentialBrokerOptions(Azure.Identity.TokenCachePersistenceOptions tokenCacheOptions) { }
     }
 }
diff --git a/...entity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.netstandard2.0.cs b/...entity.BrokeredAuthentication/api/Azure.Identity.BrokeredAuthentication.netstandard2.0.cs
@@ -7,5 +7,6 @@ public InteractiveBrowserCredentialBrokerOptions() { }
     public partial class SharedTokenCacheCredentialBrokerOptions : Azure.Identity.SharedTokenCacheCredentialOptions
     {
         public SharedTokenCacheCredentialBrokerOptions() { }
+        public SharedTokenCacheCredentialBrokerOptions(Azure.Identity.TokenCachePersistenceOptions tokenCacheOptions) { }
     }
 }
diff --git a/...tity/Azure.Identity.BrokeredAuthentication/src/SharedTokenCacheCredentialBrokerOptions.cs b/...tity/Azure.Identity.BrokeredAuthentication/src/SharedTokenCacheCredentialBrokerOptions.cs
@@ -14,6 +14,22 @@ namespace Azure.Identity.BrokeredAuthentication
     /// </summary>
     public class SharedTokenCacheCredentialBrokerOptions : SharedTokenCacheCredentialOptions, IMsalPublicClientInitializerOptions
     {
+        /// <summary>
+        /// Initializes a new instance of <see cref="SharedTokenCacheCredentialBrokerOptions"/>.
+        /// </summary>
+        public SharedTokenCacheCredentialBrokerOptions()
+            : this(null)
+        { }
+
+        /// <summary>
+        /// Initializes a new instance of <see cref="SharedTokenCacheCredentialBrokerOptions"/>.
+        /// </summary>
+        /// <param name="tokenCacheOptions">The <see cref="TokenCachePersistenceOptions"/> that will apply to the token cache used by this credential.</param>
+        public SharedTokenCacheCredentialBrokerOptions(TokenCachePersistenceOptions tokenCacheOptions)
+            : base(tokenCacheOptions)
+        {
+        }
+
         Action<PublicClientApplicationBuilder> IMsalPublicClientInitializerOptions.BeforeBuildClient => AddBroker;
 
         private void AddBroker(PublicClientApplicationBuilder builder)

diff --git a/...ure.Identity.BrokeredAuthentication/tests/SharedTokenCacheCredentialBrokerOptionsTests.cs b/...ure.Identity.BrokeredAuthentication/tests/SharedTokenCacheCredentialBrokerOptionsTests.cs
@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using NUnit.Framework;
+
+namespace Azure.Identity.BrokeredAuthentication.Tests
+{
+    public class SharedTokenCacheCredentialBrokerOptionsTests
+    {
+        [Test]
+        public void VerifyTokenCacheOptionsCtorParam()
+        {
+            // verify passed in TokenCachePeristenceOptions are honored
+            var persistenceOptions = new TokenCachePersistenceOptions { Name = "mocktokencachename" };
+
+            var credentialOptions = new SharedTokenCacheCredentialBrokerOptions(persistenceOptions);
+
+            Assert.AreEqual(persistenceOptions, credentialOptions.TokenCachePersistenceOptions);
+        }
+    }
+}
diff --git a/sdk/identity/Azure.Identity/src/Credentials/SharedTokenCacheCredentialOptions.cs b/sdk/identity/Azure.Identity/src/Credentials/SharedTokenCacheCredentialOptions.cs
@@ -10,6 +10,8 @@ public class SharedTokenCacheCredentialOptions : TokenCredentialOptions, ITokenC
     {
         private string _tenantId;
 
+        internal static readonly TokenCachePersistenceOptions s_defaulTokenCachetPersistenceOptions = new TokenCachePersistenceOptions();
+
         /// <summary>
         /// The client id of the application registration used to authenticate users in the cache.
         /// </summary>
@@ -59,7 +61,8 @@ public SharedTokenCacheCredentialOptions()
         /// <param name="tokenCacheOptions">The <see cref="TokenCachePersistenceOptions"/> that will apply to the token cache used by this credential.</param>
         public SharedTokenCacheCredentialOptions(TokenCachePersistenceOptions tokenCacheOptions)
         {
-            TokenCachePersistenceOptions = tokenCacheOptions;
+            // if no tokenCacheOptions were specified we should use the default shared token cache
+            TokenCachePersistenceOptions = tokenCacheOptions ?? s_defaulTokenCachetPersistenceOptions;
         }
     }
 }
diff --git a/sdk/identity/Azure.Identity/tests/Mock/MockTokenCache.cs b/sdk/identity/Azure.Identity/tests/Mock/MockTokenCache.cs
@@ -0,0 +1,34 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using System;
+using System.Threading.Tasks;
+
+namespace Azure.Identity.Tests.Mock
+{
+    public class MockTokenCache : UnsafeTokenCacheOptions
+    {
+        private readonly Func<Task<ReadOnlyMemory<byte>>> _refreshCacheDelegate;
+        private readonly Func<TokenCacheUpdatedArgs, Task> _cacheUpdatedDelegate;
+
+        public MockTokenCache(Func<Task<ReadOnlyMemory<byte>>> refreshDelegate = default, Func<TokenCacheUpdatedArgs, Task> updatedDelegate = default)
+        {
+            _refreshCacheDelegate = refreshDelegate;
+
+            _cacheUpdatedDelegate = updatedDelegate;
+        }
+
+        protected internal override Task<ReadOnlyMemory<byte>> RefreshCacheAsync()
+        {
+            return (_refreshCacheDelegate != null) ? _refreshCacheDelegate() : null;
+        }
+
+        protected internal override async Task TokenCacheUpdatedAsync(TokenCacheUpdatedArgs tokenCacheUpdatedArgs)
+        {
+            if (_cacheUpdatedDelegate != null)
+            {
+                await _cacheUpdatedDelegate(tokenCacheUpdatedArgs).ConfigureAwait(false);
+            }
+        }
+    }
+}
diff --git a/sdk/identity/Azure.Identity/tests/SharedTokenCacheCredentialOptionsTests.cs b/sdk/identity/Azure.Identity/tests/SharedTokenCacheCredentialOptionsTests.cs
@@ -0,0 +1,31 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using NUnit.Framework;
+
+namespace Azure.Identity.Tests
+{
+    public class SharedTokenCacheCredentialOptionsTests
+    {
+        [Test]
+        public void VerifyCachePersistenceOptionsCtorParam()
+        {
+            // verify passed in TokenCachePeristenceOptions are honored
+            var persistenceOptions = new TokenCachePersistenceOptions { Name = "mocktokencachename" };
+
+            var credentialOptions = new SharedTokenCacheCredentialOptions(persistenceOptions);
+
+            Assert.AreEqual(persistenceOptions, credentialOptions.TokenCachePersistenceOptions);
+
+            // verify passing null uses the default token cache persistence settings
+            credentialOptions = new SharedTokenCacheCredentialOptions(null);
+
+            Assert.AreEqual(SharedTokenCacheCredentialOptions.s_defaulTokenCachetPersistenceOptions, credentialOptions.TokenCachePersistenceOptions);
+
+            // verify calling the default constructor uses the default token cache persistence settings
+            credentialOptions = new SharedTokenCacheCredentialOptions();
+
+            Assert.AreEqual(SharedTokenCacheCredentialOptions.s_defaulTokenCachetPersistenceOptions, credentialOptions.TokenCachePersistenceOptions);
+        }
+    }
+}
diff --git a/sdk/identity/Azure.Identity/tests/SharedTokenCacheCredentialTests.cs b/sdk/identity/Azure.Identity/tests/SharedTokenCacheCredentialTests.cs
@@ -74,6 +74,25 @@ public void RespectsIsPIILoggingEnabled([Values(true, false)] bool isLoggingPIIE
             Assert.AreEqual(isLoggingPIIEnabled, credential.Client.IsPiiLoggingEnabled);
         }
 
+        [Test]
+        public void RespectsTokenCachePersistenceOptions()
+        {
+            bool cacheDelegateCalled = false;
+
+            var cachePersistenceOptions = new MockTokenCache(refreshDelegate: () =>
+            {
+                cacheDelegateCalled = true;
+
+                return Task.FromResult<ReadOnlyMemory<byte>>(null);
+            });
+
+            var credential = InstrumentClient(new SharedTokenCacheCredential(new SharedTokenCacheCredentialOptions(cachePersistenceOptions)));
+
+            Assert.ThrowsAsync<CredentialUnavailableException>(async () => await credential.GetTokenAsync(new TokenRequestContext(MockScopes.Default)));
+
+            Assert.IsTrue(cacheDelegateCalled);
+        }
+
         [Test]
         public async Task OneAccountNoTentantNoUsername()
         {