Merge pull request #4 from ChrisDavies-MSFT/BetterWarningHandling

Even better warning handling
2026-06-08 17:36:09 +00:00 · 2018-12-12 09:01:40 +03:00
parent 5139331e7a adee785997
commit 158b98ef33
10 changed files with 225 additions and 40 deletions
@@ -20,6 +20,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "YaraTest", "YaraTest\YaraTest.csproj", "{602143B0-7EA3-4843-8CEE-228BC66F0437}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "YaraSharpUnitTests", "YaraSharpUnitTests\YaraSharpUnitTests.csproj", "{77A34A2C-411B-4958-B553-0151A11BA09B}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -62,6 +64,18 @@ Global
 		{602143B0-7EA3-4843-8CEE-228BC66F0437}.Release|x64.Build.0 = Release|Any CPU
 		{602143B0-7EA3-4843-8CEE-228BC66F0437}.Release|x86.ActiveCfg = Release|Any CPU
 		{602143B0-7EA3-4843-8CEE-228BC66F0437}.Release|x86.Build.0 = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|x64.Build.0 = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Debug|x86.Build.0 = Debug|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|x64.ActiveCfg = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|x64.Build.0 = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|x86.ActiveCfg = Release|Any CPU
+		{77A34A2C-411B-4958-B553-0151A11BA09B}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -10,8 +10,12 @@ namespace YaraSharp
 		ErrorUtility::ThrowOnError(yr_compiler_create(&TestCompiler));
 		Compiler = TestCompiler;

-		Errors = gcnew List<String^>();
-		
+		// Set up and initialize the error dictionary for errors and warnings
+		// Which are populated by the callback handler
+		Errors = gcnew Dictionary<int, List<String^>^>();
+		Errors->Add(YARA_ERROR_LEVEL_ERROR, gcnew List<String^>());
+		Errors->Add(YARA_ERROR_LEVEL_WARNING, gcnew List<String^>());
+
 		SetCompilerExternals(ExternalVariables);
 		SetCompilerCallback();
 	}
@@ -23,12 +27,15 @@ namespace YaraSharp
 	{
 		FILE* File;
 		Errors->Clear();
+		Errors->Add(YARA_ERROR_LEVEL_ERROR, gcnew List<String^>());
+		Errors->Add(YARA_ERROR_LEVEL_WARNING, gcnew List<String^>());
+
 		auto NativePath = marshal_as<std::string>(FilePath);

 		auto FileOpenError = fopen_s(&File, NativePath.c_str(), "r");

 		if (FileOpenError)
-			ErrorUtility::ThrowOnError(String::Format("Îøèáêà îòêðûòèÿ ôàéëà: {0}", FileOpenError));
+			ErrorUtility::ThrowOnError(String::Format("Error opening file: {0}", FileOpenError));

 		auto errors = yr_compiler_add_file(Compiler, File, nullptr, NativePath.c_str());

@@ -36,11 +43,13 @@ namespace YaraSharp

 		return errors;
 	}
+
 	void CCompiler::AddFiles(List<String^>^ FilePathList)
 	{
 		for each (auto FilePath in FilePathList)
 			AddFile(FilePath);
 	}
+
 	CRules^ CCompiler::GetRules()
 	{
 		YR_RULES* Rules;
@@ -50,9 +59,17 @@ namespace YaraSharp

 		return gcnew CRules(Rules);
 	}
-	List<String^>^ CCompiler::GetErrors()
+
+	List<String^>^ CCompiler::GetErrors(Boolean IncludeWarnings)
 	{
-		return this->Errors;
+		if (IncludeWarnings)
+		{
+			List<String^>^ errorsAndWarnings = gcnew List<String^>(this->Errors[YARA_ERROR_LEVEL_ERROR]);
+			errorsAndWarnings->AddRange(this->Errors[YARA_ERROR_LEVEL_WARNING]);
+			return errorsAndWarnings;
+		}
+		
+		return this->Errors[YARA_ERROR_LEVEL_ERROR];
 	}

 	//	Set externals
@@ -93,26 +110,23 @@ namespace YaraSharp
 		YR_COMPILER_CALLBACK_FUNC CallbackPointer = (YR_COMPILER_CALLBACK_FUNC)(Marshal::GetFunctionPointerForDelegate(CompilerCallback)).ToPointer();
 		yr_compiler_set_callback(Compiler, CallbackPointer, NULL);
 	}
+
 	void CCompiler::HandleCompilerCallback(int ErrorLevel, const char* Filename, int LineNumber, const char* Message, void* UserData)
 	{
 		UNREFERENCED_PARAMETER(ErrorLevel);
 		UNREFERENCED_PARAMETER(UserData);

-		String^ errorLevel;
+		String^ errorLevel = "ERROR";

-		if (ErrorLevel == YARA_ERROR_LEVEL_ERROR)
-		{
-			errorLevel = "ERROR";
-		}
-		else if (ErrorLevel == YARA_ERROR_LEVEL_WARNING)
+		if (ErrorLevel == YARA_ERROR_LEVEL_WARNING)
 		{
 			errorLevel = "WARNING";
 		}
-
+		
 		auto msg = String::Format("{0}: {1} on line {2} in file: {3}",
 			errorLevel, marshal_as<String^>(Message), LineNumber,
 			Filename ? marshal_as<String^>(Filename) : "[none]");

-		Errors->Add(msg);
+		Errors[ErrorLevel]->Add(msg);
 	}
 }
@@ -8,14 +8,14 @@ namespace YaraSharp
 	public ref class CCompiler sealed
 	{
 		initonly YR_COMPILER* Compiler;
-		initonly List<String^>^ Errors;
+		initonly Dictionary<int, List<String^>^>^ Errors;

 	public:
 		CCompiler(Dictionary<String^, Object^>^ ExternalVariables);
 		~CCompiler();

 		CRules^ GetRules();
-		List<String^>^ GetErrors();
+		List<String^>^ GetErrors(Boolean IncludeWarnings);
 		int AddFile(String^ FilePath);
 		void AddFiles(List<String^>^ FilePathList);

@@ -6,44 +6,41 @@ namespace YaraSharp
 	//	Check list of yara files
 	Dictionary<String^, List<String^>^>^ CYaraSharp::CheckYaraRules([Out] List<String^>^ FilePathList, Dictionary<String^, Object^>^ ExternalVariables)
 	{
-		Dictionary<String^, List<String^>^>^ CompilationErrors =
-			gcnew Dictionary<String^, List<String^>^>();
+		Dictionary<String^, List<String^>^>^ CompilationErrors = gcnew Dictionary<String^, List<String^>^>();

 		//	Iterative check
 		for (int i = 0; i < FilePathList->Count; i++)
 		{
 			CCompiler^ TestCompiler = gcnew CCompiler(ExternalVariables);

-			if (TestCompiler->AddFile(FilePathList[i]) || TestCompiler->GetErrors()->Count > 0)
+			if (TestCompiler->AddFile(FilePathList[i]))
 			{
-				CompilationErrors->Add(FilePathList[i], TestCompiler->GetErrors());
+				if (CompilationErrors->ContainsKey(FilePathList[i]))
+				{
+					CompilationErrors[FilePathList[i]]->AddRange(TestCompiler->GetErrors(false));
+				}
+				else
+				{
+					CompilationErrors->Add(FilePathList[i], TestCompiler->GetErrors(false));
+				}
+
 				FilePathList->Remove(FilePathList[i--]);
 			}
+			else if (TestCompiler->GetErrors(true)->Count > 0)
+			{
+				if (CompilationErrors->ContainsKey(FilePathList[i]))
+				{
+					CompilationErrors[FilePathList[i]]->AddRange(TestCompiler->GetErrors(true));
+				}
+				else
+				{
+					CompilationErrors->Add(FilePathList[i], TestCompiler->GetErrors(true));
+				}
+			}

 			delete TestCompiler;
 		}

-		//	Simultaneous check
-		bool SuccessFlag = false;
-		while (!SuccessFlag)
-		{
-			SuccessFlag = true;
-			CCompiler^ TestCompiler = gcnew CCompiler(ExternalVariables);
-			for each (auto FilePath in FilePathList)
-			{
-				if (TestCompiler->AddFile(FilePath) || TestCompiler->GetErrors()->Count > 0)
-				{
-					CompilationErrors->Add(FilePath, TestCompiler->GetErrors());
-					FilePathList->Remove(FilePath);
-					SuccessFlag = false;
-
-					//	New compiler must be created if we fail
-					delete TestCompiler;
-					break;
-				}
-			}
-		}
-
 		return CompilationErrors;
 	}
 	
@@ -0,0 +1,20 @@
+using System.Reflection;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
+
+[assembly: AssemblyTitle("YaraSharpUnitTests")]
+[assembly: AssemblyDescription("")]
+[assembly: AssemblyConfiguration("")]
+[assembly: AssemblyCompany("")]
+[assembly: AssemblyProduct("YaraSharpUnitTests")]
+[assembly: AssemblyCopyright("Copyright ©  2018")]
+[assembly: AssemblyTrademark("")]
+[assembly: AssemblyCulture("")]
+
+[assembly: ComVisible(false)]
+
+[assembly: Guid("77a34a2c-411b-4958-b553-0151a11ba09b")]
+
+// [assembly: AssemblyVersion("1.0.*")]
+[assembly: AssemblyVersion("1.0.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]
@@ -0,0 +1 @@
+this is a slow regex
@@ -0,0 +1,10 @@
+// This file contains a rule that should trigger a warning. This should not prevent scanning from being successful
+
+rule WarningRule
+{
+  strings:
+    $error_str = /this.+?is.+?a.+?slow.+?regex/
+
+  condition:
+    $error_str
+}
@@ -0,0 +1,43 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Reflection;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using YaraSharp;
+
+namespace YaraSharpUnitTests
+{
+    [TestClass]
+    public class WarningsAndErrors
+    {
+        private static string BaseDirectory = Environment.CurrentDirectory;
+        private static string TestDataDirectory = Path.Combine(BaseDirectory, "TestData");
+
+        /// <summary>
+        /// Ensures warnings are correctly reported along with errors,
+        /// but does not prevent scanning from working
+        /// </summary>
+        [TestMethod]
+        public void CheckWarningsStillScan()
+        {
+            string inputFileBase = "CheckWarningStillScans";
+            string yaraRuleFile = Path.Combine(TestDataDirectory, $"{inputFileBase}.yar");
+            string yaraInputFile = Path.Combine(TestDataDirectory, $"{inputFileBase}.txt");
+
+            CYaraSharp yaraInstance = new CYaraSharp();
+
+            using (CContext context = new CContext())
+            {
+                using (CCompiler compiler = new CCompiler(null))
+                {
+                    compiler.AddFile(yaraRuleFile);
+                    List<string> compilerErrors = compiler.GetErrors(true);
+
+                    CScanner scanner = new CScanner(compiler.GetRules(), null);
+                    Assert.IsTrue(scanner.ScanFile(yaraInputFile).Any(r => r.Rule.Identifier == "WarningRule"));
+                }
+            }
+        }
+    }
+}
@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.props" Condition="Exists('..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.props')" />
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <ProjectGuid>{77A34A2C-411B-4958-B553-0151A11BA09B}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <AppDesignerFolder>Properties</AppDesignerFolder>
+    <RootNamespace>YaraSharpUnitTests</RootNamespace>
+    <AssemblyName>YaraSharpUnitTests</AssemblyName>
+    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <FileAlignment>512</FileAlignment>
+    <ProjectTypeGuids>{3AC096D0-A1C2-E12C-1390-A8335801FDAB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
+    <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">15.0</VisualStudioVersion>
+    <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
+    <ReferencePath>$(ProgramFiles)\Common Files\microsoft shared\VSTT\$(VisualStudioVersion)\UITestExtensionPackages</ReferencePath>
+    <IsCodedUITest>False</IsCodedUITest>
+    <TestProjectType>UnitTest</TestProjectType>
+    <NuGetPackageImportStamp>
+    </NuGetPackageImportStamp>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <Optimize>false</Optimize>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DefineConstants>DEBUG;TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>pdbonly</DebugType>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DefineConstants>TRACE</DefineConstants>
+    <ErrorReport>prompt</ErrorReport>
+    <WarningLevel>4</WarningLevel>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="Microsoft.VisualStudio.TestPlatform.TestFramework, Version=14.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\packages\MSTest.TestFramework.1.3.2\lib\net45\Microsoft.VisualStudio.TestPlatform.TestFramework.dll</HintPath>
+    </Reference>
+    <Reference Include="Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions, Version=14.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL">
+      <HintPath>..\packages\MSTest.TestFramework.1.3.2\lib\net45\Microsoft.VisualStudio.TestPlatform.TestFramework.Extensions.dll</HintPath>
+    </Reference>
+    <Reference Include="System" />
+    <Reference Include="System.Core" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="WarningsAndErrors.cs" />
+    <Compile Include="Properties\AssemblyInfo.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="TestData\CheckWarningStillScans.txt">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+    <None Include="packages.config" />
+    <Content Include="TestData\CheckWarningStillScans.yar">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\YaraSharp\YaraSharp.vcxproj">
+      <Project>{c005e3b9-2474-4fea-b5f4-7bb897111e8f}</Project>
+      <Name>YaraSharp</Name>
+    </ProjectReference>
+  </ItemGroup>
+  <ItemGroup />
+  <Import Project="$(VSToolsPath)\TeamTest\Microsoft.TestTools.targets" Condition="Exists('$(VSToolsPath)\TeamTest\Microsoft.TestTools.targets')" />
+  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
+  <Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
+    <PropertyGroup>
+      <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
+    </PropertyGroup>
+    <Error Condition="!Exists('..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.props')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.props'))" />
+    <Error Condition="!Exists('..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.targets'))" />
+  </Target>
+  <Import Project="..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.targets" Condition="Exists('..\packages\MSTest.TestAdapter.1.3.2\build\net45\MSTest.TestAdapter.targets')" />
+</Project>
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="MSTest.TestAdapter" version="1.3.2" targetFramework="net45" />
+  <package id="MSTest.TestFramework" version="1.3.2" targetFramework="net45" />
+</packages>