Skip to content

Commit 7cb9894

Browse files
AArnottAArnott
authored
Merge pull request #135 from robmen/94-nativebinaries
Support GitVersioning in .vcxprojs
2 parents f815bb3 + 101e907 commit 7cb9894

File tree

5 files changed

+516
-1
lines changed

5 files changed

+516
-1
lines changed

‎src/NerdBank.GitVersioning.Tests/BuildIntegrationTests.cs‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -802,6 +802,29 @@ public async Task AssemblyInfo_SuppressedImplicitlyByTargetExt()
802802
Assert.Empty(result.LoggedEvents.OfType<BuildWarningEventArgs>());
803803
}
804804

805+
/// <summary>
806+
/// Create a native resource .dll and verify that its version
807+
/// information is set correctly.
808+
/// </summary>
809+
[Fact]
810+
public async Task NativeVersionInfo_CreateNativeResourceDll()
811+
{
812+
this.testProject = this.CreateNativeProjectRootElement(this.projectDirectory, "test.vcxproj");
813+
this.WriteVersionFile();
814+
var result = await this.BuildAsync(Targets.Build, logVerbosity: LoggerVerbosity.Minimal);
815+
Assert.Empty(result.LoggedEvents.OfType<BuildErrorEventArgs>());
816+
817+
string targetFile = Path.Combine(this.projectDirectory, result.BuildResult.ProjectStateAfterBuild.GetPropertyValue("TargetPath"));
818+
Assert.True(File.Exists(targetFile));
819+
820+
var fileInfo = FileVersionInfo.GetVersionInfo(targetFile);
821+
Assert.Equal("1.2", fileInfo.FileVersion);
822+
Assert.Equal("1.2.0", fileInfo.ProductVersion);
823+
Assert.Equal("test", fileInfo.InternalName);
824+
Assert.Equal("NerdBank", fileInfo.CompanyName);
825+
Assert.Equal($"Copyright (c) {DateTime.Now.Year}. All rights reserved.", fileInfo.LegalCopyright);
826+
}
827+
805828
private static Version GetExpectedAssemblyVersion(VersionOptions versionOptions, Version version)
806829
{
807830
// Function should be very similar to VersionOracle.GetAssemblyVersion()
@@ -952,6 +975,17 @@ where name.StartsWith(prefix, StringComparison.Ordinal)
952975
}
953976
}
954977

978+
private ProjectRootElement CreateNativeProjectRootElement(string projectDirectory, string projectName)
979+
{
980+
using (var reader = XmlReader.Create(Assembly.GetExecutingAssembly().GetManifestResourceStream($"{ThisAssembly.RootNamespace}.test.vcprj")))
981+
{
982+
var pre = ProjectRootElement.Create(reader, this.projectCollection);
983+
pre.FullPath = Path.Combine(projectDirectory, projectName);
984+
pre.AddImport(Path.Combine(this.RepoPath, GitVersioningTargetsFileName));
985+
return pre;
986+
}
987+
}
988+
955989
private ProjectRootElement CreateProjectRootElement(string projectDirectory, string projectName)
956990
{
957991
using (var reader = XmlReader.Create(Assembly.GetExecutingAssembly().GetManifestResourceStream($"{ThisAssembly.RootNamespace}.test.prj")))
@@ -1003,9 +1037,11 @@ private static class CloudBuild
10031037

10041038
private static class Targets
10051039
{
1040+
internal const string Build = "Build";
10061041
internal const string GetBuildVersion = "GetBuildVersion";
10071042
internal const string GetNuGetPackageVersion = "GetNuGetPackageVersion";
10081043
internal const string GenerateAssemblyVersionInfo = "GenerateAssemblyVersionInfo";
1044+
internal const string GenerateNativeVersionInfo = "GenerateNativeVersionInfo";
10091045
}
10101046

10111047
private class BuildResults

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<EmbeddedResource Include="Keys\*.snk" />
1414
<EmbeddedResource Include="Keys\*.pfx" />
1515
<EmbeddedResource Include="..\NerdBank.GitVersioning\version.schema.json" Link="version.schema.json" />
16+
<EmbeddedResource Include="test.vcprj" />
1617
<EmbeddedResource Include="test.prj" />
1718
<EmbeddedResource Include="repos\submodules.7z" />
1819
</ItemGroup>

‎src/NerdBank.GitVersioning.Tests/test.vcprj‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
<ItemGroup Label="ProjectConfigurations">
4+
<ProjectConfiguration Include="Debug|Win32">
5+
<Configuration>Debug</Configuration>
6+
<Platform>Win32</Platform>
7+
</ProjectConfiguration>
8+
<ProjectConfiguration Include="Release|Win32">
9+
<Configuration>Release</Configuration>
10+
<Platform>Win32</Platform>
11+
</ProjectConfiguration>
12+
<ProjectConfiguration Include="Debug|x64">
13+
<Configuration>Debug</Configuration>
14+
<Platform>x64</Platform>
15+
</ProjectConfiguration>
16+
<ProjectConfiguration Include="Release|x64">
17+
<Configuration>Release</Configuration>
18+
<Platform>x64</Platform>
19+
</ProjectConfiguration>
20+
</ItemGroup>
21+
<PropertyGroup Label="Globals">
22+
<VCProjectVersion>15.0</VCProjectVersion>
23+
<ProjectGuid>{8FD9B6E8-A6E4-42A3-8B5A-E6F7ADC826F5}</ProjectGuid>
24+
<RootNamespace>test</RootNamespace>
25+
<WindowsTargetPlatformVersion>10.0.14393.0</WindowsTargetPlatformVersion>
26+
<ConfigurationType>DynamicLibrary</ConfigurationType>
27+
<ResourceOnlyDll>true</ResourceOnlyDll>
28+
<AssemblyCompany>NerdBank</AssemblyCompany>
29+
</PropertyGroup>
30+
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
31+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
32+
<UseDebugLibraries>true</UseDebugLibraries>
33+
<PlatformToolset>v140</PlatformToolset>
34+
<CharacterSet>MultiByte</CharacterSet>
35+
</PropertyGroup>
36+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
37+
<UseDebugLibraries>false</UseDebugLibraries>
38+
<PlatformToolset>v140</PlatformToolset>
39+
<WholeProgramOptimization>true</WholeProgramOptimization>
40+
<CharacterSet>MultiByte</CharacterSet>
41+
</PropertyGroup>
42+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
43+
<UseDebugLibraries>true</UseDebugLibraries>
44+
<PlatformToolset>v140</PlatformToolset>
45+
<CharacterSet>MultiByte</CharacterSet>
46+
</PropertyGroup>
47+
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
48+
<UseDebugLibraries>false</UseDebugLibraries>
49+
<PlatformToolset>v140</PlatformToolset>
50+
<WholeProgramOptimization>true</WholeProgramOptimization>
51+
<CharacterSet>MultiByte</CharacterSet>
52+
</PropertyGroup>
53+
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
54+
<ImportGroup Label="ExtensionSettings">
55+
</ImportGroup>
56+
<ImportGroup Label="Shared">
57+
</ImportGroup>
58+
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
59+
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
60+
</ImportGroup>
61+
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
62+
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
63+
</ImportGroup>
64+
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
65+
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
66+
</ImportGroup>
67+
<ImportGroup Label="PropertySheets" Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
68+
<Import Project="$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props" Condition="exists('$(UserRootDir)\Microsoft.Cpp.$(Platform).user.props')" Label="LocalAppDataPlatform" />
69+
</ImportGroup>
70+
<PropertyGroup Label="UserMacros" />
71+
<PropertyGroup />
72+
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">
73+
<ClCompile>
74+
<WarningLevel>Level3</WarningLevel>
75+
<Optimization>Disabled</Optimization>
76+
<SDLCheck>true</SDLCheck>
77+
</ClCompile>
78+
<Link>
79+
<NoEntryPoint>$(ResourceOnlyDll)</NoEntryPoint>
80+
</Link>
81+
</ItemDefinitionGroup>
82+
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">
83+
<ClCompile>
84+
<WarningLevel>Level3</WarningLevel>
85+
<Optimization>Disabled</Optimization>
86+
<SDLCheck>true</SDLCheck>
87+
</ClCompile>
88+
<Link>
89+
<NoEntryPoint>$(ResourceOnlyDll)</NoEntryPoint>
90+
</Link>
91+
</ItemDefinitionGroup>
92+
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'">
93+
<ClCompile>
94+
<WarningLevel>Level3</WarningLevel>
95+
<Optimization>MaxSpeed</Optimization>
96+
<FunctionLevelLinking>true</FunctionLevelLinking>
97+
<IntrinsicFunctions>true</IntrinsicFunctions>
98+
<SDLCheck>true</SDLCheck>
99+
</ClCompile>
100+
<Link>
101+
<EnableCOMDATFolding>true</EnableCOMDATFolding>
102+
<OptimizeReferences>true</OptimizeReferences>
103+
<NoEntryPoint>$(ResourceOnlyDll)</NoEntryPoint>
104+
</Link>
105+
</ItemDefinitionGroup>
106+
<ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'">
107+
<ClCompile>
108+
<WarningLevel>Level3</WarningLevel>
109+
<Optimization>MaxSpeed</Optimization>
110+
<FunctionLevelLinking>true</FunctionLevelLinking>
111+
<IntrinsicFunctions>true</IntrinsicFunctions>
112+
<SDLCheck>true</SDLCheck>
113+
</ClCompile>
114+
<Link>
115+
<EnableCOMDATFolding>true</EnableCOMDATFolding>
116+
<OptimizeReferences>true</OptimizeReferences>
117+
<NoEntryPoint>$(ResourceOnlyDll)</NoEntryPoint>
118+
</Link>
119+
</ItemDefinitionGroup>
120+
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
121+
<ImportGroup Label="ExtensionTargets">
122+
</ImportGroup>
123+
</Project>

‎src/Nerdbank.GitVersioning.NuGet/build/Nerdbank.GitVersioning.targets‎

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22
<Project DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
33
<PropertyGroup>
44
<MSBuildAllProjects>$(MSBuildAllProjects);$(MSBuildThisFileFullPath)</MSBuildAllProjects>
5-
<VersionSourceFile>$(IntermediateOutputPath)\$(AssemblyName).Version$(DefaultLanguageSourceExtension)</VersionSourceFile>
5+
6+
<PrepareForBuildDependsOn>
7+
GenerateNativeVersionInfo;
8+
$(PrepareForBuildDependsOn);
9+
</PrepareForBuildDependsOn>
610

711
<PrepareResourcesDependsOn>
812
GenerateAssemblyVersionInfo;
@@ -39,6 +43,7 @@
3943
</PropertyGroup>
4044

4145
<UsingTask AssemblyFile="$(NerdbankGitVersioningTasksPath)Nerdbank.GitVersioning.Tasks.dll" TaskName="Nerdbank.GitVersioning.Tasks.AssemblyVersionInfo"/>
46+
<UsingTask AssemblyFile="$(NerdbankGitVersioningTasksPath)Nerdbank.GitVersioning.Tasks.dll" TaskName="Nerdbank.GitVersioning.Tasks.NativeVersionInfo"/>
4247
<UsingTask AssemblyFile="$(NerdbankGitVersioningTasksPath)Nerdbank.GitVersioning.Tasks.dll" TaskName="Nerdbank.GitVersioning.Tasks.SetCloudBuildVariables"/>
4348
<UsingTask AssemblyFile="$(NerdbankGitVersioningTasksPath)Nerdbank.GitVersioning.Tasks.dll" TaskName="Nerdbank.GitVersioning.Tasks.GetBuildVersion"/>
4449
<UsingTask AssemblyFile="$(NerdbankGitVersioningTasksPath)Nerdbank.GitVersioning.Tasks.dll" TaskName="Nerdbank.GitVersioning.Tasks.CompareFiles"/>
@@ -121,6 +126,7 @@
121126

122127
<Target Name="GenerateAssemblyVersionInfo" DependsOnTargets="GetBuildVersion" Condition=" '$(GenerateAssemblyVersionInfo)' != 'false' ">
123128
<PropertyGroup>
129+
<VersionSourceFile>$(IntermediateOutputPath)\$(AssemblyName).Version$(DefaultLanguageSourceExtension)</VersionSourceFile>
124130
<NewVersionSourceFile>$(VersionSourceFile).new</NewVersionSourceFile>
125131
<UltimateResourceFallbackLocation Condition=" '$(DevDivProjectSubType)' != 'portable' ">UltimateResourceFallbackLocation.MainAssembly</UltimateResourceFallbackLocation>
126132
</PropertyGroup>
@@ -152,6 +158,39 @@
152158
</ItemGroup>
153159
</Target>
154160

161+
<Target Name="GenerateNativeVersionInfo" DependsOnTargets="GetBuildVersion" Condition=" '$(Language)'=='C++' and '$(GenerateAssemblyVersionInfo)' != 'false' ">
162+
<PropertyGroup>
163+
<VersionSourceFile>$(IntermediateOutputPath)\$(AssemblyName).Version.rc</VersionSourceFile>
164+
<NewVersionSourceFile>$(VersionSourceFile).new</NewVersionSourceFile>
165+
</PropertyGroup>
166+
<MakeDir Directories="$(IntermediatePath)"/>
167+
<Nerdbank.GitVersioning.Tasks.NativeVersionInfo
168+
OutputFile="$(NewVersionSourceFile)"
169+
CodeLanguage="$(Language)"
170+
ConfigurationType="$(ConfigurationType)"
171+
AssemblyName="$(AssemblyName)"
172+
AssemblyVersion="$(AssemblyVersion)"
173+
AssemblyFileVersion="$(AssemblyFileVersion)"
174+
AssemblyInformationalVersion="$(AssemblyInformationalVersion)"
175+
AssemblyTitle="$(AssemblyTitle)"
176+
AssemblyProduct="$(AssemblyProduct)"
177+
AssemblyCopyright="$(AssemblyCopyright)"
178+
AssemblyCompany="$(AssemblyCompany)"
179+
AssemblyLanguage="$(AssemblyLanguage)"
180+
AssemblyCodepage="$(AssemblyCodepage)"
181+
TargetFileName="$(TargetFileName)"
182+
/>
183+
<!-- Avoid applying the newly generated Version.rc file to the build
184+
unless it has changed in order to allow for incremental building. -->
185+
<Nerdbank.GitVersioning.Tasks.CompareFiles OriginalItems="$(VersionSourceFile)" NewItems="$(NewVersionSourceFile)">
186+
<Output TaskParameter="AreChanged" PropertyName="_NativeVersionInfoChanged" />
187+
</Nerdbank.GitVersioning.Tasks.CompareFiles>
188+
<Copy Condition=" '$(_NativeVersionInfoChanged)' == 'true' " SourceFiles="$(NewVersionSourceFile)" DestinationFiles="$(VersionSourceFile)" />
189+
<ItemGroup>
190+
<ResourceCompile Include="$(VersionSourceFile)" />
191+
</ItemGroup>
192+
</Target>
193+
155194
<!-- Support for pattern found in users of Tvl.NuGet.BuildTasks. -->
156195
<Target Name="SupplyNuGetManifestVersion"
157196
DependsOnTargets="GetBuildVersion"

0 commit comments

Comments
 (0)