ConfigurationFixture.cs

using System;
using System.Collections;
using System.IO;
using System.Linq;
using System.Xml;
using NHibernate.Cfg;
using NHibernate.DomainModel;
using NHibernate.Engine;
using NHibernate.Linq;
using NHibernate.Tool.hbm2ddl;
using NHibernate.Util;
using NUnit.Framework;
using Environment = NHibernate.Cfg.Environment;

namespace NHibernate.Test.CfgTest
{
	/// <summary>
	/// Summary description for ConfigurationFixture.
	/// </summary>
	[TestFixture]
	public class ConfigurationFixture
	{
		/// <summary>
		/// Verify that NHibernate can read the configuration from any hibernate.cfg.xml
		/// file and that the values override what is in the app.config.
		/// </summary>
		[Test]
		public void ReadCfgXmlFromDefaultFile()
		{
			Configuration cfg = new Configuration();
			cfg.Configure(Path.Combine(TestContext.CurrentContext.TestDirectory, "TestEmbeddedConfig.cfg.xml"));

			Assert.IsTrue(cfg.Properties.ContainsKey(Environment.ShowSql));
			Assert.IsTrue(cfg.Properties.ContainsKey(Environment.UseQueryCache));
			Assert.IsFalse(cfg.Properties.ContainsKey(Environment.PrepareSql), 
				"Our default conf should not include override the possible Dialect default configuration.");
			Assert.IsTrue(cfg.Properties.ContainsKey(Environment.Isolation));
			Assert.AreEqual("true 1, false 0, yes 1, no 0", cfg.Properties[Environment.QuerySubstitutions]);
			Assert.AreEqual("Server=localhost;initial catalog=nhibernate;User Id=;Password=",
			                cfg.Properties[Environment.ConnectionString]);
		}

		/// <summary>
		/// Received sample code that Configuration could not be configured manually.  It can be configured
		/// manually just need to set all of the properties before adding classes
		/// </summary>
		[Test, Explicit]
		public void ManualConfiguration()
		{
			//log4net.Config.DOMConfigurator.ConfigureAndWatch( new FileInfo("log4net.cfg.xml") ); //use xml file instead of config
			Configuration cfg = new Configuration();
			IDictionary props = new Hashtable();

			props[Environment.ConnectionProvider] = "NHibernate.Connection.DriverConnectionProvider";
			props[Environment.Dialect] = "NHibernate.Dialect.MsSql2000Dialect";
			props[Environment.ConnectionDriver] = "NHibernate.Driver.SqlClientDriver";
			props[Environment.ConnectionString] =
				"Server=localhost;initial catalog=nhibernate;Integrated Security=SSPI";

			foreach (DictionaryEntry de in props)
			{
				cfg.SetProperty(de.Key.ToString(), de.Value.ToString());
			}

			cfg.AddClass(typeof(Simple));

			new SchemaExport(cfg).Create(true, true);

			ISessionFactory factory = cfg.BuildSessionFactory();
		}

		/// <summary>
		/// Verify that NHibernate can read the configuration from a manifest resource in an
		/// Assembly and that the values override what is in the app.config.
		/// </summary>
		[Test]
		public void ReadCfgXmlFromAssembly()
		{
			Configuration cfg = new Configuration();
			cfg.Configure(this.GetType().Assembly, "NHibernate.Test.TestEmbeddedConfig.cfg.xml");

			Assert.AreEqual("true 1, false 0, yes 1, no 0", cfg.Properties[Environment.QuerySubstitutions]);
			Assert.AreEqual("Server=localhost;initial catalog=nhibernate;User Id=;Password=",
			                cfg.Properties[Environment.ConnectionString]);
		}

		/// <summary>
		/// Verify that NHibernate properly releases resources when an Exception occurs
		/// during the reading of config files.
		/// </summary>
		[Test]
		public void InvalidXmlInCfgFile()
		{
			XmlDocument cfgXml = new XmlDocument();
			cfgXml.Load(Path.Combine(TestContext.CurrentContext.TestDirectory, "TestEmbeddedConfig.cfg.xml"));

			// this should put us at the first <property> element
			XmlElement propElement = cfgXml.DocumentElement.GetElementsByTagName("property")[0] as XmlElement;

			// removing this will cause it not to validate
			propElement.RemoveAttribute("name");

			string FileNameForInvalidCfg = Path.Combine(TestContext.CurrentContext.TestDirectory, "hibernate.invalid.cfg.xml");
			cfgXml.Save(FileNameForInvalidCfg);

			Configuration cfg = new Configuration();
			try
			{
				cfg.Configure(FileNameForInvalidCfg);
			}
			catch (HibernateException)
			{
				// just absorb it - not what we are testing
			}
			finally
			{
				// clean up the bad file - if the Configure method cleans up after
				// itself we should be able to do this without problem.  If it does
				// property release the resource then this won't be able to access
				// the file to delete.
				File.Delete(FileNameForInvalidCfg);
			}
		}

		[Test]
		public void EmptyPropertyTag()
		{
			string xml =
				@"<?xml version='1.0' encoding='utf-8' ?>
<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
	<session-factory name='NHibernate.Test'>
		<property name='connection.provider'></property>
	</session-factory>
</hibernate-configuration>";

			XmlDocument cfgXml = new XmlDocument();
			cfgXml.LoadXml(xml);

			Configuration cfg = new Configuration();
			XmlTextReader xtr = new XmlTextReader(xml, XmlNodeType.Document, null);
			cfg.Configure(xtr);
		}

		[Test]
		public void NH1334()
		{
			string xml =
				@"<?xml version='1.0' encoding='utf-8' ?>
<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
	<session-factory name='NHibernate.Test'>
		<property name='current_session_context_class'>
		web
		</property>
	</session-factory>
</hibernate-configuration>";

			XmlDocument cfgXml = new XmlDocument();
			cfgXml.LoadXml(xml);

			Configuration cfg = new Configuration();
			XmlTextReader xtr = new XmlTextReader(xml, XmlNodeType.Document, null);
			cfg.Configure(xtr);
			Assert.AreEqual("web", PropertiesHelper.GetString(Environment.CurrentSessionContextClass, cfg.Properties, null));
		}

		[Test]
		public void CacheConfigurationForUnmappedClass()
		{
			string cfgString =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
								<session-factory>
									<class-cache class='NHibernate.DomainModel.A, NHibernate.DomainModel' usage='read-write' region='xx' />
								</session-factory>
							</hibernate-configuration>";

			Configuration cfg = new Configuration();
			Assert.Throws<HibernateConfigException>(()=>cfg.Configure(new XmlTextReader(cfgString, XmlNodeType.Document, null)));
		}

		[Test]
		public void CacheConfigurationForUnmappedCollection()
		{
			string cfgString =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
								<session-factory>
									<mapping resource='NHibernate.DomainModel.ABC.hbm.xml' assembly='NHibernate.DomainModel' />
									<collection-cache collection='NHibernate.DomainModel.B.XX' usage='nonstrict-read-write' region='yy' />
								</session-factory>
							</hibernate-configuration>";

			Configuration cfg = new Configuration();
			Assert.Throws<HibernateConfigException>(()=>cfg.Configure(new XmlTextReader(cfgString, XmlNodeType.Document, null)));
		}

		[Test]
		public void NoSessionFactoriesInConfiguration()
		{
			string cfgString = @"<?xml version='1.0' encoding='utf-8' ?><someElement />";

			Configuration cfg = new Configuration();
			Assert.Throws<HibernateConfigException>(()=>cfg.Configure(new XmlTextReader(cfgString, XmlNodeType.Document, null)));
		}

		[Test]
		public void CacheConfiguration()
		{
			string cfgString =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
								<session-factory>
									<mapping resource='NHibernate.DomainModel.ABC.hbm.xml' assembly='NHibernate.DomainModel' />
									<class-cache class='NHibernate.DomainModel.A, NHibernate.DomainModel' usage='read-write' region='xx' />
									<collection-cache collection='NHibernate.DomainModel.B.Map' usage='nonstrict-read-write' region='yy' />
								</session-factory>
							</hibernate-configuration>";

			Configuration cfg = new Configuration();
			cfg.Configure(new XmlTextReader(cfgString, XmlNodeType.Document, null)).BuildSessionFactory();
		}

		[Test]
		public void InvalidXmlInHbmFile()
		{
			string filename = Path.Combine(TestContext.CurrentContext.TestDirectory, "invalid.hbm.xml");
			// it's missing the class name - won't validate
			string hbm =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
								<class table='a'></class>
							</hibernate-mapping>";
			XmlDocument hbmDoc = new XmlDocument();
			hbmDoc.LoadXml(hbm);
			hbmDoc.Save(filename);

			Configuration cfg = new Configuration();
			try
			{
				cfg.Configure();
				cfg.AddXmlFile("invalid.hbm.xml");
			}
			catch (HibernateException)
			{
				// just absorb it - not what we are testing
			}
			finally
			{
				// clean up the bad file - if the AddXmlFile method cleans up after
				// itself we should be able to do this without problem.  If it does
				// property release the resource then this won't be able to access
				// the file to delete.
				File.Delete(filename);
			}
		}

		[Test]
		public void ProxyWithDefaultNamespaceAndAssembly()
		{
			string hbm =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'
								namespace='NHibernate.DomainModel'
								assembly='NHibernate.DomainModel'>
								<class name='A' proxy='A'>
									<id name='Id'>
										<generator class='native' />
									</id>
								</class>
							</hibernate-mapping>";

			Configuration cfg = new Configuration();
			cfg.AddXmlString(hbm)
				.BuildSessionFactory();
		}

		[Test]
		public void PersisterWithDefaultNamespaceAndAssembly()
		{
			string hbm =
				@"<?xml version='1.0' encoding='utf-8' ?> 
							<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'
								namespace='NHibernate.DomainModel'
								assembly='NHibernate.DomainModel'>
								<class name='A' persister='A'>
									<id name='Id'>
										<generator class='native' />
									</id>
								</class>
							</hibernate-mapping>";

			Configuration cfg = new Configuration();
			cfg.AddXmlString(hbm); //.BuildSessionFactory();
		}

		[Test]
		public void AddDocument()
		{
			string hbm =
				@"<?xml version='1.0' ?>
<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
	<class name='NHibernate.DomainModel.A, NHibernate.DomainModel'>
		<id name='Id' column='somecolumn'>
			<generator class='native' />
		</id>
	</class>
</hibernate-mapping>";

			Configuration cfg = new Configuration();
			XmlDocument doc = new XmlDocument();
			doc.LoadXml(hbm);
			cfg.AddDocument(doc);
		}

		[Test]
		public void ProxyValidator()
		{
			string hbm =
				@"<?xml version='1.0' ?>
<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
	<class name='NHibernate.DomainModel.NHSpecific.InvalidProxyClass, NHibernate.DomainModel'
		lazy='true'>
		<id name='Id' column='somecolumn'>
			<generator class='native' />
		</id>
	</class>
</hibernate-mapping>";

			Configuration cfg = new Configuration();

			try
			{
				cfg.AddXmlString(hbm).BuildSessionFactory();
				Assert.Fail("Validation should have failed");
			}
			catch (MappingException e)
			{
				Assert.IsTrue(e is InvalidProxyTypeException);
			}
		}

		[Test]
		public void DisabledProxyValidator()
		{
			string hbm =
				@"<?xml version='1.0' ?>
<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
	<class name='NHibernate.DomainModel.NHSpecific.InvalidProxyClass, NHibernate.DomainModel'
		lazy='true'>
		<id name='Id' column='somecolumn'>
			<generator class='native' />
		</id>
	</class>
</hibernate-mapping>";

			Configuration cfg = new Configuration();
			cfg.Properties[Environment.UseProxyValidator] = "false";
			cfg.AddXmlString(hbm).BuildSessionFactory();
		}

		/// <summary>
		/// Verify that setting the default assembly and namespace through
		/// <see cref="Configuration" /> works as intended.
		/// </summary>
		[Test]
		public void SetDefaultAssemblyAndNamespace()
		{
			string hbmFromDomainModel =
				@"<?xml version='1.0' ?>
<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
	<class name='A'>
		<id name='Id' column='somecolumn'>
			<generator class='native' />
		</id>
	</class>
</hibernate-mapping>";

			string hbmFromTest =
				@"<?xml version='1.0' ?>
<hibernate-mapping xmlns='urn:nhibernate-mapping-2.2'>
	<class name='LocatedInTestAssembly' lazy='false'>
		<id name='Id' column='somecolumn'>
			<generator class='native' />
		</id>
	</class>
</hibernate-mapping>";

			Configuration cfg = new Configuration();
			cfg
				.SetDefaultAssembly("NHibernate.DomainModel")
				.SetDefaultNamespace("NHibernate.DomainModel")
				.AddXmlString(hbmFromDomainModel);

			cfg
				.SetDefaultAssembly("NHibernate.Test")
				.SetDefaultNamespace(typeof(LocatedInTestAssembly).Namespace)
				.AddXmlString(hbmFromTest);

			cfg.BuildSessionFactory().Close();
		}

		[Test]
		public void NH1348()
		{
			string xml =
				@"<?xml version='1.0' encoding='utf-8' ?>
<hibernate-configuration xmlns='urn:nhibernate-configuration-2.2'>
	<session-factory name='NHibernate.Test'>
  <event type='flush'>
    <listener class='NHibernate.Event.Default.DefaultFlushEventListener, NHibernate'/>
  </event> 
	</session-factory>
</hibernate-configuration>";

			XmlDocument cfgXml = new XmlDocument();
			cfgXml.LoadXml(xml);

			Configuration cfg = new Configuration();
			XmlTextReader xtr = new XmlTextReader(xml, XmlNodeType.Document, null);
			cfg.Configure(xtr);
			// No exception expected
		}

		public class SampleQueryProvider : DefaultQueryProvider
		{
			public SampleQueryProvider(ISessionImplementor session) : base(session)
			{
			}

			protected SampleQueryProvider(ISessionImplementor session, object collection,  NhQueryableOptions options) : base(session, collection, options)
			{
			}

			protected override IQueryProvider CreateWithOptions(NhQueryableOptions options)
			{
				return new SampleQueryProvider(Session, Collection, options);
			}
		}

		[Test]
		public void NH2890Standard()
		{
			var cfg = new Configuration();
			cfg.Configure(Path.Combine(TestContext.CurrentContext.TestDirectory, "TestEmbeddedConfig.cfg.xml"))
				.LinqQueryProvider<SampleQueryProvider>()
				.SetDefaultAssembly("NHibernate.DomainModel")
				.SetDefaultNamespace("NHibernate.DomainModel");

			using (var sessionFactory = cfg.BuildSessionFactory())
			{
				using (var session = sessionFactory.OpenSession())
				{
					var query = session.Query<NHibernate.DomainModel.A>();
					Assert.IsInstanceOf(typeof(SampleQueryProvider), query.Provider);
				}

				using (var session = sessionFactory.OpenSession())
				{
					var query = session.Query<NHibernate.DomainModel.A>().WithOptions(x => x.SetReadOnly(true));
					Assert.IsInstanceOf(typeof(SampleQueryProvider), query.Provider);
				}
			}
		}

		[Test]
		public void NH2890Xml()
		{
			var cfg = new Configuration();
			cfg.Configure(Path.Combine(TestContext.CurrentContext.TestDirectory, "TestEmbeddedConfig.cfg.xml"))
				.SetDefaultAssembly("NHibernate.DomainModel")
				.SetDefaultNamespace("NHibernate.DomainModel");

			using (var sessionFactory = cfg.BuildSessionFactory())
			{
				using (var session = sessionFactory.OpenSession())
				{
					var query = session.Query<NHibernate.DomainModel.A>();
					Assert.IsInstanceOf(typeof(SampleQueryProvider), query.Provider);
				}
			}
		}
	}
}