Test Unicode string. (#1511)

* Test Unicode string
* Support Unicode in Firebird tests
* Support Unicode in Oracle tests

Author: fredericDelaporte

build-common/teamcity-hibernate.cfg.xml

@@ -24,5 +24,7 @@
 			<property name="adonet.wrap_result_sets">false</property>
 
 			<property name="odbc.explicit_datetime_scale"></property>
+			<property name="oracle.use_n_prefixed_types_for_unicode"></property>
+			<property name="query.default_cast_length"></property>
 		</session-factory>
 	</hibernate-configuration>

default.build

@@ -133,6 +133,26 @@
 				<namespace prefix="hbm" uri="urn:nhibernate-configuration-2.2" />
 			</namespaces>
 		</xmlpoke>
+
+		<!-- Make sure the property exists - it's only set for some scenarios. -->
+		<property name="nhibernate.oracle.use_n_prefixed_types_for_unicode" value="" unless="${property::exists('nhibernate.oracle.use_n_prefixed_types_for_unicode')}"/>
+		<xmlpoke file="${app.config}"
+			xpath="//*/hbm:property[@name='oracle.use_n_prefixed_types_for_unicode']"
+			value="${nhibernate.oracle.use_n_prefixed_types_for_unicode}">
+			<namespaces>
+				<namespace prefix="hbm" uri="urn:nhibernate-configuration-2.2" />
+			</namespaces>
+		</xmlpoke>
+
+		<!-- Make sure the property exists - it's only set for some scenarios. -->
+		<property name="nhibernate.query.default_cast_length" value="" unless="${property::exists('nhibernate.query.default_cast_length')}"/>
+		<xmlpoke file="${app.config}"
+			xpath="//*/hbm:property[@name='query.default_cast_length']"
+			value="${nhibernate.query.default_cast_length}">
+			<namespaces>
+				<namespace prefix="hbm" uri="urn:nhibernate-configuration-2.2" />
+			</namespaces>
+		</xmlpoke>
 	</target>
 
 	<target name="put-connection-settings-into-app-config">

lib/teamcity/firebird/firebird_installation.txt

@@ -23,9 +23,10 @@ UserManager = Srp
 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 manual testing, take care of not creating the NHibernate database 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.
+Due to test constraints, make sure you create the database with a 16384 page size.
 
 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
@@ -35,4 +36,6 @@ 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.
+Note that the TestDatabaseSetup will drop and recreate the database when run, with forced writes disabled
+and with a 16384 page size. So you may consider running the TestDatabaseSetup test instead for creating the
+NHibernate database.

lib/teamcity/oracle/oracle_installation.txt

@@ -7,8 +7,9 @@ Installation steps for Oracle for NH TeamCity:
 
 2.  Run the installer ...
 3.  Choose any HTTP port for the listener if asked (it may automatically choose the default 8080 if available);
-4.  Choose the ASCII character set. You will have to ensure nhibernate.oracle.use_n_prefixed_types_for_unicode
-    parameter is set to true; Choosing instead the Unicode character set will cause some NHibernate tests to fail.
+4.  Choose the ASCII character set. You will have to ensure oracle.use_n_prefixed_types_for_unicode
+    parameter is set to true and that query.default_cast_length is set to 2000. Choosing instead the Unicode
+    character set will cause some NHibernate tests to fail.
 5.  Enter 'password' as the password for the SYS and SYSTEM accounts;
 6.  The setup should install Oracle on the machine.
 

src/NHibernate.Config.Templates/FireBird.cfg.xml

@@ -22,6 +22,7 @@ for your own use before compile tests in VisualStudio.
 			Database=nhibernate;
 			User ID=SYSDBA;Password=masterkey;
 			MaxPoolSize=200;
+			charset=utf8;
 		</property>
 		<property name="show_sql">false</property>
 		<property name="dialect">NHibernate.Dialect.FirebirdDialect</property>

src/NHibernate.Config.Templates/Oracle-Managed.cfg.xml

@@ -14,5 +14,12 @@ for your own use before compile tests in VisualStudio.
 		<property name="show_sql">false</property>
 		<property name="dialect">NHibernate.Dialect.Oracle10gDialect</property>
 		<property name="query.substitutions">true 1, false 0, yes 'Y', no 'N'</property>
+		<!-- If your database setup use an ASCII charset, switch following property to true. -->
+		<property name="oracle.use_n_prefixed_types_for_unicode">false</property>
+		<!-- Depending on your database setup, the default cast length of 4000 may be too big.
+		     By example, if previous setting is true, NHibernate may try to use nvarchar2(4000),
+		     which will be rejected if its underlying charset is UTF16 and the database
+		     MAX_STRING_SIZE is not extended. In such case, reduce it to 2000. -->
+		<property name="query.default_cast_length"></property>
 	</session-factory>
 </hibernate-configuration>

src/NHibernate.Config.Templates/Oracle.cfg.xml

@@ -14,5 +14,12 @@ for your own use before compile tests in VisualStudio.
 		<property name="show_sql">false</property>
 		<property name="dialect">NHibernate.Dialect.OracleDialect</property>
 		<property name="query.substitutions">true 1, false 0, yes 'Y', no 'N'</property>
+		<!-- If your database setup use an ASCII charset, switch following property to true. -->
+		<property name="oracle.use_n_prefixed_types_for_unicode">false</property>
+		<!-- Depending on your database setup, the default cast length of 4000 may be too big.
+		     By example, if previous setting is true, NHibernate may try to use nvarchar2(4000),
+		     which will be rejected if its underlying charset is UTF16 and the database
+		     MAX_STRING_SIZE is not extended. In such case, reduce it to 2000. -->
+		<property name="query.default_cast_length"></property>
 	</session-factory>
 </hibernate-configuration>

src/NHibernate.Test/Async/TypesTest/StringTypeFixture.cs

@@ -8,15 +8,13 @@
 //------------------------------------------------------------------------------
 
 
-using System;
+using System.Linq;
 using NUnit.Framework;
+using NHibernate.Linq;
 
 namespace NHibernate.Test.TypesTest
 {
 	using System.Threading.Tasks;
-	/// <summary>
-	/// Summary description for StringTypeFixture.
-	/// </summary>
 	[TestFixture]
 	public class StringTypeFixtureAsync : TypeFixtureBase
 	{
@@ -25,6 +23,14 @@ protected override string TypeName
 			get { return "String"; }
 		}
 
+		protected override void OnTearDown()
+		{
+			using (var s = OpenSession())
+			{
+				s.CreateQuery("delete from StringClass").ExecuteUpdate();
+			}
+		}
+
 		[Test]
 		public async Task InsertNullValueAsync()
 		{
@@ -38,12 +44,27 @@ public async Task InsertNullValueAsync()
 
 			using (ISession s = OpenSession())
 			{
-				StringClass b = (StringClass) await (s.CreateCriteria(
-				                              	typeof(StringClass)).UniqueResultAsync());
-				Assert.IsNull(b.StringValue);
-				await (s.DeleteAsync(b));
+				StringClass b = (StringClass) await (s.CreateCriteria(typeof(StringClass)).UniqueResultAsync());
+				Assert.That(b.StringValue, Is.Null);
+			}
+		}
+
+		[Test]
+		public async Task InsertUnicodeValueAsync()
+		{
+			const string unicode = "길동 최고 新闻 地图 ます プル éèêëîïôöõàâäåãçùûü бджзй αβ ខគឃ ضذخ";
+			using (var s = OpenSession())
+			{
+				var b = new StringClass { StringValue = unicode };
+				await (s.SaveAsync(b));
 				await (s.FlushAsync());
 			}
+
+			using (var s = OpenSession())
+			{
+				var b = await (s.Query<StringClass>().SingleAsync());
+				Assert.That(b.StringValue, Is.EqualTo(unicode));
+			}
 		}
 	}
-}
+}

src/NHibernate.Test/TypesTest/StringTypeFixture.cs

@@ -1,11 +1,8 @@
-using System;
+using System.Linq;
 using NUnit.Framework;
 
 namespace NHibernate.Test.TypesTest
 {
-	/// <summary>
-	/// Summary description for StringTypeFixture.
-	/// </summary>
 	[TestFixture]
 	public class StringTypeFixture : TypeFixtureBase
 	{
@@ -14,6 +11,14 @@ protected override string TypeName
 			get { return "String"; }
 		}
 
+		protected override void OnTearDown()
+		{
+			using (var s = OpenSession())
+			{
+				s.CreateQuery("delete from StringClass").ExecuteUpdate();
+			}
+		}
+
 		[Test]
 		public void InsertNullValue()
 		{
@@ -27,12 +32,27 @@ public void InsertNullValue()
 
 			using (ISession s = OpenSession())
 			{
-				StringClass b = (StringClass) s.CreateCriteria(
-				                              	typeof(StringClass)).UniqueResult();
-				Assert.IsNull(b.StringValue);
-				s.Delete(b);
+				StringClass b = (StringClass) s.CreateCriteria(typeof(StringClass)).UniqueResult();
+				Assert.That(b.StringValue, Is.Null);
+			}
+		}
+
+		[Test]
+		public void InsertUnicodeValue()
+		{
+			const string unicode = "길동 최고 新闻 地图 ます プル éèêëîïôöõàâäåãçùûü бджзй αβ ខគឃ ضذخ";
+			using (var s = OpenSession())
+			{
+				var b = new StringClass { StringValue = unicode };
+				s.Save(b);
 				s.Flush();
 			}
+
+			using (var s = OpenSession())
+			{
+				var b = s.Query<StringClass>().Single();
+				Assert.That(b.StringValue, Is.EqualTo(unicode));
+			}
 		}
 	}
-}
+}

src/NHibernate.TestDatabaseSetup/TestDatabaseSetup.cs

@@ -112,7 +112,10 @@ private static void SetupFirebird(Cfg.Configuration cfg)
 			{
 				Console.WriteLine(e);
 			}
-			FbConnection.CreateDatabase(connStr, forcedWrites:false);
+			// With UTF8 charset, string takes up to four times as many space, causing the
+			// default page-size of 4096 to no more be enough for index key sizes. (Index key
+			// size is limited to a quarter of the page size.)
+			FbConnection.CreateDatabase(connStr, pageSize:16384, forcedWrites:false);
 		}
 
 		private static void SetupSqlServerCe(Cfg.Configuration cfg)