Merge lp:~adam-rpconnelly/dbversion/cmdtimeout into lp:dbversion

[Adam Connelly]

Moved the code to convert the property value to an int into the PropertyService.

[Colin Winning (colinwinning)]

All looks good to me.

[Colin Winning (colinwinning)]

review: Approve

=== modified file 'src/DatabaseVersion.Tests/Manifests/ManifestReaderTests.cs'
--- src/DatabaseVersion.Tests/Manifests/ManifestReaderTests.cs	2011-10-10 18:43:53 +0000
+++ src/DatabaseVersion.Tests/Manifests/ManifestReaderTests.cs	2012-08-29 19:06:19 +0000
@@ -95,9 +95,8 @@
 
             Mock<IDatabaseTaskFactory > factory = new Mock<IDatabaseTaskFactory>();
             Mock<IDatabaseTask > task = new Mock<IDatabaseTask>();
-            Mock<IMessageService> messageService = new Mock<IMessageService>();
             factory.Setup(f => f.CanCreate(It.Is<XElement>(r => r.Name == "script"))).Returns(true);
-            factory.Setup(f => f.Create(It.Is<XElement>(r => r.Name == "script"), 0, It.IsAny<IDatabaseVersion>(), messageService.Object)).Returns(task.Object);
+            factory.Setup(f => f.Create(It.Is<XElement>(r => r.Name == "script"), 0, It.IsAny<IDatabaseVersion>())).Returns(task.Object);
 
             reader.Factories = new[] { factory.Object };
 
@@ -116,9 +115,8 @@
 
             Mock<IDatabaseTaskFactory > factory = new Mock<IDatabaseTaskFactory>();
             Mock<IDatabaseTask > task = new Mock<IDatabaseTask>();
-            Mock<IMessageService> messageService = new Mock<IMessageService>();
             factory.Setup(f => f.CanCreate(It.IsAny<XElement>())).Returns(true);
-            factory.Setup(f => f.Create(It.IsAny<XElement>(), It.IsAny<int>(), It.IsAny<IDatabaseVersion>(), messageService.Object)).Returns(task.Object);
+            factory.Setup(f => f.Create(It.IsAny<XElement>(), It.IsAny<int>(), It.IsAny<IDatabaseVersion>())).Returns(task.Object);
 
             reader.Factories = new[] { factory.Object };
 
@@ -129,7 +127,7 @@
             int expectedOrder = 0;
             foreach (IDatabaseTask createdTask in version.Tasks)
             {
-                factory.Verify(f => f.Create(It.IsAny<XElement>(), expectedOrder, It.IsAny<IDatabaseVersion>(), messageService.Object));
+                factory.Verify(f => f.Create(It.IsAny<XElement>(), expectedOrder, It.IsAny<IDatabaseVersion>()));
                 expectedOrder++;
             }
         }

=== modified file 'src/DatabaseVersion.Tests/Property/PropertyServiceTests.cs'
--- src/DatabaseVersion.Tests/Property/PropertyServiceTests.cs	2011-09-02 23:16:14 +0000
+++ src/DatabaseVersion.Tests/Property/PropertyServiceTests.cs	2012-08-29 19:06:19 +0000
@@ -85,6 +85,6 @@
 
             // Assert
             Assert.Equal(0, service.Properties.Count());
-        }
+        }

        [Fact]
        public void ShouldBeAbleToReturnPropertyAsInt()
        {
            // Arrange
            var service = new PropertyService();
            service.Add(new Property { Key = "myProperty", Value = "100" });

            // Act
            var value = service.GetInt("myProperty");

            // Assert
            Assert.Equal(100, value);
        }

        [Fact]
        public void ShouldReturnNullIfPropertyIsNotAnInt()
        {
            // Arrange
            var service = new PropertyService();
            service.Add(new Property { Key = "myProperty", Value = "abcd" });

            // Act
            var value = service.GetInt("myProperty");

            // Assert
            Assert.Null(value);
        }

        [Fact]
        public void ShouldReturnNullFromGetIntIfPropertyIsNotSet()
        {
            // Arrange
            var service = new PropertyService();

            // Act
            var value = service.GetInt("myProperty");

            // Assert
            Assert.Null(value);
        }
     }
 }

=== modified file 'src/DatabaseVersion.Tests/Sql/ScriptTaskFactoryTests.cs'
--- src/DatabaseVersion.Tests/Sql/ScriptTaskFactoryTests.cs	2011-10-10 09:00:52 +0000
+++ src/DatabaseVersion.Tests/Sql/ScriptTaskFactoryTests.cs	2012-08-29 19:06:19 +0000
@@ -63,7 +63,7 @@
                 new XAttribute(XName.Get("file"), "path/file.sql"));
 
             // Act
-            IDatabaseTask task = this.factory.Create(element, 0, null, null);
+            IDatabaseTask task = this.factory.Create(element, 0, null);
 
             // Assert
             Assert.IsType<ScriptTask>(task);
@@ -78,7 +78,7 @@
                 new XAttribute(XName.Get("file"), "path/file.sql"));
 
             // Act
-            IDatabaseTask task = this.factory.Create(element, 0, null, null);
+            IDatabaseTask task = this.factory.Create(element, 0, null);
 
             // Assert
             Assert.Equal("path/file.sql", ((ScriptTask)task).FileName);
@@ -93,7 +93,7 @@
                 new XAttribute(XName.Get("file"), "path/file.sql"));
 
             // Act
-            IDatabaseTask task = this.factory.Create(element, 25, null, null);
+            IDatabaseTask task = this.factory.Create(element, 25, null);
 
             // Assert
             Assert.Equal(25, task.ExecutionOrder);

=== modified file 'src/DatabaseVersion.Tests/Sql/ScriptTaskTests.cs'
--- src/DatabaseVersion.Tests/Sql/ScriptTaskTests.cs	2012-01-24 22:01:24 +0000
+++ src/DatabaseVersion.Tests/Sql/ScriptTaskTests.cs	2012-08-29 19:06:19 +0000
@@ -9,6 +9,7 @@
     using Moq;
     using System.Data;
     using System.IO;
+    using dbversion.Property;
     using dbversion.Tasks;
     using dbversion.Version;
     using NHibernate;
@@ -18,10 +19,12 @@
         private readonly Mock<ISession> session = new Mock<ISession>() { DefaultValue = DefaultValue.Mock };
         private readonly Mock<IDbCommand> command = new Mock<IDbCommand>();
         private readonly Mock<IMessageService> messageService = new Mock<IMessageService> { DefaultValue = DefaultValue.Mock };
+        private readonly Mock<IPropertyService> propertyService = new Mock<IPropertyService>();
 
         public ScriptTaskTests()
         {
             this.session.Setup(s => s.Connection.CreateCommand()).Returns(command.Object);
+            this.command.SetupProperty(c => c.CommandTimeout);
         }
 
         [Fact]
@@ -32,7 +35,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(this.GetStream("A"));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -49,7 +52,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
             version.Setup(v => v.Archive.GetFile("1\\scripts\\schema.sql")).Returns(GetStream("ABCDE"));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -67,7 +70,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream("ABCDE" + Environment.NewLine + "GO" + Environment.NewLine + "FGHIJ"));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -96,7 +99,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream(ScriptWithDifferentCasedSeparators));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -124,7 +127,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream(ScriptWithSeparatorsWithinLines));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -147,7 +150,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream(ScriptWithSeparatorAtStartOfScript));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -168,7 +171,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream(ScriptWithSeparatorAtEndOfScript));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             task.Execute(session.Object, 1, 1);
@@ -186,7 +189,7 @@
             version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
                 GetStream(ScriptWithSeparatorAtEndOfScript));
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
             Exception exception = new Exception();
             command.Setup(c=>c.ExecuteNonQuery()).Throws(exception);
 
@@ -207,7 +210,7 @@
             version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
             version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
             version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns((Stream)null);
-            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object);
+            ScriptTask task = new ScriptTask("scripts\\schema.sql", 0, version.Object, messageService.Object, this.propertyService.Object);
 
             // Act
             Exception thrownException = Record.Exception(() => task.Execute(new Mock<ISession>().Object, 1, 1));
@@ -217,6 +220,44 @@
             Assert.Equal("The script file \"1\\scripts\\schema.sql\" does not exist in the archive.", thrownException.Message);
         }
 
+        [Fact]
+        public void ShouldSetCommandTimeoutIfSpecified()
+        {
+            // Arrange
+            Mock<IDatabaseVersion> version = new Mock<IDatabaseVersion>{ DefaultValue = DefaultValue.Mock };
+            version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
+            version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
+            version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
+                GetStream(ScriptWithSeparatorAtEndOfScript));
+            var task = new ScriptTask("scripts\\test.sql", 0, version.Object, this.messageService.Object, this.propertyService.Object);
+
+            propertyService.Setup(p => p.GetInt(ScriptTask.CommandTimeoutPropertyName)).Returns(100);
+
+            // Act
+            task.Execute(this.session.Object, 1, 1);
+
+            // Assert
+            Assert.Equal(100, task.TaskTimeout);
+        }
+
+        [Fact]
+        public void ShouldNotSetCommandTimeoutIfNotSpecified()
+        {
+            // Arrange
+            Mock<IDatabaseVersion> version = new Mock<IDatabaseVersion> { DefaultValue = DefaultValue.Mock };
+            version.Setup(v => v.ManifestPath).Returns("1\\database.xml");
+            version.Setup(v => v.Archive.GetScriptPath("1\\database.xml", "scripts\\schema.sql")).Returns("1\\scripts\\schema.sql");
+            version.Setup(v => v.Archive.GetFile(It.IsAny<string>())).Returns(
+                GetStream(ScriptWithSeparatorAtEndOfScript));
+            var task = new ScriptTask("scripts\\test.sql", 0, version.Object, this.messageService.Object, this.propertyService.Object);
+
+            // Act
+            task.Execute(this.session.Object, 1, 1);
+
+            // Assert
+            Assert.Null(task.TaskTimeout);
+        }
+
         private Stream GetStream(string contents)
         {
             return new MemoryStream(Encoding.Default.GetBytes(contents));

=== modified file 'src/DatabaseVersion/Manifests/ManifestReader.cs'
--- src/DatabaseVersion/Manifests/ManifestReader.cs	2011-10-10 18:43:53 +0000
+++ src/DatabaseVersion/Manifests/ManifestReader.cs	2012-08-29 19:06:19 +0000
@@ -58,7 +58,7 @@
                 IDatabaseTaskFactory factory = this.Factories.FirstOrDefault(f => f.CanCreate(element));
                 if (factory != null)
                 {
-                    return factory.Create(element, element.ElementsBeforeSelf().Count(), version, MessageService);
+                    return factory.Create(element, element.ElementsBeforeSelf().Count(), version);
                 }
             }
 

=== modified file 'src/DatabaseVersion/Property/IPropertyService.cs'
--- src/DatabaseVersion/Property/IPropertyService.cs	2011-09-02 23:16:14 +0000
+++ src/DatabaseVersion/Property/IPropertyService.cs	2012-08-29 19:06:19 +0000
@@ -51,6 +51,17 @@
         /// The prefix to look for.
         /// </param>
         IEnumerable<Property> StartingWith(string prefix);
+
+        /// <summary>
+        /// Gets the specified property as an int.
+        /// </summary>
+        /// <param name='key'>
+        /// The property key.
+        /// </param>
+        /// <returns>
+        /// The int value or null if the property is not defined, or is not an int.
+        /// </returns>
+        int? GetInt(string key);
     }
 }
 

=== modified file 'src/DatabaseVersion/Property/PropertyService.cs'
--- src/DatabaseVersion/Property/PropertyService.cs	2011-09-03 23:15:46 +0000
+++ src/DatabaseVersion/Property/PropertyService.cs	2012-08-29 19:06:19 +0000
@@ -53,14 +53,7 @@
         {
             get
             {
-                Property propertyValue;
-
-                if (this.properties.TryGetValue(propertyName, out propertyValue))
-                {
-                    return propertyValue;
-                }
-
-                return null;
+                return this.Get(propertyName);
             }
         }
 
@@ -88,6 +81,47 @@
         {
             return this.properties.Where(p => p.Key.StartsWith(prefix)).Select(p => p.Value);
         }
+
+        /// <summary>
+        /// Gets the specified property as an int.
+        /// </summary>
+        /// <param name='key'>
+        /// The property key.
+        /// </param>
+        /// <returns>
+        /// The int value or null if the property is not defined, or is not an int.
+        /// </returns>
+        public int? GetInt(string key)
+        {
+            Validate.NotNull(() => key);
+
+            int value;
+            var property = this.Get(key);
+
+            if (property != null && int.TryParse(property.Value, out value))
+            {
+                return value;
+            }
+
+            return null;
+        }
+
+        /// <summary>
+        /// Get the property with the specified name.
+        /// </summary>
+        /// <param name='propertyName'>
+        /// The name of the property.
+        /// </param>
+        private Property Get(string propertyName)
+        {
+            Property propertyValue;
+            if (this.properties.TryGetValue(propertyName, out propertyValue))
+            {
+                return propertyValue;
+            }
+
+            return null;
+        }
     }
 }
 

=== modified file 'src/DatabaseVersion/Tasks/IDatabaseTaskFactory.cs'
--- src/DatabaseVersion/Tasks/IDatabaseTaskFactory.cs	2011-10-10 18:43:53 +0000
+++ src/DatabaseVersion/Tasks/IDatabaseTaskFactory.cs	2012-08-29 19:06:19 +0000
@@ -19,8 +19,7 @@
         /// <param name="element">The element containing the definition of the task.</param>
         /// <param name="executionOrder">The zero-based execution order of the task.</param>
         /// <param name="version">The database version that the task is contained within.</param>
-        /// <param name="messageService">The Message Service to use for logging</param>
         /// <returns>The new task.</returns>
-        IDatabaseTask Create(XElement element, int executionOrder, IDatabaseVersion version, IMessageService messageService);
+        IDatabaseTask Create(XElement element, int executionOrder, IDatabaseVersion version);
     }
 }

=== modified file 'src/DatabaseVersion/Tasks/Sql/ScriptTask.cs'
--- src/DatabaseVersion/Tasks/Sql/ScriptTask.cs	2012-01-24 22:01:24 +0000
+++ src/DatabaseVersion/Tasks/Sql/ScriptTask.cs	2012-08-29 19:06:19 +0000
@@ -9,6 +9,7 @@
     using System.Diagnostics;
     using System.Text.RegularExpressions;
 
+    using dbversion.Property;
     using dbversion.Version;
 
     using NHibernate;
@@ -27,6 +28,11 @@
             "{0}{1}|{0}{1}{0}|{1}{0}";
 
         /// <summary>
+        /// The name of the command timeout property.
+        /// </summary>
+        public const string CommandTimeoutPropertyName = "dbversion.sql.command_timeout";
+
+        /// <summary>
         /// The regex object created from the regex format.
         /// </summary>
         private readonly Regex StringSplitRegex;
@@ -36,15 +42,30 @@
         /// </summary>
         private readonly IDatabaseVersion version;
 
+        private readonly IPropertyService propertyService;
+
         protected override string GetTaskDescription()
         {
             return string.Format("Executing script \"{0}\"", this.GetScriptPath());
         }
 
-        public ScriptTask(string fileName, int executionOrder, IDatabaseVersion version, IMessageService messageService)
+        /// <summary>
+        /// The Timeout in seconds for the task
+        /// </summary>
+        /// <returns>The Timeout in seconds or if none set null</returns>
+        public int? TaskTimeout
+        {
+            get
+            {
+                return this.propertyService.GetInt(CommandTimeoutPropertyName);
+            }
+        }
+
+        public ScriptTask(string fileName, int executionOrder, IDatabaseVersion version, IMessageService messageService, IPropertyService propertyService)
             : base(fileName, executionOrder, messageService)
         {
             this.version = version;
+            this.propertyService = propertyService;
 
             this.StringSplitRegex = GetStringSplitRegex();
         }
@@ -119,6 +140,7 @@
             using (var command = session.Connection.CreateCommand())
             {
                 session.Transaction.Enlist(command);
+                if (TaskTimeout.HasValue) command.CommandTimeout = TaskTimeout.Value;
                 command.CommandText = batch;
                 command.ExecuteNonQuery();
             }

=== modified file 'src/DatabaseVersion/Tasks/Sql/ScriptTaskFactory.cs'
--- src/DatabaseVersion/Tasks/Sql/ScriptTaskFactory.cs	2011-10-10 09:00:52 +0000
+++ src/DatabaseVersion/Tasks/Sql/ScriptTaskFactory.cs	2012-08-29 19:06:19 +0000
@@ -7,19 +7,34 @@
     using System.Xml.Linq;
     using System.ComponentModel.Composition;
 
+    using dbversion.Property;
     using dbversion.Version;
 
     [Export(typeof(IDatabaseTaskFactory))]
     public class ScriptTaskFactory : IDatabaseTaskFactory
     {
+        [Import]
+        public IPropertyService PropertyService
+        {
+            get;
+            set;
+        }
+
+        [Import]
+        public IMessageService MessageService 
+        { 
+            get; 
+            set; 
+        }
+
         public bool CanCreate(XElement element)
         {
             return element != null && element.Name == "script";
         }
 
-        public IDatabaseTask Create(XElement element, int executionOrder, IDatabaseVersion version, IMessageService messageService)
+        public IDatabaseTask Create(XElement element, int executionOrder, IDatabaseVersion version)
         {
-            return new ScriptTask(element.Attribute(XName.Get("file")).Value, executionOrder, version, messageService);
+            return new ScriptTask(element.Attribute(XName.Get("file")).Value, executionOrder, version, this.MessageService, this.PropertyService);
         }
     }
 }