Skip to content

Commit af3e7c4

Browse files
russcamrusscam
authored
Merge pull request #13 from elastic/feature/differ
Port Differ to console application
2 parents fa9f7b9 + d815722 commit af3e7c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1349
-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>

‎License.txt

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use thes
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.

‎README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,12 @@ Works with `.NET Core` and `.NET 4.6` and up.
2222

2323
Supports `dotnet xunit`, `dotnet test`, `xunit.console.runner` and tests will be runnable in your IDE through VSTest and jetBrains Rider.
2424

25+
### [Differ](src/Differ/README.md)
26+
27+
Compare and Diff assemblies from different sources e.g. assemblies, directories, GitHub commit, NuGet packages.
28+
Useful for determining what changes are introduced across versions, and if any are _breaking_.
29+
30+
Outputs differences in XML, Markdown or AsciiDoc.
31+
2532

2633

‎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+
}

0 commit comments

Comments
 (0)