[testcontainers#399] #IMPLEMENT 'assemblyName: DotNet.Testcontainers;…

… function: ExecScript {Add function in the database modules to execute scripts}
fabiogouw · Oct 4, 2021 · d811057 · d811057
1 parent ef67133
commit d811057
Show file tree

Hide file tree

Showing 13 changed files with 274 additions and 8 deletions.
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/CouchbaseTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/CouchbaseTestcontainer.cs
@@ -1,13 +1,16 @@
 namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
   using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class CouchbaseTestcontainer : TestcontainerDatabase
+  public sealed class CouchbaseTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     private const string CouchbaseCli = "/opt/couchbase/bin/couchbase-cli";
 
@@ -50,5 +53,18 @@ public Task<ExecResult> FlushBucket(string bucket)
       var flushBucketCommand = $"yes | {CouchbaseCli} bucket-flush -c 127.0.0.1:8091 --username {this.Username} --password {this.Password} --bucket {bucket}";
       return this.ExecAsync(new[] { "/bin/sh", "-c", flushBucketCommand });
     }
+
+    /// <summary>
+    /// Executes a N1QL script in the database container.
+    /// </summary>
+    /// <param name="scriptContent">The content of the N1QL script to be executed.</param>
+    /// <returns>Task that completes when the script has been executed.</returns>
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.n1ql";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"cbq -user {this.Username} -password {this.Password} -file={randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/MsSqlTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/MsSqlTestcontainer.cs
@@ -1,12 +1,16 @@
 namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
+  using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class MsSqlTestcontainer : TestcontainerDatabase
+  public sealed class MsSqlTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     /// <summary>
     /// Initializes a new instance of the <see cref="MsSqlTestcontainer" /> class.
@@ -21,5 +25,14 @@ internal MsSqlTestcontainer(ITestcontainersConfiguration configuration, ILogger
     /// <inheritdoc />
     public override string ConnectionString
       => $"Server={this.Hostname},{this.Port};Database={this.Database};User Id={this.Username};Password={this.Password};";
+
+    /// <inheritdoc />
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.sql";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"/opt/mssql-tools/bin/sqlcmd -b -r1 -S {this.Hostname} -U {this.Username} -P \"{this.Password}\" -i {randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/MySqlTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/MySqlTestcontainer.cs
@@ -1,12 +1,16 @@
 namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
+  using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class MySqlTestcontainer : TestcontainerDatabase
+  public sealed class MySqlTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     /// <summary>
     /// Initializes a new instance of the <see cref="MySqlTestcontainer" /> class.
@@ -21,5 +25,14 @@ internal MySqlTestcontainer(ITestcontainersConfiguration configuration, ILogger
     /// <inheritdoc />
     public override string ConnectionString
       => $"Server={this.Hostname};Port={this.Port};Database={this.Database};Uid={this.Username};Pwd={this.Password};";
+
+    /// <inheritdoc />
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.sql";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"mysql -u{this.Username} -p{this.Password} {this.Database} < {randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/OracleTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/OracleTestcontainer.cs
@@ -1,12 +1,16 @@
-namespace DotNet.Testcontainers.Containers
+namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
+  using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class OracleTestcontainer : TestcontainerDatabase
+  public sealed class OracleTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     /// <summary>
     /// Initializes a new instance of the <see cref="OracleTestcontainer" /> class.
@@ -21,5 +25,14 @@ internal OracleTestcontainer(ITestcontainersConfiguration configuration, ILogger
     /// <inheritdoc />
     public override string ConnectionString
       => $"Data Source={this.Hostname}:{this.Port};User id={this.Username};Password={this.Password};";
+
+    /// <inheritdoc />
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.sql";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"exit | $ORACLE_HOME/bin/sqlplus -S {this.Username}/{this.Password}@{this.Hostname} @{randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/PostgreSqlTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/PostgreSqlTestcontainer.cs
@@ -1,12 +1,16 @@
 namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
+  using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class PostgreSqlTestcontainer : TestcontainerDatabase
+  public sealed class PostgreSqlTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     /// <summary>
     /// Initializes a new instance of the <see cref="PostgreSqlTestcontainer" /> class.
@@ -21,5 +25,14 @@ internal PostgreSqlTestcontainer(ITestcontainersConfiguration configuration, ILo
     /// <inheritdoc />
     public override string ConnectionString
       => $"Server={this.Hostname};Port={this.Port};Database={this.Database};User Id={this.Username};Password={this.Password};";
+
+    /// <inheritdoc />
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.sql";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"psql -U {this.Username} -d {this.Database} -a -f {randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/Databases/RedisTestcontainer.cs b/src/DotNet.Testcontainers/Containers/Modules/Databases/RedisTestcontainer.cs
@@ -1,12 +1,16 @@
 namespace DotNet.Testcontainers.Containers
 {
+  using System;
+  using System.Text;
+  using System.Threading.Tasks;
   using DotNet.Testcontainers.Configurations;
+  using DotNet.Testcontainers.Containers.Modules;
   using JetBrains.Annotations;
   using Microsoft.Extensions.Logging;
 
   /// <inheritdoc cref="TestcontainerDatabase" />
   [PublicAPI]
-  public sealed class RedisTestcontainer : TestcontainerDatabase
+  public sealed class RedisTestcontainer : TestcontainerDatabase, IScriptExecution
   {
     /// <summary>
     /// Initializes a new instance of the <see cref="RedisTestcontainer" /> class.
@@ -21,5 +25,18 @@ internal RedisTestcontainer(ITestcontainersConfiguration configuration, ILogger
     /// <inheritdoc />
     public override string ConnectionString
       => $"{this.Hostname}:{this.Port}";
+
+    /// <summary>
+    /// Executes a Lua script in the database container.
+    /// </summary>
+    /// <param name="scriptContent">The content of the Lua script to be executed.</param>
+    /// <returns>Task that completes when the script has been executed.</returns>
+    public async Task<ExecResult> ExecScript(string scriptContent)
+    {
+      var randomFileName = $"/{Guid.NewGuid()}.lua";
+      await this.CopyFileAsync(randomFileName, Encoding.ASCII.GetBytes(scriptContent));
+      var execScriptCommand = $"redis-cli --no-raw --eval {randomFileName}";
+      return await this.ExecAsync(new[] { "/bin/sh", "-c", execScriptCommand });
+    }
   }
 }
diff --git a/src/DotNet.Testcontainers/Containers/Modules/IScriptExecution.cs b/src/DotNet.Testcontainers/Containers/Modules/IScriptExecution.cs
@@ -0,0 +1,19 @@
+namespace DotNet.Testcontainers.Containers.Modules
+{
+  using System.Threading.Tasks;
+  using JetBrains.Annotations;
+
+  /// <summary>
+  /// Define the contract for database modules that has the script execution capability.
+  /// </summary>
+  public interface IScriptExecution
+  {
+    /// <summary>
+    /// Executes a script in the database container.
+    /// </summary>
+    /// <param name="scriptContent">The content of the script to be executed.</param>
+    /// <returns>Task that completes when the script has been executed.</returns>
+    [PublicAPI]
+    Task<ExecResult> ExecScript(string scriptContent);
+  }
+}
diff --git a/...Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/CouchbaseTestcontainerTest.cs b/...Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/CouchbaseTestcontainerTest.cs
@@ -233,6 +233,27 @@ public void ShouldThrowArgumentOutOfRangeExceptionWhenClusterAnalyticsRamSizeIsN
       Assert.Equal("Couchbase ClusterAnalyticsRamSize ram size can not be less than 1024 MB. (Parameter 'ClusterAnalyticsRamSize')", exception.Message);
     }
 
+    [Fact]
+    public async Task ShouldExecuteCommandsWhenScriptExecuted()
+    {
+      // Given
+      var script = @"
+        CREATE PRIMARY INDEX ON `Sample`;
+        INSERT INTO `Sample` (KEY,VALUE) 
+        VALUES (""mykey"", { ""name"": ""MyName"", ""type"": ""MyType""});
+        SELECT * FROM `Sample`;
+        ";
+
+      // When
+      await this.couchbaseFixture.Container.ExecScript(script)
+        .ConfigureAwait(false);
+      var results = await this.couchbaseFixture.Container.ExecScript("SELECT * FROM `Sample`")
+        .ConfigureAwait(false);
+
+      // Then
+      Assert.Contains("MyName", results.Stdout);
+    }
+
     private readonly struct Customer
     {
       public Customer(string name, int age)

diff --git a/...Net.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/MsSqlTestcontainerTest.cs b/...Net.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/MsSqlTestcontainerTest.cs
@@ -44,5 +44,44 @@ public void CannotSetUsername()
       var mssql = new MsSqlTestcontainerConfiguration();
       Assert.Throws<NotImplementedException>(() => mssql.Username = string.Empty);
     }
+
+    [Fact]
+    public async Task ScriptExecuted()
+    {
+      // Given
+      var script = @"
+        CREATE DATABASE testcontainers;
+        GO
+        USE testcontainers;
+        GO
+        CREATE TABLE MyTable (
+        id INT,
+        name VARCHAR(30) NOT NULL
+        );
+        GO
+        INSERT INTO MyTable (id, name) VALUES (1, 'MyName');
+        SELECT * FROM MyTable;
+        ";
+
+      // When
+      var results = await this.msSqlFixture.Container.ExecScript(script);
+
+      // Then
+      Assert.Contains("MyName", results.Stdout);
+    }
+
+    [Fact]
+    public async Task ScriptThrowsError()
+    {
+      // Given
+      var script = "invalid SQL command";
+
+      // When
+      var results = await this.msSqlFixture.Container.ExecScript(script);
+
+      // Then
+      Assert.NotEqual(0, results.ExitCode);
+      Assert.NotEqual(string.Empty, results.Stderr);
+    }
   }
 }
diff --git a/...Net.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/MySqlTestcontainerTest.cs b/...Net.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/MySqlTestcontainerTest.cs
@@ -28,5 +28,41 @@ await connection.OpenAsync()
       // Then
       Assert.Equal(ConnectionState.Open, connection.State);
     }
+
+    [Fact]
+    public async Task ScriptExecuted()
+    {
+      // Given
+      var script = @"
+        CREATE TABLE MyTable (
+        id INT(6) UNSIGNED PRIMARY KEY,
+        name VARCHAR(30) NOT NULL
+        );
+        GO
+        INSERT INTO MyTable (id, name) VALUES (1, 'MyName');
+        GO
+        SELECT * FROM MyTable;
+        ";
+
+      // When
+      var results = await this.mySqlFixture.Container.ExecScript(script);
+
+      // Then
+      Assert.Contains("MyName", results.Stdout);
+    }
+
+    [Fact]
+    public async Task ScriptThrowsError()
+    {
+      // Given
+      var script = "invalid SQL command";
+
+      // When
+      var results = await this.mySqlFixture.Container.ExecScript(script);
+
+      // Then
+      Assert.NotEqual(0, results.ExitCode);
+      Assert.NotEqual(string.Empty, results.Stderr);
+    }
   }
 }
diff --git a/...et.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/OracleTestcontainerTest.cs b/...et.Testcontainers.Tests/Unit/Containers/Unix/Modules/Databases/OracleTestcontainerTest.cs
@@ -1,4 +1,4 @@
-namespace DotNet.Testcontainers.Tests.Unit
+namespace DotNet.Testcontainers.Tests.Unit
 {
   using System;
   using System.Data;
@@ -51,5 +51,26 @@ public void CannotSetPassword()
       var oracle = new OracleTestcontainerConfiguration();
       Assert.Throws<NotImplementedException>(() => oracle.Password = string.Empty);
     }
+
+    [Fact]
+    public async Task ScriptExecuted()
+    {
+      // Given
+      var script = @"
+        CREATE TABLE MyTable (
+        id INT,
+        name VARCHAR(30) NOT NULL
+        );
+        GO
+        INSERT INTO MyTable (id, name) VALUES (1, 'MyName');
+        SELECT * FROM MyTable;
+        ";
+
+      // When
+      var results = await this.oracleFixture.Container.ExecScript(script);
+
+      // Then
+      Assert.Contains("MyName", results.Stdout);
+    }
   }
 }