feat: Add support for copying directories and files to a container (t…

…estcontainers#913)
alexeyzimarev · Jun 19, 2023 · f7f3c49 · f7f3c49
1 parent de410de
commit f7f3c49
Show file tree

Hide file tree

Showing 27 changed files with 611 additions and 48 deletions.
diff --git a/src/Testcontainers.Kafka/KafkaBuilder.cs b/src/Testcontainers.Kafka/KafkaBuilder.cs
@@ -84,7 +84,7 @@ protected override KafkaBuilder Init()
                 startupScript.Append("echo '' > /etc/confluent/docker/ensure");
                 startupScript.Append(lf);
                 startupScript.Append("/etc/confluent/docker/run");
-                return container.CopyFileAsync(StartupScriptFilePath, Encoding.Default.GetBytes(startupScript.ToString()), 493, ct: ct);
+                return container.CopyAsync(Encoding.Default.GetBytes(startupScript.ToString()), StartupScriptFilePath, Unix.FileMode755, ct);
             });
     }
 

diff --git a/src/Testcontainers.MariaDb/MariaDbContainer.cs b/src/Testcontainers.MariaDb/MariaDbContainer.cs
@@ -42,7 +42,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "mysql", "--protocol=TCP", $"--port={MariaDbBuilder.MariaDbPort}", $"--user={_configuration.Username}", $"--password={_configuration.Password}", _configuration.Database, $"--execute=source {scriptFilePath};" }, ct)

diff --git a/src/Testcontainers.MongoDb/MongoDbContainer.cs b/src/Testcontainers.MongoDb/MongoDbContainer.cs
@@ -40,7 +40,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new MongoDbShellCommand($"load('{scriptFilePath}')", _configuration.Username, _configuration.Password), ct)

diff --git a/src/Testcontainers.MsSql/MsSqlContainer.cs b/src/Testcontainers.MsSql/MsSqlContainer.cs
@@ -42,7 +42,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "/opt/mssql-tools/bin/sqlcmd", "-b", "-r", "1", "-U", _configuration.Username, "-P", _configuration.Password, "-i", scriptFilePath }, ct)

diff --git a/src/Testcontainers.MySql/MySqlContainer.cs b/src/Testcontainers.MySql/MySqlContainer.cs
@@ -42,7 +42,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "mysql", "--protocol=TCP", $"--port={MySqlBuilder.MySqlPort}", $"--user={_configuration.Username}", $"--password={_configuration.Password}", _configuration.Database, $"--execute=source {scriptFilePath};" }, ct)

diff --git a/src/Testcontainers.Oracle/OracleContainer.cs b/src/Testcontainers.Oracle/OracleContainer.cs
@@ -37,7 +37,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "/bin/sh", "-c", $"exit | sqlplus -LOGON -SILENT {_configuration.Username}/{_configuration.Password}@localhost:1521/{_configuration.Database} @{scriptFilePath}" }, ct)

diff --git a/src/Testcontainers.PostgreSql/PostgreSqlContainer.cs b/src/Testcontainers.PostgreSql/PostgreSqlContainer.cs
@@ -42,7 +42,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "psql", "--username", _configuration.Username, "--dbname", _configuration.Database, "--file", scriptFilePath }, ct)

diff --git a/src/Testcontainers.Redis/RedisContainer.cs b/src/Testcontainers.Redis/RedisContainer.cs
@@ -33,7 +33,7 @@ public async Task<ExecResult> ExecScriptAsync(string scriptContent, Cancellation
     {
         var scriptFilePath = string.Join("/", string.Empty, "tmp", Guid.NewGuid().ToString("D"), Path.GetRandomFileName());
 
-        await CopyFileAsync(scriptFilePath, Encoding.Default.GetBytes(scriptContent), 493, 0, 0, ct)
+        await CopyAsync(Encoding.Default.GetBytes(scriptContent), scriptFilePath, Unix.FileMode644, ct)
             .ConfigureAwait(false);
 
         return await ExecAsync(new[] { "redis-cli", "--eval", scriptFilePath, "0" }, ct)

diff --git a/src/Testcontainers.Redpanda/RedpandaBuilder.cs b/src/Testcontainers.Redpanda/RedpandaBuilder.cs
@@ -61,7 +61,7 @@ protected override RedpandaBuilder Init()
                 startupScript.Append("--mode dev-container ");
                 startupScript.Append("--kafka-addr PLAINTEXT://0.0.0.0:29092,OUTSIDE://0.0.0.0:9092 ");
                 startupScript.Append("--advertise-kafka-addr PLAINTEXT://127.0.0.1:29092,OUTSIDE://" + container.Hostname + ":" + container.GetMappedPublicPort(RedpandaPort));
-                return container.CopyFileAsync(StartupScriptFilePath, Encoding.Default.GetBytes(startupScript.ToString()), 493, ct: ct);
+                return container.CopyAsync(Encoding.Default.GetBytes(startupScript.ToString()), StartupScriptFilePath, Unix.FileMode755, ct);
             });
     }
 

diff --git a/src/Testcontainers/Clients/ITestcontainersClient.cs b/src/Testcontainers/Clients/ITestcontainersClient.cs
@@ -2,6 +2,7 @@ namespace DotNet.Testcontainers.Clients
 {
   using System;
   using System.Collections.Generic;
+  using System.IO;
   using System.Threading;
   using System.Threading.Tasks;
   using Docker.DotNet.Models;
@@ -103,6 +104,37 @@ internal interface ITestcontainersClient
     /// <returns>Task that completes when the shell command has been executed.</returns>
     Task<ExecResult> ExecAsync(string id, IList<string> command, CancellationToken ct = default);
 
+    /// <summary>
+    /// Copies the content of an implementation of <see cref="IResourceMapping" /> to the container.
+    /// </summary>
+    /// <param name="id">The container id.</param>
+    /// <param name="resourceMapping">The resource mapping to add to the archive.</param>
+    /// <param name="ct">Cancellation token.</param>
+    /// <returns>A task that completes when the content has been copied.</returns>
+    Task CopyAsync(string id, IResourceMapping resourceMapping, CancellationToken ct = default);
+
+    /// <summary>
+    /// Copies a test host directory to the container.
+    /// </summary>
+    /// <param name="id">The container id.</param>
+    /// <param name="source">The source directory to be copied.</param>
+    /// <param name="target">The target directory path to copy the files to.</param>
+    /// <param name="fileMode">The POSIX file mode permission.</param>
+    /// <param name="ct">Cancellation token.</param>
+    /// <returns>A task that completes when the directory has been copied.</returns>
+    Task CopyAsync(string id, DirectoryInfo source, string target, UnixFileMode fileMode, CancellationToken ct = default);
+
+    /// <summary>
+    /// Copies a test host file to the container.
+    /// </summary>
+    /// <param name="id">The container id.</param>
+    /// <param name="source">The source file to be copied.</param>
+    /// <param name="target">The target directory path to copy the file to.</param>
+    /// <param name="fileMode">The POSIX file mode permission.</param>
+    /// <param name="ct">Cancellation token.</param>
+    /// <returns>A task that completes when the file has been copied.</returns>
+    Task CopyAsync(string id, FileInfo source, string target, UnixFileMode fileMode, CancellationToken ct = default);
+
     /// <summary>
     /// Copies a file to the container.
     /// </summary>

diff --git a/src/Testcontainers/Clients/TestcontainersClient.cs b/src/Testcontainers/Clients/TestcontainersClient.cs
@@ -26,7 +26,7 @@ internal sealed class TestcontainersClient : ITestcontainersClient
 
     public const string TestcontainersSessionIdLabel = TestcontainersLabel + ".session-id";
 
-    private readonly string _osRootDirectory = Path.GetPathRoot(Directory.GetCurrentDirectory());
+    private static readonly string OSRootDirectory = Path.GetPathRoot(Directory.GetCurrentDirectory());
 
     private readonly DockerRegistryAuthenticationProvider _registryAuthenticationProvider;
 
@@ -79,7 +79,7 @@ private TestcontainersClient(
     public IDockerSystemOperations System { get; }
 
     /// <inheritdoc />
-    public bool IsRunningInsideDocker => File.Exists(Path.Combine(_osRootDirectory, ".dockerenv"));
+    public bool IsRunningInsideDocker => File.Exists(Path.Combine(OSRootDirectory, ".dockerenv"));
 
     /// <inheritdoc />
     public Task<long> GetContainerExitCodeAsync(string id, CancellationToken ct = default)
@@ -147,7 +147,7 @@ await Container.RemoveAsync(id, ct)
         catch (DockerApiException e)
         {
           // The Docker daemon may already start the progress to removes the container (AutoRemove):
-          // https://docs.docker.com/engine/api/v1.41/#operation/ContainerCreate.
+          // https://docs.docker.com/engine/api/v1.43/#operation/ContainerCreate.
           if (!e.Message.Contains($"removal of container {id} is already in progress"))
           {
             throw;
@@ -162,11 +162,58 @@ public Task<ExecResult> ExecAsync(string id, IList<string> command, Cancellation
       return Container.ExecAsync(id, command, ct);
     }
 
+    /// <inheritdoc />
+    public async Task CopyAsync(string id, IResourceMapping resourceMapping, CancellationToken ct = default)
+    {
+      using (var tarOutputMemStream = new TarOutputMemoryStream())
+      {
+        await tarOutputMemStream.AddAsync(resourceMapping, ct)
+          .ConfigureAwait(false);
+
+        tarOutputMemStream.Close();
+        tarOutputMemStream.Seek(0, SeekOrigin.Begin);
+
+        await Container.ExtractArchiveToContainerAsync(id, "/", tarOutputMemStream, ct)
+          .ConfigureAwait(false);
+      }
+    }
+
+    /// <inheritdoc />
+    public async Task CopyAsync(string id, DirectoryInfo source, string target, UnixFileMode fileMode, CancellationToken ct = default)
+    {
+      using (var tarOutputMemStream = new TarOutputMemoryStream(target))
+      {
+        await tarOutputMemStream.AddAsync(source, true, fileMode, ct)
+          .ConfigureAwait(false);
+
+        tarOutputMemStream.Close();
+        tarOutputMemStream.Seek(0, SeekOrigin.Begin);
+
+        await Container.ExtractArchiveToContainerAsync(id, "/", tarOutputMemStream, ct)
+          .ConfigureAwait(false);
+      }
+    }
+
+    /// <inheritdoc />
+    public async Task CopyAsync(string id, FileInfo source, string target, UnixFileMode fileMode, CancellationToken ct = default)
+    {
+      using (var tarOutputMemStream = new TarOutputMemoryStream(target))
+      {
+        await tarOutputMemStream.AddAsync(source, fileMode, ct)
+          .ConfigureAwait(false);
+
+        tarOutputMemStream.Close();
+        tarOutputMemStream.Seek(0, SeekOrigin.Begin);
+
+        await Container.ExtractArchiveToContainerAsync(id, "/", tarOutputMemStream, ct)
+          .ConfigureAwait(false);
+      }
+    }
+
     /// <inheritdoc />
     public async Task CopyFileAsync(string id, string filePath, byte[] fileContent, int accessMode, int userId, int groupId, CancellationToken ct = default)
     {
-      IOperatingSystem os = new Unix(dockerEndpointAuthConfig: null);
-      var containerPath = os.NormalizePath(filePath);
+      var containerPath = Unix.Instance.NormalizePath(filePath);
 
       using (var tarOutputMemStream = new MemoryStream())
       {
@@ -200,7 +247,7 @@ await tarOutputStream.CloseEntryAsync(ct)
 
         tarOutputMemStream.Seek(0, SeekOrigin.Begin);
 
-        await Container.ExtractArchiveToContainerAsync(id, Path.AltDirectorySeparatorChar.ToString(), tarOutputMemStream, ct)
+        await Container.ExtractArchiveToContainerAsync(id, "/", tarOutputMemStream, ct)
           .ConfigureAwait(false);
       }
     }
@@ -210,8 +257,7 @@ public async Task<byte[]> ReadFileAsync(string id, string filePath, Cancellation
     {
       Stream tarStream;
 
-      IOperatingSystem os = new Unix(dockerEndpointAuthConfig: null);
-      var containerPath = os.NormalizePath(filePath);
+      var containerPath = Unix.Instance.NormalizePath(filePath);
 
       try
       {
@@ -252,15 +298,6 @@ public async Task<byte[]> ReadFileAsync(string id, string filePath, Cancellation
     /// <inheritdoc />
     public async Task<string> RunAsync(IContainerConfiguration configuration, CancellationToken ct = default)
     {
-      async Task CopyResourceMappingAsync(string containerId, IResourceMapping resourceMapping)
-      {
-        var resourceMappingContent = await resourceMapping.GetAllBytesAsync(ct)
-          .ConfigureAwait(false);
-
-        await CopyFileAsync(containerId, resourceMapping.Target, resourceMappingContent, 420, 0, 0, ct)
-          .ConfigureAwait(false);
-      }
-
       if (TestcontainersSettings.ResourceReaperEnabled && ResourceReaper.DefaultSessionId.Equals(configuration.SessionId))
       {
         var isWindowsEngineEnabled = await System.GetIsWindowsEngineEnabled(ct)
@@ -302,7 +339,7 @@ await Network.ConnectAsync("bridge", id, ct)
 
       if (configuration.ResourceMappings.Any())
       {
-        await Task.WhenAll(configuration.ResourceMappings.Values.Select(resourceMapping => CopyResourceMappingAsync(id, resourceMapping)))
+        await Task.WhenAll(configuration.ResourceMappings.Values.Select(resourceMapping => CopyAsync(id, resourceMapping, ct)))
           .ConfigureAwait(false);
       }
 

diff --git a/src/Testcontainers/Configurations/Unix.cs b/src/Testcontainers/Configurations/Unix.cs
@@ -10,6 +10,60 @@ namespace DotNet.Testcontainers.Configurations
   [PublicAPI]
   public sealed class Unix : IOperatingSystem
   {
+    /// <summary>
+    /// Represents the Unix file mode 644, which grants read and write permissions to the user and read permissions to the group and others.
+    /// </summary>
+    public const UnixFileMode FileMode644 =
+      UnixFileMode.UserRead |
+      UnixFileMode.UserWrite |
+      UnixFileMode.GroupRead |
+      UnixFileMode.OtherRead;
+
+    /// <summary>
+    /// Represents the Unix file mode 666, which grants read and write permissions to the user, group, and others.
+    /// </summary>
+    public const UnixFileMode FileMode666 =
+      UnixFileMode.UserRead |
+      UnixFileMode.UserWrite |
+      UnixFileMode.GroupRead |
+      UnixFileMode.GroupWrite |
+      UnixFileMode.OtherRead |
+      UnixFileMode.OtherWrite;
+
+    /// <summary>
+    /// Represents the Unix file mode 700, which grants read, write, and execute permissions to the user, and no permissions to the group and others.
+    /// </summary>
+    public const UnixFileMode FileMode700 =
+      UnixFileMode.UserRead |
+      UnixFileMode.UserWrite |
+      UnixFileMode.UserExecute;
+
+    /// <summary>
+    /// Represents the Unix file mode 755, which grants read, write, and execute permissions to the user, and read and execute permissions to the group and others.
+    /// </summary>
+    public const UnixFileMode FileMode755 =
+      UnixFileMode.UserRead |
+      UnixFileMode.UserWrite |
+      UnixFileMode.UserExecute |
+      UnixFileMode.GroupRead |
+      UnixFileMode.GroupExecute |
+      UnixFileMode.OtherRead |
+      UnixFileMode.OtherExecute;
+
+    /// <summary>
+    /// Represents the Unix file mode 777, which grants read, write, and execute permissions to the user, group, and others.
+    /// </summary>
+    public const UnixFileMode FileMode777 =
+      UnixFileMode.UserRead |
+      UnixFileMode.UserWrite |
+      UnixFileMode.UserExecute |
+      UnixFileMode.GroupRead |
+      UnixFileMode.GroupWrite |
+      UnixFileMode.GroupExecute |
+      UnixFileMode.OtherRead |
+      UnixFileMode.OtherWrite |
+      UnixFileMode.OtherExecute;
+
     /// <summary>
     /// Initializes a new instance of the <see cref="Unix" /> class.
     /// </summary>
@@ -49,6 +103,12 @@ public Unix(IDockerEndpointAuthenticationConfiguration dockerEndpointAuthConfig)
       DockerEndpointAuthConfig = dockerEndpointAuthConfig;
     }
 
+    /// <summary>
+    /// Gets the <see cref="IOperatingSystem" /> instance.
+    /// </summary>
+    public static IOperatingSystem Instance { get; }
+      = new Unix(dockerEndpointAuthConfig: null);
+
     /// <inheritdoc />
     public IDockerEndpointAuthenticationConfiguration DockerEndpointAuthConfig { get; }