Update nugets and minor refactorings

mark-s · May 5, 2024 · 06783fa · 06783fa
1 parent b115da4
commit 06783fa
Show file tree

Hide file tree

Showing 17 changed files with 116 additions and 99 deletions.
diff --git a/src/QnapBackupDecryptor.Console/Options.cs b/src/QnapBackupDecryptor.Console/Options.cs
@@ -1,34 +1,35 @@
-using CommandLine;
+using System.Diagnostics.CodeAnalysis;
+using CommandLine;
 using CommandLine.Text;
 
 namespace QnapBackupDecryptor.Console;
 
-public class Options
+internal class Options
 {
     [Option('p', "password", Required = false, HelpText = "Password")]
-    public string? Password { get; set; }
+    public string? Password { get; init; }
 
     [Option('e', "encrypted", Required = true, HelpText = "Encrypted file or folder")]
-    public string EncryptedSource { get; set; } = null!;
+    public required  string EncryptedSource { get; init; } = null!;
 
     [Option('d', "decrypted", Required = true, HelpText = "Where to place the decrypted file(s)")]
-    public string OutputDestination { get; set; } = null!;
+    public string OutputDestination { get; init; } = null!;
 
     [Option('s', "subfolders", Required = false, HelpText = "Include Subfolders (default: false)")]
-    public bool IncludeSubfolders { get; set; }
+    public bool IncludeSubfolders { get; init; }
 
     [Option('v', "verbose", Required = false, HelpText = "Set output to verbose")]
-    public bool Verbose { get; set; }
+    public bool Verbose { get; init; }
 
     [Option('o', "overwrite", Required = false, HelpText = "Overwrite file(s) in output (default: false)")]
-    public bool Overwrite { get; set; }
+    public bool Overwrite { get; init; }
 
     [Option('r', "removeencrypted", Required = false, HelpText = "Delete encrypted files when decrypted (default: false)")]
-    public bool RemoveEncrypted { get; set; }
+    public bool RemoveEncrypted { get; init; }
 
 
     [Usage(ApplicationAlias = "QnapBackupDecryptor")]
-    // ReSharper disable once UnusedMember.Global
+    // ReSharper disable once UnusedMember.Global // Used by the console
     public static IEnumerable<Example> Examples
     {
         get

diff --git a/src/QnapBackupDecryptor.Console/Output.cs b/src/QnapBackupDecryptor.Console/Output.cs
@@ -1,12 +1,11 @@
 using QnapBackupDecryptor.Core;
 using Spectre.Console;
-using System.Collections.Concurrent;
 
 namespace QnapBackupDecryptor.Console;
 
-internal class Output
+internal static class Output
 {
-    public static void ShowResults(ConcurrentBag<DecryptResult> decryptResults, ConcurrentBag<DeleteResult> deleteResults, bool verbose, TimeSpan swElapsed)
+    public static void ShowResults(IReadOnlyList<DecryptResult> decryptResults, IReadOnlyList<DeleteResult> deleteResults, bool verbose, TimeSpan swElapsed)
     {
         if (verbose && decryptResults.Count > 1)
         {
@@ -25,7 +24,7 @@ public static void ShowResults(ConcurrentBag<DecryptResult> decryptResults, Conc
             Environment.ExitCode = 1;
     }
 
-    private static void ShowSimpleResults(ConcurrentBag<DecryptResult> decryptResults, ConcurrentBag<DeleteResult> deleteResults)
+    private static void ShowSimpleResults(IReadOnlyList<DecryptResult> decryptResults, IReadOnlyList<DeleteResult> deleteResults)
     {
         var table = new Table();
         table
@@ -46,7 +45,7 @@ private static void ShowSimpleResults(ConcurrentBag<DecryptResult> decryptResult
         AnsiConsole.Write(table);
     }
 
-    private static void ShowFileListResults(ConcurrentBag<DecryptResult> decryptResults, ConcurrentBag<DeleteResult> deleteResults)
+    private static void ShowFileListResults(IReadOnlyList<DecryptResult> decryptResults, IReadOnlyList<DeleteResult> deleteResults)
     {
         var table = new Table();
         table
@@ -98,10 +97,10 @@ private static List<string> DecryptResultToRow(DecryptResult decryptResult)
         return row;
     }
 
-    private static List<string> DeleteResultToRow(DeleteResult deleteResult)
+    private static IEnumerable<string> DeleteResultToRow(DeleteResult? deleteResult)
     {
         if (deleteResult == null)
-            return new List<string>(0);
+            return [];
 
         var colour = deleteResult.DeletedOk ? "green" : "red";
         var status = deleteResult.DeletedOk ? "Deleted" : "Failed";
@@ -131,11 +130,10 @@ private static void ShowTiming(TimeSpan swElapsed)
     }
 
     public static ProgressColumn[] GetProgressColumns()
-        => new ProgressColumn[]
-        {
+        => [
             new TaskDescriptionColumn(),
             new ProgressBarColumn(),
             new PercentageColumn(),
-            new SpinnerColumn(Spinner.Known.SimpleDots),
-        };
+            new SpinnerColumn(Spinner.Known.SimpleDots)
+        ];
 }
diff --git a/src/QnapBackupDecryptor.Console/Program.cs b/src/QnapBackupDecryptor.Console/Program.cs
@@ -27,7 +27,11 @@ private static void Run(Options options)
 
         var decryptJobs = GetDecryptJobs(options);
 
-        DoDecrypt(decryptJobs, options, password, stopwatch);
+        var (decryptResults, deleteResults) = DoDecrypt(decryptJobs, options, password);
+
+        stopwatch.Stop();
+
+        Output.ShowResults(decryptResults, deleteResults, options.Verbose, stopwatch.Elapsed);
     }
 
     private static IReadOnlyList<FileJob> GetDecryptJobs(Options options)
@@ -41,18 +45,23 @@ private static IReadOnlyList<FileJob> GetDecryptJobs(Options options)
                 statusContext.Spinner(Spinner.Known.SimpleDots);
                 statusContext.SpinnerStyle(Style.Parse("green"));
 
-                decryptJobs = JobMaker.GetDecryptJobs(options.EncryptedSource, options.OutputDestination, options.Overwrite, options.IncludeSubfolders);
+                decryptJobs.AddRange(
+                    JobMaker.GetDecryptJobs(
+                        encryptedSource: options.EncryptedSource,
+                        decryptedTarget: options.OutputDestination,
+                        overwrite: options.Overwrite,
+                        includeSubFolders: options.IncludeSubfolders)
+                    );
             });
 
         return decryptJobs;
     }
 
-    private static void DoDecrypt(IReadOnlyList<FileJob> decryptJobs, Options options, byte[] password, Stopwatch sw)
+    private static (IReadOnlyList<DecryptResult> DecryptResults, IReadOnlyList<DeleteResult> DeleteResults) DoDecrypt(IReadOnlyCollection<FileJob> decryptJobs, Options options, byte[] password)
     {
         var decryptResults = new ConcurrentBag<DecryptResult>();
         var deleteResults = new ConcurrentBag<DeleteResult>();
 
-
         AnsiConsole.Progress()
             .Columns(Output.GetProgressColumns())
             .AutoClear(true)
@@ -61,13 +70,12 @@ private static void DoDecrypt(IReadOnlyList<FileJob> decryptJobs, Options option
                 var progressTask = progressContext.AddTask("[green]Decrypting Files[/]");
                 progressTask.MaxValue = decryptJobs.Count;
 
-                Parallel.ForEach(decryptJobs, currentJob => DecryptSingleJob(options, password, currentJob, decryptResults, deleteResults, progressTask));
-
+                Parallel.ForEach(
+                    decryptJobs, 
+                    currentJob => DecryptSingleJob(options, password, currentJob, decryptResults, deleteResults, progressTask));
             });
 
-        sw.Stop();
-
-        Output.ShowResults(decryptResults, deleteResults, options.Verbose, sw.Elapsed);
+        return (decryptResults.ToList(), deleteResults.ToList());
 
     }
 

diff --git a/src/QnapBackupDecryptor.Console/Prompts.cs b/src/QnapBackupDecryptor.Console/Prompts.cs
@@ -3,7 +3,7 @@
 
 namespace QnapBackupDecryptor.Console;
 
-internal class Prompts
+internal static class Prompts
 {
     public static byte[] GetPassword(Options opts)
     {

diff --git a/src/QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj b/src/QnapBackupDecryptor.Console/QnapBackupDecryptor.Console.csproj
@@ -5,11 +5,12 @@
 	  <TargetFramework>net6.0</TargetFramework>
 	  <Nullable>enable</Nullable>
 	  <ImplicitUsings>enable</ImplicitUsings>
+	  <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
 
   <ItemGroup>
     <PackageReference Include="CommandLineParser" Version="2.9.1" />
-    <PackageReference Include="Spectre.Console" Version="0.44.0" />
+    <PackageReference Include="Spectre.Console" Version="0.49.1" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/QnapBackupDecryptor.Core.Tests/DecryptorTests.cs b/src/QnapBackupDecryptor.Core.Tests/DecryptorTests.cs
@@ -1,13 +1,11 @@
-using NUnit.Framework;
-using Shouldly;
-using System.Text;
+using System.Text;
 
 namespace QnapBackupDecryptor.Core.Tests;
 
 [TestFixture]
 public class DecryptorTests
 {
-    private const string PASSWORD = "wisLUBIMyBNcnvo3eDMS";
+    private const string TEST_PASSWORD = "wisLUBIMyBNcnvo3eDMS";
 
     [Test]
     public void OpenSSLDecrypt_ValidPassword_OkResult()
@@ -17,7 +15,7 @@ public void OpenSSLDecrypt_ValidPassword_OkResult()
         var outputFile = new FileInfo("decrypted.txt");
 
         // Act 
-        var passwordBytes = Encoding.UTF8.GetBytes(PASSWORD);
+        var passwordBytes = Encoding.UTF8.GetBytes(TEST_PASSWORD);
         var sslDecrypt = OpenSsl.Decrypt(encryptedFile, passwordBytes, outputFile);
 
         // Assert
@@ -33,7 +31,7 @@ public void OpenSSLDecrypt_Text()
         var outputFile = new FileInfo("decrypted.txt");
 
         // Act 
-        var passwordBytes = Encoding.UTF8.GetBytes(PASSWORD);
+        var passwordBytes = Encoding.UTF8.GetBytes(TEST_PASSWORD);
         var sslDecrypt = OpenSsl.Decrypt(encryptedFile, passwordBytes, outputFile);
 
         // Assert
@@ -43,20 +41,20 @@ public void OpenSSLDecrypt_Text()
         decryptedText[1].ShouldStartWith("line2: End!");
     }
 
-    [Test]
-    public void OpenSSLDecrypt_Binary()
-    {
-        // Arrange
-        var encryptedFile = new FileInfo(Path.Combine("TestFiles", "encrypted.jpg"));
-        var decryptedFile = new FileInfo(Path.Combine("TestFiles", "decrypted.jpg"));
-
-        // Act 
-        var passwordBytes = Encoding.UTF8.GetBytes(PASSWORD);
-        var decrypted = OpenSsl.Decrypt(encryptedFile, passwordBytes, decryptedFile);
-
-        // Assert
-        //var decryptedText = File.ReadAllText(decrpyted.FullName);
-        //decryptedText.ShouldBe("line1: this is a plaintext file\r\nline2: End!\r\n");
-    }
+    //[Test]
+    //public void OpenSSLDecrypt_Binary()
+    //{
+    //    // Arrange
+    //    var encryptedFile = new FileInfo(Path.Combine("TestFiles", "encrypted.jpg"));
+    //    var decryptedFile = new FileInfo(Path.Combine("TestFiles", "decrypted.jpg"));
+
+    //    // Act 
+    //    var passwordBytes = Encoding.UTF8.GetBytes(TEST_PASSWORD);
+    //    var decrypted = OpenSsl.Decrypt(encryptedFile, passwordBytes, decryptedFile);
+
+    //    // Assert
+    //    var decryptedText = File.ReadAllText(decrypted.Data.Name);
+    //    decryptedText.ShouldBe("line1: this is a plaintext file\r\nline2: End!\r\n");
+    //}
 
 }
diff --git a/src/QnapBackupDecryptor.Core.Tests/FileHelpersTests.cs b/src/QnapBackupDecryptor.Core.Tests/FileHelpersTests.cs
@@ -1,7 +1,4 @@
-using NUnit.Framework;
-using Shouldly;
-
-namespace QnapBackupDecryptor.Core.Tests;
+namespace QnapBackupDecryptor.Core.Tests;
 
 [TestFixture]
 public class FileHelpersTests

diff --git a/src/QnapBackupDecryptor.Core.Tests/JobMakerTests.cs b/src/QnapBackupDecryptor.Core.Tests/JobMakerTests.cs
@@ -1,7 +1,4 @@
-using NUnit.Framework;
-using Shouldly;
-
-namespace QnapBackupDecryptor.Core.Tests;
+namespace QnapBackupDecryptor.Core.Tests;
 
 [TestFixture]
 public class JobMakerTests

diff --git a/src/QnapBackupDecryptor.Core.Tests/QnapBackupDecryptor.Core.Tests.csproj b/src/QnapBackupDecryptor.Core.Tests/QnapBackupDecryptor.Core.Tests.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
 	<PropertyGroup>
 		<TargetFramework>net6.0</TargetFramework>
@@ -26,15 +26,22 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="JunitXml.TestLogger" Version="3.0.114" />
-		<PackageReference Include="NUnit" Version="3.13.3" />
-		<PackageReference Include="NUnit3TestAdapter" Version="4.2.1" />
-		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.0" />
-		<PackageReference Include="Shouldly" Version="4.1.0" />
+		<PackageReference Include="JunitXml.TestLogger" Version="3.1.12" />
+		<PackageReference Include="NUnit" Version="4.1.0" />
+		<PackageReference Include="NUnit3TestAdapter" Version="4.5.0" />
+		<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.9.0" />
+		<PackageReference Include="Shouldly" Version="4.2.1" />
 	</ItemGroup>
 
 	<ItemGroup>
 		<ProjectReference Include="..\QnapBackupDecryptor.Core\QnapBackupDecryptor.Core.csproj" />
 	</ItemGroup>
 
+	<ItemGroup>
+		<Using Include="NUnit" />
+		<Using Include="Shouldly" />
+		<Using Include="NUnit.Framework" />
+	</ItemGroup>
+
+
 </Project>
diff --git a/src/QnapBackupDecryptor.Core/DecryptResult.cs b/src/QnapBackupDecryptor.Core/DecryptResult.cs
@@ -1,3 +1,3 @@
 namespace QnapBackupDecryptor.Core;
 
-public record DecryptResult(FileSystemInfo Source, FileSystemInfo Dest, bool Success, string ErrorMessage);
+public sealed record DecryptResult(FileSystemInfo Source, FileSystemInfo Dest, bool Success, string ErrorMessage);
diff --git a/src/QnapBackupDecryptor.Core/DeleteResult.cs b/src/QnapBackupDecryptor.Core/DeleteResult.cs
@@ -1,3 +1,3 @@
 namespace QnapBackupDecryptor.Core;
 
-public record DeleteResult(FileSystemInfo ToDelete, bool DeletedOk, string ErrorMessage);
+public sealed record DeleteResult(FileSystemInfo ToDelete, bool DeletedOk, string ErrorMessage);
diff --git a/src/QnapBackupDecryptor.Core/FileInfoExtensions.cs b/src/QnapBackupDecryptor.Core/FileInfoExtensions.cs
@@ -1,8 +1,8 @@
 namespace QnapBackupDecryptor.Core;
 
-public static class FileInfoExtensions
+internal static class FileInfoExtensions
 {
-    public static bool TryDelete(this FileInfo fileInfo)
+    internal static bool TryDelete(this FileInfo fileInfo)
     {
         try
         {

diff --git a/src/QnapBackupDecryptor.Core/FileJob.cs b/src/QnapBackupDecryptor.Core/FileJob.cs
@@ -1,10 +1,3 @@
 namespace QnapBackupDecryptor.Core;
 
-public record FileJob(FileSystemInfo EncryptedFile, FileSystemInfo OutputFile, bool IsValid, string ErrorMessage);
-
-public static class FileJobExtensions
-{
-
-    public static List<FileJob> ToList(this FileJob job)
-        => new() { job };
-}
+public sealed record FileJob(FileSystemInfo EncryptedFile, FileSystemInfo OutputFile, bool IsValid, string ErrorMessage);
diff --git a/src/QnapBackupDecryptor.Core/FileJobExtensions.cs b/src/QnapBackupDecryptor.Core/FileJobExtensions.cs
@@ -0,0 +1,7 @@
+namespace QnapBackupDecryptor.Core;
+
+internal static class FileJobExtensions
+{
+    internal static List<FileJob> ToList(this FileJob job)
+        => [job];
+}
diff --git a/src/QnapBackupDecryptor.Core/JobMaker.cs b/src/QnapBackupDecryptor.Core/JobMaker.cs
@@ -43,13 +43,13 @@ private static FileJob GetFileToFileJob(FileInfo encrytedFile, FileInfo outputFi
         return new FileJob(encrytedFile, outputFile, true, string.Empty);
     }
 
-    private static FileJob GetFileToFolderJob(FileInfo encrytedFile, DirectoryInfo outputFolder, bool overwrite)
+    private static FileJob GetFileToFolderJob(FileInfo encrytedFile, FileSystemInfo outputFolder, bool overwrite)
     {
         var outputFile = new FileInfo(Path.Combine(outputFolder.FullName, encrytedFile.Name));
         return GetFileToFileJob(encrytedFile, outputFile, overwrite);
     }
 
-    private static List<FileJob> GetFolderToFolderJobs(DirectoryInfo encrytedFolder, DirectoryInfo outputFolder, bool overwrite, bool includeSubfolders)
+    private static List<FileJob> GetFolderToFolderJobs(DirectoryInfo encrytedFolder, FileSystemInfo outputFolder, bool overwrite, bool includeSubfolders)
     {
         if (encrytedFolder.Exists == false)
             return new FileJob(encrytedFolder, outputFolder, false, "Encrypted folder doesn't exist").ToList();