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

Include test assembly in incudes only when necessary #496

Merged
merged 9 commits into from
Mar 11, 2025
Merged

Include test assembly in incudes only when necessary #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d4ed3a1
OpenCover include when necessary - tests to come
tonyhallett Mar 10, 2025
bae106d
Merge branch 'master' into include-test-assembly-in-incudes-only-when…
tonyhallett Mar 10, 2025
7e0dd27
refactor and tests for OpenCover
tonyhallett Mar 10, 2025
d4acf1a
Coverlet console
tonyhallett Mar 10, 2025
111885d
coverlet collector
tonyhallett Mar 10, 2025
64cfd7c
simplify OpenCover
tonyhallett Mar 10, 2025
e4a5339
ms code coverage
tonyhallett Mar 11, 2025
158aede
update readme
tonyhallett Mar 11, 2025
dac99c2
refactor
tonyhallett Mar 11, 2025
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
89 changes: 88 additions & 1 deletion FineCodeCoverageTests/CoverletConsole_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@

namespace Test
{

public class CoverletExeArgumentsProvider_Tests
{
private const string testProjectName = "TestProject";
[Test]
public void Should_Have_ExcludeByAttribute_Setting_For_Each_ExcludeByAttribute()
{
Expand All @@ -43,12 +43,99 @@ public void Should_Unqualified_Qualified_ExcludeByAttribute()
AssertHasSetting(coverletSettings, "--exclude-by-attribute ExcludeByAttribute1");
}

[Test]
public void Should_Not_Add_Test_Test_Assembly_To_Includes_When_IncludeTestAssembly_And_No_Other_Includes()
{
var mockCoverageProject = SafeMockCoverageProject();
mockCoverageProject.SetupGet(cp => cp.Settings.IncludeTestAssembly).Returns(true);

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.IsFalse(HasIncludedTestAssemblySetting(coverletSettings));
}

private bool HasIncludedTestAssemblySetting(List<string> coverletSettings)
{
return coverletSettings.Any(coverletSetting => coverletSetting == $@"--include ""[{testProjectName}]*""");
}

[Test]
public void Should_Add_Test_Test_Assembly_To_Includes_When_IncludeTestAssembly_And_Other_Includes()
{
var mockCoverageProject = SafeMockCoverageProject();
mockCoverageProject.SetupGet(cp => cp.Settings.IncludeTestAssembly).Returns(true);
mockCoverageProject.SetupGet(cp => cp.Settings.Include).Returns(new string[] { "[anassembly]*" });

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.IsTrue(HasIncludedTestAssemblySetting(coverletSettings));
}

[Test]
public void Should_Add_IncludedReferencedProjects_As_Include()
{
var mockCoverageProject = SafeMockCoverageProject();
var mockReferencedProject = new Mock<IReferencedProject>();
mockReferencedProject.SetupGet(rp => rp.AssemblyName).Returns("ReferencedProject");
mockCoverageProject.SetupGet(cp => cp.IncludedReferencedProjects).Returns(new List<IReferencedProject> { mockReferencedProject.Object});

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.True(coverletSettings.Contains($@"--include ""[ReferencedProject]*"""));

}

[Test]
public void Should_Include_From_Settings()
{
var mockCoverageProject = SafeMockCoverageProject();
mockCoverageProject.SetupGet(cp => cp.Settings.Include).Returns(new string[]{ "[Include]*" });

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.True(coverletSettings.Contains($@"--include ""[Include]*"""));

}

public void Should_Add_ExcludedReferencedProjects_As_Exclude()
{
var mockCoverageProject = SafeMockCoverageProject();
var mockReferencedProject = new Mock<IReferencedProject>();
mockReferencedProject.SetupGet(rp => rp.AssemblyName).Returns("ReferencedProject");
mockCoverageProject.SetupGet(cp => cp.ExcludedReferencedProjects).Returns(new List<IReferencedProject> { mockReferencedProject.Object });

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.True(coverletSettings.Contains($@"--exclude ""[ReferencedProject]*"""));

}

[Test]
public void Should_Exclude_From_Settings()
{
var mockCoverageProject = SafeMockCoverageProject();
mockCoverageProject.SetupGet(cp => cp.Settings.Exclude).Returns(new string[] { "[Exclude]*" });

var coverletExeArgumentsProvider = new CoverletExeArgumentsProvider();
var coverletSettings = coverletExeArgumentsProvider.GetArguments(mockCoverageProject.Object);

Assert.True(coverletSettings.Contains($@"--exclude ""[Exclude]*"""));

}


private Mock<ICoverageProject> SafeMockCoverageProject()
{
var mockCoverageProject = new Mock<ICoverageProject>();
mockCoverageProject.SetupGet(coverageProject => coverageProject.IncludedReferencedProjects).Returns(new List<IReferencedProject>());
mockCoverageProject.SetupGet(coverageProject => coverageProject.ExcludedReferencedProjects).Returns(new List<IReferencedProject>());
mockCoverageProject.SetupGet(coverageProject => coverageProject.Settings).Returns(new Mock<IAppOptions>().Object);
mockCoverageProject.Setup(coverageProject => coverageProject.ProjectName).Returns(testProjectName);
return mockCoverageProject;
}

Expand Down
45 changes: 43 additions & 2 deletions FineCodeCoverageTests/CoverletDataCollectorUtil_RunAsync_Tests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,17 +118,58 @@ public async Task Should_Get_Settings_With_ExcludeByAttribute_From_CoverageProje
}

[Test]
public async Task Should_Get_Settings_With_Include_From_CoverageProject_And_RunSettings_Async()
public async Task Should_Include_From_CoverageProject_Settings_Include_And_RunSettings_Async()
{
var projectInclude= new string[] { "included" };
mockCoverageProject.Setup(cp => cp.Settings.Include).Returns(projectInclude);
mockCoverageProject.Setup(cp => cp.CoverageOutputFolder).Returns("");

await coverletDataCollectorUtil.RunAsync(CancellationToken.None);
mockDataCollectorSettingsBuilder.Verify(b => b.WithInclude(projectInclude, It.IsAny<string>()));
}

[Test]
public async Task Should_Include_From_CoverageProject_IncludedReferencedProjects_And_RunSettings_Async()
{
var projectInclude = new string[] { "[ReferencedProject]*" };
mockCoverageProject.Setup(cp => cp.CoverageOutputFolder).Returns("");
var mockReferencedProject = new Mock<IReferencedProject>();
mockReferencedProject.SetupGet(rp => rp.AssemblyName).Returns("ReferencedProject");
mockCoverageProject.Setup(cp => cp.IncludedReferencedProjects).Returns(new List<IReferencedProject> { mockReferencedProject.Object });

await coverletDataCollectorUtil.RunAsync(CancellationToken.None);
mockDataCollectorSettingsBuilder.Verify(b => b.WithInclude(projectInclude, It.IsAny<string>()));
}

[Test]
public async Task Should_Not_Include_Test_Assembly_When_IncludeTestAssembly_True_And_No_Other_Includes_Async()
{
mockCoverageProject.Setup(cp => cp.CoverageOutputFolder).Returns("");
mockCoverageProject.Setup(cp => cp.Settings.IncludeTestAssembly).Returns(true);
mockRunSettingsCoverletConfiguration.Setup(rsc => rsc.Include).Returns("rsincluded");

await coverletDataCollectorUtil.RunAsync(CancellationToken.None);
mockDataCollectorSettingsBuilder.Verify(b => b.WithInclude(new string[] { },It.IsAny<string>()));
}

[Test]
public async Task Should_Include_Test_Assembly_When_IncludeTestAssembly_True_And_Other_Includes_Async()
{
mockCoverageProject.Setup(cp => cp.CoverageOutputFolder).Returns("");
var projectInclude = new string[] { "included" };
mockCoverageProject.Setup(cp => cp.Settings.Include).Returns(projectInclude);
mockCoverageProject.Setup(cp => cp.Settings.IncludeTestAssembly).Returns(true);
mockCoverageProject.Setup(cp => cp.ProjectName).Returns("TestProject");
mockRunSettingsCoverletConfiguration.Setup(rsc => rsc.Include).Returns("rsincluded");

await coverletDataCollectorUtil.RunAsync(CancellationToken.None);
mockDataCollectorSettingsBuilder.Verify(b => b.WithInclude(projectInclude, "rsincluded"));
mockDataCollectorSettingsBuilder.Verify(
b => b.WithInclude(
It.Is<string[]>(includes => includes.OrderBy(incl => incl).SequenceEqual(new string[] { "[TestProject]*", "included"})),
It.IsAny<string>()));
}


[TestCase(true,"true")]
[TestCase(false, "false")]
public async Task Should_Get_Settings_With_IncludeTestAssembly_From_CoverageProject_And_RunSettings_Async(bool projectIncludeTestAssembly, string runSettingsIncludeTestAssembly)
Expand Down
Loading
Loading