NH-3869 Added an option for adding comments into LINQ queries

Author: maca88

src/NHibernate.Test/Async/Linq/QueryCommentTests.cs

@@ -0,0 +1,71 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by AsyncGenerator.
+//
+//     Changes to this file may cause incorrect behavior and will be lost if
+//     the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+
+
+using System.Linq;
+using NHibernate.Cfg;
+using NHibernate.Linq;
+using NUnit.Framework;
+
+namespace NHibernate.Test.Linq
+{
+	using System.Threading.Tasks;
+	[TestFixture]
+	public class QueryCommentTestsAsync : LinqTestCase
+	{
+		protected override void Configure(Configuration configuration)
+		{
+			configuration.SetProperty(Environment.UseSqlComments, "true");
+		}
+		
+		[Test]
+		public async Task CanSetCommentOnLinqQueriesAsync()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = await ((from e in db.Customers
+				              where e.CompanyName == "Bon app'"
+				              select e).WithOptions(o => o.SetComment(comment)).ToListAsync());
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+
+		[Test]
+		public async Task CanSetCommentOnLinqPagingQueryAsync()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = await ((from e in db.Customers
+				              select e).Skip(1).Take(1).WithOptions(o => o.SetComment(comment)).ToListAsync());
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+
+		[Test]
+		public async Task CanSetCommentBeforeSkipOnLinqOrderedPageQueryAsync()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = await ((from e in db.Customers
+				              orderby e.CompanyName
+				              select e).WithOptions(o => o.SetComment(comment)).Skip(5).Take(5).ToListAsync());
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+	}
+}

src/NHibernate.Test/Linq/QueryCommentTests.cs

@@ -0,0 +1,60 @@
+using System.Linq;
+using NHibernate.Cfg;
+using NHibernate.Linq;
+using NUnit.Framework;
+
+namespace NHibernate.Test.Linq
+{
+	[TestFixture]
+	public class QueryCommentTests : LinqTestCase
+	{
+		protected override void Configure(Configuration configuration)
+		{
+			configuration.SetProperty(Environment.UseSqlComments, "true");
+		}
+		
+		[Test]
+		public void CanSetCommentOnLinqQueries()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = (from e in db.Customers
+				              where e.CompanyName == "Bon app'"
+				              select e).WithOptions(o => o.SetComment(comment)).ToList();
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+
+		[Test]
+		public void CanSetCommentOnLinqPagingQuery()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = (from e in db.Customers
+				              select e).Skip(1).Take(1).WithOptions(o => o.SetComment(comment)).ToList();
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+
+		[Test]
+		public void CanSetCommentBeforeSkipOnLinqOrderedPageQuery()
+		{
+			using (var sl = new SqlLogSpy())
+			{
+				var comment = "This is my comment";
+				var result = (from e in db.Customers
+				              orderby e.CompanyName
+				              select e).WithOptions(o => o.SetComment(comment)).Skip(5).Take(5).ToList();
+				var sql = sl.Appender.GetEvents()[0].RenderedMessage;
+				
+				Assert.That(sql.IndexOf(comment), Is.GreaterThan(0));
+			}
+		}
+	}
+}

src/NHibernate/Linq/NhQueryableOptions.cs

@@ -13,6 +13,7 @@ public class NhQueryableOptions
 		protected string CacheRegion { get; private set; }
 		protected int? Timeout { get; private set; }
 		protected bool? ReadOnly { get; private set; }
+		protected string Comment { get; private set; }
 
 #pragma warning disable 618
 		/// <inheritdoc />
@@ -100,6 +101,17 @@ public NhQueryableOptions SetReadOnly(bool readOnly)
 			ReadOnly = readOnly;
 			return this;
 		}
+		
+		/// <summary> 
+		/// Set a comment that will be prepended before the generated SQL.
+		/// </summary>
+		/// <param name="comment">The comment to prepend.</param>
+		/// <returns><see langword="this"/> (for method chaining).</returns>
+		public NhQueryableOptions SetComment(string comment)
+		{
+			Comment = comment;
+			return this;
+		}
 
 		protected internal NhQueryableOptions Clone()
 		{
@@ -109,7 +121,8 @@ protected internal NhQueryableOptions Clone()
 				CacheMode = CacheMode,
 				CacheRegion = CacheRegion,
 				Timeout = Timeout,
-				ReadOnly = ReadOnly
+				ReadOnly = ReadOnly,
+				Comment = Comment
 			};
 		}
 
@@ -129,6 +142,9 @@ protected internal void Apply(IQuery query)
 
 			if (ReadOnly.HasValue)
 				query.SetReadOnly(ReadOnly.Value);
+			
+			if (!string.IsNullOrEmpty(Comment))
+				query.SetComment(Comment);
 		}
 	}
 }