Tools/VSNetWizards/CastleTemplates/VS8/CSharp/ARProjectTest/AbstractModelTestCase.cs

   1 namespace !NAMESPACE!
   2 {
   3         using System;
   4
   5         using Castle.ActiveRecord;
   6         using Castle.ActiveRecord.Framework;
   7         using Castle.ActiveRecord.Framework.Config;
   8
   9         using NUnit.Framework;
  10
  11         /// <summary>
  12         /// This is a suggestion of base class that might
  13         /// simplify the unit testing for the ActiveRecord
  14         /// classes.
  15         /// <para>
  16         /// Basically you have to create a separate database
  17         /// for your tests, which is always a good idea:
  18         /// - production
  19         /// - development
  20         /// - test
  21         /// </para>
  22         /// <para>
  23         /// You have to decide if you want to administrate the
  24         /// schema on the <c>test</c> database or let ActiveRecord
  25         /// generate them for you during test execution. Check
  26         /// <see cref="AbstractModelTestCase.PrepareSchema"/>
  27         /// </para>
  28         /// </summary>
  29         /// <remarks>
  30         /// Note that this class enables lazy classes and collections
  31         /// by using a <see cref="SessionScope"/>.
  32         /// This have side effects. Some of your test must
  33         /// invoke <see cref="Flush"/>
  34         /// to persist the changes.
  35         /// </remarks>
  36         public abstract class AbstractModelTestCase
  37         {
  38                 protected SessionScope scope;
  39
  40                 [TestFixtureSetUp]
  41                 public virtual void FixtureInit()
  42                 {
  43                         InitFramework();
  44                 }
  45
  46                 [SetUp]
  47                 public virtual void Init()
  48                 {
  49                         PrepareSchema();
  50
  51                         CreateScope();
  52                 }
  53
  54                 [TearDown]
  55                 public virtual void Terminate()
  56                 {
  57                         DisposeScope();
  58
  59                         DropSchema();
  60                 }
  61
  62                 [TestFixtureTearDown]
  63                 public virtual void TerminateAll()
  64                 {
  65                 }
  66
  67                 protected void Flush()
  68                 {
  69                         SessionScope.Current.Flush();
  70                 }
  71
  72                 protected void CreateScope()
  73                 {
  74                         scope = new SessionScope(FlushAction.Never);
  75                 }
  76
  77                 protected void DisposeScope()
  78                 {
  79                         scope.Dispose();
  80                 }
  81
  82                 /// <summary>
  83                 /// If you want to delete everything from the model.
  84                 /// Remember to do it in a descendent dependency order
  85                 /// </summary>
  86                 protected virtual void PrepareSchema()
  87                 {
  88                         // If you want to delete everything from the model.
  89                         // Remember to do it in a descendent dependency order
  90
  91                         // Office.DeleteAll();
  92                         // User.DeleteAll();
  93
  94                         // Another approach is to always recreate the schema
  95                         // (please use a separate test database if you want to do that)
  96
  97                         ActiveRecordStarter.CreateSchema();
  98                 }
  99
 100                 protected virtual void DropSchema()
 101                 {
 102                         ActiveRecordStarter.DropSchema();
 103                 }
 104
 105                 protected virtual void InitFramework()
 106                 {
 107                         IConfigurationSource source = ActiveRecordSectionHandler.Instance;
 108
 109                         ActiveRecordStarter.Initialize( source );
 110
 111                         // Remember to add the types, for example
 112                         // ActiveRecordStarter.Initialize( source, typeof(Blog), typeof(Post) );
 113
 114                         // Or to use the assembly that holds the ActiveRecord types
 115                         // ActiveRecordStarter.Initialize(System.Reflection.Assembly.Load("MyARProject"), source);
 116                 }
 117         }
 118 }