Merge pull request #481 from oskarb/nh3403-param-length-test

Additional tests in StringTypeWithLengthFixture related to NH-3403 and NH-3036

Author: oskarb

src/NHibernate.Test/NHibernate.Test.csproj

@@ -3302,7 +3302,6 @@
     <EmbeddedResource Include="NHSpecificTest\NH2913\Mappings.hbm.xml">
       <SubType>Designer</SubType>
     </EmbeddedResource>
-    <EmbeddedResource Include="TypesTest\StringClassWithLength.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH2846\Mappings.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH1007\Mappings.hbm.xml" />
     <EmbeddedResource Include="NHSpecificTest\NH2907\Mappings.hbm.xml" />

src/NHibernate.Test/TypesTest/StringClassWithLength.hbm.xml

@@ -1,124 +1,308 @@
 using System;
-using System.Collections;
+using System.Linq;
+using NHibernate.Cfg.MappingSchema;
 using NHibernate.Criterion;
 using NHibernate.Dialect;
 using NHibernate.Driver;
+using NHibernate.Exceptions;
+using NHibernate.Linq;
+using NHibernate.Mapping.ByCode;
 using NUnit.Framework;
 
 namespace NHibernate.Test.TypesTest
 {
 	/// <summary>
-	/// Summary description for StringTypeWithLengthFixture.
+	/// Various tests regarding handling of size of query parameters.
 	/// </summary>
 	[TestFixture]
-	public class StringTypeWithLengthFixture : TypeFixtureBase
+	public class StringTypeWithLengthFixture : TestCaseMappingByCode
 	{
-		protected override string TypeName
+		private int GetLongStringMappedLength()
 		{
-			get { return "String"; }
-		}
+			// This is a bit ugly...
+			//
+			// Return a value that should be the largest possible length of a string column
+			// in the corresponding database. Note that the actual column type selected by the dialect
+			// depends on this value, so it must be the largest possible value for the type
+			// that the dialect will pick. Doesn't matter if the dialect can pick another
+			// type for an even larger size.
 
+			if (Dialect is Oracle8iDialect)
+				return 2000;
 
-		protected override IList Mappings
-		{
-			get
-			{
-				return new string[]
-					{
-						String.Format("TypesTest.{0}ClassWithLength.hbm.xml", TypeName)
-					};
-			}
+			if (Dialect is MySQLDialect)
+				return 65535;
+
+			return 4000;
 		}
 
-		protected override bool AppliesTo(Dialect.Dialect dialect)
+		protected override HbmMapping GetMappings()
 		{
-			// this test only works where the driver has set an explicit length on the IDbDataParameter
-			return dialect is MsSql2008Dialect;
+			var mapper = new ModelMapper();
+			mapper.Class<StringClass>(ca =>
+			{
+				ca.Lazy(false);
+				ca.Id(x => x.Id, map => map.Generator(Generators.Assigned));
+				ca.Property(x => x.StringValue, map => map.Length(10));
+				ca.Property(x => x.LongStringValue, map => map.Length(GetLongStringMappedLength()));
+			});
+
+			return mapper.CompileMappingForAllExplicitlyAddedEntities();
 		}
 
+
 		[Test]
-		public void NhThrowsOnTooLong()
+		[Description("Values longer than the maximum possible string length " +
+		             "should raise an exception if they would otherwise be truncated.")]
+		public void ShouldPreventInsertionOfVeryLongStringThatWouldBeTruncated()
 		{
-			int maxStringLength = 4000;
-			PropertyValueException ex = Assert.Throws<PropertyValueException>(() =>
+			// This test case is for when the current driver will use a parameter size
+			// that is significantly larger than the mapped column size (e.g. SqlClientDriver currently).
+
+			// Note: This test could possible be written as
+			//   "database must raise an error OR it must store and return the full value"
+			// to avoid this dialect specific exception.
+			if (Dialect is SQLiteDialect)
+				Assert.Ignore("SQLite does not enforce specified string lengths.");
+
+			int maxStringLength = GetLongStringMappedLength();
+
+			var ex = Assert.Catch<Exception>(
+				() =>
 				{
 					using (ISession s = OpenSession())
 					{
-						StringClass b = new StringClass();
-						b.LongStringValue = new string('x', maxStringLength + 1);
+						StringClass b = new StringClass {LongStringValue = new string('x', maxStringLength + 1)};
 						s.Save(b);
 						s.Flush();
 					}
 				});
 
-			Assert.That(ex.Message, Iz.EqualTo("Error dehydrating property value for NHibernate.Test.TypesTest.StringClass.LongStringValue"));
-			Assert.That(ex.InnerException, Iz.TypeOf<HibernateException>());
-			Assert.That(ex.InnerException.Message, Iz.EqualTo("The length of the string value exceeds the length configured in the mapping/parameter."));
+			AssertFailedInsertExceptionDetailsAndEmptyTable(ex);
 		}
 
 		[Test]
-		public void DbThrowsOnTooLong()
+		[Description("Values longer than the mapped string length " +
+		             "should raise an exception if they would otherwise be truncated.")]
+		public void ShouldPreventInsertionOfTooLongStringThatWouldBeTruncated()
 		{
-			bool dbThrewError = false;
+			// Note: This test could possible be written as
+			//   "database must raise an error OR it must store and return the full value"
+			// to avoid this dialect specific exception.
+			if (Dialect is SQLiteDialect)
+				Assert.Ignore("SQLite does not enforce specified string lengths.");
 
-			try
-			{
-				using (ISession s = OpenSession())
+			var ex = Assert.Catch<Exception>(
+				() =>
 				{
-					StringClass b = new StringClass();
-					b.StringValue = "0123456789a";
-					s.Save(b);
-					s.Flush();
-				}
+					using (ISession s = OpenSession())
+					{
+						StringClass b = new StringClass {StringValue = "0123456789a"};
+						s.Save(b);
+						s.Flush();
+					}
+				},
+				"An exception was expected when trying to put too large a value into a column.");
+
+			AssertFailedInsertExceptionDetailsAndEmptyTable(ex);
+		}
+
+
+		private void AssertFailedInsertExceptionDetailsAndEmptyTable(Exception ex)
+		{
+			// We can get different sort of exceptions.
+			if (ex is PropertyValueException)
+			{
+				// Some drivers/dialects set explicit parameter sizes, in which case we expect NH to
+				// raise a PropertyValueException (to avoid ADO.NET from silently truncating).
+
+				Assert.That(
+					ex.Message,
+					Is.StringStarting("Error dehydrating property value for NHibernate.Test.TypesTest.StringClass."));
+
+				Assert.That(ex.InnerException, Is.TypeOf<HibernateException>());
+
+				Assert.That(
+					ex.InnerException.Message,
+					Is.EqualTo("The length of the string value exceeds the length configured in the mapping/parameter."));
+			}
+			else if (Dialect is MsSqlCeDialect && ex is InvalidOperationException)
+			{
+				Assert.That(ex.Message, Is.StringContaining("max=4000, len=4001"));
 			}
-			catch
+			else
 			{
-				dbThrewError = true;
+				// In other cases, we expect the database itself to raise an error. This case
+				// will also happen if the driver does set an explicit parameter size, but that
+				// size is larger than the mapped column size.
+				Assert.That(ex, Is.TypeOf<GenericADOException>());
 			}
 
-			Assert.That(dbThrewError, "Database did not throw an error when trying to put too large a value into a column");
+			// In any case, nothing should have been inserted.
+			using (ISession s = OpenSession())
+			{
+				Assert.That(s.Query<StringClass>().ToList(), Is.Empty);
+			}
 		}
 
+
 		[Test]
 		public void CriteriaLikeParameterCanExceedColumnSize()
 		{
-			if (!(sessions.ConnectionProvider.Driver is SqlClientDriver))
-				Assert.Ignore("This test fails against the ODBC driver.  The driver would need to be override to allow longer parameter sizes than the column.");
+			Exception exception = CatchException<Exception>(
+				() =>
+				{
+					using (ISession s = OpenSession())
+					using (s.BeginTransaction())
+					{
+						s.Save(new StringClass {Id = 1, StringValue = "AAAAAAAAAB"});
+						s.Save(new StringClass {Id = 2, StringValue = "BAAAAAAAAA"});
 
-			using (ISession s = OpenSession())
-			using (ITransaction t = s.BeginTransaction())
-			{
-				s.Save(new StringClass() { Id = 1, StringValue = "AAAAAAAAAB" });
-				s.Save(new StringClass() { Id = 2, StringValue = "BAAAAAAAAA" });
+						var aaItems =
+							s.CreateCriteria<StringClass>()
+							 .Add(Restrictions.Like("StringValue", "%AAAAAAAAA%"))
+							 .List();
 
-				var aaItems =
-					s.CreateCriteria<StringClass>()
-						.Add(Restrictions.Like("StringValue", "%AAAAAAAAA%"))
-						.List();
+						Assert.That(aaItems.Count, Is.EqualTo(2));
+					}
+				});
 
-				Assert.That(aaItems.Count, Is.EqualTo(2));
-			}
+
+			// This test fails against the ODBC driver. The driver would need to be override to allow longer parameter sizes than the column.
+			AssertExpectedFailureOrNoException(
+				exception,
+				(sessions.ConnectionProvider.Driver is OdbcDriver));
 		}
 
 		[Test]
 		public void HqlLikeParameterCanExceedColumnSize()
 		{
-			if (!(sessions.ConnectionProvider.Driver is SqlClientDriver))
-				Assert.Ignore("This test fails against the ODBC driver.  The driver would need to be override to allow longer parameter sizes than the column.");
+			Exception exception = CatchException<Exception>(
+				() =>
+				{
+					using (ISession s = OpenSession())
+					using (s.BeginTransaction())
+					{
+						s.Save(new StringClass {Id = 1, StringValue = "AAAAAAAAAB"});
+						s.Save(new StringClass {Id = 2, StringValue = "BAAAAAAAAA"});
 
-			using (ISession s = OpenSession())
-			using (ITransaction t = s.BeginTransaction())
+						var aaItems =
+							s.CreateQuery("from StringClass s where s.StringValue like :likeValue")
+							 .SetParameter("likeValue", "%AAAAAAAAA%")
+							 .List();
+
+						Assert.That(aaItems.Count, Is.EqualTo(2));
+					}
+				});
+
+
+			// This test fails against the ODBC driver. The driver would need to be override to allow longer parameter sizes than the column.
+			AssertExpectedFailureOrNoException(
+				exception,
+				(sessions.ConnectionProvider.Driver is OdbcDriver));
+		}
+
+
+		[Test]
+		public void CriteriaEqualityParameterCanExceedColumnSize()
+		{
+			// We should be able to query a column with a value longer than
+			// the specified column size, to avoid tedious exceptions.
+
+			Exception exception = CatchException<Exception>(
+				() =>
+				{
+					using (ISession s = OpenSession())
+					using (s.BeginTransaction())
+					{
+						s.Save(new StringClass {Id = 1, StringValue = "AAAAAAAAAB"});
+						s.Save(new StringClass {Id = 2, StringValue = "BAAAAAAAAA"});
+
+						var aaItems =
+							s.CreateCriteria<StringClass>()
+							 .Add(Restrictions.Eq("StringValue", "AAAAAAAAABx"))
+							 .List();
+
+						Assert.That(aaItems.Count, Is.EqualTo(0));
+					}
+				});
+
+			// Doesn't work on Firebird due to Firebird not figuring out parameter types on its own.
+			// This test fails against the ODBC driver. The driver would need to be override to allow longer parameter sizes than the column.
+			AssertExpectedFailureOrNoException(
+				exception,
+				(Dialect is FirebirdDialect) || (sessions.ConnectionProvider.Driver is OdbcDriver));
+		}
+
+
+		[Test]
+		public void HqlEqualityParameterCanExceedColumnSize()
+		{
+			// We should be able to query a column with a value longer than
+			// the specified column size, to avoid tedious exceptions.
+
+			Exception exception = CatchException<Exception>(
+				() =>
+				{
+					using (ISession s = OpenSession())
+					using (s.BeginTransaction())
+					{
+						s.Save(new StringClass {Id = 1, StringValue = "AAAAAAAAAB"});
+						s.Save(new StringClass {Id = 2, StringValue = "BAAAAAAAAA"});
+
+						var aaItems =
+							s.CreateQuery("from StringClass s where s.StringValue = :likeValue")
+							 .SetParameter("likeValue", "AAAAAAAAABx")
+							 .List();
+
+						Assert.That(aaItems.Count, Is.EqualTo(0));
+					}
+				});
+
+			// Doesn't work on Firebird due to Firebird not figuring out parameter types on its own.
+			// This test fails against the ODBC driver. The driver would need to be override to allow longer parameter sizes than the column.
+			AssertExpectedFailureOrNoException(
+				exception,
+				(Dialect is FirebirdDialect) || (sessions.ConnectionProvider.Driver is OdbcDriver));
+		}
+
+
+		/// <summary>
+		/// Some test cases doesn't work during some scenarios for well-known reasons. If the test
+		/// fails under these circumstances, mark it as IGNORED. If it _stops_ failing, mark it
+		/// as a FAILURE so that it can be investigated.
+		/// </summary>
+		private void AssertExpectedFailureOrNoException(Exception exception, bool requireExceptionAndIgnoreTest)
+		{
+			if (requireExceptionAndIgnoreTest)
 			{
-				s.Save(new StringClass() { Id = 1, StringValue = "AAAAAAAAAB" });
-				s.Save(new StringClass() { Id = 2, StringValue = "BAAAAAAAAA" });
+				Assert.NotNull(
+					exception,
+					"Test was expected to have a well-known, but ignored, failure for the current configuration. If " +
+					"that expected failure no longer occurs, it may now be possible to remove this exception.");
+
+				Assert.Ignore("This test is known to fail for the current configuration.");
+			}
+
+			// If the above didn't ignore the exception, it's for real - rethrow to trigger test failure.
+			if (exception != null)
+				throw new Exception("Wrapped exception.", exception);
+		}
 
-				var aaItems =
-					s.CreateQuery("from StringClass s where s.StringValue like :likeValue")
-						.SetParameter("likeValue", "%AAAAAAAAA%")
-						.List();
 
-				Assert.That(aaItems.Count, Is.EqualTo(2));
+		private TException CatchException<TException>(System.Action action)
+			where TException : Exception
+		{
+			try
+			{
+				action();
 			}
+			catch (TException exception)
+			{
+				return exception;
+			}
+
+			return null;
 		}
 	}
 }