Merge pull request #111 from AArnott/dotnetCore

Add support for MSBuild Core (aka `dotnet build`)

Author: AArnott

CONTRIBUTING.md

@@ -7,7 +7,7 @@ This project is actively developed using the following software.
 It is highly recommended that anyone contributing to this library use the same
 software.
 
-1. [Visual Studio 2015][VS]
+1. [Visual Studio 2017][VS]
 2. [Node.js][NodeJs]
 
 ### Optional additional software
@@ -17,7 +17,6 @@ They are not required to build the full solution from the command line using MSB
 but installing this software will facilitate an enhanced developer experience in Visual Studio.
 
 1. [Node.js Tools for Visual Studio][NodeJsTools]
-2. [NuProj for VS2015][NuProj]
 
 All other dependencies are acquired via NuGet or NPM.
 
@@ -30,8 +29,8 @@ and you are running Windows PowerShell, the command is:
 
     .\init.ps1
 
-Everything in the repo may be built via building the solution file
-either from Visual Studio 2015 or the VS2015 Developer Command Prompt:
+Most of the repo may be built via building the solution file from Visual Studio 2017,
+but for a complete build, build from the VS2017 Developer Command Prompt:
 
     .\build.ps1
 
@@ -40,28 +39,9 @@ It then builds an NPM package that includes some of the outputs of MSBuild, alon
 some javascript, for our NPM consumers who want a reasonable versioning story for their
 NPM packages too.
 
-### Important notice when developing with Visual Studio
-
-The NuGet package restore functionality in Visual Studio does not work for this project, which relies
-on newer functionality than comes with Visual Studio 2015 Update 3. You should disable automatic
-package restore on build in Visual Studio in order to build successfully and have a useful Error List
-while developing.
-
-Follow these steps to disable automatic package restore in Visual Studio:
-
-1. Tools -> Options -> NuGet Package Manager -> General
-2. *Clear* the checkbox for "Automatically check for missing packages during build in Visual Studio
-
-With this setting, you can still execute a package restore within Visual Studio by right-clicking
-on the _solution_ node in Solution Explorer and clicking "Restore NuGet Packages". But do not ever
-execute that on this project as that will corrupt the result of `init.ps1`.
-
-Before developing this project in Visual Studio, or after making project or project.json changes,
-or to recover after Visual Studio executes a package restore, run the `init` script again.
-
 ## Testing
 
-The Visual Studio 2015 Test Explorer will list and execute all tests.
+The Visual Studio 2017 Test Explorer will list and execute all tests.
 
 ## Pull requests
 
@@ -104,8 +84,6 @@ for your pull request. You can get the version number by reviewing the result of
 validation build for your pull request, clicking ARTIFACTS, and noting the version
 of the produced packages.
 
- [VS]: https://www.visualstudio.com/en-us/downloads/visual-studio-2015-downloads-vs.aspx
+ [VS]: https://www.visualstudio.com/downloads/
  [NodeJs]: https://nodejs.org
- [NuProj]: https://onedrive.live.com/redir?resid=63D0C265F96E43D!2477835&authkey=!AHh2k9FoNR-nFHo&ithint=file%2cmsi
  [NodeJsTools]: https://www.visualstudio.com/vs/node-js/
- [NuGetClient]: https://dist.nuget.org/win-x86-commandline/v3.3.0/nuget.exe

appveyor.yml

@@ -1,17 +1,16 @@
 version: 1.0.{build}
 skip_tags: true
-os: Visual Studio 2015
+os: Visual Studio 2017 RC
 configuration: Release
 cache:
- - '%USERPROFILE%\.nuget\packages -> **\project.json'
  - '%APPDATA%\npm-cache -> src\nerdbank-gitversioning.npm\package.json'
 init:
 - ps: >-
     git config --global user.name appveyor
 
     git config --global user.email [email protected]
 environment:
-  VisualStudioVersion: 14.0
+  VisualStudioVersion: 15.0
 install:
 - ps: >-
     npm install npm -g
@@ -21,7 +20,8 @@ before_build:
 
     #$blockRdp = $true; iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
 build_script:
-- ps: .\build.ps1
+- ps: >-
+    .\build.ps1
 artifacts:
 - path: bin\**\*.nupkg
 - path: bin\js\*.tgz

init.ps1

@@ -23,6 +23,9 @@ try {
         & "$toolsPath\Restore-NuGetPackages.ps1" -Path $_.FullName -Verbosity Quiet
     }
 
+    # Restore VS2017 style as well, since nuget 3.3 doesn't support it.
+    msbuild "$PSScriptRoot\src\NerdBank.GitVersioning.Tests\NerdBank.GitVersioning.Tests.csproj" /t:restore /v:minimal /m /nologo
+
     Write-Host "Restoring NPM packages..." -ForegroundColor Yellow
     Push-Location "$PSScriptRoot\src\nerdbank-gitversioning.npm"
     try {

src/Directory.Build.props

@@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <BaseIntermediateOutputPath>$(MSBuildThisFileDirectory)..\obj\$(MSBuildProjectName)\</BaseIntermediateOutputPath>
+    <OutputPath>$(MSBuildThisFileDirectory)..\bin\$(MSBuildProjectName)\$(Configuration)\</OutputPath>
+  </PropertyGroup>
+</Project>

src/NerdBank.GitVersioning.Tests/App.config

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<configuration>
+  <runtime>
+    <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
+      <dependentAssembly>
+        <assemblyIdentity name="Validation" publicKeyToken="2fc06f0d701809a7" culture="neutral" />
+        <bindingRedirect oldVersion="2.0.0.0" newVersion="2.3.0.0" />
+      </dependentAssembly>
+    </assemblyBinding>
+  </runtime>
+</configuration>

src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs

@@ -57,7 +57,7 @@ public BuildIntegrationTests(ITestOutputHelper logger)
         this.projectDirectory = Path.Combine(this.RepoPath, "projdir");
         Directory.CreateDirectory(this.projectDirectory);
         this.LoadTargetsIntoProjectCollection();
-        this.testProject = this.CreateProjectRootElement(this.projectDirectory, "test.proj");
+        this.testProject = this.CreateProjectRootElement(this.projectDirectory, "test.prj");
         this.globalProperties.Add("NerdbankGitVersioningTasksPath", Environment.CurrentDirectory + "\\");
         Environment.SetEnvironmentVariable("_NBGV_UnitTest", "true");
 
@@ -582,7 +582,7 @@ public async Task PublicRelease_RegEx_SatisfiedByCheckedOutBranch()
         {
             // Check out a branch that conforms.
             var releaseBranch = this.Repo.CreateBranch("release");
-            this.Repo.Checkout(releaseBranch);
+            Commands.Checkout(this.Repo, releaseBranch);
             var buildResult = await this.BuildAsync();
             Assert.True(buildResult.PublicRelease);
             AssertStandardProperties(versionOptions, buildResult);
@@ -888,7 +888,7 @@ private async Task<BuildResults> BuildAsync(string target = Targets.GetBuildVers
 
     private void LoadTargetsIntoProjectCollection()
     {
-        const string prefix = "Nerdbank.GitVersioning.Tests.Targets.";
+        string prefix = $"{ThisAssembly.RootNamespace}.Targets.";
 
         var streamNames = from name in Assembly.GetExecutingAssembly().GetManifestResourceNames()
                           where name.StartsWith(prefix, StringComparison.Ordinal)
@@ -905,7 +905,7 @@ where name.StartsWith(prefix, StringComparison.Ordinal)
 
     private ProjectRootElement CreateProjectRootElement(string projectDirectory, string projectName)
     {
-        using (var reader = XmlReader.Create(Assembly.GetExecutingAssembly().GetManifestResourceStream($"{ThisAssembly.RootNamespace}.test.proj")))
+        using (var reader = XmlReader.Create(Assembly.GetExecutingAssembly().GetManifestResourceStream($"{ThisAssembly.RootNamespace}.test.prj")))
         {
             var pre = ProjectRootElement.Create(reader, this.projectCollection);
             pre.FullPath = Path.Combine(projectDirectory, projectName);

src/NerdBank.GitVersioning.Tests/GitExtensionsTests.cs

@@ -47,7 +47,7 @@ public void GetHeight_Merge()
         var firstCommit = this.Repo.Commit("First", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
         var anotherBranch = this.Repo.CreateBranch("another");
         var secondCommit = this.Repo.Commit("Second", this.Signer, this.Signer, new CommitOptions { AllowEmptyCommit = true });
-        this.Repo.Checkout(anotherBranch);
+        Commands.Checkout(this.Repo, anotherBranch);
         Commit[] branchCommits = new Commit[5];
         for (int i = 1; i <= branchCommits.Length; i++)
         {
@@ -83,7 +83,7 @@ public void GetVersionHeight_VersionJsonHasUnrelatedHistory()
         string versionJsonPath = Path.Combine(this.RepoPath, "version.json");
         File.WriteAllText(versionJsonPath, @"{ ""unrelated"": false }");
         Assert.Equal(0, this.Repo.GetVersionHeight()); // exercise code that handles the file not yet checked in.
-        this.Repo.Stage(versionJsonPath);
+        Commands.Stage(this.Repo, versionJsonPath);
         this.Repo.Commit("Add unrelated version.json file.", this.Signer, this.Signer);
         Assert.Equal(1, this.Repo.GetVersionHeight()); // exercise code that handles a checked in file.
 
@@ -109,7 +109,7 @@ public void GetVersionHeight_VersionJsonHasParsingErrorsInHistory()
         string versionJsonPath = Path.Combine(this.RepoPath, "version.json");
         File.WriteAllText(versionJsonPath, @"{ ""version"": ""1.0"""); // no closing curly brace for parsing error
         Assert.Equal(0, this.Repo.GetVersionHeight());
-        this.Repo.Stage(versionJsonPath);
+        Commands.Stage(this.Repo, versionJsonPath);
         this.Repo.Commit("Add broken version.json file.", this.Signer, this.Signer);
         Assert.Equal(1, this.Repo.GetVersionHeight());
 

src/NerdBank.GitVersioning.Tests/NerdBank.GitVersioning.Tests.csproj

@@ -1,96 +1,29 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
-    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
-    <ProjectGuid>{C54F9EC8-FDA7-4D22-BCB2-7D97523BD91E}</ProjectGuid>
-    <OutputType>Library</OutputType>
-    <AppDesignerFolder>Properties</AppDesignerFolder>
-    <RootNamespace>Nerdbank.GitVersioning.Tests</RootNamespace>
-    <AssemblyName>NerdBank.GitVersioning.Tests</AssemblyName>
-    <TargetFrameworkVersion>v4.5.2</TargetFrameworkVersion>
-    <FileAlignment>512</FileAlignment>
-    <NuGetPackageImportStamp>
-    </NuGetPackageImportStamp>
-    <CopyNugetImplementations>true</CopyNugetImplementations>
+    <TargetFramework>net45</TargetFramework>
   </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.Build" />
-    <Reference Include="Microsoft.Build.Framework" />
-    <Reference Include="Microsoft.Build.Tasks.v4.0" />
-    <Reference Include="System" />
-    <Reference Include="System.Core" />
-    <Reference Include="System.Xml.Linq" />
-    <Reference Include="System.Data.DataSetExtensions" />
-    <Reference Include="Microsoft.CSharp" />
-    <Reference Include="System.Data" />
-    <Reference Include="System.Net.Http" />
-    <Reference Include="System.Xml" />
-  </ItemGroup>
-  <ItemGroup>
-    <Compile Include="BuildIntegrationTests.cs" />
-    <Compile Include="GitExtensionsTests.cs" />
-    <Compile Include="MSBuildExtensions.cs" />
-    <Compile Include="Properties\AssemblyInfo.cs" />
-    <Compile Include="RepoTestBase.cs" />
-    <Compile Include="SemanticVersionTests.cs" />
-    <Compile Include="TestUtilities.cs" />
-    <Compile Include="VersionExtensionsTests.cs" />
-    <Compile Include="VersionFileTests.cs" />
-    <Compile Include="VersionOptionsTests.cs" />
-    <Compile Include="VersionOracleTests.cs" />
-  </ItemGroup>
   <ItemGroup>
     <EmbeddedResource Include="..\Nerdbank.GitVersioning.NuGet\build\*.targets">
       <Visible>false</Visible>
       <Link>Targets\%(FileName)%(Extension)</Link>
     </EmbeddedResource>
-    <EmbeddedResource Include="Keys\keypair.snk" />
-    <EmbeddedResource Include="Keys\public.snk" />
-  </ItemGroup>
-  <ItemGroup>
-    <ProjectReference Include="..\NerdBank.GitVersioning.Tasks\Nerdbank.GitVersioning.Tasks.csproj">
-      <Project>{d76be1f9-5063-4443-b792-eaeecaa457d7}</Project>
-      <Name>Nerdbank.GitVersioning.Tasks</Name>
-    </ProjectReference>
-    <ProjectReference Include="..\NerdBank.GitVersioning\NerdBank.GitVersioning.csproj">
-      <Project>{50d7b410-d986-499a-9fd1-fbbb55b095bd}</Project>
-      <Name>NerdBank.GitVersioning</Name>
-    </ProjectReference>
+    <EmbeddedResource Include="Keys\*.snk" />
+    <EmbeddedResource Include="Keys\*.pfx" />
+    <EmbeddedResource Include="test.prj" />
+    <EmbeddedResource Include="repos\submodules.7z" />
   </ItemGroup>
   <ItemGroup>
-    <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
+    <ProjectReference Include="..\Nerdbank.GitVersioning.Tasks\Nerdbank.GitVersioning.Tasks.csproj" />
+    <ProjectReference Include="..\NerdBank.GitVersioning\NerdBank.GitVersioning.csproj" />
   </ItemGroup>
   <ItemGroup>
-    <EmbeddedResource Include="Keys\protectedPair.pfx" />
-    <None Include="project.json" />
-    <EmbeddedResource Include="test.proj" />
-    <EmbeddedResource Include="repos\submodules.7z" />
+    <PackageReference Include="7z.NET" Version="1.0.3" />
+    <PackageReference Include="System.Collections.Immutable" Version="1.3.1" />
+    <PackageReference Include="Microsoft.Build" Version="14.3" Condition=" '$(TargetFramework)' == 'net45' " />
+    <PackageReference Include="Xunit.Combinatorial" Version="1.1.12" />
+    <PackageReference Include="xunit" Version="2.1.0" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="1.1.1" />
+    <PackageReference Include="Nerdbank.GitVersioning.LKG" Version="1.5.108-g37118a0bd6" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.1.0" />
   </ItemGroup>
-  <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
-  <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
-       Other similar extension points exist, see Microsoft.Common.targets.
-  <Target Name="BeforeBuild">
-  </Target>
-  <Target Name="AfterBuild">
-  </Target>
-  -->
 </Project>

src/NerdBank.GitVersioning.Tests/Properties/AssemblyInfo.cs

@@ -61,7 +61,7 @@ protected void InitializeSourceControl()
             this.Repo = new Repository(this.RepoPath);
             foreach (var file in this.Repo.RetrieveStatus().Untracked)
             {
-                this.Repo.Stage(file.FilePath);
+                Commands.Stage(this.Repo, file.FilePath);
             }
 
             if (this.Repo.Index.Count > 0)