Refactor broker and add failed method

Author: ethanhann

docs-src/commands.md

@@ -36,10 +36,10 @@ namespace MyCommandPlugin
 {
     public class MyCommand : ICommand
     {
-        public CommandResult Run()
+        public void Run()
         {
             Console.WriteLine("Hello, world!");
-            return new CommandResult(true);
+            return new void(true);
         }
     }
 }
@@ -56,10 +56,10 @@ namespace MyCommandPlugin
 {
     public class MyCommand : AbstractCommand
     {
-        public override CommandResult Run()
+        public override void Run()
         {
             Console.WriteLine("Hello, world!");
-            return new CommandResult(true);
+            return new void(true);
         }
     }
 }
@@ -188,7 +188,7 @@ IWrite Line(string val);
 ```
 
 ```c#
-public override CommandResult Run()
+public override void Run()
 {
     Info("Display some information");
 }
@@ -215,15 +215,15 @@ Line("This is a plain line.");
 The **InEngine.Core.AbstractCommand** class provides a Logger property. It implements the **NLog.ILogger** interface.
 
 ```c#
-public override CommandResult Run()
+public override void Run()
 {
     Logger.Trace("Sample trace message");
     Logger.Debug("Sample debug message");
     Logger.Info("Sample informational message");
     Logger.Warn("Sample warning message");
     Logger.Error("Sample error message");
     Logger.Fatal("Sample fatal error message");
-    return new CommandResult(true);
+    return new void(true);
 }
 ```
 
@@ -251,7 +251,7 @@ Setup an [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configu
 The **InEngine.Core.AbstractCommand** class provides a ProgressBar property. This is how it is used.
 
 ```c#
-public override CommandResult Run()
+public override void Run()
 {
     // Define the ticks (aka steps) for the command...
     var maxTicks = 100000;
@@ -264,7 +264,7 @@ public override CommandResult Run()
         UpdateProgress(i);
     }
 
-    return new CommandResult(true);
+    return new void(true);
 }
 ```
 

src/InEngine.Commands/Sample/Minimal.cs

@@ -11,9 +11,8 @@ namespace InEngine.Commands.Sample
      */
     public class Minimal : ICommand
     {
-        public CommandResult Run()
+        public void Run()
         {
-            return new CommandResult(true);
         }
     }
 }

src/InEngine.Commands/Sample/SayHello.cs

@@ -5,10 +5,9 @@ namespace InEngine.Commands.Sample
 {
     public class SayHello : AbstractCommand
     {
-        public override CommandResult Run()
+        public override void Run()
         {
             Console.WriteLine("hello");
-            return new CommandResult(true);
         }
     }
 }

src/InEngine.Commands/Sample/ShowProgress.cs

@@ -12,7 +12,7 @@ public class ShowProgress : AbstractCommand
          * Note that the override keyword is necessary in the Run method 
          * signature as the base class method is virtual.
          */
-        public override CommandResult Run()
+        public override void Run()
         {
             // Define the ticks (aka steps) for the command...
             var maxTicks = 100000;
@@ -24,8 +24,6 @@ public override CommandResult Run()
                 // Update the command's progress
                 UpdateProgress(i);
             }
-
-            return new CommandResult(true);
         }
     }
 }

src/InEngine.Core.Tests/Queue/Commands/ConsumeTest.cs

@@ -22,48 +22,37 @@ public void Setup()
         [Test]
         public void ShouldConsumePrimaryQueue()
         {
-            var expectedMessage = "Consumed";
             new Publish() {
-                Command = new Null()
+                Command = new AlwaysSucceed()
             }.Run();
 
-            var result = Subject.Run();
-
-            Assert.IsTrue(result.IsSuccessful);
-            Assert.AreEqual(expectedMessage, result.Message);
+            Subject.Run();
         }
 
         [Test]
         public void ShouldConsumeSecondaryQueue()
         {
             var expectedMessage = "Consumed";
             new Publish() {
-                Command = new Null()
+                Command = new AlwaysSucceed()
             }.Run();
             Subject.UseSecondaryQueue = true;
 
-            var result = Subject.Run();
-
-            Assert.IsTrue(result.IsSuccessful);
-            Assert.AreEqual(expectedMessage, result.Message);
+            Subject.Run();
         }
 
         [Test]
         public void ShouldConsumeSecondaryQueueBasedOnJobContextData()
         {
-            var expectedMessage = "Consumed";
             new Publish() {
-                Command = new Null()
+                Command = new AlwaysSucceed()
             }.Run();
             var jobExecutionConext = new Mock<IJobExecutionContext>();
             var jobDataMap = new JobDataMap { { "useSecondaryQueue", true } };
             jobExecutionConext.SetupGet(p => p.JobDetail.JobDataMap).Returns(jobDataMap);
             Subject.JobExecutionContext = jobExecutionConext.Object;
 
-            var result = Subject.Run();
-
-            Assert.IsTrue(result.IsSuccessful);
-            Assert.AreEqual(expectedMessage, result.Message);
+            Subject.Run();
         }
     }
 }

src/InEngine.Core.Tests/Queue/Commands/PublishTest.cs

@@ -21,41 +21,31 @@ public void Setup()
         [Test]
         public void ShouldPublishCommandObject()
         {
-            var expectedMessage = "Published";
-            Subject.Command = new Null();
+            Subject.Command = new AlwaysSucceed();
 
-            var result = Subject.Run();
-
-            Assert.IsTrue(result.IsSuccessful);
-            Assert.AreEqual(expectedMessage, result.Message);
+            Subject.Run();
         }
 
         [Test]
         public void ShouldPublishCommandByArgs()
         {
-            var expectedMessage = "Published";
-            var nullCommand = new Null();
+            var nullCommand = new AlwaysSucceed();
             Subject.CommandAssembly = nullCommand.GetType().Assembly.GetName().Name + ".dll";
             Subject.CommandClass = nullCommand.GetType().FullName;
 
-            var result = Subject.Run();
-
-            Assert.IsTrue(result.IsSuccessful);
-            Assert.AreEqual(expectedMessage, result.Message);
+            Subject.Run();
         }
 
         [Test]
         public void ShouldPublishManyCommands()
         {
-            //var expectedMessage = "Published";
-            Subject.Command = new Null();
-            var results = new List<CommandResult>();
-
-            foreach(var i in Enumerable.Range(0, 200).ToList())
-                results.Add(Subject.Run());
 
-            //Assert.IsTrue(result.IsSuccessful);
-            //Assert.AreEqual(expectedMessage, result.Message);
+            foreach (var i in Enumerable.Range(0, 200).ToList()) {
+                Subject.Command = new Echo() {
+                    Text = $"test job: {i}"
+                };
+                Subject.Run();   
+            }
         }
 
         [Test]

src/InEngine.Core/AbstractCommand.cs

@@ -6,7 +6,7 @@
 
 namespace InEngine.Core
 {
-    abstract public class AbstractCommand : ICommand, IJob, IWrite
+    abstract public class AbstractCommand : ICommand, IFailed, IJob, IWrite
     {
         public IJobExecutionContext JobExecutionContext { get; set; }
         public ILogger Logger { get; internal set; }
@@ -33,11 +33,14 @@ protected AbstractCommand()
             Write = new Write();;
         }
 
-        public virtual CommandResult Run()
+        public virtual void Run()
         {
             throw new NotImplementedException();
         }
 
+        public virtual void Failed(Exception exception)
+        {}
+
         #region ProgressBar
         public void SetProgressBarMaxTicks(int maxTicks)
         {
@@ -54,7 +57,14 @@ public void UpdateProgress(int tick)
         public void Execute(IJobExecutionContext context)
         {
             JobExecutionContext = context;
-            Run();
+            try
+            {
+                Run();
+            }
+            catch (Exception exception)
+            {
+                Failed(exception);
+            }
         }
 
         public T GetJobContextData<T>(string key)

src/InEngine.Core/Commands/AlwaysFail.cs

@@ -0,0 +1,21 @@
+using System;
+using InEngine.Core.Exceptions;
+
+namespace InEngine.Core.Commands
+{
+    /// <summary>
+    /// Dummy command for testing and sample code.
+    /// </summary>
+    public class AlwaysFail : AbstractCommand
+    {
+        public override void Run()
+        {
+            throw new CommandFailedException("This command always fails.");
+        }
+
+        public override void Failed(Exception exception)
+        {
+            Error(exception.Message);
+        }
+    }
+}

src/InEngine.Core/Commands/Null.cs renamed to src/InEngine.Core/Commands/AlwaysSucceed.cs

@@ -3,11 +3,10 @@
     /// <summary>
     /// Dummy command for testing and sample code.
     /// </summary>
-    public class Null : AbstractCommand
+    public class AlwaysSucceed : AbstractCommand
     {
-        public override CommandResult Run()
+        public override void Run()
         {
-            return new CommandResult(true);
         }
     }
 }

src/InEngine.Core/Commands/Echo.cs

@@ -11,10 +11,9 @@ public class Echo : AbstractCommand
         [Option("text", HelpText = "The text to echo.")]
         public string Text { get; set; }
 
-        public override CommandResult Run()
+        public override void Run()
         {
-            Console.WriteLine(Text);
-            return new CommandResult(true);
+            Write.Line(Text);
         }
     }
 }