Added support for specifying arguments, added a .NET Core 3.1 integration test project, added a failing integration test for version 9 binlogs, and updated deps as far as I can before MSBuild start multi-targeting

Author: daveaglick

src/Buildalyzer/Buildalyzer.csproj

@@ -21,7 +21,7 @@
     <PackageReference Include="Microsoft.Extensions.DependencyModel" Version="2.1.0" />
     <PackageReference Include="Microsoft.Extensions.Logging" Version="2.1.1" />
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="2.1.1" />
-    <PackageReference Include="MSBuild.StructuredLogger" Version="2.0.11" />
+    <PackageReference Include="MSBuild.StructuredLogger" Version="2.0.174" />
     <PackageReference Include="MsBuildPipeLogger.Server" Version="1.1.2" />
     <PackageReference Include="System.Reflection.TypeExtensions" Version="4.6.0" />
   </ItemGroup>

src/Buildalyzer/Environment/BuildEnvironment.cs

@@ -42,6 +42,8 @@ public sealed class BuildEnvironment
 
         public string DotnetExePath { get; }
 
+        public IEnumerable<string> Arguments { get; }
+
         public IReadOnlyDictionary<string, string> GlobalProperties => _globalProperties;
 
         public IReadOnlyDictionary<string, string> EnvironmentVariables => _environmentVariables;
@@ -52,12 +54,14 @@ public BuildEnvironment(
             string[] targetsToBuild,
             string msBuildExePath,
             string dotnetExePath,
+            IEnumerable<string> arguments,
             IDictionary<string, string> additionalGlobalProperties = null,
             IDictionary<string, string> additionalEnvironmentVariables = null)
         {
             DesignTime = designTime;
             Restore = restore;
             TargetsToBuild = targetsToBuild ?? throw new ArgumentNullException(nameof(targetsToBuild));
+            Arguments = arguments ?? throw new ArgumentNullException(nameof(arguments));
 
             // Check if we've already specified a path to MSBuild
             string envMsBuildExePath = System.Environment.GetEnvironmentVariable(Environment.EnvironmentVariables.MSBUILD_EXE_PATH);
@@ -133,6 +137,7 @@ public BuildEnvironment WithTargetsToBuild(params string[] targets) =>
                 targets,
                 MsBuildExePath,
                 DotnetExePath,
+                Arguments,
                 _additionalGlobalProperties,
                 _additionalEnvironmentVariables);
     }

src/Buildalyzer/Environment/EnvironmentFactory.cs

@@ -6,6 +6,7 @@
 using System.Xml.Linq;
 using Buildalyzer.Construction;
 using Microsoft.Build.Utilities;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 
 namespace Buildalyzer.Environment
@@ -114,6 +115,7 @@ private BuildEnvironment CreateCoreEnvironment(EnvironmentOptions options)
                 options.TargetsToBuild.ToArray(),
                 msBuildExePath,
                 options.DotnetExePath,
+                options.Arguments,
                 additionalGlobalProperties,
                 additionalEnvironmentVariables);
         }
@@ -150,6 +152,7 @@ private BuildEnvironment CreateFrameworkEnvironment(EnvironmentOptions options)
                 options.TargetsToBuild.ToArray(),
                 msBuildExePath,
                 options.DotnetExePath,
+                options.Arguments,
                 additionalGlobalProperties,
                 options.EnvironmentVariables);
         }

src/Buildalyzer/Environment/EnvironmentOptions.cs

@@ -42,8 +42,19 @@ public class EnvironmentOptions
         /// </remarks>
         public string DotnetExePath { get; set; } = "dotnet";
 
+        /// <summary>
+        /// The global MSBuild properties to set.
+        /// </summary>
         public IDictionary<string, string> GlobalProperties { get; } = new Dictionary<string, string>();
 
+        /// <summary>
+        /// Environment variables to set.
+        /// </summary>
         public IDictionary<string, string> EnvironmentVariables { get; } = new Dictionary<string, string>();
+
+        /// <summary>
+        /// Additional MSBuild command-line arguments to use.
+        /// </summary>
+        public IList<string> Arguments { get; } = new List<string>();
     }
 }

src/Buildalyzer/ProjectAnalyzer.cs

@@ -113,7 +113,7 @@ public IAnalyzerResults Build(string[] targetFrameworks, EnvironmentOptions envi
                 targetFrameworks = new string[] { null };
             }
 
-            // Create a new build envionment for each target
+            // Create a new build environment for each target
             AnalyzerResults results = new AnalyzerResults();
             foreach (string targetFramework in targetFrameworks)
             {
@@ -247,6 +247,11 @@ private string GetCommand(BuildEnvironment buildEnvironment, string targetFramew
                 initialArguments = $"\"{buildEnvironment.MsBuildExePath}\"";
             }
 
+            // Environment arguments
+            string environmentArguments = buildEnvironment.Arguments.Any()
+                ? string.Join(" ", buildEnvironment.Arguments)
+                : string.Empty;
+
             // Get the logger arguments (/l)
             string loggerPath = typeof(BuildalyzerLogger).Assembly.Location;
             bool logEverything = _buildLoggers.Count > 0;
@@ -273,7 +278,7 @@ private string GetCommand(BuildEnvironment buildEnvironment, string targetFramew
             // Get the restore argument (/restore)
             string restoreArgument = buildEnvironment.Restore ? "/restore" : string.Empty;
 
-            arguments = $"{initialArguments} /noconsolelogger {restoreArgument} {targetArgument} {propertyArgument} {loggerArgument} {FormatArgument(ProjectFile.Path)}";
+            arguments = $"{initialArguments} /noconsolelogger {environmentArguments} {restoreArgument} {targetArgument} {propertyArgument} {loggerArgument} {FormatArgument(ProjectFile.Path)}";
             return fileName;
         }
 

tests/Buildalyzer.Tests/Integration/SimpleProjectsFixture.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.IO.Compression;
 using System.Linq;
 using System.Text;
 using System.Xml.Linq;
@@ -35,6 +36,7 @@ public class SimpleProjectsFixture
             @"SdkMultiTargetingProject\SdkMultiTargetingProject.csproj",
 #endif
             @"SdkNetCoreProject\SdkNetCoreProject.csproj",
+            @"SdkNetCore31Project\SdkNetCore31Project.csproj",
             @"SdkNetCoreProjectImport\SdkNetCoreProjectImport.csproj",
             @"SdkNetCoreProjectWithReference\SdkNetCoreProjectWithReference.csproj",
             @"SdkNetCoreProjectWithImportedProps\SdkNetCoreProjectWithImportedProps.csproj",
@@ -500,6 +502,56 @@ public void BuildsFSharpProject()
             results.ShouldAllBe(x => x.Succeeded, log.ToString());
         }
 
+        [Test]
+        public void GetsSourceFilesFromVersion9BinLog()
+        {
+            // Given
+            StringWriter log = new StringWriter();
+            IProjectAnalyzer analyzer = GetProjectAnalyzer(
+                @"SdkNetCore31Project\SdkNetCore31Project.csproj",
+                log);
+            string binLogPath = Path.ChangeExtension(Path.GetTempFileName(), ".binlog");
+            EnvironmentOptions options = new EnvironmentOptions();
+            options.Arguments.Add("/bl:" + binLogPath); // Tell MSBuild to produce the binlog so we use the latest internal logger
+
+            try
+            {
+                // When
+                analyzer.Build(options);
+                using (Stream stream = File.OpenRead(binLogPath))
+                {
+                    using (GZipStream gzip = new GZipStream(stream, CompressionMode.Decompress))
+                    {
+                        using (BinaryReader reader = new BinaryReader(gzip))
+                        {
+                            // Verify this produced a version 9 binlog
+                            reader.ReadInt32().ShouldBe(9);
+                        }
+                    }
+                }
+                IReadOnlyList<string> sourceFiles = analyzer.Manager.Analyze(binLogPath).First().SourceFiles;
+
+                // Then
+                sourceFiles.ShouldNotBeNull(log.ToString());
+                new[]
+                {
+#if Is_Windows
+                // Linux and Mac builds appear to omit the AssemblyAttributes.cs file
+                "AssemblyAttributes",
+#endif
+                "Class1",
+                "AssemblyInfo"
+                }.ShouldBeSubsetOf(sourceFiles.Select(x => Path.GetFileName(x).Split('.').TakeLast(2).First()), log.ToString());
+            }
+            finally
+            {
+                if (File.Exists(binLogPath))
+                {
+                    File.Delete(binLogPath);
+                }
+            }
+        }
+
         private static IProjectAnalyzer GetProjectAnalyzer(string projectFile, StringWriter log)
         {
             IProjectAnalyzer analyzer = new AnalyzerManager(

tests/projects/SdkNetCore31Project/Class1.cs

@@ -0,0 +1,12 @@
+using System;
+
+namespace SdkNetCoreProject
+{
+    public class Class1
+    {
+        public void Foo()
+        {
+            Console.WriteLine("Bar");
+        }
+    }
+}

tests/projects/SdkNetCore31Project/SdkNetCore31Project.csproj

@@ -0,0 +1,7 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+</Project>