NH-4026 - Upgrade Firebird driver and use server (#639)

Author: fredericDelaporte

ShowBuildMenu.bat

@@ -91,14 +91,12 @@ goto test-setup-generic
 set CONFIG_NAME=FireBird
 set PLATFORM=x86
 set LIB_FILES=lib\teamcity\firebird\*.dll
-set LIB_FILES2=lib\teamcity\firebird\x86\*
 goto test-setup-generic
 
 :test-setup-firebirdx64
 set CONFIG_NAME=FireBird
 set PLATFORM=x64
 set LIB_FILES=lib\teamcity\firebird\*.dll
-set LIB_FILES2=lib\teamcity\firebird\x64\*
 goto test-setup-generic
 
 :test-setup-sqlitex86

lib/teamcity/firebird/FirebirdSql.Data.FirebirdClient.dll

@@ -0,0 +1,38 @@
+
+Installation steps for Firebird for NH TeamCity:
+
+1.  Download Firebird (Firebird-3.0.2.32703_0_x64):  https://www.firebirdsql.org/en/server-packages/;
+2.  Run the installer AS ADMINISTRATOR... Use the default firebird password when prompted: masterkey.
+3.  Leave other settings with their defaults.
+4.  The setup should install Firebird on the machine;
+5.  Go into Firebird folder (c:\program files\firebird\) and create a folder named Data;
+6.  Go in Firebird installation directory and open databases.conf.
+7.  Add in "Live Databases" section:
+nhibernate = D:\nhibernate.fdb
+    Firebird is particularly sensitive to disk performances, and D: is supposed to be local to the
+    Teamcity host, thus this choice. Content of this drive may be lost. But the TestDatabaseSetup will
+    instruct Firebird to recreate the database. It is put on the root because Firebird will not create
+    the folder, and the TestDatabaseSetup should not try to do that because it is used by other hosts
+    which may not want to do anything on D:.
+8.  Open firebird.conf.
+9.  Ensure AuthClient, AuthServer and UserManager are set to Srp only:
+AuthServer = Srp
+AuthClient = Srp
+UserManager = Srp
+10. Ensure WireCrypt is set to Enabled.
+WireCrypt = Enabled
+11. Restart Firebird service.
+
+For manual testing, take care of not creating it with inadequate acl on the file. This may happen
+if you use ISQL with a connection string causing it to create it in embedded mode, without actually
+using the server. Prefixing your path with "localhost:" should avoid that.
+
+For tests performances, and since it is just an expandable test database, better disable forced writes.
+Since those tests drop/create schema constantly, they are quite heavy on writes and this single setting
+can have a six fold impact on their duration. For changing it, do:
+a.  Stop Firebird service.
+b.  From Firebird installation folder, run:
+gfix -w async nhibernate -user SYSDBA
+    (Change "nhibernate" to your own alias or path as appropriate for your setup) 
+c.  Restart Firebird service.
+Note that the TestDatabaseSetup will drop and recreate the database when run, with forced writes disabled.

lib/teamcity/firebird/NHibernate.Test.last-results.xml

@@ -18,9 +18,10 @@ for your own use before compile tests in VisualStudio.
 	<session-factory name="NHibernate.Test">
 		<property name="connection.driver_class">NHibernate.Driver.FirebirdClientDriver</property>
 		<property name="connection.connection_string">
-			Server=localhost;
-			Database=C:\nhibernate.fdb;
-			User=SYSDBA;Password=masterkey
+			DataSource=localhost;
+			Database=nhibernate;
+			User ID=SYSDBA;Password=masterkey;
+			MaxPoolSize=200;
 		</property>
 		<property name="show_sql">false</property>
 		<property name="dialect">NHibernate.Dialect.FirebirdDialect</property>

lib/teamcity/firebird/firebird_installation.txt

@@ -1,4 +1,5 @@
-using System.Data;
+using System;
+using System.Data;
 using System.Data.Common;
 using NHibernate.Driver;
 using NHibernate.SqlCommand;
@@ -17,48 +18,58 @@ public class FirebirdClientDriverFixture
 		public void ConnectionPooling_OpenThenCloseThenOpenAnotherOne_OnlyOneConnectionIsPooled()
 		{
 			MakeDriver();
+
+			_driver.ClearPool(_connectionString);
+
+			var allreadyEstablished = GetEstablishedConnections();
+
 			var connection1 = MakeConnection();
 			var connection2 = MakeConnection();
 
 			//open first connection
 			connection1.Open();
-			VerifyCountOfEstablishedConnectionsIs(1);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 1, "After first open");
 
 			//return it to the pool
 			connection1.Close();
-			VerifyCountOfEstablishedConnectionsIs(1);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 1, "After first close");
 
 			//open the second connection
 			connection2.Open();
-			VerifyCountOfEstablishedConnectionsIs(1);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 1, "After second open");
 
 			//return it to the pool
 			connection2.Close();
-			VerifyCountOfEstablishedConnectionsIs(1);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 1, "After second close");
 		}
 
 		[Test]
 		public void ConnectionPooling_OpenThenCloseTwoAtTheSameTime_TowConnectionsArePooled()
 		{
 			MakeDriver();
+
+			_driver.ClearPool(_connectionString);
+
+			var allreadyEstablished = GetEstablishedConnections();
+
 			var connection1 = MakeConnection();
 			var connection2 = MakeConnection();
 
 			//open first connection
 			connection1.Open();
-			VerifyCountOfEstablishedConnectionsIs(1);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 1, "After first open");
 
 			//open second one
 			connection2.Open();
-			VerifyCountOfEstablishedConnectionsIs(2);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 2, "After second open");
 
 			//return connection1 to the pool
 			connection1.Close();
-			VerifyCountOfEstablishedConnectionsIs(2);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 2, "After first close");
 
 			//return connection2 to the pool
 			connection2.Close();
-			VerifyCountOfEstablishedConnectionsIs(2);
+			VerifyCountOfEstablishedConnectionsIs(allreadyEstablished + 2, "After second close");
 		}
 
 		[Test]
@@ -163,10 +174,10 @@ private DbConnection MakeConnection()
 			return result;
 		}
 
-		private void VerifyCountOfEstablishedConnectionsIs(int expectedCount)
+		private void VerifyCountOfEstablishedConnectionsIs(int expectedCount, string step)
 		{
 			var physicalConnections = GetEstablishedConnections();
-			Assert.That(physicalConnections, Is.EqualTo(expectedCount));
+			Assert.That(physicalConnections, Is.EqualTo(expectedCount), step);
 		}
 
 		private int GetEstablishedConnections()
@@ -178,7 +189,7 @@ private int GetEstablishedConnections()
 				using (var cmd = conn.CreateCommand())
 				{
 					cmd.CommandText = "select count(*) from mon$attachments where mon$attachment_id <> current_connection";
-					return (int)cmd.ExecuteScalar();
+					return Convert.ToInt32(cmd.ExecuteScalar());
 				}
 			}
 		}

lib/teamcity/firebird/x64/fbembed.dll

@@ -733,6 +733,14 @@ public void Cast()
 						if (!ex.InnerException.Message.StartsWith("ORA-00979"))
 							throw;
 					}
+					else if (Dialect is FirebirdDialect)
+					{
+						string msgToCheck =
+							"not contained in either an aggregate function or the GROUP BY clause";
+						// This test raises an exception in Firebird for an unknown reason.
+						if (!ex.InnerException.Message.Contains(msgToCheck))
+							throw;
+					}
 					else
 					{
 						string msgToCheck =

lib/teamcity/firebird/x64/firebird.msg

@@ -2,7 +2,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
-using NHibernate.Util;
+using NHibernate.Dialect;
 using NUnit.Framework;
 
 namespace NHibernate.Test.NHSpecificTest.NH1908ThreadSafety
@@ -12,29 +12,12 @@ public class Fixture : BugTestCase
 	{
 		protected override bool AppliesTo(Dialect.Dialect dialect)
 		{
-			return !(dialect is Dialect.Oracle8iDialect);
+			return !(dialect is Oracle8iDialect);
 			// Oracle sometimes causes: ORA-12520: TNS:listener could not find available handler for requested type of server
 			// Following links bizarrely suggest it's an Oracle limitation under load:
 			// http://www.orafaq.com/forum/t/60019/2/ & http://www.ispirer.com/wiki/sqlways/troubleshooting-guide/oracle/import/tns_listener
 		}
 
-		protected override void OnTearDown()
-		{
-			base.OnTearDown();
-
-			if (!(Dialect is Dialect.FirebirdDialect))
-				return;
-
-			// Firebird will pool each connection created during the test and will not drop the created tables
-			// which will result in other tests failing when they try to create tables with same name
-			// By clearing the connection pool the tables will get dropped. This is done by the following code.
-			var fbConnectionType = ReflectHelper.TypeFromAssembly("FirebirdSql.Data.FirebirdClient.FbConnection", "FirebirdSql.Data.FirebirdClient", false);
-			var clearPool = fbConnectionType.GetMethod("ClearPool");
-			var sillyConnection = Sfi.ConnectionProvider.GetConnection();
-			clearPool.Invoke(null, new object[] { sillyConnection });
-			Sfi.ConnectionProvider.CloseConnection(sillyConnection);
-		}
-
 		[Test]
 		public void UsingFiltersIsThreadSafe()
 		{

lib/teamcity/firebird/x64/ib_util.dll

@@ -1,6 +1,4 @@
-using System.Linq;
-using NHibernate.Cfg.MappingSchema;
-using NHibernate.Linq;
+using NHibernate.Cfg.MappingSchema;
 using NHibernate.Mapping.ByCode;
 using NUnit.Framework;
 
@@ -15,9 +13,11 @@ protected override HbmMapping GetMappings()
 			mapper.Class<Document>(rc =>
 			{
 				rc.Id(x => x.Id, idMapper => idMapper.Generator(Generators.Identity));
-				rc.ManyToOne(x => x.Blob, m =>
+				rc.ManyToOne(x => x.Blob,
+					m =>
 					{
 						m.Cascade(Mapping.ByCode.Cascade.All);
+						m.Column("`Blob`");
 					});
 				rc.Property(x => x.Name);
 			});
@@ -30,21 +30,31 @@ protected override HbmMapping GetMappings()
 							y.Length(int.MaxValue);
 							y.Lazy(true);
 						});
+					map.Table("`Blob`");
 				});
 
 			return mapper.CompileMappingForAllExplicitlyAddedEntities();
 		}
 
+		private int _blobId;
+		private int _docId;
+
 		protected override void OnSetUp()
 		{
 			using (ISession session = OpenSession())
 			using (ITransaction transaction = session.BeginTransaction())
 			{
-				var e1 = new Document { Name = "Bob" };
-				e1.Blob = new Blob { Bytes = new byte[] { 1, 2, 3 } };
+				var e1 = new Document
+				{
+					Name = "Bob",
+					Blob = new Blob {Bytes = new byte[] {1, 2, 3}}
+				};
+
 				session.Save(e1);
-				
 				session.Flush();
+
+				_blobId = e1.Blob.Id;
+				_docId = e1.Id;
 				transaction.Commit();
 			}
 		}
@@ -71,7 +81,7 @@ public void TestNoTargetException()
 			document.Blob = blob;
 
 			using (ISession session = OpenSession())
-			using (ITransaction transaction = session.BeginTransaction())
+			using (session.BeginTransaction())
 			{
 				session.Merge(document);
 			}
@@ -82,7 +92,7 @@ private Blob LoadDetachedBlob()
 			using (ISession session = OpenSession())
 			using (session.BeginTransaction())
 			{
-				var blob = session.Get<Blob>(1);
+				var blob = session.Get<Blob>(_blobId);
 				NHibernateUtil.Initialize(blob.Bytes);
 				return blob;
 			}
@@ -93,7 +103,7 @@ private Document LoadDetachedEntity()
 			using (ISession session = OpenSession())
 			using (session.BeginTransaction())
 			{
-				return session.Get<Document>(1);
+				return session.Get<Document>(_docId);
 			}
 		}
 	}

lib/teamcity/firebird/x64/icudt30.dll

@@ -11,9 +11,9 @@
 using NHibernate.Tool.hbm2ddl;
 using NHibernate.Type;
 using NUnit.Framework;
-using NHibernate.Hql.Ast.ANTLR;
 using NUnit.Framework.Interfaces;
 using System.Text;
+using NHibernate.Driver;
 
 namespace NHibernate.Test
 {
@@ -269,6 +269,17 @@ protected virtual void CreateSchema()
 
 		protected virtual void DropSchema()
 		{
+			if (Sfi.ConnectionProvider.Driver is FirebirdClientDriver fbDriver)
+			{
+				// Firebird will pool each connection created during the test and will marked as used any table
+				// referenced by queries. It will at best delays those tables drop until connections are actually
+				// closed, or immediately fail dropping them.
+				// This results in other tests failing when they try to create tables with same name.
+				// By clearing the connection pool the tables will get dropped. This is done by the following code.
+				// Moved from NH1908 test case, contributed by Amro El-Fakharany.
+				fbDriver.ClearPool(null);
+			}
+
 			new SchemaExport(cfg).Drop(OutputDdl, true);
 		}
 

lib/teamcity/firebird/x64/icuin30.dll

@@ -102,17 +102,16 @@ private static void SetupSqlServerOdbc(Cfg.Configuration cfg)
 
 		private static void SetupFirebird(Cfg.Configuration cfg)
 		{
+			var connStr = cfg.Properties[Cfg.Environment.ConnectionString];
 			try
 			{
-				if (File.Exists("NHibernate.fdb"))
-					File.Delete("NHibernate.fdb");
+				FbConnection.DropDatabase(connStr);
 			}
 			catch (Exception e)
 			{
 				Console.WriteLine(e);
 			}
-
-			FbConnection.CreateDatabase("Database=NHibernate.fdb;ServerType=1");
+			FbConnection.CreateDatabase(connStr, forcedWrites:false);
 		}
 
 		private static void SetupSqlServerCe(Cfg.Configuration cfg)