Adding functionality to UnzipTask to check the expected MD5

Author: StanleyGoldman

src/GitHub.Api/IO/IFileSystem.cs

@@ -44,6 +44,5 @@ public interface IFileSystem
         char DirectorySeparatorChar { get; }
         bool ExistingPathIsDirectory(string path);
         void SetCurrentDirectory(string currentDirectory);
-        byte[] ReadAllBytes(string path);
     }
 }

src/GitHub.Api/Installer/UnzipTask.cs

@@ -7,24 +7,27 @@ namespace GitHub.Unity
     class UnzipTask: TaskBase
     {
         private readonly string archiveFilePath;
-        private readonly string extractedPath;
+        private readonly NPath extractedPath;
         private readonly IZipHelper zipHelper;
+        private readonly IFileSystem fileSystem;
+        private readonly string expectedMD5;
         private readonly IProgress<float> zipFileProgress;
         private readonly IProgress<long> estimatedDurationProgress;
 
-        public UnzipTask(CancellationToken token, string archiveFilePath, string extractedPath,
-            IProgress<float> zipFileProgress = null, IProgress<long> estimatedDurationProgress = null) :
-            this(token, archiveFilePath, extractedPath, ZipHelper.Instance, zipFileProgress, estimatedDurationProgress)
+        public UnzipTask(CancellationToken token, string archiveFilePath, NPath extractedPath, IFileSystem fileSystem, string expectedMD5 = null, IProgress<float> zipFileProgress = null, IProgress<long> estimatedDurationProgress = null) :
+            this(token, archiveFilePath, extractedPath, ZipHelper.Instance, fileSystem, expectedMD5, zipFileProgress, estimatedDurationProgress)
         {
 
         }
 
-        public UnzipTask(CancellationToken token, string archiveFilePath, string extractedPath, IZipHelper zipHelper, IProgress<float> zipFileProgress = null, IProgress<long> estimatedDurationProgress = null)
+        public UnzipTask(CancellationToken token, string archiveFilePath, NPath extractedPath, IZipHelper zipHelper, IFileSystem fileSystem, string expectedMD5 = null, IProgress<float> zipFileProgress = null, IProgress<long> estimatedDurationProgress = null)
             : base(token)
         {
             this.archiveFilePath = archiveFilePath;
             this.extractedPath = extractedPath;
             this.zipHelper = zipHelper;
+            this.fileSystem = fileSystem;
+            this.expectedMD5 = expectedMD5;
             this.zipFileProgress = zipFileProgress;
             this.estimatedDurationProgress = estimatedDurationProgress;
         }
@@ -33,16 +36,43 @@ protected override void Run(bool success)
         {
             base.Run(success);
 
-            UnzipArchive();
-        }
-
-        private void UnzipArchive()
-        {
             Logger.Trace("Unzip File: {0} to Path: {1}", archiveFilePath, extractedPath);
 
-            zipHelper.Extract(archiveFilePath, extractedPath, Token, zipFileProgress, estimatedDurationProgress);
+            try
+            {
+                zipHelper.Extract(archiveFilePath, extractedPath, Token, zipFileProgress, estimatedDurationProgress);
+            }
+            catch (Exception ex)
+            {
+                var message = "Error Unzipping file";
+
+                Logger.Error(ex, message);
+                throw new UnzipTaskException(message);
+            }
+
+            if (expectedMD5 != null)
+            {
+                var calculatedMD5 = fileSystem.CalculateFolderMD5(extractedPath);
+                if (!calculatedMD5.Equals(expectedMD5, StringComparison.InvariantCultureIgnoreCase))
+                {
+                    extractedPath.DeleteIfExists();
+
+                    var message = $"Extracted MD5: {calculatedMD5} Does not match expected: {expectedMD5}";
+                    Logger.Error(message);
+
+                    throw new UnzipTaskException(message);
+                }
+            }
 
             Logger.Trace("Completed Unzip");
         }
     }
+
+    public class UnzipTaskException : Exception {
+        public UnzipTaskException(string message) : base(message)
+        { }
+
+        public UnzipTaskException(string message, Exception innerException) : base(message, innerException)
+        { }
+    }
 }

src/GitHub.Api/Tasks/DownloadTask.cs

@@ -130,7 +130,7 @@ protected override void Run(bool success)
                     result = Download();
                     if (result && ValidationHash != null)
                     {
-                        var md5 = fileSystem.CalculateMD5(Destination);
+                        var md5 = fileSystem.CalculateFileMD5(Destination);
                         result = md5.Equals(ValidationHash, StringComparison.CurrentCultureIgnoreCase);
 
                         if (!result)

src/tests/IntegrationTests/Download/DownloadTaskTests.cs

@@ -31,7 +31,7 @@ public async Task TestDownloadTask()
             var downloadPathBytes = fileSystem.ReadAllBytes(downloadPath);
             Logger.Trace("File size {0} bytes", downloadPathBytes.Length);
 
-            var md5Sum = fileSystem.CalculateMD5(downloadPath);
+            var md5Sum = fileSystem.CalculateFileMD5(downloadPath);
             md5Sum.Should().Be(TestDownloadMD5.ToUpperInvariant());
 
             var random = new Random();
@@ -48,7 +48,7 @@ public async Task TestDownloadTask()
             var downloadHalfPathBytes = fileSystem.ReadAllBytes(downloadHalfPath);
             Logger.Trace("File size {0} Bytes", downloadHalfPathBytes.Length);
 
-            md5Sum = fileSystem.CalculateMD5(downloadPath);
+            md5Sum = fileSystem.CalculateFileMD5(downloadPath);
             md5Sum.Should().Be(TestDownloadMD5.ToUpperInvariant());
         }
 

src/tests/IntegrationTests/SetUpFixture.cs

@@ -14,7 +14,7 @@ public void Setup()
 
             Logging.LogAdapter = new MultipleLogAdapter(
                 new FileLogAdapter($"..\\{DateTime.UtcNow.ToString("yyyyMMddHHmmss")}-integration-tests.log")
-                //, new ConsoleLogAdapter()
+                , new ConsoleLogAdapter()
             );
         }
     }

src/tests/IntegrationTests/UnzipTaskTests.cs

@@ -1,5 +1,7 @@
+using System;
 using System.Threading;
 using System.Threading.Tasks;
+using FluentAssertions;
 using GitHub.Unity;
 using Microsoft.Win32.SafeHandles;
 using NSubstitute;
@@ -11,8 +13,10 @@ namespace IntegrationTests
     [TestFixture]
     class UnzipTaskTests : BaseTaskManagerTest
     {
+        private const string GitZipMD5 = "e6cfc0c294a2312042f27f893dfc9c0a";
+
         [Test]
-        public void UnzipTest()
+        public void TaskSucceeds()
         {
             InitializeTaskManager();
 
@@ -22,14 +26,11 @@ public void UnzipTest()
             var destinationPath = TestBasePath.Combine("git_zip").CreateDirectory();
             var archiveFilePath = AssemblyResources.ToFile(ResourceType.Platform, "git.zip", destinationPath, Environment);
 
-            Logger.Trace("ArchiveFilePath: {0}", archiveFilePath);
-            Logger.Trace("TestBasePath: {0}", TestBasePath);
-
             var extractedPath = TestBasePath.Combine("git_zip_extracted").CreateDirectory();
 
             var zipProgress = 0;
             Logger.Trace("Pct Complete {0}%", zipProgress);
-            var unzipTask = new UnzipTask(CancellationToken.None, archiveFilePath, extractedPath, 
+            var unzipTask = new UnzipTask(CancellationToken.None, archiveFilePath, extractedPath, Environment.FileSystem, GitZipMD5, 
                 new Progress<float>(zipFileProgress => {
                     var zipFileProgressInteger = (int) (zipFileProgress * 100);
                     if (zipProgress != zipFileProgressInteger)
@@ -40,6 +41,39 @@ public void UnzipTest()
                 }));
 
             unzipTask.Start().Wait();
+
+            extractedPath.DirectoryExists().Should().BeTrue();
+        }
+
+        [Test]
+        public void TaskFailsWhenMD5Incorect()
+        {
+            InitializeTaskManager();
+
+            var cacheContainer = Substitute.For<ICacheContainer>();
+            Environment = new IntegrationTestEnvironment(cacheContainer, TestBasePath, SolutionDirectory);
+
+            var destinationPath = TestBasePath.Combine("git_zip").CreateDirectory();
+            var archiveFilePath = AssemblyResources.ToFile(ResourceType.Platform, "git.zip", destinationPath, Environment);
+
+            var extractedPath = TestBasePath.Combine("git_zip_extracted").CreateDirectory();
+
+
+            var failed = false;
+            Exception exception = null;
+
+            var unzipTask = new UnzipTask(CancellationToken.None, archiveFilePath, extractedPath, Environment.FileSystem, "AABBCCDD")
+                .Finally((b, ex) => {
+                    failed = true;
+                    exception = ex;
+                });
+
+            unzipTask.Start().Wait();
+
+            extractedPath.DirectoryExists().Should().BeFalse();
+            failed.Should().BeTrue();
+            exception.Should().NotBeNull();
+            exception.Should().BeOfType<UnzipTaskException>();
         }
     }
 }