SourceLink.Test (#147)

* SourceLink.Test nupkg #136 * adjusted readme for trying out 2.0.0 * fix appveyor url * remove SourceLink.props * remove props reference mistake * debug appveyor paths * try removing duplicate slash * check powershell version * set location * try including build output * don't rename and separte out OutputPath * include explicit dll reference * forgot the $ * root cause *.targets;$(OutputPath)*.* didn't work on appveyor * guess not, try just dlls * explicit for msbuild projects * adjust tool help
ctaggart · Feb 25, 2017 · a99f6b1 · a99f6b1
1 parent 5be8ea9
commit a99f6b1
Show file tree

Hide file tree

Showing 15 changed files with 177 additions and 38 deletions.
diff --git a/NuGet.Config b/NuGet.Config
@@ -2,6 +2,6 @@
 <configuration>
   <packageSources>
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
-    <add key="sourcelink" value="https://ci.appveyor.com/nuget/sourcelink" />
+    <add key="sourcelink" value="https://ci.appveyor.com/nuget/sourcelink/" />
   </packageSources>
 </configuration>
diff --git a/README.md b/README.md
@@ -18,17 +18,19 @@ SourceLink v2 is a set of dotnet and msbuild tools to help create the source lin
 /sourcelink:<file>            Source link info to embed into Portable PDB.
 ```
 
-SourceLine v2 is [under active development](https://github.com/ctaggart/SourceLink/milestone/16) and a prerelease will be out soon. Installation will hopefully be as simple as adding a single reference to one of the SourceLink.Create NuGet packages.
+A prerelease of SourceLine v2 is available. Updated docs are coming soon. Add the references below to your project file and it should run automatically on a CI server. To try it out locally, you can do `dotnet build /p:ci=true /v:n`.
 
 ``` xml
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>netstandard1.4</TargetFramework>
+    <TargetFramework>netstandard1.6</TargetFramework>
     <DebugType>Portable</DebugType>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="SourceLink.Create.GitHub" Version="2.0.0-*" />
+    <PackageReference Include="SourceLink.Test" Version="2.0.0-*" />
     <DotNetCliToolReference Include="dotnet-sourcelink-git" Version="2.0.0-*" />
+    <DotNetCliToolReference Include="dotnet-sourcelink" Version="2.0.0-*" />
   </ItemGroup>
 </Project>
 ```

diff --git a/SourceLink.Create.GitHub/CreateTask.cs b/SourceLink.Create.GitHub/CreateTask.cs
@@ -1,6 +1,5 @@
 using Microsoft.Build.Framework;
 using MSBuildTask = Microsoft.Build.Utilities.Task;
-using System.Diagnostics;
 using System.Text;
 using System;
 using IO = System.IO;
@@ -33,16 +32,6 @@ public class CreateTask : MSBuildTask
         [Output]
         public string[] EmbeddedFiles { get; set; }
 
-        DataReceivedEventHandler LogMessageHander(MessageImportance importance)
-        {
-            return (s, e) => {
-                if (e.Data != null) // end
-                {
-                    Log.LogMessage(importance, e.Data);
-                }
-            };
-        }
-
         public override bool Execute()
         {
             var url = Url;

diff --git a/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj b/SourceLink.Create.GitHub/SourceLink.Create.GitHub.csproj
@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netstandard1.3</TargetFramework>
+    <TargetFramework>netstandard1.6</TargetFramework>
     <!-- https://github.com/NuGet/Home/wiki/Adding-nuget-pack-as-a-msbuild-target -->
     <IncludeBuildOutput>false</IncludeBuildOutput>
 
@@ -17,12 +17,24 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="15.1.0-preview-000545-01" />
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="14.3.0" />
   </ItemGroup>
 
   <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
   <ItemGroup Label="dotnet pack instructions">
-    <Content Include="*.targets;$(OutputPath)\*.*">
+    <Content Include="SourceLink.Create.GitHub.targets">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Create.GitHub.dll">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Create.GitHub.deps.json">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Create.GitHub.pdb">
       <Pack>true</Pack>
       <PackagePath>build</PackagePath>
     </Content>

diff --git a/SourceLink.Test/SourceLink.Test.csproj b/SourceLink.Test/SourceLink.Test.csproj
@@ -0,0 +1,46 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netstandard1.6</TargetFramework>
+    <!-- https://github.com/NuGet/Home/wiki/Adding-nuget-pack-as-a-msbuild-target -->
+    <IncludeBuildOutput>false</IncludeBuildOutput>
+
+    <Authors>Cameron Taggart</Authors>
+    <PackageLicenseUrl>https://opensource.org/licenses/MIT</PackageLicenseUrl>
+    <PackageIconUrl>https://ctaggart.github.io/SourceLink/SourceLink128.jpg</PackageIconUrl>
+    <PackageProjectUrl>https://github.com/ctaggart/SourceLink</PackageProjectUrl>
+    <PackageTags>sourcelink pdb symbols git sourceindexing debugging sourceserver build</PackageTags>
+    <Description>
+      SourceLink: Source Code On Demand
+      Source Link your Portable PDB files to allow source code to be downloaded on demand
+    </Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="14.3.0" />
+  </ItemGroup>
+
+  <!-- https://docs.microsoft.com/en-us/dotnet/articles/core/preview3/tools/extensibility -->
+  <ItemGroup Label="dotnet pack instructions">
+    <Content Include="SourceLink.Test.targets">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Test.dll">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Test.deps.json">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+    <Content Include="$(OutputPath)SourceLink.Test.pdb">
+      <Pack>true</Pack>
+      <PackagePath>build</PackagePath>
+    </Content>
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="..\SourceLink.Create.GitHub\Process.cs" Link="Process.cs" />
+  </ItemGroup>
+
+</Project>
diff --git a/SourceLink.Test/SourceLink.Test.targets b/SourceLink.Test/SourceLink.Test.targets
@@ -0,0 +1,16 @@
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+
+  <UsingTask TaskName="SourceLink.Test.TestTask" AssemblyFile="SourceLink.Test.dll" />
+
+  <PropertyGroup>
+    <!-- enable only in CI environments by default -->
+    <SourceLinkTest Condition="'$(SourceLinkTest)' == ''">$(CI)</SourceLinkTest>
+    <CompileDependsOn Condition="'$(SourceLinkTest)' == 'true'">$(CompileDependsOn);SourceLinkTest</CompileDependsOn>
+    <SourceLinkPdb Condition="'$(SourceLinkPdb)' == ''">$(PdbFile)</SourceLinkPdb>
+    <SourceLinkPdb Condition="'$(SourceLinkPdb)' == ''">$(IntermediateOutputPath)$(TargetName).pdb</SourceLinkPdb>
+  </PropertyGroup>
+
+  <Target Name="SourceLinkTest">
+    <SourceLink.Test.TestTask Pdb="$(SourceLinkPdb)" />
+  </Target>
+</Project>
diff --git a/SourceLink.Test/TestTask.cs b/SourceLink.Test/TestTask.cs
@@ -0,0 +1,39 @@
+using Microsoft.Build.Framework;
+using MSBuildTask = Microsoft.Build.Utilities.Task;
+using System.Diagnostics;
+using System.Text;
+
+namespace SourceLink.Test
+{
+    public class TestTask : MSBuildTask
+    {
+        [Required]
+        public string Pdb { get; set; }
+
+        public override bool Execute()
+        {
+            var sbArgs = new StringBuilder();
+            sbArgs.Append("sourcelink test");
+            sbArgs.Append(" \"" + Pdb + "\"");
+            var args = sbArgs.ToString();
+
+            var create = Process.RunAndGetOutput("dotnet", args);
+            if (create.ExitCode != 0)
+            {
+                Log.LogMessage(MessageImportance.High, "dotnet " + args);
+                foreach (var line in create.OutputLines)
+                    Log.LogMessage(MessageImportance.High, line);
+                Log.LogError("exit code " + create.ExitCode + " when running: dotnet " + args);
+            }
+            else
+            {
+                Log.LogMessage(MessageImportance.Normal, "dotnet " + args);
+                foreach (var line in create.OutputLines)
+                    Log.LogMessage(MessageImportance.Normal, line);
+            }
+
+            return !Log.HasLoggedErrors;
+        }
+
+    }
+}
diff --git a/SourceLink.sln b/SourceLink.sln
@@ -19,6 +19,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "dotnet-sourcelink-git", "do
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "Tests\Tests.csproj", "{13B28F5D-43CA-4243-A932-3352BB788216}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SourceLink.Test", "SourceLink.Test\SourceLink.Test.csproj", "{76A52AA7-0433-4B6C-831C-2C2CEB371082}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -77,6 +79,18 @@ Global
 		{13B28F5D-43CA-4243-A932-3352BB788216}.Release|x64.Build.0 = Release|x64
 		{13B28F5D-43CA-4243-A932-3352BB788216}.Release|x86.ActiveCfg = Release|x86
 		{13B28F5D-43CA-4243-A932-3352BB788216}.Release|x86.Build.0 = Release|x86
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|x64.ActiveCfg = Debug|x64
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|x64.Build.0 = Debug|x64
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|x86.ActiveCfg = Debug|x86
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Debug|x86.Build.0 = Debug|x86
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|Any CPU.Build.0 = Release|Any CPU
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|x64.ActiveCfg = Release|x64
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|x64.Build.0 = Release|x64
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|x86.ActiveCfg = Release|x86
+		{76A52AA7-0433-4B6C-831C-2C2CEB371082}.Release|x86.Build.0 = Release|x86
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/Tests/Tests.csproj b/Tests/Tests.csproj
@@ -5,7 +5,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Build.Utilities.Core" Version="15.1.0-preview-000545-01" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0-preview-20170217-05" />
     <PackageReference Include="xunit" Version="2.2.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />

diff --git a/appveyor.yml b/appveyor.yml
@@ -2,6 +2,7 @@ os: Visual Studio 2017 RC
 clone_depth: 10
 build_script:
   - ps: |
+      dotnet --version
       .\build.ps1
       if ($lastexitcode -ne 0){ exit $lastexitcode }
 test: off

diff --git a/build.ps1 b/build.ps1
@@ -1,5 +1,5 @@
 $version = '2.0.0' # the version under development, update after a release
-$versionSuffix = '-a057' # manually incremented for local builds
+$versionSuffix = '-a088' # manually incremented for local builds
 
 function isVersionTag($tag){
     $v = New-Object Version
@@ -17,21 +17,24 @@ if ($env:appveyor){
 
 $pack = "pack", "-c", "release", "--include-symbols", "-o", "../bin", "/p:Version=$version$versionSuffix"
 
-Push-Location .\dotnet-sourcelink
+Set-Location $psscriptroot\dotnet-sourcelink
 dotnet restore
 dotnet $pack
-Pop-Location
 
-Push-Location .\dotnet-sourcelink-git
+Set-Location $psscriptroot\dotnet-sourcelink-git
 dotnet restore
 dotnet $pack
-Pop-Location
 
-Push-Location .\SourceLink.Create.GitHub
+Set-Location $psscriptroot\SourceLink.Create.GitHub
+dotnet msbuild /t:Paths
 dotnet restore
 dotnet $pack
-Pop-Location
 
+Set-Location $psscriptroot\SourceLink.Test
+dotnet restore
+dotnet $pack
+
+Set-Location $psscriptroot
 bash .\build-rename.sh
 
 # testing on local nuget feed

diff --git a/dotnet-sourcelink-git/Program.cs b/dotnet-sourcelink-git/Program.cs
@@ -13,10 +13,8 @@ public class Program
     {
         public static int Main(string[] args)
         {
-            var app = new CommandLineApplication()
-            {
-                Name = "dotnet sourcelink-git",
-            };
+            var app = new CommandLineApplication();
+            app.FullName = "Source Code On Demand";
             app.HelpOption("-h|--help");
 
             app.Command("repo", PrintRepo);
@@ -25,6 +23,7 @@ public static int Main(string[] args)
 
             if (args.Length == 0)
             {
+                Console.WriteLine("SourceLink Git " + Version.GetAssemblyInformationalVersion());
                 app.ShowHelp();
                 return 0;
             }
@@ -258,12 +257,12 @@ public static void Create(CommandLineApplication command)
                     js.Serialize(sw, json);
                 }
 
+                //var embedFile = embedOption.Value();
+                //if (String.IsNullOrEmpty(embedFile))
+                var embedFile = Path.ChangeExtension(file, ".embed");
                 if (embedFiles.Count > 0)
                 {
                     Console.WriteLine("embedding " + embedFiles.Count + " source files");
-                    //var embedFile = embedOption.Value();
-                    //if (String.IsNullOrEmpty(embedFile))
-                    var embedFile = Path.ChangeExtension(file, ".embed");
                     using (var sw = new StreamWriter(File.OpenWrite(embedFile)))
                     {
                         foreach (var sf in embedFiles)
@@ -272,6 +271,11 @@ public static void Create(CommandLineApplication command)
                         }
                     }
                 }
+                else
+                {
+                    if (File.Exists(embedFile))
+                        File.Delete(embedFile);
+                }
 
                 return errors == 0 ? 0 : 1;
             });

diff --git a/dotnet-sourcelink-git/dotnet-sourcelink-git.csproj b/dotnet-sourcelink-git/dotnet-sourcelink-git.csproj
@@ -17,6 +17,7 @@
   <ItemGroup>
     <Compile Include="..\dotnet-sourcelink\SourceLinkJson.cs" Link="SourceLinkJson.cs" />
     <Compile Include="..\dotnet-sourcelink\System.cs" Link="System.cs" />
+    <Compile Include="..\dotnet-sourcelink\Version.cs" Link="Version.cs" />
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="LibGit2Sharp.Portable" Version="0.24.10" />

diff --git a/dotnet-sourcelink/Program.cs b/dotnet-sourcelink/Program.cs
@@ -16,12 +16,8 @@ public class Program
     {
         public static int Main(string[] args)
         {
-            var app = new CommandLineApplication()
-            {
-                Name = "dotnet sourcelink",
-                FullName = "SourceLink: Source Code On Demand",
-                Description = "Source Link your Portable PDB files to allow source code to be downloaded on demand from the source code repository host"
-            };
+            var app = new CommandLineApplication();
+            app.FullName = "Source Code On Demand";
             app.HelpOption("-h|--help");
 
             app.Command("print-json", PrintJson);
@@ -31,6 +27,7 @@ public static int Main(string[] args)
 
             if (args.Length == 0)
             {
+                Console.WriteLine("SourceLink " + Version.GetAssemblyInformationalVersion());
                 app.ShowHelp();
                 return 0;
             }
@@ -301,6 +298,7 @@ public static IEnumerable<Document> GetDocumentsWithUrls(string pdb)
 
         public static string GetUrl(string file, SourceLinkJson json)
         {
+            if (json == null) return null;
             foreach (var key in json.documents.Keys)
             {
                 if (key.Contains("*"))

diff --git a/dotnet-sourcelink/Version.cs b/dotnet-sourcelink/Version.cs
@@ -0,0 +1,15 @@
+using System.Reflection;
+
+namespace SourceLink
+{
+    public static class Version
+    {
+        public static string GetAssemblyInformationalVersion()
+        {
+            var assembly = Assembly.GetEntryAssembly();
+            var attribute = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>();
+            if (attribute == null) return null;
+            return attribute.InformationalVersion;
+        }
+    }
+}