Add a BenchmarkDotNet project #52123
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -316,6 +316,7 @@ | |
| <Project Path="src/Tasks/Microsoft.NET.Build.Extensions.Tasks.UnitTests/Microsoft.NET.Build.Extensions.Tasks.UnitTests.csproj" /> | ||
| <Project Path="test/ArgumentForwarding.Tests/ArgumentForwarding.Tests.csproj" /> | ||
| <Project Path="test/ArgumentsReflector/ArgumentsReflector.csproj" /> | ||
| <Project Path="test/Benchmark/Benchmark.csproj" /> | ||
| <Project Path="test/containerize.UnitTests/containerize.UnitTests.csproj" /> | ||
| <Project Path="test/dotnet-format.UnitTests/dotnet-format.UnitTests.csproj" /> | ||
| <Project Path="test/dotnet-MsiInstallation.Tests/dotnet-MsiInstallation.Tests.csproj" /> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
|
|
||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>$(ToolsetTargetFramework)</TargetFramework> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <Nullable>enable</Nullable> | ||
|
|
||
| <ExcludeFromSourceOnlyBuild>true</ExcludeFromSourceOnlyBuild> | ||
| <CanRunTestAsTool>false</CanRunTestAsTool> | ||
| <IsTestProject>false</IsTestProject> | ||
| <IsUnitTestProject>false</IsUnitTestProject> | ||
| <IncludeTestUsings>false</IncludeTestUsings> | ||
| <NoWarn>$(NoWarn);CS8002</NoWarn> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="BenchmarkDotNet" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\src\Cli\dotnet\dotnet.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <!-- Copy to output so BenchmarkDotNet generated projects inherit this as well --> | ||
| <None Include="Directory.Build.props" CopyToOutputDirectory="PreserveNewest" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Project> | ||
| <PropertyGroup> | ||
| <!-- | ||
| We need to output to something other than the normal bin and obj folders to prevent picking up the global.json that | ||
| is being dropped there as that will break building the project that BenchmarkDotNet generates to run the benchmarks. | ||
| --> | ||
| <BaseOutputPath>$([MSBuild]::NormalizeDirectory('$(MSBuildThisFileDirectory)', '..', '..', 'artifacts', '$(MSBuildProjectName)', 'bin'))</BaseOutputPath> | ||
| <BaseIntermediateOutputPath>$([MSBuild]::NormalizeDirectory('$(MSBuildThisFileDirectory)', '..', '..', 'artifacts', '$(MSBuildProjectName)', 'obj'))</BaseIntermediateOutputPath> | ||
|
Comment on lines
+7
to
+8
Member
There was a problem hiding this comment. I think there's an ambient property called |
||
|
|
||
| <!-- | ||
| Skipping here as we want the auto-generated projects to skip as well. The project file will copy this Directory.Build.props | ||
| to the output folder and the auto-generated projects will implicitly import it. | ||
| --> | ||
| <SkipCustomizeXlfSourceNames>true</SkipCustomizeXlfSourceNames> | ||
| </PropertyGroup> | ||
| <Import Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)..'))"/> | ||
| </Project> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using BenchmarkDotNet.Attributes; | ||
|
|
||
| namespace Benchmark; | ||
|
|
||
| [MemoryDiagnoser] | ||
| [SimpleJob(launchCount: 1, warmupCount: 1, iterationCount: 1, invocationCount: 1)] | ||
| public class InfoTests | ||
| { | ||
| private static readonly string[] s_args = ["--info"]; | ||
|
|
||
| [Benchmark] | ||
| public int RunInfoCommand() | ||
| { | ||
| return Microsoft.DotNet.Cli.Program.Main(s_args); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using BenchmarkDotNet.Running; | ||
|
|
||
| namespace Benchmark; | ||
|
|
||
| internal class Program | ||
| { | ||
| static void Main(string[] args) | ||
| { | ||
| BenchmarkRunner.Run(typeof(Program).Assembly); | ||
|
|
||
| // BenchmarkDotNet bakes a fair amount of assumptions into the way it generates | ||
| // projects for running its benchmarks. One of the key problems we run into is how | ||
| // it figures out the root of the repository. It walks up the directory structure | ||
| // to find the first folder with a `*.sln` or `*.slnx` or `global.json`. It then | ||
| // searches down from there to find the project file. In the SDK repo currently | ||
| // we have a `global.json` in the `artifacts/bin` folder- that prevents it from | ||
| // finding the project file. | ||
| // | ||
| // We work around this currently by redirecting the output to `artifacts/Benchmark`. | ||
| // One partially explored alternative was to derive the `CsProjGenerator` and customize | ||
| // its `GetProjectFilePath(Type benchmarkTarget, ILogger logger)`. There is a fair | ||
| // amount of logic there that needs reimplemented, and you have to create a custom | ||
| // toolchain something like this: | ||
| // | ||
| // public class CustomToolchain : Toolchain | ||
| // { | ||
| // public CustomToolchain(string? tfm = default) : base( | ||
| // "CustomToolchain", | ||
| // new CustomCsProjGenerator( | ||
| // targetFrameworkMoniker: tfm ?? GetCurrentTfm(), | ||
| // cliPath: null, | ||
| // packagesPath: null, | ||
| // runtimeFrameworkVersion: null), | ||
| // new DotNetCliBuilder(tfm ?? GetCurrentTfm()), | ||
| // new DotNetCliExecutor(customDotNetCliPath: null)) { } | ||
| // } | ||
| // | ||
| // Things still break with the `bin/global.json` with this. Pulling in and tweaking | ||
| // everything that is needed to get the temporary project to build successfully looks | ||
| // to be a potential whack-a-mole problem, so starting by rooting the output in a new | ||
| // folder in the `artifacts` directory that ensures the repo root's `global.json` is | ||
| // in "scope" so we don't have to modify the toolchain. | ||
| // | ||
| // https://github.com/dotnet/BenchmarkDotNet/blob/master/src/BenchmarkDotNet/Toolchains/CsProj/CsProjGenerator.cs | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,7 +30,7 @@ | |
|
|
||
| <!-- Global usings --> | ||
| <!-- See: https://learn.microsoft.com/dotnet/core/project-sdk/msbuild-props#using --> | ||
| <ItemGroup Condition="'$(IncludeTestUsings)'!='false'"> | ||
|
Member
There was a problem hiding this comment. I think it's worth having a top-level |
||
| <Using Include="FluentAssertions" /> | ||
| <Using Include="Microsoft.NET.TestFramework" /> | ||
| <Using Include="Microsoft.NET.TestFramework.Assertions" /> | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You shouldn't need both this Condition and the change to the DependsOnTargets - if a Condition evaluates to
falsethen the DependsOnTargets should not be run at all. Were you seeing different?