Improve validation failure reporting

Consolidated validation exception Refactoring
nullpainter · Oct 5, 2020 · ae59a95 · ae59a95
1 parent aba141d
commit ae59a95
Show file tree

Hide file tree

Showing 47 changed files with 119 additions and 97 deletions.
diff --git a/Sanchez.Processing/Extensions/Images/ImageExtensions.cs b/Sanchez.Processing/Extensions/Images/ImageExtensions.cs
@@ -1,7 +1,9 @@
-using System.IO;
+using System;
+using System.IO;
 using System.Reflection;
 using System.Threading.Tasks;
 using ExifLibrary;
+using FluentValidation;
 using SixLabors.ImageSharp;
 using SixLabors.ImageSharp.PixelFormats;
 
@@ -22,7 +24,14 @@ public static async Task SaveWithExifAsync(this Image<Rgba32> image, string path
             }
 
             // Save image
-            await image.SaveAsync(path);
+            try
+            {
+                await image.SaveAsync(path);
+            }
+            catch (NotSupportedException)
+            {
+                throw new ValidationException($"Unsupported output file extension: {Path.GetExtension(path)}");
+            }
 
             // Add EXIF metadata to image
             var version = Assembly.GetExecutingAssembly().GetName().Version;

diff --git a/Sanchez.Processing/Resources/Migration/001. Create cache table.sql b/Sanchez.Processing/Resources/Migration/001. Create cache table.sql
@@ -1,4 +1,4 @@
-CREATE TABLE UnderlayCache(
+CREATE TABLE IF NOT EXISTS UnderlayCache(
   Id INTEGER PRIMARY KEY AUTOINCREMENT,
   Filename TEXT NOT NULL,
   Longitude NUMERIC,

diff --git a/Sanchez.Processing/Services/FileService.cs b/Sanchez.Processing/Services/FileService.cs
@@ -16,7 +16,7 @@ public interface IFileService
         ///     can be a single file, a directory or a glob and wildcard pattern (such as <c>source/**/*IR.jpg</c>)
         /// </summary>
         List<string> GetSourceFiles();
-        
+
         List<Registration> ToRegistrations(List<string> sourceFiles);
 
         /// <summary>
@@ -76,7 +76,10 @@ public List<string> GetSourceFiles()
             var absolutePath = Path.GetFullPath(_options.SourcePath!);
 
             // Source is a single file
-            if (!_options.MultipleSources) return new List<string> { absolutePath };
+            if (!_options.MultipleSources)
+            {
+                return File.Exists(absolutePath) ? new List<string> { absolutePath } : new List<string>();
+            }
 
             // If the source is a directory, enumerate all files
             if (Directory.Exists(absolutePath))

diff --git a/Sanchez.Shared/Exceptions/ValidationException.cs b/Sanchez.Shared/Exceptions/ValidationException.cs
diff --git a/Sanchez.Workflow/Extensions/StepExtensions.cs b/Sanchez.Workflow/Extensions/StepExtensions.cs
@@ -1,5 +1,4 @@
-using Sanchez.Workflow.Models;
-using Sanchez.Workflow.Models.Data;
+using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Steps.Common;
 using WorkflowCore.Interface;
 

diff --git a/Sanchez.Workflow/Extensions/WorkflowExtensions.cs b/Sanchez.Workflow/Extensions/WorkflowExtensions.cs
@@ -1,5 +1,4 @@
-using Sanchez.Workflow.Models;
-using Sanchez.Workflow.Models.Data;
+using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using WorkflowCore.Interface;
 

diff --git a/Sanchez.Workflow/Models/Data/EquirectangularStitchWorkflowData.cs b/Sanchez.Workflow/Models/Data/EquirectangularStitchWorkflowData.cs
@@ -1,11 +1,10 @@
 using JetBrains.Annotations;
-using Sanchez.Workflow.Workflows.Equirectangular;
 using SixLabors.ImageSharp;
 
 namespace Sanchez.Workflow.Models.Data
 {
     /// <summary>
-    ///     Data backing <see cref="EquirectangularStitchWorkflow"/>.
+    ///     Data backing <see cref="Sanchez.Workflow.Workflows.Equirectangular.EquirectangularStitchWorkflow"/>.
     /// </summary>
     public class EquirectangularStitchWorkflowData : WorkflowData
     {

diff --git a/Sanchez.Workflow/Models/Data/EquirectangularTimelapseWorkflowData.cs b/Sanchez.Workflow/Models/Data/EquirectangularTimelapseWorkflowData.cs
@@ -1,13 +1,12 @@
 using System;
 using System.Collections.Generic;
 using JetBrains.Annotations;
-using Sanchez.Workflow.Workflows.Equirectangular;
 using ShellProgressBar;
 
 namespace Sanchez.Workflow.Models.Data
 {
     /// <summary>
-    ///     Data backing <see cref="EquirectangularTimelapseWorkflow"/>.
+    ///     Data backing <see cref="Sanchez.Workflow.Workflows.Equirectangular.EquirectangularTimelapseWorkflow"/>.
     /// </summary>
     public class EquirectangularTimelapseWorkflowData : EquirectangularStitchWorkflowData
     {

diff --git a/Sanchez.Workflow/Models/Data/GeostationaryWorkflowData.cs b/Sanchez.Workflow/Models/Data/GeostationaryWorkflowData.cs
@@ -1,10 +1,7 @@
-
-using Sanchez.Workflow.Workflows.Geostationary;
-
-namespace Sanchez.Workflow.Models.Data
+namespace Sanchez.Workflow.Models.Data
 {
     /// <summary>
-    ///     Data backing <see cref="GeostationaryWorkflow"/>.
+    ///     Data backing <see cref=" Sanchez.Workflow.Workflows.Geostationary.GeostationaryWorkflow"/>.
     /// </summary>
     public class GeostationaryWorkflowData : WorkflowData
     {

diff --git a/Sanchez.Workflow/Models/Data/WorkflowData.cs b/Sanchez.Workflow/Models/Data/WorkflowData.cs
@@ -18,9 +18,9 @@ public interface IWorkflowData
     /// </summary>
     /// <remarks>
     ///    This is arguably a misuse of WorkflowCore data, as it should be able to be serialized. Add disposable
-    ///    services and binary data breaks this pattern.
+    ///    services and binary data breaks this pattern. In practice, this state needs to be available somewhere,
+    ///    and the workflows aren't log enough to warrant having a persistence provider specified.
     /// </remarks>
-    // TODO check if WorkflowCore has some sort of never serialize flag
     public abstract class WorkflowData : IWorkflowData, IDisposable
     {
         /// <summary>

diff --git a/Sanchez.Workflow/Services/WorkflowService.cs b/Sanchez.Workflow/Services/WorkflowService.cs
@@ -1,8 +1,8 @@
 using System;
 using System.Threading;
 using System.Threading.Tasks;
+using FluentValidation;
 using Sanchez.Processing.Models;
-using Sanchez.Shared.Exceptions;
 using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Workflows.Equirectangular;
@@ -31,7 +31,7 @@ public sealed class WorkflowService : IWorkflowService, IDisposable
 
         private readonly AutoResetEvent _resetEvent;
         private string? _workflowId;
-        private bool _initialised = false;
+        private bool _initialised;
 
         public WorkflowService(
             RenderOptions options,
@@ -110,11 +110,13 @@ private void OnLifeCycleEvent(CancellationTokenSource cancellationToken, LifeCyc
 
         private void OnStepError(Exception exception, WorkflowInstance workflow)
         {
+            DisposeData();
+
             switch (exception)
             {
                 case ValidationException validationException:
                     Console.WriteLine(validationException.Message);
-                    Log.Error(validationException.Message);
+                    Log.Warning(validationException.Message);
                     break;
                 default:
                     if (!_options.Verbose) Console.WriteLine("Unhandled failure; check logs for details, or run again with verbose logging (-v / --verbose)");

diff --git a/Sanchez.Workflow/Steps/Common/ColourCorrect.cs b/Sanchez.Workflow/Steps/Common/ColourCorrect.cs
@@ -2,7 +2,6 @@
 using JetBrains.Annotations;
 using Sanchez.Processing.Models;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using SixLabors.ImageSharp;
 using SixLabors.ImageSharp.PixelFormats;

diff --git a/Sanchez.Workflow/Steps/Common/CreateActivity.cs b/Sanchez.Workflow/Steps/Common/CreateActivity.cs
@@ -5,7 +5,6 @@
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Processing.Services;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Common/GetSourceFiles.cs b/Sanchez.Workflow/Steps/Common/GetSourceFiles.cs
@@ -1,10 +1,10 @@
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using FluentValidation;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Processing.Services;
-using Sanchez.Shared.Exceptions;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;
@@ -23,11 +23,13 @@ public override ExecutionResult Run(IStepExecutionContext context)
             try
             {
                 var sourceFiles = _fileService.GetSourceFiles();
+                if (!sourceFiles.Any()) throw new ValidationException("No source files found");
+
                 SourceRegistrations = _fileService.ToRegistrations(sourceFiles);
             }
-            catch (DirectoryNotFoundException e)
+            catch (DirectoryNotFoundException)
             {
-                throw new ValidationException("Source directory not found", e);
+                throw new ValidationException("Source directory not found");
             }
 
             return ExecutionResult.Next();

diff --git a/Sanchez.Workflow/Steps/Common/InitialiseProgressBar.cs b/Sanchez.Workflow/Steps/Common/InitialiseProgressBar.cs
@@ -4,7 +4,6 @@
 using Sanchez.Processing.Helpers;
 using Sanchez.Processing.Models;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using ShellProgressBar;
 using WorkflowCore.Interface;

diff --git a/Sanchez.Workflow/Steps/Common/InitialiseSatelliteRegistry.cs b/Sanchez.Workflow/Steps/Common/InitialiseSatelliteRegistry.cs
@@ -1,10 +1,9 @@
 using System;
 using System.Threading.Tasks;
+using FluentValidation;
 using Microsoft.Extensions.Logging;
 using Sanchez.Processing.Services;
-using Sanchez.Shared.Exceptions;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Common/InitialiseUnderlayCache.cs b/Sanchez.Workflow/Steps/Common/InitialiseUnderlayCache.cs
@@ -1,6 +1,5 @@
 using Sanchez.Processing.Services.Underlay;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Common/LoadImageSingle.cs b/Sanchez.Workflow/Steps/Common/LoadImageSingle.cs
@@ -2,7 +2,6 @@
 using Ardalis.GuardClauses;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using WorkflowCore.Interface;

diff --git a/Sanchez.Workflow/Steps/Common/LogCompletion.cs b/Sanchez.Workflow/Steps/Common/LogCompletion.cs
@@ -2,7 +2,6 @@
 using JetBrains.Annotations;
 using Microsoft.Extensions.Logging;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using ShellProgressBar;

diff --git a/Sanchez.Workflow/Steps/Common/NormaliseImage.cs b/Sanchez.Workflow/Steps/Common/NormaliseImage.cs
@@ -3,7 +3,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using WorkflowCore.Interface;

diff --git a/Sanchez.Workflow/Steps/Common/SaveImage.cs b/Sanchez.Workflow/Steps/Common/SaveImage.cs
@@ -5,7 +5,6 @@
 using Sanchez.Processing.Extensions.Images;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;

diff --git a/Sanchez.Workflow/Steps/Common/SetWorkflowRegistration.cs b/Sanchez.Workflow/Steps/Common/SetWorkflowRegistration.cs
@@ -1,6 +1,5 @@
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Common/ShouldWriteSingle.cs b/Sanchez.Workflow/Steps/Common/ShouldWriteSingle.cs
@@ -6,7 +6,6 @@
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Processing.Services;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using ShellProgressBar;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/RegisterImages.cs b/Sanchez.Workflow/Steps/Equirectangular/RegisterImages.cs
@@ -6,7 +6,6 @@
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Processing.Services;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/SetWorkflowActivity.cs b/Sanchez.Workflow/Steps/Equirectangular/SetWorkflowActivity.cs
@@ -1,6 +1,5 @@
 using Sanchez.Processing.Models;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using WorkflowCore.Interface;
 using WorkflowCore.Models;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/CalculateGlobalOffset.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/CalculateGlobalOffset.cs
@@ -2,7 +2,6 @@
 using Ardalis.GuardClauses;
 using Sanchez.Processing.Models;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using WorkflowCore.Interface;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/CalculateVisibleRange.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/CalculateVisibleRange.cs
@@ -3,7 +3,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Services;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using WorkflowCore.Interface;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/CropImage.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/CropImage.cs
@@ -3,7 +3,6 @@
 using Sanchez.Processing.Extensions;
 using Sanchez.Processing.Models;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/GetCropBounds.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/GetCropBounds.cs
@@ -5,7 +5,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/LoadImage.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/LoadImage.cs
@@ -5,7 +5,6 @@
 using Ardalis.GuardClauses;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using ShellProgressBar;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/RenderUnderlay.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/RenderUnderlay.cs
@@ -8,7 +8,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Services.Underlay;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/SaveStitchedImage.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/SaveStitchedImage.cs
@@ -7,7 +7,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using ShellProgressBar;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/ShouldWrite.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/ShouldWrite.cs
@@ -7,7 +7,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Services;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using ShellProgressBar;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/StitchImages.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/StitchImages.cs
@@ -4,7 +4,6 @@
 using Sanchez.Processing.Models;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;

diff --git a/Sanchez.Workflow/Steps/Equirectangular/Stitch/ToEquirectangular.cs b/Sanchez.Workflow/Steps/Equirectangular/Stitch/ToEquirectangular.cs
@@ -7,7 +7,6 @@
 using Sanchez.Processing.Models.Angles;
 using Sanchez.Processing.Models.Projections;
 using Sanchez.Workflow.Extensions;
-using Sanchez.Workflow.Models;
 using Sanchez.Workflow.Models.Data;
 using Sanchez.Workflow.Models.Steps;
 using SixLabors.ImageSharp;