Skip to content

Fix: Avoid assembly loading in MSBuild task #25

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

Merged
stephanprobst merged 2 commits into from
Jan 11, 2026
Merged

Fix: Avoid assembly loading in MSBuild task #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d328f42
Fix MSBuild task to avoid assembly loading
stephanprobst Jan 11, 2026
b99703d
Remove unused VersionFileWriter generation
stephanprobst Jan 11, 2026
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
36 changes: 0 additions & 36 deletions src/SimpleBranchVersioning/AppVersionGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,13 +218,6 @@ public void Initialize(IncrementalGeneratorInitializationContext context)
// Generate assembly version attributes
string assemblyAttributesSource = GenerateAssemblyAttributes(versionInfo);
ctx.AddSource("AssemblyVersionInfo.g.cs", SourceText.From(assemblyAttributesSource, Encoding.UTF8));

// Generate version file writer helper only when needed (GenerateVersionFile or SetPackageVersionFromBranch)
if (buildProps.GenerateVersionFile || buildProps.SetPackageVersionFromBranch)
{
string writerSource = GenerateVersionFileWriter(versionInfo, branch, commitId);
ctx.AddSource("VersionFileWriter.g.cs", SourceText.From(writerSource, Encoding.UTF8));
}
});
}

Expand Down Expand Up @@ -265,35 +258,6 @@ private static string GenerateAssemblyAttributes(VersionInfo versionInfo)
""";
}

private static string GenerateVersionFileWriter(VersionInfo versionInfo, string branch, string commitId)
{
return $$"""
// <auto-generated/>
namespace SimpleBranchVersioning.Generated
{
[global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)]
internal static class VersionFileWriter
{
public static void WriteJson(string path)
{
string json = "{\n" +
" \"Version\": \"{{EscapeJson(versionInfo.Version)}}\",\n" +
" \"Branch\": \"{{EscapeJson(branch)}}\",\n" +
" \"CommitId\": \"{{EscapeJson(commitId)}}\",\n" +
" \"PackageVersion\": \"{{EscapeJson(versionInfo.PackageVersion)}}\",\n" +
" \"AssemblyVersion\": \"{{EscapeJson(versionInfo.AssemblyVersion)}}\",\n" +
" \"FileVersion\": \"{{EscapeJson(versionInfo.FileVersion)}}\",\n" +
" \"InformationalVersion\": \"{{EscapeJson(versionInfo.InformationalVersion)}}\"\n" +
"}";
global::System.IO.File.WriteAllText(path, json);
}
}
}
""";
}

private static string EscapeJson(string value) => value.Replace("\\", @"\\").Replace("\"", "\\\"");

private static string GenerateSource(string? namespaceName, string className, VersionInfo versionInfo, string branch, string commitId)
{
string classDefinition = $$"""
Expand Down
3 changes: 3 additions & 0 deletions src/SimpleBranchVersioning/build/SimpleBranchVersioning.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@
<GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
<GenerateAssemblyFileVersionAttribute>false</GenerateAssemblyFileVersionAttribute>
<GenerateAssemblyInformationalVersionAttribute>false</GenerateAssemblyInformationalVersionAttribute>

<!-- Emit generated files to disk so MSBuild task can read version info without loading assembly -->
<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
</PropertyGroup>

<ItemGroup>
Expand Down
100 changes: 87 additions & 13 deletions src/SimpleBranchVersioning/build/SimpleBranchVersioning.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,99 @@

<UsingTask TaskName="GenerateVersionFileTask" TaskFactory="RoslynCodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.Core.dll">
<ParameterGroup>
<AssemblyPath ParameterType="System.String" Required="true" />
<GeneratedFilesDir ParameterType="System.String" Required="true" />
<OutputPath ParameterType="System.String" Required="true" />
</ParameterGroup>
<Task>
<Using Namespace="System.Collections.Generic" />
<Using Namespace="System.IO" />
<Using Namespace="System.Reflection" />
<Using Namespace="System.Text" />
<Using Namespace="System.Text.RegularExpressions" />
<Code Type="Fragment" Language="cs">
<![CDATA[
// Load assembly from bytes to avoid file locking and assembly identity conflicts
byte[] assemblyBytes = File.ReadAllBytes(AssemblyPath);
var assembly = Assembly.Load(assemblyBytes);
var writerType = assembly.GetType("SimpleBranchVersioning.Generated.VersionFileWriter");
if (writerType != null)
// Parse generated source file to extract version info (no assembly loading needed)
// This avoids issues with test frameworks like TUnit that use module initializers
var values = new Dictionary<string, string>();

try
{
var method = writerType.GetMethod("WriteJson", BindingFlags.Public | BindingFlags.Static);
method.Invoke(null, new object[] { OutputPath });
// Find AppVersion.g.cs in generated files directory
// Path pattern: generated/SimpleBranchVersioning/SimpleBranchVersioning.AppVersionGenerator/AppVersion.g.cs
string sourceFile = null;
if (Directory.Exists(GeneratedFilesDir))
{
// Search for any .g.cs file containing "public const string Version"
foreach (string file in Directory.GetFiles(GeneratedFilesDir, "*.g.cs", SearchOption.AllDirectories))
{
string content = File.ReadAllText(file);
if (content.Contains("public const string Version") && content.Contains("public const string PackageVersion"))
{
sourceFile = file;
break;
}
}
}

if (sourceFile == null)
{
Log.LogWarning("SimpleBranchVersioning: Generated AppVersion source file not found in " + GeneratedFilesDir + ". Ensure EmitCompilerGeneratedFiles is enabled.");
return true;
}

Log.LogMessage(MessageImportance.Low, "SimpleBranchVersioning: Reading version info from " + sourceFile);
string sourceContent = File.ReadAllText(sourceFile);

// Extract const string values using regex
// Pattern matches: public const string FieldName = "value";
var pattern = new Regex(@"public const string (\w+) = ""([^""]*)"";");
foreach (Match match in pattern.Matches(sourceContent))
{
string fieldName = match.Groups[1].Value;
string fieldValue = match.Groups[2].Value;
values[fieldName] = fieldValue;
}

if (values.Count == 0)
{
Log.LogWarning("SimpleBranchVersioning: No version constants found in generated source file.");
return true;
}

// Build JSON manually (avoid System.Text.Json dependency for .NET Framework MSBuild compatibility)
var sb = new StringBuilder();
sb.AppendLine("{");

string GetValue(string key) { string v; return values.TryGetValue(key, out v) ? v : ""; }

sb.AppendLine(" \"Version\": \"" + EscapeJson(GetValue("Version")) + "\",");
sb.AppendLine(" \"Branch\": \"" + EscapeJson(GetValue("Branch")) + "\",");
sb.AppendLine(" \"CommitId\": \"" + EscapeJson(GetValue("CommitId")) + "\",");
sb.AppendLine(" \"PackageVersion\": \"" + EscapeJson(GetValue("PackageVersion")) + "\",");
sb.AppendLine(" \"AssemblyVersion\": \"" + EscapeJson(GetValue("AssemblyVersion")) + "\",");
sb.AppendLine(" \"FileVersion\": \"" + EscapeJson(GetValue("FileVersion")) + "\",");
sb.AppendLine(" \"InformationalVersion\": \"" + EscapeJson(GetValue("InformationalVersion")) + "\"");
sb.AppendLine("}");

// Ensure directory exists
string dir = Path.GetDirectoryName(OutputPath);
if (!string.IsNullOrEmpty(dir) && !Directory.Exists(dir))
{
Directory.CreateDirectory(dir);
}

File.WriteAllText(OutputPath, sb.ToString());
Log.LogMessage(MessageImportance.Normal, "Generated version file: " + OutputPath);
}
else
catch (Exception ex)
{
Log.LogWarning("SimpleBranchVersioning: Failed to generate version file: " + ex.Message);
}

// Local function to escape JSON strings
string EscapeJson(string s)
{
Log.LogWarning("SimpleBranchVersioning: VersionFileWriter type not found. Ensure the source generator is running correctly.");
if (string.IsNullOrEmpty(s)) return s;
return s.Replace("\\", "\\\\").Replace("\"", "\\\"").Replace("\n", "\\n").Replace("\r", "\\r").Replace("\t", "\\t");
}
]]>
</Code>
Expand All @@ -35,8 +107,9 @@ else
<Target Name="GenerateVersionFile" AfterTargets="Build" Condition="'$(GenerateVersionFile)' == 'true' and '$(TargetFramework)' != ''">
<PropertyGroup>
<VersionFileOutputPath Condition="'$(VersionFileOutputPath)' == ''">$([System.IO.Path]::Combine('$(MSBuildProjectDirectory)', '$(OutputPath)', 'version.json'))</VersionFileOutputPath>
<SimpleBranchVersioning_GeneratedFilesDir>$(IntermediateOutputPath)generated\</SimpleBranchVersioning_GeneratedFilesDir>
</PropertyGroup>
<GenerateVersionFileTask AssemblyPath="$(TargetPath)" OutputPath="$(VersionFileOutputPath)" />
<GenerateVersionFileTask GeneratedFilesDir="$(SimpleBranchVersioning_GeneratedFilesDir)" OutputPath="$(VersionFileOutputPath)" />
<ItemGroup>
<ContentWithTargetPath Include="$(VersionFileOutputPath)" TargetPath="version.json" CopyToOutputDirectory="PreserveNewest" CopyToPublishDirectory="PreserveNewest" />
</ItemGroup>
Expand Down Expand Up @@ -89,7 +162,8 @@ else
Condition="'$(SetPackageVersionFromBranch)' == 'true' and '$(TargetFramework)' != ''">
<PropertyGroup>
<VersionFileOutputPath Condition="'$(VersionFileOutputPath)' == ''">$([System.IO.Path]::Combine('$(MSBuildProjectDirectory)', '$(OutputPath)', 'version.json'))</VersionFileOutputPath>
<SimpleBranchVersioning_GeneratedFilesDir>$(IntermediateOutputPath)generated\</SimpleBranchVersioning_GeneratedFilesDir>
</PropertyGroup>
<GenerateVersionFileTask AssemblyPath="$(TargetPath)" OutputPath="$(VersionFileOutputPath)" />
<GenerateVersionFileTask GeneratedFilesDir="$(SimpleBranchVersioning_GeneratedFilesDir)" OutputPath="$(VersionFileOutputPath)" />
</Target>
</Project>
38 changes: 0 additions & 38 deletions tests/SimpleBranchVersioning.Tests/AppVersionGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,44 +307,6 @@ public async Task Generator_WithTopLevelStatements_UsesGlobalNamespace()

#endregion

#region VersionFileWriter Generation Tests

[Test]
public async Task Generator_WithGenerateVersionFile_GeneratesVersionFileWriter()
{
var result = GeneratorTestHelper.RunGenerator(
MinimalSource,
branchOverride: "main",
generateVersionFile: true);

await Assert.That(result.GeneratedFileNames).Contains("VersionFileWriter.g.cs");
}

[Test]
public async Task Generator_WithSetPackageVersionFromBranch_GeneratesVersionFileWriter()
{
var result = GeneratorTestHelper.RunGenerator(
MinimalSource,
branchOverride: "main",
setPackageVersionFromBranch: true);

await Assert.That(result.GeneratedFileNames).Contains("VersionFileWriter.g.cs");
}

[Test]
public async Task Generator_WithBothDisabled_DoesNotGenerateVersionFileWriter()
{
var result = GeneratorTestHelper.RunGenerator(
MinimalSource,
branchOverride: "main",
generateVersionFile: false,
setPackageVersionFromBranch: false);

await Assert.That(result.GeneratedFileNames).DoesNotContain("VersionFileWriter.g.cs");
}

#endregion

#region Branch Name Slash Replacement Tests

[Test]
Expand Down
Loading