Merge pull request #54 from nzbart/process-exit-code

Set process exit code to 0 on success, 1 on failure

Author: christianspecht

src/ScmBackup.Tests/ErrorHandlingScmBackupTests.cs

@@ -6,8 +6,7 @@ namespace ScmBackup.Tests
 {
     public class ErrorHandlingScmBackupTests
     {
-        [Fact]
-        public void LogsWhenExceptionIsThrown()
+        static (FakeLogger FakeLogger, ErrorHandlingScmBackup ErrorHandlingScmBackup) BuildFakeScmBackup()
         {
             var ex = new Exception("!!!");
             var subBackup = new FakeScmBackup();
@@ -21,12 +20,30 @@ public void LogsWhenExceptionIsThrown()
             var logger = new FakeLogger();
 
             var backup = new ErrorHandlingScmBackup(subBackup, logger, context);
+            return (logger, backup);
+        }
+
+        [Fact]
+        public void LogsWhenExceptionIsThrown()
+        {
+            var (logger, backup) = BuildFakeScmBackup();
+
             backup.Run();
 
             Assert.True(logger.LoggedSomething);
             Assert.Equal(ErrorLevel.Error, logger.LastErrorLevel);
             // we can't check whether the last exception is the exception from above,
             // because there are more logging outputs after the exception.
         }
+
+        [Fact]
+        public void ReturnsFalseWhenExceptionIsThrown()
+        {
+            var (_, backup) = BuildFakeScmBackup();
+
+            var result = backup.Run();
+
+            Assert.False(result);
+        }
     }
 }

src/ScmBackup.Tests/FakeScmBackup.cs

@@ -5,13 +5,16 @@ namespace ScmBackup.Tests
     public class FakeScmBackup : IScmBackup
     {
         public Exception ToThrow { get; set; }
+        public bool ToReturn { get; set; } = true;
 
-        public void Run()
+        public bool Run()
         {
             if (this.ToThrow != null)
             {
                 throw this.ToThrow;
             }
+
+            return ToReturn;
         }
     }
 }

src/ScmBackup.Tests/LogMailingScmBackupTests.cs

@@ -5,10 +5,10 @@ namespace ScmBackup.Tests
 {
     public class LogMailingScmBackupTests
     {
-        [Fact]
-        public void RunSendsMail()
+        static (FakeEmailSender mail, LogMailingScmBackup sut) BuildFakeLogMailingScmBackup(bool innerReturnValue)
         {
             var subBackup = new FakeScmBackup();
+            subBackup.ToReturn = innerReturnValue;
 
             var messages = new LogMessages();
             messages.AddMessage("1");
@@ -17,12 +17,32 @@ public void RunSendsMail()
             var mail = new FakeEmailSender();
 
             var sut = new LogMailingScmBackup(subBackup, messages, mail);
+            return (mail, sut);
+        }
+
+        [Fact]
+        public void RunSendsMail()
+        {
+            var (mail, sut) = BuildFakeLogMailingScmBackup(true);
+
             sut.Run();
 
             Assert.NotNull(mail.LastSubject);
             Assert.NotNull(mail.LastBody);
             Assert.Contains("1", mail.LastBody);
             Assert.Contains("2", mail.LastBody);
         }
+
+        [Theory]
+        [InlineData(true)]
+        [InlineData(false)]
+        public void RunReturnsValueFromInnerExecution(bool innerReturnValue)
+        {
+            var (mail, sut) = BuildFakeLogMailingScmBackup(innerReturnValue);
+
+            var result = sut.Run();
+
+            Assert.Equal(result, innerReturnValue);
+        }
     }
 }

src/ScmBackup/ErrorHandlingScmBackup.cs

@@ -27,24 +27,19 @@ public ErrorHandlingScmBackup(IScmBackup backup, ILogger logger, IContext contex
             this.WaitSecondsOnError = 5;
         }
 
-        public void Run()
+        public bool Run()
         {
-            bool ok = false;
             string className = this.GetType().Name;
 
             try
             {
                 this.logger.Log(ErrorLevel.Debug, Resource.StartingBackup, className);
-                this.backup.Run();
-                ok = true;
+                return this.backup.Run();
             }
             catch (Exception ex)
             {
                 this.logger.Log(ErrorLevel.Error, ex.Message);
-            }
 
-            if (!ok)
-            {
                 // Wait as many seconds as defined in the config.
                 // If we don't have the config value because the exception was thrown while reading the config, use the default value defined in this class
                 int seconds = this.WaitSecondsOnError;
@@ -57,6 +52,8 @@ public void Run()
                 this.logger.Log(ErrorLevel.Error, Resource.BackupFailed);
                 this.logger.Log(ErrorLevel.Error, Resource.EndSeconds, seconds);
                 Task.Delay(TimeSpan.FromSeconds(seconds)).Wait();
+
+                return false;
             }
         }
     }

src/ScmBackup/IScmBackup.cs

@@ -2,6 +2,6 @@
 {
     internal interface IScmBackup
     {
-        void Run();
+        bool Run();
     }
 }

src/ScmBackup/LogMailingScmBackup.cs

@@ -21,14 +21,16 @@ public LogMailingScmBackup(IScmBackup backup, ILogMessages messages, IEmailSende
             this.mail = mail;
         }
 
-        public void Run()
+        public bool Run()
         {
-            this.backup.Run();
+            var result = this.backup.Run();
 
             string subject = string.Format(Resource.LogMailSubject, DateTime.Now.ToString("dd MMM HH:mm:ss"));
             string body = string.Join(Environment.NewLine, this.messages.GetMessages().ToArray());
 
             this.mail.Send(subject, body);
+
+            return result;
         }
     }
 }

src/ScmBackup/LoggingScmBackup.cs

@@ -13,17 +13,19 @@ public LoggingScmBackup(IScmBackup backup, IContext context, ILogger logger)
             this.logger = logger;
         }
 
-        public void Run()
+        public bool Run()
         {
             logger.Log(ErrorLevel.Info, this.context.AppTitle);
             logger.Log(ErrorLevel.Info, Resource.AppWebsite);
 
             // TODO: log more stuff (operating system, configuration...)
 
-            this.backup.Run();
+            var result = this.backup.Run();
 
             logger.Log(ErrorLevel.Info, Resource.BackupFinished);
             logger.Log(ErrorLevel.Info, string.Format(Resource.BackupFinishedDirectory, this.context.Config.LocalFolder));
+
+            return result;
         }
     }
 }

src/ScmBackup/Program.cs

@@ -4,10 +4,11 @@ namespace ScmBackup
 {
     public class Program
     {
-        public static void Main(string[] args)
+        public static int Main(string[] args)
         {
             var container = Bootstrapper.BuildContainer();            
-            container.GetInstance<IScmBackup>().Run();
+            var success = container.GetInstance<IScmBackup>().Run();
+            return success ? 0 : 1;
         }
     }
 }

src/ScmBackup/ScmBackup.cs

@@ -21,7 +21,7 @@ public ScmBackup(IApiCaller apiCaller, IScmValidator validator, IBackupMaker bac
             this.configBackupMaker = configBackupMaker;
         }
 
-        public void Run()
+        public bool Run()
         {
             this.configBackupMaker.BackupConfigs();
 
@@ -36,6 +36,8 @@ public void Run()
             {
                 this.backupMaker.Backup(source, repos.GetReposForSource(source));
             }
+
+            return true;
         }
     }
 }