Skip to content

Commit ee6d607

Browse files
russcamrusscam
committed
Port Differ to console application
This commit ports the Differ F# script over to a console application, and includes a number of improvements: - Correct resolution of NuGet references respective to target framework - Ability to diff any two assembly providers e.g. compare NuGet package to the build of a GitHub commit compare loacl assembly to NuGet package, etc. Closes elastic/elasticsearch-net#3305
1 parent eb8dd2c commit ee6d607

39 files changed

+1100
-3
lines changed

‎.paket/Paket.Restore.targets‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@
7272
<PaketRestoreRequired Condition=" '$(PaketRestoreLockFileHash)' == '' ">true</PaketRestoreRequired>
7373
</PropertyGroup>
7474

75+
<PropertyGroup Condition="'$(PaketPropsVersion)' != '5.174.2' ">
76+
<PaketRestoreRequired>true</PaketRestoreRequired>
77+
</PropertyGroup>
7578

7679
<!-- Do a global restore if required -->
7780
<Exec Command='$(PaketBootStrapperCommand)' Condition="Exists('$(PaketBootStrapperExePath)') AND !(Exists('$(PaketExePath)'))" ContinueOnError="false" />
@@ -93,7 +96,7 @@
9396
<PaketOriginalReferencesFilePath Condition=" !Exists('$(PaketOriginalReferencesFilePath)')">$(MSBuildProjectDirectory)\$(MSBuildProjectName).paket.references</PaketOriginalReferencesFilePath>
9497
<!-- paket.references -->
9598
<PaketOriginalReferencesFilePath Condition=" !Exists('$(PaketOriginalReferencesFilePath)')">$(MSBuildProjectDirectory)\paket.references</PaketOriginalReferencesFilePath>
96-
99+
97100
<DoAllResolvedFilesExist>false</DoAllResolvedFilesExist>
98101
<DoAllResolvedFilesExist Condition="Exists(%(PaketResolvedFilePaths.Identity))">true</DoAllResolvedFilesExist>
99102
<PaketRestoreRequired>true</PaketRestoreRequired>
@@ -132,11 +135,11 @@
132135
<Error Condition=" '$(DoAllResolvedFilesExist)' != 'true' AND '$(ResolveNuGetPackages)' != 'False' " Text="One Paket file '@(PaketResolvedFilePaths)' is missing while restoring $(MSBuildProjectFile). Please delete 'paket-files/paket.restore.cached' and call 'paket restore'." />
133136

134137
<!-- Step 4 forward all msbuild properties (PackageReference, DotNetCliToolReference) to msbuild -->
135-
<ReadLinesFromFile Condition="'@(PaketResolvedFilePaths)' != ''" File="%(PaketResolvedFilePaths.Identity)" ><!--Condition="Exists('%(PaketResolvedFilePaths.Identity)')"-->
138+
<ReadLinesFromFile Condition="($(DesignTimeBuild) != true OR '$(PaketPropsLoaded)' != 'true') AND '@(PaketResolvedFilePaths)' != ''" File="%(PaketResolvedFilePaths.Identity)" >
136139
<Output TaskParameter="Lines" ItemName="PaketReferencesFileLines"/>
137140
</ReadLinesFromFile>
138141

139-
<ItemGroup Condition=" '@(PaketReferencesFileLines)' != '' " >
142+
<ItemGroup Condition="($(DesignTimeBuild) != true OR '$(PaketPropsLoaded)' != 'true') AND '@(PaketReferencesFileLines)' != '' " >
140143
<PaketReferencesFileLinesInfo Include="@(PaketReferencesFileLines)" >
141144
<PackageName>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[0])</PackageName>
142145
<PackageVersion>$([System.String]::Copy('%(PaketReferencesFileLines.Identity)').Split(',')[1])</PackageVersion>

‎src/Differ/AssemblyDiffPair.cs‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using System;
2+
using System.IO;
3+
using JustAssembly.Core;
4+
5+
namespace Differ
6+
{
7+
public class AssemblyDiffPair
8+
{
9+
public AssemblyDiffPair(FileInfo first, FileInfo second)
10+
{
11+
First = first ?? throw new ArgumentNullException(nameof(first));
12+
Second = second ?? throw new ArgumentNullException(nameof(second));
13+
}
14+
15+
public FileInfo First { get; }
16+
public FileInfo Second { get; }
17+
public IDiffItem Diff { get; set; }
18+
}
19+
}

‎src/Differ/Differ.csproj‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<OutputType>Exe</OutputType>
4+
<TargetFramework>net462</TargetFramework>
5+
<LangVersion>7.1</LangVersion>
6+
</PropertyGroup>
7+
<ItemGroup>
8+
<PackageReference Include="Mono.Options" Version="5.3.0.1" />
9+
<PackageReference Include="NuGet.Frameworks" Version="4.8.0" />
10+
<PackageReference Include="Proc" Version="0.3.7" />
11+
<PackageReference Include="System.IO.Compression" Version="4.3.0" />
12+
</ItemGroup>
13+
<ItemGroup>
14+
<Folder Include="lib" />
15+
</ItemGroup>
16+
<ItemGroup>
17+
<Reference Include="JustAssembly.API, Version=0.0.0.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
18+
<HintPath>lib\JustAssembly.API.dll</HintPath>
19+
</Reference>
20+
<Reference Include="JustAssembly.Core, Version=2017.2.713.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
21+
<HintPath>lib\JustAssembly.Core.dll</HintPath>
22+
</Reference>
23+
<Reference Include="JustAssembly.Infrastructure, Version=2017.2.713.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
24+
<HintPath>lib\JustAssembly.Infrastructure.dll</HintPath>
25+
</Reference>
26+
<Reference Include="JustDecompile.External.JustAssembly, Version=2017.2.705.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
27+
<HintPath>lib\JustDecompile.External.JustAssembly.dll</HintPath>
28+
</Reference>
29+
<Reference Include="JustDecompiler, Version=2017.2.705.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
30+
<HintPath>lib\JustDecompiler.dll</HintPath>
31+
</Reference>
32+
<Reference Include="Telerik.JustDecompile.Mono.Cecil, Version=2017.2.705.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
33+
<HintPath>lib\Telerik.JustDecompile.Mono.Cecil.dll</HintPath>
34+
</Reference>
35+
<Reference Include="Telerik.JustDecompile.Mono.Cecil.Mdb, Version=2017.2.705.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
36+
<HintPath>lib\Telerik.JustDecompile.Mono.Cecil.Mdb.dll</HintPath>
37+
</Reference>
38+
<Reference Include="Telerik.JustDecompile.Mono.Cecil.Pdb, Version=2017.2.705.1, Culture=neutral, PublicKeyToken=2b2cea67609c9510">
39+
<HintPath>lib\Telerik.JustDecompile.Mono.Cecil.Pdb.dll</HintPath>
40+
</Reference>
41+
</ItemGroup>
42+
</Project>

‎src/Differ/Exporters/AsciiDocExporter.cs‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
using System;
2+
using System.IO;
3+
using System.Linq;
4+
using System.Text.RegularExpressions;
5+
using System.Xml.Linq;
6+
using JustAssembly.Core;
7+
8+
namespace Differ.Exporters
9+
{
10+
public class AsciiDocExporter : IExporter
11+
{
12+
public string Format { get; } = "asciidoc";
13+
14+
public void Export(AssemblyDiffPair assemblyDiffPair, string outputPath)
15+
{
16+
// IDiffItem implementations are internal so parse from XML for now
17+
var xml = assemblyDiffPair.Diff.ToXml();
18+
var doc = XDocument.Parse(xml);
19+
var name = assemblyDiffPair.First.Name;
20+
using (var writer = new StreamWriter(Path.Combine(outputPath, Path.ChangeExtension(name, "asciidoc"))))
21+
{
22+
writer.WriteLine($"== Breaking changes for {Path.GetFileNameWithoutExtension(name)}");
23+
writer.WriteLine();
24+
25+
foreach (var typeElement in doc.Descendants("Type"))
26+
WriteTypeElement(writer, typeElement);
27+
}
28+
}
29+
30+
private void WriteTypeElement(StreamWriter writer, XElement typeElement)
31+
{
32+
var typeName = typeElement.Attribute("Name")?.Value;
33+
var diffType = (DiffType) Enum.Parse(typeof(DiffType), typeElement.Attribute("DiffType").Value);
34+
35+
switch(diffType)
36+
{
37+
case DiffType.Deleted:
38+
writer.WriteLine($"[float]{Environment.NewLine}=== `{typeName}` is deleted");
39+
break;
40+
case DiffType.Modified:
41+
WriteMemberElements(writer, typeName, typeElement);
42+
break;
43+
case DiffType.New:
44+
writer.WriteLine($"[float]{Environment.NewLine}=== `{typeName}` is added");
45+
break;
46+
default:
47+
throw new ArgumentOutOfRangeException();
48+
}
49+
}
50+
51+
private void WriteMemberElements(StreamWriter writer, string typeName, XElement typeElement)
52+
{
53+
var memberElements = typeElement.Elements("Method").Concat(typeElement.Elements("Property"));
54+
55+
if (memberElements.Any())
56+
writer.WriteLine($"[float]{Environment.NewLine}=== `{typeName}`");
57+
58+
foreach (var memberElement in memberElements)
59+
{
60+
var memberName = memberElement.Attribute("Name")?.Value;
61+
if (!string.IsNullOrEmpty(memberName) && Enum.TryParse(typeElement.Attribute("DiffType")?.Value, out DiffType diffType))
62+
{
63+
switch (diffType)
64+
{
65+
case DiffType.Deleted:
66+
writer.WriteLine($"[float]{Environment.NewLine}==== `{memberName}` is deleted");
67+
break;
68+
case DiffType.Modified:
69+
var diffItem = memberElement.Descendants("DiffItem").FirstOrDefault();
70+
if (diffItem != null)
71+
{
72+
writer.WriteLine($"[float]{Environment.NewLine}==== `{memberName}`");
73+
writer.WriteLine(
74+
Regex.Replace(diffItem.Value, "changed from (.*?) to (.*).", "changed from `$1` to `$2`."));
75+
}
76+
break;
77+
case DiffType.New:
78+
writer.WriteLine($"[float]{Environment.NewLine}==== `{memberName}` is added");
79+
break;
80+
default:
81+
throw new ArgumentOutOfRangeException();
82+
}
83+
}
84+
}
85+
}
86+
}
87+
}

‎src/Differ/Exporters/ExporterCollection.cs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
using System;
2+
using System.Collections.ObjectModel;
3+
using System.Linq;
4+
5+
namespace Differ.Exporters
6+
{
7+
public class ExporterCollection : KeyedCollection<string, IExporter>
8+
{
9+
protected override string GetKeyForItem(IExporter item) => item.Format;
10+
11+
public ExporterCollection(params IExporter[] exporters)
12+
{
13+
if (exporters == null)
14+
throw new ArgumentNullException(nameof(exporters));
15+
16+
foreach (var exporter in exporters)
17+
this.Add(exporter);
18+
}
19+
20+
public string SupportedFormats => string.Join(", ", this.Select(e => e.Format));
21+
}
22+
}

‎src/Differ/Exporters/IExporter.cs‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
using JustAssembly.Core;
2+
3+
namespace Differ.Exporters
4+
{
5+
public interface IExporter
6+
{
7+
string Format { get; }
8+
9+
void Export(AssemblyDiffPair assemblyDiffPair, string outputPath);
10+
}
11+
}

‎src/Differ/Exporters/MarkdownExporter.cs‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
using System;
2+
using System.IO;
3+
using System.Linq;
4+
using System.Text.RegularExpressions;
5+
using System.Xml.Linq;
6+
using JustAssembly.Core;
7+
8+
namespace Differ.Exporters
9+
{
10+
public class MarkdownExporter : IExporter
11+
{
12+
public string Format { get; } = "markdown";
13+
14+
public void Export(AssemblyDiffPair assemblyDiffPair, string outputPath)
15+
{
16+
// IDiffItem implementations are internal so parse from XML for now
17+
var xml = assemblyDiffPair.Diff.ToXml();
18+
var doc = XDocument.Parse(xml);
19+
var name = assemblyDiffPair.First.Name;
20+
using (var writer = new StreamWriter(Path.Combine(outputPath, Path.ChangeExtension(name, "md"))))
21+
{
22+
writer.WriteLine($"# Breaking changes for {Path.GetFileNameWithoutExtension(name)}");
23+
writer.WriteLine();
24+
25+
foreach (var typeElement in doc.Descendants("Type"))
26+
WriteTypeElement(writer, typeElement);
27+
}
28+
}
29+
30+
private void WriteTypeElement(StreamWriter writer, XElement typeElement)
31+
{
32+
var typeName = typeElement.Attribute("Name")?.Value;
33+
var diffType = (DiffType) Enum.Parse(typeof(DiffType), typeElement.Attribute("DiffType").Value);
34+
35+
switch(diffType)
36+
{
37+
case DiffType.Deleted:
38+
writer.WriteLine($"## `{typeName}` is deleted");
39+
break;
40+
case DiffType.Modified:
41+
WriteMemberElements(writer, typeName, typeElement);
42+
break;
43+
case DiffType.New:
44+
writer.WriteLine($"## `{typeName}` is added");
45+
break;
46+
default:
47+
throw new ArgumentOutOfRangeException();
48+
}
49+
}
50+
51+
private void WriteMemberElements(StreamWriter writer, string typeName, XElement typeElement)
52+
{
53+
var memberElements = typeElement.Elements("Method").Concat(typeElement.Elements("Property"));
54+
55+
if (memberElements.Any())
56+
writer.WriteLine($"## `{typeName}`");
57+
58+
foreach (var memberElement in memberElements)
59+
{
60+
var memberName = memberElement.Attribute("Name")?.Value;
61+
if (!string.IsNullOrEmpty(memberName) && Enum.TryParse(typeElement.Attribute("DiffType")?.Value, out DiffType diffType))
62+
{
63+
switch (diffType)
64+
{
65+
case DiffType.Deleted:
66+
writer.WriteLine($"### `{memberName}` is deleted");
67+
break;
68+
case DiffType.Modified:
69+
var diffItem = memberElement.Descendants("DiffItem").FirstOrDefault();
70+
if (diffItem != null)
71+
{
72+
writer.WriteLine($"### `{memberName}`");
73+
writer.WriteLine(
74+
Regex.Replace(diffItem.Value, "changed from (.*?) to (.*).", "changed from `$1` to `$2`."));
75+
}
76+
break;
77+
case DiffType.New:
78+
writer.WriteLine($"### `{memberName}` is added");
79+
break;
80+
default:
81+
throw new ArgumentOutOfRangeException();
82+
}
83+
}
84+
}
85+
}
86+
}
87+
}

‎src/Differ/Exporters/XmlExporter.cs‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
using System;
2+
using System.IO;
3+
4+
namespace Differ.Exporters
5+
{
6+
public class XmlExporter : IExporter
7+
{
8+
public string Format { get; } = "xml";
9+
10+
public void Export(AssemblyDiffPair assemblyDiffPair, string outputPath)
11+
{
12+
var xml = assemblyDiffPair.Diff.ToXml();
13+
using (var writer = new StreamWriter(Path.Combine(outputPath, Path.ChangeExtension(assemblyDiffPair.First.Name, "xml"))))
14+
writer.Write(xml);
15+
}
16+
}
17+
}

0 commit comments

Comments
 (0)