feat: Improve error reporting when loading the Docker configuration file (#1263)

Co-authored-by: Andre Hofmeister <[email protected]>

Author: 0xced

src/Testcontainers/Builders/DockerConfig.cs

@@ -77,7 +77,7 @@ public JsonDocument Parse()
     /// Executes a command equivalent to <c>docker context inspect --format {{.Endpoints.docker.Host}}</c>.
     /// </remarks>
     /// A <see cref="Uri" /> representing the current Docker endpoint if available; otherwise, <c>null</c>.
-    [CanBeNull]
+    [NotNull]
     public Uri GetCurrentEndpoint()
     {
       const string defaultDockerContext = "default";
@@ -99,16 +99,28 @@ public Uri GetCurrentEndpoint()
         var dockerContextHash = BitConverter.ToString(sha256.ComputeHash(Encoding.Default.GetBytes(dockerContext))).Replace("-", string.Empty).ToLowerInvariant();
         var metaFilePath = Path.Combine(_dockerConfigDirectoryPath, "contexts", "meta", dockerContextHash, "meta.json");
 
-        if (!File.Exists(metaFilePath))
+        try
         {
-          return null;
+          using (var metaFileStream = File.OpenRead(metaFilePath))
+          {
+            var meta = JsonSerializer.Deserialize(metaFileStream, SourceGenerationContext.Default.DockerContextMeta);
+            var host = meta.Endpoints?.Docker?.Host;
+
+            if (string.IsNullOrEmpty(host))
+            {
+              throw new DockerConfigurationException($"The Docker host is null or empty in '{metaFilePath}' (JSONPath: Endpoints.docker.Host).");
+            }
+
+            return new Uri(host.Replace("npipe:////./", "npipe://./"));
+          }
         }
-
-        using (var metaFileStream = File.OpenRead(metaFilePath))
+        catch (Exception e) when (e is DirectoryNotFoundException or FileNotFoundException)
         {
-          var meta = JsonSerializer.Deserialize(metaFileStream, SourceGenerationContext.Default.DockerContextMeta);
-          var host = meta?.Name == dockerContext ? meta.Endpoints?.Docker?.Host : null;
-          return string.IsNullOrEmpty(host) ? null : new Uri(host.Replace("npipe:////./", "npipe://./"));
+          throw new DockerConfigurationException($"The Docker context '{dockerContext}' does not exist.", e);
+        }
+        catch (Exception e) when (e is not DockerConfigurationException)
+        {
+          throw new DockerConfigurationException($"The Docker context '{dockerContext}' failed to load from '{metaFilePath}'.", e);
         }
       }
     }
@@ -162,15 +174,11 @@ private string GetDockerContext()
     internal sealed class DockerContextMeta
     {
       [JsonConstructor]
-      public DockerContextMeta(string name, DockerContextMetaEndpoints endpoints)
+      public DockerContextMeta(DockerContextMetaEndpoints endpoints)
       {
-        Name = name;
         Endpoints = endpoints;
       }
 
-      [JsonPropertyName("Name")]
-      public string Name { get; }
-
       [JsonPropertyName("Endpoints")]
       public DockerContextMetaEndpoints Endpoints { get; }
     }

src/Testcontainers/Builders/DockerConfigurationException.cs

@@ -0,0 +1,31 @@
+namespace DotNet.Testcontainers.Builders
+{
+  using System;
+  using JetBrains.Annotations;
+
+  /// <summary>
+  /// Represents an exception that is thrown when the Docker configuration file
+  /// cannot be read successfully.
+  /// </summary>
+  [PublicAPI]
+  public sealed class DockerConfigurationException : Exception
+  {
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DockerConfigurationException" /> class.
+    /// </summary>
+    /// <param name="message">The message that describes the error.</param>
+    public DockerConfigurationException(string message) : base(message)
+    {
+    }
+
+    /// <summary>
+    /// Initializes a new instance of the <see cref="DockerConfigurationException" /> class.
+    /// </summary>
+    /// <param name="message">The message that describes the error.</param>
+    /// <param name="innerException">The exception that is the cause of the current exception.</param>
+    public DockerConfigurationException(string message, Exception innerException)
+      : base(message, innerException)
+    {
+    }
+  }
+}

src/Testcontainers/Builders/DockerDesktopEndpointAuthenticationProvider.cs

@@ -15,7 +15,7 @@ internal sealed class DockerDesktopEndpointAuthenticationProvider : RootlessUnix
     /// Initializes a new instance of the <see cref="DockerDesktopEndpointAuthenticationProvider" /> class.
     /// </summary>
     public DockerDesktopEndpointAuthenticationProvider()
-      : base(DockerConfig.Instance.GetCurrentEndpoint()?.AbsolutePath, GetSocketPathFromHomeDesktopDir(), GetSocketPathFromHomeRunDir())
+      : base(DockerConfig.Instance.GetCurrentEndpoint())
     {
     }
 

src/Testcontainers/Builders/RootlessUnixEndpointAuthenticationProvider.cs

@@ -30,6 +30,15 @@ public RootlessUnixEndpointAuthenticationProvider(params string[] socketPaths)
       DockerEngine = socketPath == null ? null : new Uri("unix://" + socketPath);
     }
 
+    /// <summary>
+    /// Initializes a new instance of the <see cref="RootlessUnixEndpointAuthenticationProvider" /> class.
+    /// </summary>
+    /// <param name="dockerEngine">The Docker Engine endpoint.</param>
+    public RootlessUnixEndpointAuthenticationProvider(Uri dockerEngine)
+    {
+      DockerEngine = dockerEngine;
+    }
+
     /// <summary>
     /// Gets the Unix socket Docker Engine endpoint.
     /// </summary>

tests/Testcontainers.Tests/Unit/Builders/DockerConfigTest.cs

@@ -46,9 +46,9 @@ public void ReturnsDefaultEndpointWhenDockerContextIsDefault()
       public void ReturnsConfiguredEndpointWhenDockerContextIsCustomFromPropertiesFile()
       {
         // Given
-        using var context = new ConfigMetaFile("custom", "tcp://127.0.0.1:2375/");
+        using var context = new ConfigMetaFile("custom", new Uri("tcp://127.0.0.1:2375/"));
 
-        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.context=custom", context.GetDockerConfig() });
+        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.context=custom", $"docker.config={context.DockerConfigDirectoryPath}" });
         var dockerConfig = new DockerConfig(customConfiguration);
 
         // When
@@ -62,10 +62,10 @@ public void ReturnsConfiguredEndpointWhenDockerContextIsCustomFromPropertiesFile
       public void ReturnsConfiguredEndpointWhenDockerContextIsCustomFromConfigFile()
       {
         // Given
-        using var context = new ConfigMetaFile("custom", "tcp://127.0.0.1:2375/");
+        using var context = new ConfigMetaFile("custom", new Uri("tcp://127.0.0.1:2375/"));
 
         // This test reads the current context JSON node from the Docker config file.
-        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { context.GetDockerConfig() });
+        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { $"docker.config={context.DockerConfigDirectoryPath}" });
         var dockerConfig = new DockerConfig(customConfiguration);
 
         // When
@@ -83,17 +83,37 @@ public void ReturnsActiveEndpointWhenDockerContextIsUnset()
       }
 
       [Fact]
-      public void ReturnsNullWhenDockerContextNotFound()
+      public void ThrowsWhenDockerContextNotFound()
       {
         // Given
         ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.context=missing" });
         var dockerConfig = new DockerConfig(customConfiguration);
 
         // When
-        var currentEndpoint = dockerConfig.GetCurrentEndpoint();
+        var exception = Assert.Throws<DockerConfigurationException>(() => dockerConfig.GetCurrentEndpoint());
 
         // Then
-        Assert.Null(currentEndpoint);
+        Assert.Equal("The Docker context 'missing' does not exist.", exception.Message);
+        Assert.IsType<DirectoryNotFoundException>(exception.InnerException);
+      }
+
+      [Fact]
+      public void ThrowsWhenDockerHostNotFound()
+      {
+        // Given
+        using var context = new ConfigMetaFile("custom", null);
+
+        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.context=custom", $"docker.config={context.DockerConfigDirectoryPath}" });
+        var dockerConfig = new DockerConfig(customConfiguration);
+
+        // When
+        var exception = Assert.Throws<DockerConfigurationException>(() => dockerConfig.GetCurrentEndpoint());
+
+        // Then
+        Assert.StartsWith("The Docker host is null or empty in ", exception.Message);
+        Assert.Contains(context.DockerConfigDirectoryPath, exception.Message);
+        Assert.EndsWith(" (JSONPath: Endpoints.docker.Host).", exception.Message);
+        Assert.Null(exception.InnerException);
       }
     }
 
@@ -117,9 +137,9 @@ public void ReturnsActiveEndpointWhenDockerHostIsEmpty()
       public void ReturnsConfiguredEndpointWhenDockerHostIsSet()
       {
         // Given
-        using var context = new ConfigMetaFile("custom", "");
+        using var context = new ConfigMetaFile("custom", null);
 
-        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.host=tcp://127.0.0.1:2375/", context.GetDockerConfig() });
+        ICustomConfiguration customConfiguration = new PropertiesFileConfiguration(new[] { "docker.host=tcp://127.0.0.1:2375/", $"docker.config={context.DockerConfigDirectoryPath}" });
         var dockerConfig = new DockerConfig(customConfiguration);
 
         // When
@@ -147,26 +167,21 @@ private sealed class ConfigMetaFile : IDisposable
 
       private const string MetaFileJson = "{{\"Name\":\"{0}\",\"Metadata\":{{}},\"Endpoints\":{{\"docker\":{{\"Host\":\"{1}\",\"SkipTLSVerify\":false}}}}}}";
 
-      private readonly string _dockerConfigDirectoryPath;
-
-      public ConfigMetaFile(string context, string endpoint, [CallerMemberName] string caller = "")
+      public ConfigMetaFile(string context, Uri endpoint, [CallerMemberName] string caller = "")
       {
-        _dockerConfigDirectoryPath = Path.Combine(TestSession.TempDirectoryPath, caller);
+        DockerConfigDirectoryPath = Path.Combine(TestSession.TempDirectoryPath, caller);
         var dockerContextHash = Convert.ToHexString(SHA256.HashData(Encoding.Default.GetBytes(context))).ToLowerInvariant();
-        var dockerContextMetaDirectoryPath = Path.Combine(_dockerConfigDirectoryPath, "contexts", "meta", dockerContextHash);
+        var dockerContextMetaDirectoryPath = Path.Combine(DockerConfigDirectoryPath, "contexts", "meta", dockerContextHash);
         _ = Directory.CreateDirectory(dockerContextMetaDirectoryPath);
-        File.WriteAllText(Path.Combine(_dockerConfigDirectoryPath, "config.json"), string.Format(ConfigFileJson, context));
-        File.WriteAllText(Path.Combine(dockerContextMetaDirectoryPath, "meta.json"), string.Format(MetaFileJson, context, endpoint));
+        File.WriteAllText(Path.Combine(DockerConfigDirectoryPath, "config.json"), string.Format(ConfigFileJson, context));
+        File.WriteAllText(Path.Combine(dockerContextMetaDirectoryPath, "meta.json"), endpoint == null ?  "{}" : string.Format(MetaFileJson, context, endpoint.AbsoluteUri));
       }
 
-      public string GetDockerConfig()
-      {
-        return "docker.config=" + _dockerConfigDirectoryPath;
-      }
+      public string DockerConfigDirectoryPath { get; }
 
       public void Dispose()
       {
-        Directory.Delete(_dockerConfigDirectoryPath, true);
+        Directory.Delete(DockerConfigDirectoryPath, true);
       }
     }
   }