Add support for Rd.xml file around project file #1976
Conversation
For now added either `rd.xml` or files which ends with `.rd.xml` Rename `rd.xml` supplied by BDN to `bdn_generated.rd.xml`
There was a problem hiding this comment.
@kant2002 big thanks for your contribution!
could you PTAL at the CI failures?
/home/runner/work/BenchmarkDotNet/BenchmarkDotNet/tests/BenchmarkDotNet.IntegrationTests/bin/Release/net5.0/0961d928-ba98-4cca-b6af-fc04c1f5807a/BenchmarkDotNet.Autogenerated.csproj(37,3): error MSB4067: The element <#text> beneath element <ItemGroup> is unrecognized.
you should be able to repro it locally by doing:
dotnet run -c Release -f net5.0 --project .\samples\BenchmarkDotNet.Samples\BenchmarkDotNet.Samples.csproj --filter '*Basic*' --job dry --runtimes nativeaot5.0 --keepFiles true| </ItemGroup> | ||
| <ItemGroup> | ||
| <RdXmlFile Include=""rd.xml"" /> | ||
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(_ => $"<RdXmlFile Include=\"{_}\" />{Environment.NewLine}")} |
There was a problem hiding this comment.
nit _ is typically used when the argument is ignored. In this case, we are using it.
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(_ => $"<RdXmlFile Include=\"{_}\" />{Environment.NewLine}")} | |
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(file => $"<RdXmlFile Include=\"{file}\" />{Environment.NewLine}")} |
| </ItemGroup> | ||
| <ItemGroup> | ||
| <RdXmlFile Include=""rd.xml"" /> | ||
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(_ => $"<RdXmlFile Include=\"{_}\" />{Environment.NewLine}")} |
There was a problem hiding this comment.
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(_ => $"<RdXmlFile Include=\"{_}\" />{Environment.NewLine}")} | |
| {GetRdXmlFiles(buildPartition.RepresentativeBenchmarkCase.Descriptor.Type, logger).Select(file => $"<RdXmlFile Include=\"{file}\" />{Environment.NewLine}")} |
| var projectFile = GetProjectFilePath(benchmarkTarget, logger); | ||
| var projectFileFolder = projectFile.DirectoryName; | ||
| yield return GeneratedRdXmlFileName; | ||
| var rdXml = Path.Combine(projectFileFolder, "rd.xml"); | ||
| if (File.Exists(rdXml)) | ||
| { | ||
| yield return rdXml; | ||
| } | ||
|
|
||
| foreach (var item in Directory.GetFiles(projectFileFolder, "*.rd.xml")) | ||
| { | ||
| yield return item; | ||
| } |
There was a problem hiding this comment.
it seems like this could be simplified if we search for *rd.xm files:
| var projectFile = GetProjectFilePath(benchmarkTarget, logger); | |
| var projectFileFolder = projectFile.DirectoryName; | |
| yield return GeneratedRdXmlFileName; | |
| var rdXml = Path.Combine(projectFileFolder, "rd.xml"); | |
| if (File.Exists(rdXml)) | |
| { | |
| yield return rdXml; | |
| } | |
| foreach (var item in Directory.GetFiles(projectFileFolder, "*.rd.xml")) | |
| { | |
| yield return item; | |
| } | |
| yield return GeneratedRdXmlFileName; | |
| var projectFileFolder = GetProjectFilePath(benchmarkTarget, logger).DirectoryName; | |
| foreach (var rdFile in Directory.GetFiles(projectFileFolder, "*rd.xml")) | |
| { | |
| yield return rdFile; | |
| } |
There was a problem hiding this comment.
What if somebody have library which ends with rd? or just XML files. For example Thunderbird.xml, that would be captured.
There was a problem hiding this comment.
I am afraid that neither *.rd.xml and *rd.xml are good filters, as users can call their files without rd prefix like nativeaot_rules.xml. But since it's a project with BenchmarkDotNet benchmarks we could just tell them that all that we support is rd.xml. @kant2002 what do you think?
@MichalStrehovsky what is your opinion on that? Are NativeAOT using names other than rd.xml for their RdXmlFile files?
There was a problem hiding this comment.
Based on my experience projects in the wild was using either just rd.xml or I recentrly start push for separate files per library, to at least simplify mundane work. Naming convention which I propose is exaclly nuget_package.rd.xml. Also seems to be .NET Native Rd.xml also has approximately same convention, so that's why I choose that pattern.
There was a problem hiding this comment.
*.rd.xml is the convention that most people are sticking with. I don't recall ever seeing an rd.xml file without that extension.
For now added either
rd.xmlor files which ends with.rd.xmlRename
rd.xmlsupplied by BDN tobdn_generated.rd.xmlCloses #1680