Merge pull request #118 from FOCONIS/sqlserver-startup-issue

Fix flaky SqlServer startup issue

Author: rbygrave

src/main/java/io/ebean/test/containers/SqlServerContainer.java

@@ -80,6 +80,27 @@ void dropCreateDatabase() {
     createRoleAndDatabase(true);
   }
 
+  @Override
+  boolean checkConnectivity(boolean useAdmin) {
+    if (!isDefaultCollation()) {
+      if (!logsContain("The default collation was successfully changed", "Attempting to change default collation")) {
+        // When starting a container other than the default collation, sql server rebuilds some indices for master/tempdb/...
+        // if these indices are accessed during this period (e.g. 'drop database test_db' will access systable indices)
+        // you will get a "Cannot resolve the collation conflict between" error or some other errors during startup
+        return false;
+      }
+    }
+    return super.checkConnectivity(useAdmin);
+  }
+
+  private boolean isDefaultCollation() {
+    if (dbConfig.getCollation() == null) {
+      return false;
+    }
+    return "default".equals(dbConfig.getCollation())
+      || "SQL_Latin1_General_CP1_CI_AS".equals(dbConfig.getCollation());
+  }
+
   private void createRoleAndDatabase(boolean withDrop) {
     IllegalStateException cause = null;
     for (int i = 0; i < 3; i++) {
@@ -151,6 +172,8 @@ private void dropDatabaseIfExists(Connection connection) {
   }
 
   private void dropDatabase(Connection connection, String dbName) {
+    sqlRun(connection, "alter database " + dbName + " set offline with rollback immediate"); // close all connections to DB
+    sqlRun(connection, "alter database " + dbName + " set online");
     sqlRun(connection, "drop database " + dbName);
   }
 

src/test/java/io/ebean/test/containers/SqlServerContainerTest.java

@@ -4,8 +4,10 @@
 import org.junit.jupiter.api.Test;
 
 import java.sql.Connection;
+import java.sql.DriverManager;
 import java.sql.PreparedStatement;
 import java.sql.SQLException;
+import java.sql.Statement;
 import java.util.Properties;
 
 class SqlServerContainerTest {
@@ -27,6 +29,27 @@ void start() {
     container.stopRemove();
   }
 
+  /**
+   * startWithDropCreate does not work, when the container is running and there is a connection open.
+   */
+  @Disabled
+  @Test
+  void start_dropCreate_withLeakingConnection() throws Exception {
+    SqlServerContainer container = SqlServerContainer.builder(SQLSERVER_VER)
+      .containerName("temp_sqlserver")
+      .port(2433)
+      .collation("Latin1_General_100_BIN2")
+      .build();
+    container.startWithDropCreate();
+    try (Connection conn = DriverManager.getConnection(container.jdbcUrl(), container.dbConfig.getUsername(), container.dbConfig.getPassword())) {
+      // drop during open connection
+      container.startWithDropCreate();
+    } finally {
+      container.stopRemove();
+
+    }
+  }
+
   @Disabled
   @Test
   void start_when_defaultCollation() {
@@ -40,6 +63,19 @@ void start_when_defaultCollation() {
     container.stopRemove();
   }
 
+  @Disabled
+  @Test
+  void start_when_explicitDefaultCollation() {
+    SqlServerContainer container = SqlServerContainer.builder(SQLSERVER_VER)
+      .containerName("temp_sqlserver")
+      .port(2433)
+      .collation("SQL_Latin1_General_CP1_CI_AS")
+      .build();
+
+    container.startWithCreate();
+    container.stopRemove();
+  }
+
   @Disabled
   @Test
   void start_when_noCollation() {
@@ -65,6 +101,40 @@ void start_when_explicitCollation() {
     container.stopRemove();
   }
 
+  /**
+   * When Collation is changed, the server sometimes will not start with dropCreate, because there are async
+   * processes on container start. We must ensure, that we wait until container is started.
+   * <p>
+   * It is very hard to reproduce, I could only reproduce it with "startWithDropCreate" and an active
+   * screen sharing session... So the test may look a bit messy to get the correct timing.
+   * <p>
+   * I observed the output:
+   * 16:14:42.726 [main] DEBUG io.ebean.test.containers - connectivity confirmed for temp_sqlserver
+   * <p>
+   * comparing the timestamp with the docker-logs, the server was in the middle of collation change process.
+   */
+  @Disabled
+  @Test
+  void start_dropCreate_explicitCollationTimmingTest() throws Exception {
+    SqlServerContainer container = SqlServerContainer.builder(SQLSERVER_VER)
+      .containerName("temp_sqlserver")
+      .port(2433)
+      .collation("Latin1_General_100_BIN2")
+      .build();
+    for (int i = 0; i < 10; i++) {
+      container.startWithDropCreate();
+      try (Connection conn = DriverManager.getConnection(container.jdbcUrl(), container.dbConfig.getUsername(), container.dbConfig.getPassword())) {
+        for (int j = 0; j < 10; j++) {
+          Statement stmt = conn.createStatement();
+          stmt.execute("create table my_test" + j + " (id int)");
+          conn.commit();
+        }
+        Thread.sleep(2000);
+        container.stopRemove();
+      }
+    }
+  }
+
   @Disabled
   @Test
   void viaContainerFactory() {