Add logging (#3)

adamgate · web-flow · commit ba4d4e1e8dcc · 2025-11-26T20:00:58.000-07:00
* update publish settings

* add serilog logging

* fix unit tests to work with logging

* codemaid cleanup via VS2022
diff --git a/MediaSorter/App.cs b/MediaSorter/App.cs
@@ -1,6 +1,7 @@
 ﻿using MediaSorter.Models;
 using MediaSorter.Services.Interfaces;
 using MediaSorter.Utils;
+using Microsoft.Extensions.Logging;
 using System.Reflection;
 using System.Text;
 
@@ -14,6 +15,7 @@ public class App
         private readonly IDateParser _dateParser;
         private readonly IDirectoryProvider _directoryProvider;
         private readonly IFileSorter _fileSorter;
+        private readonly ILogger<App> _logger;
         private readonly IMediaScanner _mediaScanner;
         private readonly IMetadataProvider _metadataProvider;
         private readonly string _version = Assembly.GetExecutingAssembly()?.GetName()?.Version?.ToString() ?? "X.X.X.X";
@@ -22,12 +24,14 @@ public App(
             IDateParser dateParser,
             IDirectoryProvider directoryProvider,
             IFileSorter fileSorter,
+            ILogger<App> logger,
             IMediaScanner mediaScanner,
             IMetadataProvider metadataProvider)
         {
             _dateParser = dateParser;
             _directoryProvider = directoryProvider;
             _fileSorter = fileSorter;
+            _logger = logger;
             _metadataProvider = metadataProvider;
             _mediaScanner = mediaScanner;
         }
@@ -58,9 +62,11 @@ public void Run(string[] args)
 
                 var mediaWithDatesTaken = ParseMediaDatesTaken(mediaWithMetadata);
                 SortMediaFiles(outputDirectory, mediaWithDatesTaken);
+                _logger.LogDebug("Done sorting {count} files.", mediaWithDatesTaken.Count());
             }
             catch (Exception ex)
             {
+                _logger.LogError(ex.ToString());
                 CliUtils.DisplayMessageWithColor($"An error occurred: {ex.Message}", ConsoleColor.Red);
                 CliUtils.DisplayMessageAndExit("Exiting...", ConsoleColor.Red, 1);
             }
@@ -72,7 +78,9 @@ private IEnumerable<string> GetMediaPaths(string sourceDirectory)
             var mediaPaths = _mediaScanner.GetMediaInPath(sourceDirectory);
             if (!mediaPaths.Any())
                 CliUtils.DisplayMessageAndExit("No media files were found. Exiting...", ConsoleColor.Yellow, 0);
+
             Console.WriteLine("Found {0} media files.", mediaPaths.Count());
+            _logger.LogDebug("Found {count} media file(s) to sort.", mediaPaths.Count());
 
             return mediaPaths;
         }
@@ -83,6 +91,8 @@ private string GetOutputDirectory()
             if (outputDirectory is null)
                 CliUtils.DisplayMessageAndExit("Exiting...", ConsoleColor.Yellow, 0);
 
+            _logger.LogDebug("Output Directory: \"{directory}\"", outputDirectory);
+
             return outputDirectory;
         }
 
@@ -92,6 +102,8 @@ private string GetSourceDirectory()
             if (sourceDirectory is null)
                 CliUtils.DisplayMessageAndExit("Exiting...", ConsoleColor.Yellow, 0);
 
+            _logger.LogDebug("Source Directory: \"{directory}\"", sourceDirectory);
+
             return sourceDirectory;
         }
 
diff --git a/MediaSorter/Constants/MetadataConstants.cs b/MediaSorter/Constants/MetadataConstants.cs
@@ -3,17 +3,16 @@
     public static class MetadataConstants
     {
         public const string EXIF = "EXIF";
-        public const string File = "File";
-        public const string GPS = "GPS";
-        public const string ICC = "ICC";
-        public const string IPTC = "IPTC";
-        public const string QuickTime = "QuickTime";
-
         public const string ExifDateFormat = "yyyy:MM:dd HH:mm:ss";
+        public const string File = "File";
         public const string FileDateFormat = "ddd MMM dd HH:mm:ss zzz yyyy";
+        public const string GPS = "GPS";
         public const string GpsDateFormat = "yyyy:MM:dd";
+        public const string ICC = "ICC";
         public const string IccDateFormat = "yyyy:MM:dd HH:mm:ss";
+        public const string IPTC = "IPTC";
         public const string IptcDateFormat = "MM/dd/yyyy";
+        public const string QuickTime = "QuickTime";
         public const string QuickTimeDateFormat = "ddd MMM dd HH:mm:ss yyyy";
     }
 }
diff --git a/MediaSorter/MediaSorter.csproj b/MediaSorter/MediaSorter.csproj
@@ -5,11 +5,28 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <PublishTrimmed>True</PublishTrimmed>
+    <SignAssembly>False</SignAssembly>
+    <Description>A simple app that sorts images and videos into folders based on the date they were taken.</Description>
+    <PackageProjectUrl>https://github.com/adamgate/MediaSorter</PackageProjectUrl>
+    <AssemblyVersion>1.1.0</AssemblyVersion>
+    <FileVersion>1.1.0</FileVersion>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DebugType>none</DebugType>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <DebugType>none</DebugType>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="MetadataExtractor" Version="2.9.0" />
     <PackageReference Include="Microsoft.Extensions.Hosting" Version="10.0.0-rc.2.25502.107" />
+    <PackageReference Include="Serilog" Version="4.3.0" />
+    <PackageReference Include="Serilog.Extensions.Logging" Version="10.0.0" />
+    <PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
     <PackageReference Include="System.Collections" Version="4.3.0" />
   </ItemGroup>
 
diff --git a/MediaSorter/Program.cs b/MediaSorter/Program.cs
@@ -2,6 +2,7 @@
 using MediaSorter.Services.Interfaces;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
+using Serilog;
 
 namespace MediaSorter
 {
@@ -14,6 +15,16 @@ private static void Main(string[] args)
         {
             var builder = Host.CreateApplicationBuilder(args);
 
+            builder.Services.AddLogging(builder =>
+            {
+                var logger = new LoggerConfiguration()
+                .MinimumLevel.Debug()
+                .WriteTo.File("log.txt")
+                .CreateLogger();
+
+                builder.AddSerilog(logger); // register serilog as a logging provider
+            });
+
             builder.Services.AddScoped<IDateParser, DateParser>();
             builder.Services.AddScoped<IDirectoryProvider, CliDirectoryProvider>();
             builder.Services.AddScoped<IFileSorter, FileSorter>();
@@ -23,6 +34,7 @@ private static void Main(string[] args)
             builder.Services.AddTransient<App>();
 
             var app = builder.Build();
+
             app.Services.GetRequiredService<App>().Run(args);
         }
     }
diff --git a/MediaSorter/Services/Implementations/DateParser.cs b/MediaSorter/Services/Implementations/DateParser.cs
@@ -1,12 +1,28 @@
 ﻿using MediaSorter.Constants;
 using MediaSorter.Models;
 using MediaSorter.Services.Interfaces;
+using Microsoft.Extensions.Logging;
 using System.Globalization;
 
 namespace MediaSorter.Services.Implementations
 {
+    /// <summary>
+    /// Parses date metadata into DateTime.
+    /// </summary>
     public class DateParser : IDateParser
     {
+        private readonly ILogger<DateParser> _logger;
+
+        public DateParser(ILogger<DateParser> logger)
+        {
+            _logger = logger;
+        }
+
+        /// <summary>
+        /// Attempts to parse the raw metadata date strings into <see cref="DateTime"/> and selects the most accurate date for each media path.
+        /// </summary>
+        /// <param name="mediaPathsWithMetadata"></param>
+        /// <returns></returns>
         public IDictionary<string, DateMetadata> Parse(IDictionary<string, IEnumerable<RawMetadata>> mediaPathsWithMetadata)
         {
             var mediaWithDateMetadata = new Dictionary<string, DateMetadata>();
@@ -16,11 +32,15 @@ public IDictionary<string, DateMetadata> Parse(IDictionary<string, IEnumerable<R
                 if (!media.Value.Any())
                 {
                     mediaWithDateMetadata.Add(media.Key, new DateMetadata("", "", "", DateTime.MinValue, 0));
+                    _logger.LogDebug("No date metadata found for \"{mediaPath}\"", media.Key);
                     continue;
                 }
 
                 var parsedDates = media.Value.Select(x => Parse(x)).ToList();
+                _logger.LogDebug("Media Path: \"{mediaPath}\" | {parsedDates}", media.Key, string.Join(",", parsedDates));
+
                 var mostAccurateDate = SelectMostAccurateDate(parsedDates);
+                _logger.LogDebug("Most accurate date selected for {mediaPath}: {mostAccurateDate}", media.Key, mostAccurateDate);
 
                 mediaWithDateMetadata.Add(media.Key, mostAccurateDate);
             }
diff --git a/MediaSorter/Services/Implementations/FileSorter.cs b/MediaSorter/Services/Implementations/FileSorter.cs
@@ -1,7 +1,7 @@
 ﻿using MediaSorter.Models;
 using MediaSorter.Services.Interfaces;
 using MediaSorter.Utils;
-using System.Text;
+using Microsoft.Extensions.Logging;
 
 namespace MediaSorter.Services.Implementations
 {
@@ -10,6 +10,13 @@ namespace MediaSorter.Services.Implementations
     /// </summary>
     public class FileSorter : IFileSorter
     {
+        private readonly ILogger<FileSorter> _logger;
+
+        public FileSorter(ILogger<FileSorter> logger)
+        {
+            _logger = logger;
+        }
+
         /// <summary>
         ///  Attempts to sort media files by their taken date if possible, otherwise by their original name.
         /// </summary>
@@ -27,12 +34,11 @@ public void SortMediaFilesByDate(string writePath, IDictionary<string, DateMetad
                 else
                     SaveMediaWithDate(writePath, media.Key, media.Value.DateTaken);
 
-                // TODO - log this so the class is decoupled from CLI 
                 CliUtils.DisplayMessageWithColor($"Sorted {Path.GetFileName(media.Key)}", ConsoleColor.Gray);
             }
         }
 
-        private static void SaveMediaWithDate(string baseWritePath, string mediaFile, DateTime dateTaken)
+        private void SaveMediaWithDate(string baseWritePath, string mediaFile, DateTime dateTaken)
         {
             var newFileName = dateTaken.Date.ToString("yyyyMMdd") + "_" + Path.GetFileName(mediaFile);
             var yearTaken = dateTaken.Date.ToString("yyyy");
@@ -42,11 +48,13 @@ private static void SaveMediaWithDate(string baseWritePath, string mediaFile, Da
             FileUtils.CreateDirectoryIfDoesntExist(outputDirectory);
 
             var destinationFilePath = Path.Join(outputDirectory, newFileName);
+            _logger.LogDebug("Attempting to save \"{file}\" to \"{destination}\"", mediaFile, destinationFilePath);
             FileUtils.CopyFile(mediaFile, destinationFilePath);
         }
 
-        private static void SaveMediaWithUnknownDate(string baseWriteFilePath, string mediaFile, string newFileName)
+        private void SaveMediaWithUnknownDate(string baseWriteFilePath, string mediaFile, string newFileName)
         {
+            _logger.LogDebug("Couldn't determine date taken for {file}. Saving to \"unkown\" folder", mediaFile);
             var destinationFile = Path.GetFileName(mediaFile);
             var destinationFilePath = Path.Join(baseWriteFilePath, destinationFile);
 
diff --git a/MediaSorter/Services/Implementations/MetadataProvider.cs b/MediaSorter/Services/Implementations/MetadataProvider.cs
@@ -2,7 +2,7 @@
 using MediaSorter.Services.Interfaces;
 using MediaSorter.Utils;
 using MetadataExtractor;
-using static System.Runtime.InteropServices.JavaScript.JSType;
+using Microsoft.Extensions.Logging;
 
 namespace MediaSorter.Services.Implementations
 {
@@ -11,6 +11,13 @@ namespace MediaSorter.Services.Implementations
     /// </summary>
     public class MetadataProvider : IMetadataProvider
     {
+        private readonly ILogger<MetadataProvider> _logger;
+
+        public MetadataProvider(ILogger<MetadataProvider> logger)
+        {
+            _logger = logger;
+        }
+
         /// <summary>
         /// Extacts the date taken metadata from the provided media.
         /// </summary>
@@ -23,6 +30,7 @@ public IDictionary<string, IEnumerable<RawMetadata>> EvaluateMediaMetadata(IEnum
             foreach (var mediaItem in mediaPaths)
             {
                 var rawMetadata = ImageMetadataReader.ReadMetadata(mediaItem);
+                _logger.LogDebug("Raw metadata for \"{media}\" : {rawMetadata}", mediaItem, @rawMetadata);
 
                 var mediaItemDateMetadata = new List<RawMetadata>();
                 foreach (var directory in rawMetadata)
diff --git a/MediaSorterTests/Services/DateParserTests.cs b/MediaSorterTests/Services/DateParserTests.cs
@@ -1,5 +1,7 @@
 ﻿using MediaSorter.Models;
 using MediaSorter.Services.Implementations;
+using Microsoft.Extensions.Logging;
+using Moq;
 using System.Diagnostics.CodeAnalysis;
 
 namespace MediaSorterTests.Services
@@ -8,21 +10,8 @@ namespace MediaSorterTests.Services
     [ExcludeFromCodeCoverage]
     public class DateParserTests
     {
-        private DateParser _sut = new();
-
-        [TestMethod]
-        public void Parse_NoMetadata_ReturnsDefault()
-        {
-            // Arrange 
-            var rawMetadataCollection = new List<RawMetadata>();
-            var input = new Dictionary<string, IEnumerable<RawMetadata>> { { "test", rawMetadataCollection } };
-
-            // Act
-            var result = _sut.Parse(input);
-
-            // Assert
-            Assert.AreEqual(DateTime.MinValue, result.First().Value.DateTaken);
-        }
+        private Mock<ILogger<DateParser>> _logger;
+        private DateParser _sut;
 
         private static IEnumerable<object[]> ParseMetadataTypeData
         {
@@ -45,15 +34,36 @@ private static IEnumerable<object[]> ParseMetadataTypeData
         [DynamicData(nameof(ParseMetadataTypeData))]
         public void Parse_MetadataType_ReturnsExpected(RawMetadata rawMetadata, DateTime expectedDate)
         {
-            // Arrange 
+            // Arrange
             var rawMetadataCollection = new List<RawMetadata>() { rawMetadata };
-            var input = new Dictionary<string, IEnumerable<RawMetadata>> { { "test",  rawMetadataCollection } };
+            var input = new Dictionary<string, IEnumerable<RawMetadata>> { { "test", rawMetadataCollection } };
 
             // Act
             var result = _sut.Parse(input);
 
             // Assert
             Assert.AreEqual(expectedDate, result.First().Value.DateTaken, rawMetadata.Directory);
         }
+
+        [TestMethod]
+        public void Parse_NoMetadata_ReturnsDefault()
+        {
+            // Arrange
+            var rawMetadataCollection = new List<RawMetadata>();
+            var input = new Dictionary<string, IEnumerable<RawMetadata>> { { "test", rawMetadataCollection } };
+
+            // Act
+            var result = _sut.Parse(input);
+
+            // Assert
+            Assert.AreEqual(DateTime.MinValue, result.First().Value.DateTaken);
+        }
+
+        [TestInitialize]
+        public void Setup()
+        {
+            _logger = new();
+            _sut = new(_logger.Object);
+        }
     }
-}
+}
diff --git a/MediaSorterTests/Utils/CliUtilsTests.cs b/MediaSorterTests/Utils/CliUtilsTests.cs
@@ -4,7 +4,7 @@
 namespace MediaSorterTests.Utils
 {
     [TestClass]
-    [ExcludeFromCodeCoverage] 
+    [ExcludeFromCodeCoverage]
     public class CliUtilsTests
     {
         private const string _displayMessage = "Display Message";

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`namespace MediaSorterTests.Utils`
`5`	`5`	`{`
`6`	`6`	`[TestClass]`
`7`		`- [ExcludeFromCodeCoverage]`
	`7`	`+ [ExcludeFromCodeCoverage]`
`8`	`8`	`public class CliUtilsTests`
`9`	`9`	`{`
`10`	`10`	`private const string _displayMessage = "Display Message";`