Add unit tests for logger and make logger optional

absynce · absynce · commit 779d599931ff · 2016-06-17T17:07:15.000-05:00
Added xunit and moq to run tests in VS and to better test logger.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@ All notable changes will be documented in this file, particularly any breaking
 changes. This project adheres to [Semantic Versioning](http://semver.org).
 
 ## [x.x.x]
+- Added - Option to configure a `RavenMigration.ILogger` or use the `ConsoleLogger`.
 
 ## [2.0.0]
 - Changed (breaking) - The way the MigrationDocument's Id is determined. Multiple underscores
diff --git a/RavenMigrations.Tests/AlterTests.cs b/RavenMigrations.Tests/AlterTests.cs
@@ -6,6 +6,7 @@
 using Raven.Client.Indexes;
 using Raven.Json.Linq;
 using Raven.Tests.Helpers;
+using Moq;
 using Xunit;
 
 namespace RavenMigrations.Tests
@@ -76,6 +77,48 @@ public void Can_add_additional_commands_as_part_of_migration()
             }
         }
 
+        [Fact]
+        public void Logger_WriteInformation_is_called_when_altering_collection()
+        {
+            var loggerMock = new Mock<ILogger>();
+
+            using (var store = NewDocumentStore())
+            {
+                InitialiseWithPerson(store, "Sean Kearon");
+
+                var migration = new AlterCollectionMigration();
+                migration.Setup(store, loggerMock.Object);
+
+                migration.Up();
+            }
+
+            loggerMock.Verify(logger => logger.WriteInformation("Updated {0} documents", 1), "Informational message should indicate how many documents were updated.");
+        }
+
+        [Fact]
+        public void Logger_WriteInformation_is_called_per_batch_when_altering_collection()
+        {
+            var loggerMock = new Mock<ILogger>();
+
+            using (var store = NewDocumentStore())
+            {
+                InitialiseWithPeople(store, new List<Person1>() {
+                    new Person1 {Name = "Sean Kearon"},
+                    new Person1 {Name = "Jared M. Smith"},
+                    new Person1 {Name = "Michael Owen"},
+                    new Person1 {Name = "Jonathan Skelton"},
+                    new Person1 {Name = "Matt King"}
+                });
+                var migration = new AlterCollectionMigration();
+                migration.Setup(store, loggerMock.Object);
+
+                migration.Up();
+            }
+
+            loggerMock.Verify(logger => logger.WriteInformation("Updated {0} documents", 2), Times.Exactly(2), "Informational message should indicate how many documents were updated.");
+            loggerMock.Verify(logger => logger.WriteInformation("Updated {0} documents", 1), Times.Once, "Informational message should indicate how many documents were updated.");
+        }
+
         private void InitialiseWithPerson(IDocumentStore store, string name)
         {
             new RavenDocumentsByEntityName().Execute(store); //https://groups.google.com/forum/#!topic/ravendb/QqZPrRUwEkE
@@ -86,6 +129,17 @@ private void InitialiseWithPerson(IDocumentStore store, string name)
             }
             WaitForIndexing(store);
         }
+
+        private void InitialiseWithPeople(IDocumentStore store, List<Person1> people)
+        {
+            new RavenDocumentsByEntityName().Execute(store); //https://groups.google.com/forum/#!topic/ravendb/QqZPrRUwEkE
+            using (var session = store.OpenSession())
+            {
+                people.ForEach(session.Store);
+                session.SaveChanges();
+            }
+            WaitForIndexing(store);
+        }
     }
 
     [Migration(1, "alter")]
@@ -98,7 +152,7 @@ public override void Down()
 
         public override void Up()
         {
-            Alter.CollectionWithAdditionalCommands("Person1s", MigratePerson1ToPerson2);
+            Alter.CollectionWithAdditionalCommands("Person1s", MigratePerson1ToPerson2, 2);
         }
 
         private void MigratePerson2ToPerson1(RavenJObject doc, RavenJObject metadata)
diff --git a/RavenMigrations.Tests/RavenMigrations.Tests.csproj b/RavenMigrations.Tests/RavenMigrations.Tests.csproj
@@ -1,5 +1,6 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="..\packages\xunit.runner.visualstudio.2.1.0\build\net20\xunit.runner.visualstudio.props" Condition="Exists('..\packages\xunit.runner.visualstudio.2.1.0\build\net20\xunit.runner.visualstudio.props')" />
   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
   <PropertyGroup>
     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
@@ -32,6 +33,10 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Reference Include="Castle.Core, Version=3.3.0.0, Culture=neutral, PublicKeyToken=407dd0808d44fbdc, processorArchitecture=MSIL">
+      <HintPath>..\packages\Castle.Core.3.3.3\lib\net45\Castle.Core.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="FluentAssertions">
       <HintPath>..\packages\FluentAssertions.2.1.0.0\lib\net45\FluentAssertions.dll</HintPath>
     </Reference>
@@ -49,6 +54,10 @@
     <Reference Include="Microsoft.WindowsAzure.Storage, Version=2.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
       <HintPath>..\packages\WindowsAzure.Storage.2.0.6.1\lib\net40\Microsoft.WindowsAzure.Storage.dll</HintPath>
     </Reference>
+    <Reference Include="Moq, Version=4.5.9.0, Culture=neutral, PublicKeyToken=69f491c39445e920, processorArchitecture=MSIL">
+      <HintPath>..\packages\Moq.4.5.9\lib\net45\Moq.dll</HintPath>
+      <Private>True</Private>
+    </Reference>
     <Reference Include="Raven.Abstractions">
       <HintPath>..\packages\RavenDB.Client.2.5.2700\lib\net45\Raven.Abstractions.dll</HintPath>
     </Reference>
@@ -101,6 +110,12 @@
   </ItemGroup>
   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
   <Import Project="$(SolutionDir)\.nuget\NuGet.targets" Condition="Exists('$(SolutionDir)\.nuget\NuGet.targets')" />
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\packages\xunit.runner.visualstudio.2.1.0\build\net20\xunit.runner.visualstudio.props')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\xunit.runner.visualstudio.2.1.0\build\net20\xunit.runner.visualstudio.props'))" />
+  </Target>
   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
        Other similar extension points exist, see Microsoft.Common.targets.
   <Target Name="BeforeBuild">
diff --git a/RavenMigrations.Tests/RunnerTests.cs b/RavenMigrations.Tests/RunnerTests.cs
@@ -1,6 +1,8 @@
 ﻿using System.Linq;
 using FluentAssertions;
+using Moq;
 using Raven.Abstractions.Data;
+using Raven.Client;
 using Raven.Client.Indexes;
 using Raven.Tests.Helpers;
 using Xunit;
@@ -284,6 +286,52 @@ public void Can_call_migrations_with_custom_attributes()
                 }
             }
         }
+
+        public class Logger
+        {
+            public class WhenMigrationRunUp : RavenTestBase
+            {
+                [Fact]
+                public void Logger_WriteInformation_should_be_called_before_and_after_migration()
+                {
+                    var mockLogger = new Mock<ILogger>();
+
+                    using (var store = NewDocumentStore())
+                    {
+                        Runner.Run(store, new MigrationOptions { Logger = mockLogger.Object });
+                    }
+
+                    mockLogger.Verify(logger => logger.WriteInformation("{0}: Up migration started", typeof(First_Migration).Name), Times.AtLeastOnce, "Informational message should indicate Up migration started.");
+                    mockLogger.Verify(logger => logger.WriteInformation("{0}: Up migration completed", typeof(First_Migration).Name), Times.AtLeastOnce, "Informational message should indicate Up migration started.");
+                }
+            }
+
+            public class WhenMigrationRunDown : RavenTestBase
+            {
+                [Fact]
+                public void Logger_WriteInformation_should_be_called_before_and_after_migration()
+                {
+                    var mockLogger = new Mock<ILogger>();
+
+                    using (var store = NewDocumentStore())
+                    {
+                        new TestDocumentIndex().Execute(store);
+
+                        Runner.Run(store);
+                        WaitForIndexing(store);
+
+                        Runner.Run(store, new MigrationOptions
+                        {
+                            Direction = Directions.Down, 
+                            Logger = mockLogger.Object
+                        });
+                    }
+
+                    mockLogger.Verify(logger => logger.WriteInformation("{0}: Down migration started", typeof(First_Migration).Name), Times.AtLeastOnce, "Informational message should indicate Up migration started.");
+                    mockLogger.Verify(logger => logger.WriteInformation("{0}: Down migration completed", typeof(First_Migration).Name), Times.AtLeastOnce, "Informational message should indicate Up migration started.");
+                }
+            }
+        }
     }
 
     public class TestDocument
@@ -388,7 +436,9 @@ public override void Up()
                 session.SaveChanges();
             }
         }
-    }    
+    }
+
+
 
     public abstract class BaseMigration : Migration
     {
diff --git a/RavenMigrations.Tests/packages.config b/RavenMigrations.Tests/packages.config
@@ -1,14 +1,17 @@
 ﻿<?xml version="1.0" encoding="utf-8"?>
 <packages>
+  <package id="Castle.Core" version="3.3.3" targetFramework="net45" />
   <package id="FluentAssertions" version="2.1.0.0" targetFramework="net45" />
   <package id="Microsoft.Data.Edm" version="5.2.0" targetFramework="net45" />
   <package id="Microsoft.Data.OData" version="5.2.0" targetFramework="net45" />
   <package id="Microsoft.WindowsAzure.ConfigurationManager" version="1.8.0.0" targetFramework="net45" />
+  <package id="Moq" version="4.5.9" targetFramework="net45" />
   <package id="RavenDB.Client" version="2.5.2700" targetFramework="net45" />
   <package id="RavenDB.Database" version="2.5.2700" targetFramework="net45" />
   <package id="RavenDB.Embedded" version="2.5.2700" targetFramework="net45" />
   <package id="RavenDB.Tests.Helpers" version="2.5.2700" targetFramework="net45" />
   <package id="System.Spatial" version="5.2.0" targetFramework="net45" />
   <package id="WindowsAzure.Storage" version="2.0.6.1" targetFramework="net45" />
   <package id="xunit" version="1.9.2" targetFramework="net45" />
+  <package id="xunit.runner.visualstudio" version="2.1.0" targetFramework="net45" />
 </packages>
diff --git a/RavenMigrations/Migration.cs b/RavenMigrations/Migration.cs
@@ -10,10 +10,10 @@ public virtual void Down()
         {
         }
 
-        public virtual void Setup(IDocumentStore documentStore, ILogger logger)
+        public virtual void Setup(IDocumentStore documentStore, ILogger logger = null)
         {
             DocumentStore = documentStore;
-            Logger = logger;
+            Logger = logger ?? new NullLogger();
             Alter = new Alter(documentStore, logger);
         }
 
diff --git a/RavenMigrations/Runner.cs b/RavenMigrations/Runner.cs
@@ -35,6 +35,9 @@ public static void Run(IDocumentStore documentStore, MigrationOptions options =
                     switch (options.Direction)
                     {
                         case Directions.Down:
+                            if (migrationDoc == null)
+                                continue;
+
                             options.Logger.WriteInformation("{0}: Down migration started", migration.GetType().Name);
                             migration.Down();
                             session.Delete(migrationDoc);
diff --git a/RavenMigrations/Verbs/Alter.cs b/RavenMigrations/Verbs/Alter.cs
@@ -11,9 +11,9 @@ namespace RavenMigrations.Verbs
 {
     public class Alter
     {
-        public Alter(IDocumentStore documentStore, ILogger logger)
+        public Alter(IDocumentStore documentStore, ILogger logger = null)
         {
-            Logger = logger;
+            Logger = logger ?? new NullLogger();
             DocumentStore = documentStore;
         }
 
diff --git a/readme.md b/readme.md
@@ -68,24 +68,26 @@ After each migration is executed, a document of type **MigrationDocument** is in
 You can modify the runner options by declaring a **MigrationOptions** instance and passing it to the runner.
 
 ```
- 	public class MigrationOptions
+public class MigrationOptions
+{
+    public MigrationOptions()
     {
-        public MigrationOptions()
-        {
-            Direction = Directions.Up;
-            Assemblies = new List<Assembly>();
-            Profiles = new List<string>();
-            MigrationResolver = new DefaultMigrationResolver();
-            Assemblies = new List<Assembly>();
-            ToVersion = 0;
-        }
-
-        public Directions Direction { get; set; }
-        public IList<Assembly> Assemblies { get; set; }
-        public IList<string> Profiles { get; set; }
-        public IMigrationResolver MigrationResolver { get; set; }
-        public long ToVersion { get; set; }
+         Direction = Directions.Up;
+         Assemblies = new List<Assembly>();
+         Profiles = new List<string>();
+         MigrationResolver = new DefaultMigrationResolver();
+         Assemblies = new List<Assembly>();
+         ToVersion = 0;
+         Logger = new ConsoleLogger();
     }
+
+    public Directions Direction { get; set; }
+    public IList<Assembly> Assemblies { get; set; }
+    public IList<string> Profiles { get; set; }
+    public IMigrationResolver MigrationResolver { get; set; }
+    public long ToVersion { get; set; }
+    public ILogger Logger { get; set; }
+}
 ```
 
 ### Profiles
@@ -266,6 +268,20 @@ Example usage in a migration:
     }    
 ```
 
+## Logging
+
+Specify a logger when configuring the runner.
+
+By default the `ConsoleLogger` is used.
+
+Implement the `RavenMigrations.ILogger` interface to create your own logger:
+
+```
+void WriteInformation(string format, params object[] args);
+void WriteError(string format, params object[] args);
+void WriteWarning(string format, params object[] args);
+```
+
 ## Integration
 
 We suggest you run the migrations at the start of your application to ensure that any new changes you have made apply to your application before you application starts. If you do not want to do it here, you can choose to do it out of band using a seperate application.

Original file line number	Diff line number	Diff line change
`@@ -10,10 +10,10 @@ public virtual void Down()`
`10`	`10`	`{`
`11`	`11`	`}`
`12`	`12`
`13`		`- public virtual void Setup(IDocumentStore documentStore, ILogger logger)`
	`13`	`+ public virtual void Setup(IDocumentStore documentStore, ILogger logger = null)`
`14`	`14`	`{`
`15`	`15`	`DocumentStore = documentStore;`
`16`		`- Logger = logger;`
	`16`	`+ Logger = logger ?? new NullLogger();`
`17`	`17`	`Alter = new Alter(documentStore, logger);`
`18`	`18`	`}`
`19`	`19`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,9 @@ namespace RavenMigrations.Verbs`
`11`	`11`	`{`
`12`	`12`	`public class Alter`
`13`	`13`	`{`
`14`		`- public Alter(IDocumentStore documentStore, ILogger logger)`
	`14`	`+ public Alter(IDocumentStore documentStore, ILogger logger = null)`
`15`	`15`	`{`
`16`		`- Logger = logger;`
	`16`	`+ Logger = logger ?? new NullLogger();`
`17`	`17`	`DocumentStore = documentStore;`
`18`	`18`	`}`
`19`	`19`