Skip to content
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

Jump to bottom

Add code coverage reporting #1815

Merged
merged 7 commits into from Feb 18, 2022
Merged

Add code coverage reporting #1815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
de602f9
Add coverlet
eNeRGy164 Feb 16, 2022
df9e006
Make output less verbose
eNeRGy164 Feb 16, 2022
c40bbb1
Add code coverage collection
eNeRGy164 Feb 16, 2022
86545f8
Condense setup steps into a single step
eNeRGy164 Feb 16, 2022
3f674a4
Upload code coverage to coveralls.io
eNeRGy164 Feb 16, 2022
962b818
Disable .NET first-run message in output
eNeRGy164 Feb 16, 2022
47ba546
Add report generator to Nuke
eNeRGy164 Feb 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 15 additions & 15 deletions .github/workflows/build.yml
View file
Open in desktop
Expand Up @@ -13,36 +13,36 @@ jobs:

runs-on: windows-latest

env:
DOTNET_NOLOGO: true

steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Setup .NET 5
uses: actions/setup-dotnet@v1
with:
dotnet-version: 5.0.x

- name: Setup .NET 3.1
- name: Setup .NET SDKs
uses: actions/setup-dotnet@v1
with:
dotnet-version: 3.1.x

- name: Setup .NET 2.1
uses: actions/setup-dotnet@v1
with:
dotnet-version: 2.1.x
dotnet-version: |
2.1.x
3.1.x
5.0.x

- name: Run NUKE
run: ./build.ps1
env:
BranchSpec: ${{ github.ref }}
BuildNumber: ${{ github.run_number}}
BuildNumber: ${{ github.run_number }}
ApiKey: ${{ secrets.NUGETAPIKEY }}

- name: coveralls
uses: coverallsapp/github-action@1.1.3
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
path-to-lcov: TestResults/reports/lcov.info

- name: Upload artifacts
uses: actions/upload-artifact@v2
with:
path: ./Artifacts/*


23 changes: 20 additions & 3 deletions Build/Build.cs
View file
Open in desktop
Expand Up @@ -8,10 +8,12 @@
using Nuke.Common.Tooling;
using Nuke.Common.Tools.DotNet;
using Nuke.Common.Tools.GitVersion;
using Nuke.Common.Tools.ReportGenerator;
using Nuke.Common.Tools.Xunit;
using static Nuke.Common.IO.FileSystemTasks;
using static Nuke.Common.IO.PathConstruction;
using static Nuke.Common.Tools.DotNet.DotNetTasks;
using static Nuke.Common.Tools.ReportGenerator.ReportGeneratorTasks;
using static Nuke.Common.Tools.Xunit.XunitTasks;

[CheckBuildProjectConfigurations]
Expand Down Expand Up @@ -66,7 +68,7 @@ class Build : NukeBuild
"Branch spec {branchspec} is a pull request. Adding build number {buildnumber}",
BranchSpec, BuildNumber);

SemVer = string.Join('.', GitVersion.SemVer.Split('.').Take(3).Union(new [] { BuildNumber }));
SemVer = string.Join('.', GitVersion.SemVer.Split('.').Take(3).Union(new[] { BuildNumber }));
}

Serilog.Log.Information("SemVer = {semver}", SemVer);
Expand All @@ -91,6 +93,7 @@ class Build : NukeBuild
DotNetBuild(s => s
.SetProjectFile(Solution)
.SetConfiguration("CI")
.EnableNoLogo()
.EnableNoRestore()
.SetAssemblyVersion(GitVersion.AssemblySemVer)
.SetFileVersion(GitVersion.AssemblySemFileVer)
Expand Down Expand Up @@ -132,9 +135,22 @@ class Build : NukeBuild
.SetProjectFile(Solution.Specs.FluentAssertions_Specs)
.SetConfiguration("Debug")
.EnableNoBuild()
.SetDataCollector("XPlat Code Coverage")
.SetResultsDirectory(RootDirectory / "TestResults")
.CombineWith(
Solution.Specs.FluentAssertions_Specs.GetTargetFrameworks().Except(new[] { "net47" }),
(_, v) => _.SetFramework(v)));

ReportGenerator(s => s
.SetProcessToolPath(ToolPathResolver.GetPackageExecutable("ReportGenerator", "ReportGenerator.dll", framework: "net5.0"))
.SetTargetDirectory(RootDirectory / "TestResults" / "reports")
.AddReports(RootDirectory / "TestResults/**/coverage.cobertura.xml")
.AddReportTypes("HtmlInline_AzurePipelines_Dark", "lcov")
.SetAssemblyFilters("+FluentAssertions"));

string link = RootDirectory / "TestResults" / "reports" / "index.html";

Serilog.Log.Information($"Code coverage report: \x1b]8;;file://{link.Replace('\\', '/')}\x1b\\{link}\x1b]8;;\x1b\\");
});

Target TestFrameworks => _ => _
Expand Down Expand Up @@ -178,6 +194,8 @@ class Build : NukeBuild
.SetProject(Solution.Core.FluentAssertions)
.SetOutputDirectory(ArtifactsDirectory)
.SetConfiguration("Release")
.EnableNoLogo()
.EnableNoRestore()
Copy link
Member

Choose a reason for hiding this comment

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

There was a reason I had to keep restoring the dependencies, but I can't remember why.

Copy link
Member

Choose a reason for hiding this comment

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

I guess that was previously necessary because we built FluentAssertions.dll in debug mode i the Compile step, but #1674 changed that.

.EnableContinuousIntegrationBuild() // Necessary for deterministic builds
.SetVersion(SemVer));
});
Expand All @@ -187,7 +205,7 @@ class Build : NukeBuild
.OnlyWhenDynamic(() => IsTag)
.Executes(() =>
{
var packages = GlobFiles(ArtifactsDirectory, "*.nupkg");
IReadOnlyCollection<string> packages = GlobFiles(ArtifactsDirectory, "*.nupkg");

Assert.NotEmpty(packages.ToList());

Expand All @@ -201,5 +219,4 @@ class Build : NukeBuild
});

bool IsTag => BranchSpec != null && BranchSpec.Contains("refs/tags", StringComparison.InvariantCultureIgnoreCase);

}
1 change: 1 addition & 0 deletions Build/_build.csproj
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@
<ItemGroup>
<PackageDownload Include="GitVersion.Tool" Version="[5.8.1]" />
<PackageDownload Include="NSpec" Version="[3.1.0]" />
<PackageDownload Include="ReportGenerator" Version="[5.0.4]" />
<PackageDownload Include="xunit.runner.console" Version="[2.4.1]" />
<PackageReference Include="Nuke.Common" Version="6.0.1" />
</ItemGroup>
Expand Down
3 changes: 3 additions & 0 deletions Tests/FluentAssertions.Equivalency.Specs/FluentAssertions.Equivalency.Specs.csproj
View file
Open in desktop
Expand Up @@ -56,6 +56,9 @@
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="Xunit.StaFact" Version="1.1.5-alpha" />
<PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
<PackageReference Include="coverlet.collector" Version="3.1.1" PrivateAssets="all">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
Expand Down
3 changes: 3 additions & 0 deletions Tests/FluentAssertions.Specs/FluentAssertions.Specs.csproj
View file
Open in desktop
Expand Up @@ -60,6 +60,9 @@
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="Xunit.StaFact" Version="1.1.5-alpha" />
<PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
<PackageReference Include="coverlet.collector" Version="3.1.1" PrivateAssets="all">
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
Expand Down