[#370] #UPDATE 'assemblyName: DotNet.Testcontainers; refactor: IAuthe…

…nticationProvider' {Prepare the authentication provider for different configurations.}
testcontainers · Jun 6, 2022 · d535f16 · d535f16
1 parent 88eca9b
commit d535f16
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/src/DotNet.Testcontainers/Builders/Base64Provider.cs b/src/DotNet.Testcontainers/Builders/Base64Provider.cs
@@ -8,8 +8,8 @@
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
-  /// <inheritdoc cref="IAuthenticationProvider" />
-  internal sealed class Base64Provider : IAuthenticationProvider
+  /// <inheritdoc cref="IAuthenticationProvider{TAuthenticationConfiguration}" />
+  internal sealed class Base64Provider : IAuthenticationProvider<IDockerRegistryAuthenticationConfiguration>
   {
     private readonly JsonElement rootElement;
 

diff --git a/src/DotNet.Testcontainers/Builders/CredsHelperProvider.cs b/src/DotNet.Testcontainers/Builders/CredsHelperProvider.cs
@@ -2,8 +2,8 @@
 {
   using DotNet.Testcontainers.Configurations;
 
-  /// <inheritdoc cref="IAuthenticationProvider" />
-  internal sealed class CredsHelperProvider : IAuthenticationProvider
+  /// <inheritdoc cref="IAuthenticationProvider{TAuthenticationConfiguration}" />
+  internal sealed class CredsHelperProvider : IAuthenticationProvider<IDockerRegistryAuthenticationConfiguration>
   {
     /// <inheritdoc />
     public bool IsApplicable()

diff --git a/src/DotNet.Testcontainers/Builders/CredsStoreProvider.cs b/src/DotNet.Testcontainers/Builders/CredsStoreProvider.cs
@@ -7,8 +7,8 @@
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
-  /// <inheritdoc cref="IAuthenticationProvider" />
-  internal sealed class CredsStoreProvider : IAuthenticationProvider
+  /// <inheritdoc cref="IAuthenticationProvider{TAuthenticationConfiguration}" />
+  internal sealed class CredsStoreProvider : IAuthenticationProvider<IDockerRegistryAuthenticationConfiguration>
   {
     private static readonly JsonSerializerOptions JsonSerializerOptions = new JsonSerializerOptions();
 

diff --git a/src/DotNet.Testcontainers/Builders/DockerRegistryAuthenticationProvider.cs b/src/DotNet.Testcontainers/Builders/DockerRegistryAuthenticationProvider.cs
@@ -9,8 +9,8 @@
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
-  /// <inheritdoc />
-  internal sealed class DockerRegistryAuthenticationProvider : IAuthenticationProvider
+  /// <inheritdoc cref="IAuthenticationProvider{TAuthenticationConfiguration}" />
+  internal sealed class DockerRegistryAuthenticationProvider : IAuthenticationProvider<IDockerRegistryAuthenticationConfiguration>
   {
     private const string DockerHub = "index.docker.io";
 
@@ -81,7 +81,7 @@ private IDockerRegistryAuthenticationConfiguration GetUncachedAuthConfig(string
         {
           using (var dockerConfigDocument = JsonDocument.Parse(dockerConfigFileStream))
           {
-            authConfig = new IAuthenticationProvider[] { new CredsHelperProvider(), new CredsStoreProvider(dockerConfigDocument, this.logger), new Base64Provider(dockerConfigDocument, this.logger) }
+            authConfig = new IAuthenticationProvider<IDockerRegistryAuthenticationConfiguration>[] { new CredsHelperProvider(), new CredsStoreProvider(dockerConfigDocument, this.logger), new Base64Provider(dockerConfigDocument, this.logger) }
               .AsParallel()
               .Select(authenticationProvider => authenticationProvider.GetAuthConfig(hostname))
               .FirstOrDefault(authenticationProvider => authenticationProvider != null);

diff --git a/src/DotNet.Testcontainers/Builders/IAuthenticationProvider.cs b/src/DotNet.Testcontainers/Builders/IAuthenticationProvider.cs
@@ -1,13 +1,13 @@
 namespace DotNet.Testcontainers.Builders
 {
-  using DotNet.Testcontainers.Configurations;
   using JetBrains.Annotations;
 
   /// <summary>
-  /// A Docker registry authentication provider.
+  /// A Docker authentication provider.
   /// </summary>
+  /// <typeparam name="TAuthenticationConfiguration">Type of the authentication configuration.</typeparam>
   [PublicAPI]
-  internal interface IAuthenticationProvider
+  internal interface IAuthenticationProvider<out TAuthenticationConfiguration>
   {
     /// <summary>
     /// Is true when the authentication provider contains any credentials, otherwise false.
@@ -17,12 +17,12 @@ internal interface IAuthenticationProvider
     bool IsApplicable();
 
     /// <summary>
-    /// Gets the Docker registry authentication configuration.
+    /// Gets the Docker authentication configuration.
     /// </summary>
-    /// <param name="hostname">The Docker registry hostname.</param>
-    /// <returns>The Docker registry authentication configuration or null if no configuration matches the hostname.</returns>
+    /// <param name="hostname">The Docker hostname.</param>
+    /// <returns>The Docker authentication configuration or null if no configuration matches the hostname.</returns>
     [PublicAPI]
     [CanBeNull]
-    IDockerRegistryAuthenticationConfiguration GetAuthConfig(string hostname);
+    TAuthenticationConfiguration GetAuthConfig(string hostname);
   }
 }