Skip to content

Add GitVersionInformationAttribute to make reflection easier #526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed

Add GitVersionInformationAttribute to make reflection easier #526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f0396f1
R# cleanup
asbjornu Jul 21, 2015
c827ee9
Remove extranous whitespace from the generated AssemblyInfo file
asbjornu Jul 21, 2015
c53fab7
Add GitVersionInformationAttribute to generated assembly info files t…
asbjornu Jul 21, 2015
e8c4bcb
Add [AttributeUsage(AttributeTargets.Assembly)] to the custom assembl…
asbjornu Jul 21, 2015
c76ac0e
Verify that the generated assembly info contains the GitVersionInform…
asbjornu Jul 21, 2015
fb4d3d9
Just be sure that none of the variables we're comparing against are `…
asbjornu Jul 21, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_Major.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@

using System;
using System;
using System.Reflection;

[assembly: AssemblyVersion("2.0.0.0")]
[assembly: AssemblyFileVersion("2.3.4.0")]
[assembly: AssemblyInformationalVersion("2.3.4-beta.5+6.Branch.master.Sha.commitSha")]
[assembly: ReleaseDate("2014-03-06")]
[assembly: GitVersionInformation()]

[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class ReleaseDateAttribute : System.Attribute
{
public string Date { get; private set; }
Expand Down Expand Up @@ -40,7 +41,29 @@ static class GitVersionInformation
public static string NuGetVersionV2 = "2.3.4-beta0005";
public static string NuGetVersion = "2.3.4-beta0005";
public static string CommitDate = "2014-03-06";

}


[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class GitVersionInformationAttribute : System.Attribute
{
public string Major { get { return "2"; } }
public string Minor { get { return "3"; } }
public string Patch { get { return "4"; } }
public string PreReleaseTag { get { return "beta.5"; } }
public string PreReleaseTagWithDash { get { return "-beta.5"; } }
public string BuildMetaData { get { return "6"; } }
public string FullBuildMetaData { get { return "6.Branch.master.Sha.commitSha"; } }
public string MajorMinorPatch { get { return "2.3.4"; } }
public string SemVer { get { return "2.3.4-beta.5"; } }
public string LegacySemVer { get { return "2.3.4-beta5"; } }
public string LegacySemVerPadded { get { return "2.3.4-beta0005"; } }
public string AssemblySemVer { get { return "2.0.0.0"; } }
public string FullSemVer { get { return "2.3.4-beta.5+6"; } }
public string InformationalVersion { get { return "2.3.4-beta.5+6.Branch.master.Sha.commitSha"; } }
public string BranchName { get { return "master"; } }
public string Sha { get { return "commitSha"; } }
public string NuGetVersionV2 { get { return "2.3.4-beta0005"; } }
public string NuGetVersion { get { return "2.3.4-beta0005"; } }
public string CommitDate { get { return "2014-03-06"; } }
}
31 changes: 27 additions & 4 deletions ...tVersionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinor.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@

using System;
using System;
using System.Reflection;

[assembly: AssemblyVersion("2.3.0.0")]
[assembly: AssemblyFileVersion("2.3.4.0")]
[assembly: AssemblyInformationalVersion("2.3.4-beta.5+6.Branch.master.Sha.commitSha")]
[assembly: ReleaseDate("2014-03-06")]
[assembly: GitVersionInformation()]

[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class ReleaseDateAttribute : System.Attribute
{
public string Date { get; private set; }
Expand Down Expand Up @@ -40,7 +41,29 @@ static class GitVersionInformation
public static string NuGetVersionV2 = "2.3.4-beta0005";
public static string NuGetVersion = "2.3.4-beta0005";
public static string CommitDate = "2014-03-06";

}


[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class GitVersionInformationAttribute : System.Attribute
{
public string Major { get { return "2"; } }
public string Minor { get { return "3"; } }
public string Patch { get { return "4"; } }
public string PreReleaseTag { get { return "beta.5"; } }
public string PreReleaseTagWithDash { get { return "-beta.5"; } }
public string BuildMetaData { get { return "6"; } }
public string FullBuildMetaData { get { return "6.Branch.master.Sha.commitSha"; } }
public string MajorMinorPatch { get { return "2.3.4"; } }
public string SemVer { get { return "2.3.4-beta.5"; } }
public string LegacySemVer { get { return "2.3.4-beta5"; } }
public string LegacySemVerPadded { get { return "2.3.4-beta0005"; } }
public string AssemblySemVer { get { return "2.3.0.0"; } }
public string FullSemVer { get { return "2.3.4-beta.5+6"; } }
public string InformationalVersion { get { return "2.3.4-beta.5+6.Branch.master.Sha.commitSha"; } }
public string BranchName { get { return "master"; } }
public string Sha { get { return "commitSha"; } }
public string NuGetVersionV2 { get { return "2.3.4-beta0005"; } }
public string NuGetVersion { get { return "2.3.4-beta0005"; } }
public string CommitDate { get { return "2014-03-06"; } }
}
31 changes: 27 additions & 4 deletions ...ionTask.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatch.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@

using System;
using System;
using System.Reflection;

[assembly: AssemblyVersion("2.3.4.0")]
[assembly: AssemblyFileVersion("2.3.4.0")]
[assembly: AssemblyInformationalVersion("2.3.4-beta.5+6.Branch.master.Sha.commitSha")]
[assembly: ReleaseDate("2014-03-06")]
[assembly: GitVersionInformation()]

[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class ReleaseDateAttribute : System.Attribute
{
public string Date { get; private set; }
Expand Down Expand Up @@ -40,7 +41,29 @@ static class GitVersionInformation
public static string NuGetVersionV2 = "2.3.4-beta0005";
public static string NuGetVersion = "2.3.4-beta0005";
public static string CommitDate = "2014-03-06";

}


[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class GitVersionInformationAttribute : System.Attribute
{
public string Major { get { return "2"; } }
public string Minor { get { return "3"; } }
public string Patch { get { return "4"; } }
public string PreReleaseTag { get { return "beta.5"; } }
public string PreReleaseTagWithDash { get { return "-beta.5"; } }
public string BuildMetaData { get { return "6"; } }
public string FullBuildMetaData { get { return "6.Branch.master.Sha.commitSha"; } }
public string MajorMinorPatch { get { return "2.3.4"; } }
public string SemVer { get { return "2.3.4-beta.5"; } }
public string LegacySemVer { get { return "2.3.4-beta5"; } }
public string LegacySemVerPadded { get { return "2.3.4-beta0005"; } }
public string AssemblySemVer { get { return "2.3.4.0"; } }
public string FullSemVer { get { return "2.3.4-beta.5+6"; } }
public string InformationalVersion { get { return "2.3.4-beta.5+6.Branch.master.Sha.commitSha"; } }
public string BranchName { get { return "master"; } }
public string Sha { get { return "commitSha"; } }
public string NuGetVersionV2 { get { return "2.3.4-beta0005"; } }
public string NuGetVersion { get { return "2.3.4-beta0005"; } }
public string CommitDate { get { return "2014-03-06"; } }
}
31 changes: 27 additions & 4 deletions ...Task.Tests/AssemblyInfoBuilderTests.VerifyAssemblyVersion_MajorMinorPatchTag.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@

using System;
using System;
using System.Reflection;

[assembly: AssemblyVersion("2.3.4.5")]
[assembly: AssemblyFileVersion("2.3.4.0")]
[assembly: AssemblyInformationalVersion("2.3.4-beta.5+6.Branch.master.Sha.commitSha")]
[assembly: ReleaseDate("2014-03-06")]
[assembly: GitVersionInformation()]

[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class ReleaseDateAttribute : System.Attribute
{
public string Date { get; private set; }
Expand Down Expand Up @@ -40,7 +41,29 @@ static class GitVersionInformation
public static string NuGetVersionV2 = "2.3.4-beta0005";
public static string NuGetVersion = "2.3.4-beta0005";
public static string CommitDate = "2014-03-06";

}


[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class GitVersionInformationAttribute : System.Attribute
{
public string Major { get { return "2"; } }
public string Minor { get { return "3"; } }
public string Patch { get { return "4"; } }
public string PreReleaseTag { get { return "beta.5"; } }
public string PreReleaseTagWithDash { get { return "-beta.5"; } }
public string BuildMetaData { get { return "6"; } }
public string FullBuildMetaData { get { return "6.Branch.master.Sha.commitSha"; } }
public string MajorMinorPatch { get { return "2.3.4"; } }
public string SemVer { get { return "2.3.4-beta.5"; } }
public string LegacySemVer { get { return "2.3.4-beta5"; } }
public string LegacySemVerPadded { get { return "2.3.4-beta0005"; } }
public string AssemblySemVer { get { return "2.3.4.5"; } }
public string FullSemVer { get { return "2.3.4-beta.5+6"; } }
public string InformationalVersion { get { return "2.3.4-beta.5+6.Branch.master.Sha.commitSha"; } }
public string BranchName { get { return "master"; } }
public string Sha { get { return "commitSha"; } }
public string NuGetVersionV2 { get { return "2.3.4-beta0005"; } }
public string NuGetVersion { get { return "2.3.4-beta0005"; } }
public string CommitDate { get { return "2014-03-06"; } }
}
31 changes: 27 additions & 4 deletions src/GitVersionTask.Tests/AssemblyInfoBuilderTests.VerifyCreatedCode.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@

using System;
using System;
using System.Reflection;

[assembly: AssemblyVersion("1.2.3.0")]
[assembly: AssemblyFileVersion("1.2.3.0")]
[assembly: AssemblyInformationalVersion("1.2.3-unstable.4+5.Branch.feature1.Sha.commitSha")]
[assembly: ReleaseDate("2014-03-06")]
[assembly: GitVersionInformation()]

[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class ReleaseDateAttribute : System.Attribute
{
public string Date { get; private set; }
Expand Down Expand Up @@ -40,7 +41,29 @@ static class GitVersionInformation
public static string NuGetVersionV2 = "1.2.3-unstable0004";
public static string NuGetVersion = "1.2.3-unstable0004";
public static string CommitDate = "2014-03-06";

}


[System.Runtime.CompilerServices.CompilerGenerated]
[AttributeUsage(AttributeTargets.Assembly)]
sealed class GitVersionInformationAttribute : System.Attribute
{
public string Major { get { return "1"; } }
public string Minor { get { return "2"; } }
public string Patch { get { return "3"; } }
public string PreReleaseTag { get { return "unstable.4"; } }
public string PreReleaseTagWithDash { get { return "-unstable.4"; } }
public string BuildMetaData { get { return "5"; } }
public string FullBuildMetaData { get { return "5.Branch.feature1.Sha.commitSha"; } }
public string MajorMinorPatch { get { return "1.2.3"; } }
public string SemVer { get { return "1.2.3-unstable.4"; } }
public string LegacySemVer { get { return "1.2.3-unstable4"; } }
public string LegacySemVerPadded { get { return "1.2.3-unstable0004"; } }
public string AssemblySemVer { get { return "1.2.3.0"; } }
public string FullSemVer { get { return "1.2.3-unstable.4+5"; } }
public string InformationalVersion { get { return "1.2.3-unstable.4+5.Branch.feature1.Sha.commitSha"; } }
public string BranchName { get { return "feature1"; } }
public string Sha { get { return "commitSha"; } }
public string NuGetVersionV2 { get { return "1.2.3-unstable0004"; } }
public string NuGetVersion { get { return "1.2.3-unstable0004"; } }
public string CommitDate { get { return "2014-03-06"; } }
}
45 changes: 41 additions & 4 deletions src/GitVersionTask.Tests/AssemblyInfoBuilderTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
using System;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.CompilerServices;
using ApprovalTests;
using GitVersion;
Expand Down Expand Up @@ -30,13 +31,21 @@ public void VerifyCreatedCode()
Approvals.Verify(assemblyInfoText);

var compilation = CSharpCompilation.Create("Fake.dll")
.WithOptions(new CSharpCompilationOptions(OutputKind.NetModule))
.WithOptions(new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
.AddReferences(MetadataReference.CreateFromFile(typeof(object).Assembly.Location))
.AddSyntaxTrees(CSharpSyntaxTree.ParseText(assemblyInfoText));


var emitResult = compilation.Emit(new MemoryStream());
Assert.IsTrue(emitResult.Success, string.Join(Environment.NewLine, emitResult.Diagnostics.Select(x => x.Descriptor)));

using (var stream = new MemoryStream())
{
var emitResult = compilation.Emit(stream);

Assert.IsTrue(emitResult.Success, string.Join(Environment.NewLine, emitResult.Diagnostics.Select(x => x.Descriptor)));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI shouldly would give much better error messages:

Current: false should be true (some descriptor)
Shouldly: emitResult.Success should be true. Additional Context: some descriptor

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, it's not my assert. I thought I'd just leave as much code I didn't write untouched to focus the PR on one thing so it would be easier to review. 😄


stream.Seek(0, SeekOrigin.Begin);
var assembly = Assembly.Load(stream.ToArray());
VerifyGitVersionInformationAttribute(assembly, versionVariables);
}
}

[Test]
Expand Down Expand Up @@ -91,4 +100,32 @@ static void VerifyAssemblyVersion(AssemblyVersioningScheme avs)
var emitResult = compilation.Emit(new MemoryStream());
Assert.IsTrue(emitResult.Success, string.Join(Environment.NewLine, emitResult.Diagnostics.Select(x => x.Descriptor)));
}

static void VerifyGitVersionInformationAttribute(Assembly assembly, VersionVariables versionVariables)
{
var gitVersionInformationAttributeData = assembly.CustomAttributes
.FirstOrDefault(a => a.AttributeType.Name == "GitVersionInformationAttribute");

Assert.IsNotNull(gitVersionInformationAttributeData);

var gitVersionInformationAttributeType = gitVersionInformationAttributeData.AttributeType;
var gitVersionInformationAttribute = assembly
.GetCustomAttributes(gitVersionInformationAttributeType)
.FirstOrDefault();

Assert.IsNotNull(gitVersionInformationAttribute);

var properties = gitVersionInformationAttributeType.GetProperties(BindingFlags.Instance | BindingFlags.Public);

foreach (var variable in versionVariables)
{
Assert.IsNotNull(variable.Value);

var property = properties.FirstOrDefault(p => p.Name == variable.Key);
Assert.IsNotNull(property);

var propertyValue = property.GetValue(gitVersionInformationAttribute, null);
Assert.AreEqual(variable.Value, propertyValue, "{0} had an invalid value.", property.Name);
}
}
}
Loading