Merge pull request #88 from petabridge/dev

v0.2.0 Release

Author: Aaronontheweb

RELEASE_NOTES.md

@@ -1,4 +1,7 @@
-#### 0.1.7 September 09 2019 ####
-Bugfix release for Incrementalist v0.1.6
+#### 0.2.0 October 28 2019 ####
+Feature release: Incrementalist v0.2.0
 
-Fixed [Bug: in multi-targeted projects, only one "project" contains the dependency graph.](https://github.com/petabridge/Incrementalist/issues/63). This will make it easier for Incrementalist to detect changes that occur inside multi-targeted projects.
+* [Added .NET Core 3.0 global tool support](https://github.com/petabridge/Incrementalist/issues/70)
+* [Added F# project support](https://github.com/petabridge/Incrementalist/issues/69)
+* [Bugfix: Need to be able to detect changes in `.props` files referenced by projects](https://github.com/petabridge/Incrementalist/issues/68)
+* [Added configurable timeout to commandline options](https://github.com/petabridge/Incrementalist/pull/86)

build-system/windows-release.yaml

@@ -14,7 +14,7 @@ variables:
   - group: signingSecrets #create this group with SECRET variables `signingUsername` and `signingPassword`
   - group: nugetKeys #create this group with SECRET variables `nugetKey`
   - name: githubConnectionName
-    value: Petabridge
+    value: PbReleaseNotes
   - name: projectName
     value: Incrementalist
   - name: githubRepositoryName
@@ -35,4 +35,4 @@ steps:
     title: '$(projectName) v$(Build.SourceBranchName)'
     releaseNotesFile: 'RELEASE_NOTES.md'
     assets: |
-     bin\nuget\*.nupkg
+     bin\nuget\*.nupkg

build.fsx

@@ -122,8 +122,8 @@ Target "IntegrationTests" <| fun _ ->
 
     let runSingleProject project =
 
-        let folderOnlyArgs = sprintf "run --project %s -c %s --no-build -- -b dev -l -f %s" project configuration (outputTests @@ "incrementalist-affected-folders.txt")
-        let slnArgs = sprintf "run --project %s -c %s --no-build -- -b dev -f %s" project configuration (outputTests @@ "incrementalist-affected-files.txt")
+        let folderOnlyArgs = sprintf "run --project %s -c %s --framework netcoreapp3.0 --no-build -- -b dev -l -f %s" project configuration (outputTests @@ "incrementalist-affected-folders.txt")
+        let slnArgs = sprintf "run --project %s -c %s --framework netcoreapp3.0 -- -b dev -f %s" project configuration (outputTests @@ "incrementalist-affected-files.txt")
 
         let execWithArgs args =
             let result = ExecProcess(fun info ->

build.ps1

@@ -31,11 +31,11 @@ Param(
 
 $FakeVersion = "4.61.2"
 $DotNetChannel = "LTS";
-$DotNetVersion = "2.1.500";
-$DotNetInstallerUri = "https://raw.githubusercontent.com/dotnet/cli/v$DotNetVersion/scripts/obtain/dotnet-install.ps1";
+$DotNetVersion = "3.0.100";
+$DotNetInstallerUri = "https://dot.net/v1/dotnet-install.ps1";
 $NugetVersion = "4.1.0";
 $NugetUrl = "https://dist.nuget.org/win-x86-commandline/v$NugetVersion/nuget.exe"
-$ProtobufVersion = "3.4.0"
+$ProtobufVersion = "3.9.2"
 $DocfxVersion = "2.40.5"
 
 # Make sure tools folder exists
@@ -87,6 +87,7 @@ if($FoundDotNetCliVersion -ne $DotNetVersion) {
     $env:PATH = "$InstallPath;$env:PATH"
     $env:DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1
     $env:DOTNET_CLI_TELEMETRY_OPTOUT=1
+    $env:DOTNET_ROOT=$InstallPath
 }
 
 ###########################################################################
@@ -128,6 +129,22 @@ if (!(Test-Path $DocfxExePath)) {
     }
 }
 
+
+###########################################################################
+# Google.Protobuf.Tools
+###########################################################################
+
+# Make sure Google.Protobuf.Tools has been installed.
+$ProtobufExePath = Join-Path $ToolPath "Google.Protobuf.Tools/tools/windows_x64/protoc.exe"
+if (!(Test-Path $ProtobufExePath)) {
+    Write-Host "Installing Google.Protobuf.Tools..."
+    Invoke-Expression "&`"$NugetPath`" install Google.Protobuf.Tools -ExcludeVersion -Version $ProtobufVersion -OutputDirectory `"$ToolPath`"" | Out-Null;
+    if ($LASTEXITCODE -ne 0) {
+        Throw "An error occured while restoring Google.Protobuf.Tools from NuGet."
+    }
+}
+
+
 ###########################################################################
 # SignTool
 ###########################################################################
@@ -256,8 +273,8 @@ exit $LASTEXITCODE
 # +jrFfrNWxRlmVcfE+ZBH8bLJinzYGNChgg7IMIIOxAYKKwYBBAGCNwMDATGCDrQw
 # gg6wBgkqhkiG9w0BBwKggg6hMIIOnQIBAzEPMA0GCWCGSAFlAwQCAQUAMHcGCyqG
 # SIb3DQEJEAEEoGgEZjBkAgEBBglghkgBhv1sBwEwMTANBglghkgBZQMEAgEFAAQg
-# yVw1M/glzmvyYENKoVDAlG2PPFDPhYSmm6N4s9jIPD0CEDlse+eGBA4upExwL3x7
-# DG4YDzIwMTkwMzA3MTk0MjQ4WqCCC7swggaCMIIFaqADAgECAhAJwPxGyARCE7VZ
+# yVw1M/glzmvyYENKoVDAlG2PPFDPhYSmm6N4s9jIPD0CEGcCUCnVFW/SW5WYFvGQ
+# UdEYDzIwMTkwMzE1MTYwMDU3WqCCC7swggaCMIIFaqADAgECAhAJwPxGyARCE7VZ
 # i68oT05BMA0GCSqGSIb3DQEBCwUAMHIxCzAJBgNVBAYTAlVTMRUwEwYDVQQKEwxE
 # aWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20xMTAvBgNVBAMT
 # KERpZ2lDZXJ0IFNIQTIgQXNzdXJlZCBJRCBUaW1lc3RhbXBpbmcgQ0EwHhcNMTcw
@@ -324,13 +341,13 @@ exit $LASTEXITCODE
 # cnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMTEwLwYDVQQDEyhEaWdp
 # Q2VydCBTSEEyIEFzc3VyZWQgSUQgVGltZXN0YW1waW5nIENBAhAJwPxGyARCE7VZ
 # i68oT05BMA0GCWCGSAFlAwQCAQUAoIGYMBoGCSqGSIb3DQEJAzENBgsqhkiG9w0B
-# CRABBDAcBgkqhkiG9w0BCQUxDxcNMTkwMzA3MTk0MjQ4WjArBgsqhkiG9w0BCRAC
+# CRABBDAcBgkqhkiG9w0BCQUxDxcNMTkwMzE1MTYwMDU3WjArBgsqhkiG9w0BCRAC
 # DDEcMBowGDAWBBRAAZFHXJiJHeuhBK9HCRtettTLyzAvBgkqhkiG9w0BCQQxIgQg
-# THJaw67Mv8gSdYbuiJzceMQu2BnXQMbGHfTk35ilTHkwDQYJKoZIhvcNAQEBBQAE
-# ggEAD6QiEmVV5ZSFeaSHvujQ33RCMbndiy71RsysBVsJqOLp9uC0XXutmwjqa7q/
-# aOXOFNSTZAOGBeDVrObLe1eyVGO2ZdeA1WqTZC56dTo447OGSOacYd2x6S0UGPR8
-# jkDDYDIWKWhtNERUXiw4R+xGWRfUElwSn+vIT6izyV/4IgiEgoINe4/nQ3y9Asbc
-# oY8bE8uBhfimwgzpsqj6YTHCJxSrPnloqeHJYQmBn+1RcJ06lNiY8eppAZGo+zQQ
-# CMtoxnhrX3J9A/+41e6y1TX7YCLFV+bznmgVQz0cUqoEvB5TemogV2NwOTgnYvz0
-# SfejbelpMrP5PYsNcJePyRpdsQ==
+# jLu5eXUI0j43Sq/ZJ76+UJmWF/2Amb+YAcVtGZhRJKowDQYJKoZIhvcNAQEBBQAE
+# ggEAQBQNwdmatbURcWuntIUvk18FZGGLRA3bT0kNXN0pwwwopQlr4G6WbL8C8oSw
+# 0KUbWa3VonUYHemc6ZYgSOaa07X9dMoEWdgf9Jy7LDFZQCYBkI7034x0ujyTAZ6U
+# KtqQupuRPdLAsCb67KB6DR6lIuP1hj1yolPb9uyqEsH1JJqusTiirZvO1UvNVtHU
+# ljscye8j2SiO8UNLhYHL1me43S4NmqgLkaDvIE8lVx8GtyFyGRdFZYTzAufXTR9H
+# HK8lsD0ekQiOpaAIw/MfhEgTej1Z3L686Z0xwBVyH988UA9lVbXdDZWS3odGd2CT
+# /JdEUFIMzW5J8N+QntZ/Fjua/A==
 # SIG # End signature block

build.sh

@@ -11,8 +11,8 @@ NUGET_EXE=$TOOLS_DIR/nuget.exe
 NUGET_URL=https://dist.nuget.org/win-x86-commandline/v4.0.0/nuget.exe
 FAKE_VERSION=4.61.2
 FAKE_EXE=$TOOLS_DIR/FAKE/tools/FAKE.exe
-DOTNET_VERSION=2.1.500
-DOTNET_INSTALLER_URL=https://raw.githubusercontent.com/dotnet/cli/v$DOTNET_VERSION/scripts/obtain/dotnet-install.sh
+DOTNET_VERSION=3.0.100
+DOTNET_INSTALLER_URL=https://dot.net/v1/dotnet-install.sh
 DOTNET_CHANNEL=LTS;
 DOCFX_VERSION=2.40.5
 DOCFX_EXE=$TOOLS_DIR/docfx.console/tools/docfx.exe
@@ -129,4 +129,4 @@ export FrameworkPathOverride=/usr/lib/mono/4.5/
 ###########################################################################
 
 # Start Fake
-exec mono "$FAKE_EXE" build.fsx "${SCRIPT_ARGUMENTS[@]}" --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN
+exec mono "$FAKE_EXE" build.fsx "${SCRIPT_ARGUMENTS[@]}" --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN

src/Incrementalist.Cmd/Commands/LoadSolutionCmd.cs

@@ -42,7 +42,20 @@ protected override async Task<Solution> ProcessImpl(Task<string> previousTask)
                 $"solution filename. Instead returned {slnObject}");
             var slnName = slnObject;
             Contract.Assert(File.Exists(slnName), $"Expected to find {slnName} on the file system, but couldn't.");
+            
+            // Log any solution loading issues
+            _workspace.WorkspaceFailed += (sender, args) =>
+            {
+                var message = $"Issue during solution loading: {sender}: {args.Diagnostic.Message}";
+                var logLevel = args.Diagnostic.Kind == WorkspaceDiagnosticKind.Failure ? LogLevel.Error : LogLevel.Warning;
+                
+                Logger.Log(logLevel, message);
+            };
 
+            // Roslyn does not support FSharp projects, but .fsproj has same structure as .csproj files,
+            // so can treat them as a known project type to support diff tracking
+            _workspace.AssociateFileExtensionWithLanguage("fsproj", LanguageNames.CSharp);
+            
             return await _workspace.OpenSolutionAsync(slnName, _progress, CancellationToken);
         }
     }

src/Incrementalist.Cmd/Incrementalist.Cmd.csproj

@@ -4,16 +4,16 @@
     <ToolCommandName>incrementalist</ToolCommandName>
     <PackAsTool>true</PackAsTool>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp2.1</TargetFramework>
+    <TargetFrameworks>netcoreapp2.1;netcoreapp3.0;</TargetFrameworks>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <LangVersion>7.1</LangVersion>
     <Description>.NET Core global tool for determining how to run incremental builds based on the current Git diff.</Description>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="CommandLineParser" Version="2.5.0" />
-    <PackageReference Include="Microsoft.Build.Locator" Version="1.2.2" />
-    <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="3.0.0" />
+    <PackageReference Include="CommandLineParser" Version="2.6.0" />
+    <PackageReference Include="Microsoft.Build.Locator" Version="1.2.6" />
+    <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="$(RoslynVersion)" />
     <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="2.2.0" />
   </ItemGroup>
 

src/Incrementalist.Cmd/Program.cs

@@ -130,7 +130,7 @@ private static async Task<int> RunIncrementalist(SlnOptions options)
 
         private static async Task AnalyzeFolderDiff(SlnOptions options, DirectoryInfo workingFolder, ILogger logger)
         {
-            var settings = new BuildSettings(options.GitBranch, options.SolutionFilePath, workingFolder.FullName);
+            var settings = new BuildSettings(options.GitBranch, options.SolutionFilePath, workingFolder.FullName, TimeSpan.FromMinutes(options.TimeoutMinutes));
             var emitTask = new EmitAffectedFoldersTask(settings, logger);
             var affectedFiles = (await emitTask.Run());
 
@@ -155,7 +155,7 @@ private static async Task AnaylzeSolutionDIff(SlnOptions options, DirectoryInfo
         private static async Task ProcessSln(SlnOptions options, string sln, DirectoryInfo workingFolder,
             MSBuildWorkspace msBuild, ILogger logger)
         {
-            var settings = new BuildSettings(options.GitBranch, sln, workingFolder.FullName);
+            var settings = new BuildSettings(options.GitBranch, sln, workingFolder.FullName, TimeSpan.FromMinutes(options.TimeoutMinutes));
             var emitTask = new EmitDependencyGraphTask(settings, msBuild, logger);
             var affectedFiles = (await emitTask.Run()).ToList();
 

src/Incrementalist.Cmd/SlnOptions.cs

@@ -4,6 +4,9 @@
 // </copyright>
 // -----------------------------------------------------------------------
 
+using System;
+using System.Diagnostics;
+using System.Runtime.InteropServices.ComTypes;
 using CommandLine;
 
 namespace Incrementalist.Cmd
@@ -31,5 +34,8 @@ public sealed class SlnOptions
             Default = false,
             HelpText = "Prints out extensive debug logs during operation.")]
         public bool Verbose { get; set; }
+
+        [Option('t', "timeout", Default = 2, HelpText = "Specifies the load timeout for the solution in whole minutes. Defaults to 2 minutes.")]
+        public int TimeoutMinutes { get; set; }
     }
 }

src/Incrementalist.Tests/Dependencies/FSharpProjectsTrackingSpecs.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using FluentAssertions;
+using Incrementalist.Cmd.Commands;
+using Incrementalist.ProjectSystem;
+using Incrementalist.ProjectSystem.Cmds;
+using Incrementalist.Tests.Helpers;
+using Microsoft.Build.Locator;
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.MSBuild;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace Incrementalist.Tests.Dependencies
+{
+    public class FSharpProjectsTrackingSpecs : IDisposable
+    {
+        private readonly ITestOutputHelper _outputHelper;
+        public DisposableRepository Repository { get; }
+        
+        public FSharpProjectsTrackingSpecs(ITestOutputHelper outputHelper)
+        {
+            _outputHelper = outputHelper;
+            Repository = new DisposableRepository();
+        }
+
+        public void Dispose()
+        {
+            Repository?.Dispose();
+        }
+        
+        [Fact]
+        public async Task FSharpProjectDiff_should_be_tracked()
+        {
+            var sample = ProjectSampleGenerator.GetFSharpSolutionSample("FSharpSolution.sln");
+            var solutionFullPath = sample.SolutionFile.GetFullPath(Repository.BasePath);
+            var fsharpProjectFullPath = sample.FSharpProjectFile.GetFullPath(Repository.BasePath);
+            var csharpProjectFullPath = sample.CSharpProjectFile.GetFullPath(Repository.BasePath);
+
+            Repository
+                .WriteFile(sample.SolutionFile)
+                .WriteFile(sample.CSharpProjectFile)
+                .WriteFile(sample.FSharpProjectFile)
+                .Commit("Created new solution with fsharp and csharp projects")
+                .CreateBranch("foo")
+                .CheckoutBranch("foo")
+                .WriteFile(sample.CSharpProjectFile.Name, sample.CSharpProjectFile.Content + " ")
+                .WriteFile(sample.FSharpProjectFile.Name, sample.FSharpProjectFile.Content + " ")
+                .Commit("Updated both project files");
+            
+            var logger = new TestOutputLogger(_outputHelper);
+            var settings = new BuildSettings("master", solutionFullPath, Repository.BasePath);
+            var workspace = SetupMsBuildWorkspace();
+            var emitTask = new EmitDependencyGraphTask(settings, workspace, logger);
+            var affectedFiles = (await emitTask.Run()).ToList();
+
+            affectedFiles.Select(f => f.Key).Should().HaveCount(2).And.Subject.Should().BeEquivalentTo(fsharpProjectFullPath, csharpProjectFullPath);
+        }
+
+        private static MSBuildWorkspace SetupMsBuildWorkspace()
+        {
+            // Locate and register the default instance of MSBuild installed on this machine.
+            MSBuildLocator.RegisterDefaults();
+            
+            return MSBuildWorkspace.Create();
+        }
+    }
+}