Fix archive scanner and implement tests

microsoft · Oct 27, 2024 · ed21c90 · ed21c90
1 parent 104864f
commit ed21c90
Show file tree

Hide file tree

Showing 7 changed files with 85 additions and 88 deletions.
diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj
@@ -506,6 +506,9 @@
     <CopyFileToFolders Include="TestData\TestZip.zip">
       <DeploymentContent>true</DeploymentContent>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\TestTarGz.tar.gz">
+      <DeploymentContent>true</DeploymentContent>
+    </CopyFileToFolders>
     <None Include="Run-TestsInPackage.ps1" />
     <CopyFileToFolders Include="TestData\Manifest-Bad-ArchInvalid.yaml">
       <DeploymentContent>true</DeploymentContent>

diff --git a/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters b/src/AppInstallerCLITests/AppInstallerCLITests.vcxproj.filters
@@ -633,6 +633,9 @@
     <CopyFileToFolders Include="TestData\TestZip.zip">
       <Filter>TestData</Filter>
     </CopyFileToFolders>
+    <CopyFileToFolders Include="TestData\TestTarGz.tar.gz">
+      <Filter>TestData</Filter>
+    </CopyFileToFolders>
     <CopyFileToFolders Include="TestData\DownloadFlowTest_DownloadCommandProhibited.yaml">
       <Filter>TestData</Filter>
     </CopyFileToFolders>

diff --git a/src/AppInstallerCLITests/Archive.cpp b/src/AppInstallerCLITests/Archive.cpp
@@ -2,16 +2,18 @@
 // Licensed under the MIT License.
 #include "pch.h"
 #include "TestCommon.h"
+#include "WorkflowCommon.h"
 #include <winget/Archive.h>
+#include <Workflows/ShellExecuteInstallerHandler.h>
 
 using namespace AppInstaller::Archive;
+using namespace AppInstaller::CLI::Workflow;
+using namespace AppInstaller::Settings;
 using namespace TestCommon;
 
 constexpr std::string_view s_ZipFile = "TestZip.zip";
-constexpr std::string_view s_7zFile = "Test7z.7z";
-constexpr std::string_view s_RarFile = "TestRar.rar";
 constexpr std::string_view s_TarGzFile = "TestTarGz.tar.gz";
-constexpr std::string_view s_TarBz2File = "TestTarBz2.tar.bz2";
+constexpr std::string_view s_Large7zFile = "TestLarge7z.7z";
 
 TEST_CASE("Extract_ZipArchive", "[archive]")
 {
@@ -37,67 +39,27 @@ TEST_CASE("Scan_ZipArchive", "[archive]")
     REQUIRE(result);
 }
 
-TEST_CASE("Extract_7zArchive", "[archive]")
-{
-    TestCommon::TempDirectory tempDirectory("TempDirectory");
-    TestDataFile test7z(s_7zFile);
-
-    const auto& test7zPath = test7z.GetPath();
-    const auto& tempDirectoryPath = tempDirectory.GetPath();
-
-    HRESULT hr = TryExtractArchive(test7zPath, tempDirectoryPath);
-
-    std::filesystem::path expectedPath = tempDirectoryPath / "test.txt";
-    REQUIRE(SUCCEEDED(hr));
-    REQUIRE(std::filesystem::exists(expectedPath));
-}
-
-TEST_CASE("Scan_7zArchive", "[archive]")
-{
-    TestDataFile test7z(s_7zFile);
-
-    const auto& test7zPath = test7z.GetPath();
-    bool result = ScanZipFile(test7zPath);
-    REQUIRE(result);
-}
-
-TEST_CASE("Extract_RarArchive", "[archive]")
-{
-    TestCommon::TempDirectory tempDirectory("TempDirectory");
-    TestDataFile testRar(s_RarFile);
-
-    const auto& testRarPath = testRar.GetPath();
-    const auto& tempDirectoryPath = tempDirectory.GetPath();
-
-    HRESULT hr = TryExtractArchive(testRarPath, tempDirectoryPath);
-
-    std::filesystem::path expectedPath = tempDirectoryPath / "test.txt";
-    REQUIRE(SUCCEEDED(hr));
-    REQUIRE(std::filesystem::exists(expectedPath));
-}
-
-TEST_CASE("Scan_RarArchive", "[archive]")
-{
-    TestDataFile testRar(s_RarFile);
-
-    const auto& testRarPath = testRar.GetPath();
-    bool result = ScanZipFile(testRarPath);
-    REQUIRE(result);
-}
-
 TEST_CASE("Extract_TarGzArchive", "[archive]")
 {
     TestCommon::TempDirectory tempDirectory("TempDirectory");
     TestDataFile testTarGz(s_TarGzFile);
 
+    TestCommon::TestUserSettings testSettings;
+    testSettings.Set<Setting::ArchiveExtractionMethod>(AppInstaller::Archive::ExtractionMethod::Tar);
+
     const auto& testTarGzPath = testTarGz.GetPath();
     const auto& tempDirectoryPath = tempDirectory.GetPath();
 
-    HRESULT hr = TryExtractArchive(testTarGzPath, tempDirectoryPath);
+    ShellExecuteExtractArchive(testTarGzPath, tempDirectoryPath);
+
+    std::ostringstream extractOutput;
+    TestContext context{ extractOutput, std::cin };
+    context << ShellExecuteExtractArchive(testTarGzPath, tempDirectoryPath);
 
     std::filesystem::path expectedPath = tempDirectoryPath / "test.txt";
-    REQUIRE(SUCCEEDED(hr));
+    REQUIRE(SUCCEEDED(context.GetTerminationHR()));
     REQUIRE(std::filesystem::exists(expectedPath));
+    INFO(extractOutput.str());
 }
 
 TEST_CASE("Scan_TarGzArchive", "[archive]")
@@ -109,27 +71,12 @@ TEST_CASE("Scan_TarGzArchive", "[archive]")
     REQUIRE(result);
 }
 
-TEST_CASE("Extract_TarBz2Archive", "[archive]")
-{
-    TestCommon::TempDirectory tempDirectory("TempDirectory");
-    TestDataFile testTarBz2(s_TarBz2File);
-
-    const auto& testTarBz2Path = testTarBz2.GetPath();
-    const auto& tempDirectoryPath = tempDirectory.GetPath();
-
-    HRESULT hr = TryExtractArchive(testTarBz2Path, tempDirectoryPath);
-
-    std::filesystem::path expectedPath = tempDirectoryPath / "test.txt";
-    REQUIRE(SUCCEEDED(hr));
-    REQUIRE(std::filesystem::exists(expectedPath));
-}
-
-TEST_CASE("Scan_TarBz2Archive", "[archive]")
-{
-    TestDataFile testTarBz2(s_TarBz2File);
-
-    const auto& testTarBz2Path = testTarBz2.GetPath();
-    bool result = ScanZipFile(testTarBz2Path);
-    REQUIRE(result);
-}
+//TEST_CASE("Scan_Large7zArchive", "[archive]")
+//{
+//    TestDataFile testLarge7z(s_Large7zFile);
+//
+//    const auto& testTarGzPath = testLarge7z.GetPath();
+//    bool result = ScanZipFile(testTarGzPath);
+//    REQUIRE(result);
+//}
 
diff --git a/src/AppInstallerCLITests/TestData/TestTarGz.tar.gz b/src/AppInstallerCLITests/TestData/TestTarGz.tar.gz
diff --git a/src/AppInstallerCommonCore/AppInstallerCommonCore.vcxproj b/src/AppInstallerCommonCore/AppInstallerCommonCore.vcxproj
@@ -274,6 +274,21 @@
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">Windows</SubSystem>
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">Windows</SubSystem>
     </Link>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|ARM'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|ARM64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Platform)'=='Win32'">
     <ClCompile>
@@ -287,6 +302,9 @@
     <Link>
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">Windows</SubSystem>
     </Link>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)'=='Release'">
     <ClCompile>
@@ -324,6 +342,18 @@
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">Windows</SubSystem>
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='Release|x64'">Windows</SubSystem>
     </Link>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Release|ARM'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Release|ARM64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Release|x64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)'=='ReleaseStatic'">
     <ClCompile>
@@ -365,6 +395,18 @@
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|Win32'">Windows</SubSystem>
       <SubSystem Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|x64'">Windows</SubSystem>
     </Link>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|ARM'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|ARM64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|Win32'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='ReleaseStatic|x64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(Configuration)'=='Fuzzing'">
     <ClCompile>
@@ -385,6 +427,12 @@
       <GenerateWindowsMetadata>false</GenerateWindowsMetadata>
       <SubSystem>Windows</SubSystem>
     </Link>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Fuzzing|Win32'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
+    <Lib>
+      <AdditionalDependencies Condition="'$(Configuration)|$(Platform)'=='Fuzzing|x64'">amsi.lib;%(AdditionalDependencies)</AdditionalDependencies>
+    </Lib>
   </ItemDefinitionGroup>
   <ItemDefinitionGroup Condition="'$(WingetDisableTestHooks)'=='true'">
     <ClCompile>

diff --git a/src/AppInstallerCommonCore/Archive.cpp b/src/AppInstallerCommonCore/Archive.cpp
@@ -3,11 +3,6 @@
 #include "pch.h"
 #include "Public/winget/Archive.h"
 
-#include <amsi.h>
-#include <comdef.h>
-#include <fstream>
-#include <vector>
-
 namespace AppInstaller::Archive
 {
     using unique_pidlist_absolute = wil::unique_any<PIDLIST_ABSOLUTE, decltype(&::CoTaskMemFree), ::CoTaskMemFree>;
@@ -67,30 +62,30 @@ namespace AppInstaller::Archive
 #endif
 
         HRESULT hr = S_OK;
-        wil::com_ptr_nothrow<IUnknown> amsiContext;
-        wil::com_ptr_nothrow<IUnknown> amsiSession;
+        HAMSICONTEXT amsiContext;
+        HAMSISESSION amsiSession;
 
         hr = AmsiInitialize(L"WinGet", &amsiContext);
         if (FAILED(hr))
         {
             return false;
         }
 
-        hr = AmsiOpenSession(amsiContext.get(), &amsiSession);
+        hr = AmsiOpenSession(amsiContext, &amsiSession);
         if (FAILED(hr))
         {
-            AmsiUninitialize(amsiContext.get());
+            AmsiUninitialize(amsiContext);
             return false;
         }
 
         std::ifstream instream{ zipPath, std::ios::in | std::ios::binary };
         std::vector<uint8_t> data{ { std::istreambuf_iterator<char>{ instream } }, std::istreambuf_iterator<char>{} };
 
         AMSI_RESULT result = AMSI_RESULT_CLEAN;
-        hr = AmsiScanBuffer(amsiContext.get(), data.data(), data.size(), zipPath.filename().c_str(), amsiSession.get(), &result);
+        hr = AmsiScanBuffer(amsiContext, data.data(), static_cast<ULONG>(data.size()), zipPath.filename().c_str(), amsiSession, &result);
 
-        AmsiCloseSession(amsiContext.get(), amsiSession.get());
-        AmsiUninitialize(amsiContext.get());
+        AmsiCloseSession(amsiContext, amsiSession);
+        AmsiUninitialize(amsiContext);
 
         return SUCCEEDED(hr) && (result == AMSI_RESULT_CLEAN || result == AMSI_RESULT_NOT_DETECTED);
     }

diff --git a/src/AppInstallerCommonCore/pch.h b/src/AppInstallerCommonCore/pch.h
@@ -18,6 +18,7 @@
 #include <wincrypt.h>
 #include <deliveryoptimization.h>
 #include <deliveryoptimizationerrors.h>
+#include <amsi.h>
 
 #include "TraceLogging.h"