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

SLVS-1625 CaYC: Replace Moq with Nsubstitute #5836

Merged
merged 6 commits into from
Nov 15, 2024
Merged

SLVS-1625 CaYC: Replace Moq with Nsubstitute #5836

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
73afff6
SLVS-1625 CaYC Education and its test class
gabriela-trutan-sonarsource Nov 14, 2024
c3b8c3f
SLVS-1625 CaYC SonarErrorListEventProcessor and its test class
gabriela-trutan-sonarsource Nov 14, 2024
01fe631
SLVS-1625 CaYC SLCoreRuleMetaDataProvider and its test class
gabriela-trutan-sonarsource Nov 14, 2024
0c8ba8d
SLVS-1625 CaYC ErrorListHelper and its test class
gabriela-trutan-sonarsource Nov 14, 2024
946fc14
SLVS-1625 CaYC AnalysisIssueVisualization and its test class
gabriela-trutan-sonarsource Nov 14, 2024
90b1455
SLVS-1625 Apply review feedback
gabriela-trutan-sonarsource Nov 15, 2024
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
2 changes: 1 addition & 1 deletion src/ConnectedMode.UnitTests/UI/ProgressReporterViewModelTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ namespace SonarLint.VisualStudio.ConnectedMode.UnitTests.UI;
[TestClass]
public class ProgressReporterViewModelTests
{
private ProgressReporterViewModel testSubject;
private ILogger logger;
private ProgressReporterViewModel testSubject;

[TestInitialize]
public void TestInitialize()
Expand Down
277 changes: 127 additions & 150 deletions src/Education.UnitTests/EducationTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,163 +19,140 @@
*/

using System.Windows.Documents;
using Moq;
using SonarLint.VisualStudio.Core;
using SonarLint.VisualStudio.Core.Suppressions;
using SonarLint.VisualStudio.Education.Rule;
using SonarLint.VisualStudio.Education.XamlGenerator;
using SonarLint.VisualStudio.TestInfrastructure;

namespace SonarLint.VisualStudio.Education.UnitTests
namespace SonarLint.VisualStudio.Education.UnitTests;

[TestClass]
public class EducationTests
{
[TestClass]
public class EducationTests
private readonly SonarCompositeRuleId knownRule = new("repoKey", "ruleKey");
private readonly SonarCompositeRuleId unknownRule = new("known", "xxx");
gabriela-trutan-sonarsource marked this conversation as resolved.
Show resolved Hide resolved

private ILogger logger;
private IRuleHelpToolWindow ruleDescriptionToolWindow;
private IRuleHelpXamlBuilder ruleHelpXamlBuilder;
private IRuleInfo ruleInfo;
private IRuleMetaDataProvider ruleMetadataProvider;
private IShowRuleInBrowser showRuleInBrowser;
private Education testSubject;
private IThreadHandling threadHandling;
private IToolWindowService toolWindowService;

[TestInitialize]
public void TestInitialize()
{
toolWindowService = Substitute.For<IToolWindowService>();
ruleMetadataProvider = Substitute.For<IRuleMetaDataProvider>();
showRuleInBrowser = Substitute.For<IShowRuleInBrowser>();
ruleHelpXamlBuilder = Substitute.For<IRuleHelpXamlBuilder>();
ruleDescriptionToolWindow = Substitute.For<IRuleHelpToolWindow>();
ruleInfo = Substitute.For<IRuleInfo>();
logger = new TestLogger(true);
threadHandling = new NoOpThreadHandler();
GetRuleInfoAsync(ruleInfo);

testSubject = new Education(toolWindowService, ruleMetadataProvider, showRuleInBrowser, logger, ruleHelpXamlBuilder, threadHandling);
}

[TestMethod]
public void MefCtor_CheckIsExported() =>
MefTestHelpers.CheckTypeCanBeImported<Education, IEducation>(
MefTestHelpers.CreateExport<IToolWindowService>(),
MefTestHelpers.CreateExport<IRuleMetaDataProvider>(),
MefTestHelpers.CreateExport<IShowRuleInBrowser>(),
MefTestHelpers.CreateExport<IRuleHelpXamlBuilder>(),
MefTestHelpers.CreateExport<ILogger>());

[TestMethod]
public void ShowRuleHelp_KnownRule_DocumentIsDisplayedInToolWindow()
{
var flowDocument = MockFlowDocument();
toolWindowService.GetToolWindow<RuleHelpToolWindow, IRuleHelpToolWindow>().Returns(ruleDescriptionToolWindow);
// Sanity check - tool window not yet fetched
toolWindowService.ReceivedCalls().Should().HaveCount(0);
gabriela-trutan-sonarsource marked this conversation as resolved.
Show resolved Hide resolved

// Act
testSubject.ShowRuleHelp(knownRule, null, null);

VerifyGetsRuleInfoForCorrectRuleId(knownRule);
VerifyRuleIsDisplayedInIde(flowDocument);
VerifyRuleNotShownInBrowser();
}

[TestMethod]
public void ShowRuleHelp_FailedToDisplayRule_RuleIsShownInBrowser()
{
ruleHelpXamlBuilder.When(x => x.Create(ruleInfo, /* todo by SLVS-1630 */ null)).Do(x => throw new Exception("some layout error"));
toolWindowService.ClearReceivedCalls(); // Called in the constructor, so need to reset to clear the list of invocations
gabriela-trutan-sonarsource marked this conversation as resolved.
Show resolved Hide resolved

testSubject.ShowRuleHelp(knownRule, null, /* todo by SLVS-1630 */ null);

VerifyGetsRuleInfoForCorrectRuleId(knownRule);
VerifyRuleShownInBrowser(knownRule);
VerifyAttemptsToBuildRuleButFails();
}

[TestMethod]
public void ShowRuleHelp_UnknownRule_RuleIsShownInBrowser()
{
GetRuleInfoAsync(null);
toolWindowService.ClearReceivedCalls(); // Called in the constructor, so need to reset to clear the list of invocations
gabriela-trutan-sonarsource marked this conversation as resolved.
Show resolved Hide resolved

testSubject.ShowRuleHelp(unknownRule, null, /* todo by SLVS-1630 */ null);

VerifyGetsRuleInfoForCorrectRuleId(unknownRule);
VerifyRuleShownInBrowser(unknownRule);
VerifyNotAttemptsBuildRule();
}

[TestMethod]
public void ShowRuleHelp_FilterableIssueProvided_CallsGetRuleInfoForIssue()
{
[TestMethod]
public void MefCtor_CheckIsExported()
{
MefTestHelpers.CheckTypeCanBeImported<Education, IEducation>(
MefTestHelpers.CreateExport<IToolWindowService>(),
MefTestHelpers.CreateExport<IRuleMetaDataProvider>(),
MefTestHelpers.CreateExport<IShowRuleInBrowser>(),
MefTestHelpers.CreateExport<IRuleHelpXamlBuilder>(),
MefTestHelpers.CreateExport<ILogger>());
}
var issueId = Guid.NewGuid();
GetRuleInfoAsync(null);

[TestMethod]
public void ShowRuleHelp_KnownRule_DocumentIsDisplayedInToolWindow()
{
var ruleMetaDataProvider = new Mock<IRuleMetaDataProvider>();
var ruleId = new SonarCompositeRuleId("repoKey", "ruleKey");

var ruleInfo = Mock.Of<IRuleInfo>();
ruleMetaDataProvider.Setup(x => x.GetRuleInfoAsync(It.IsAny<SonarCompositeRuleId>(), It.IsAny<Guid?>())).ReturnsAsync(ruleInfo);

var flowDocument = Mock.Of<FlowDocument>();
var ruleHelpXamlBuilder = new Mock<IRuleHelpXamlBuilder>();
ruleHelpXamlBuilder.Setup(x => x.Create(ruleInfo, /* todo by SLVS-1630 */ null)).Returns(flowDocument);

var ruleDescriptionToolWindow = new Mock<IRuleHelpToolWindow>();

var toolWindowService = new Mock<IToolWindowService>();
toolWindowService.Setup(x => x.GetToolWindow<RuleHelpToolWindow, IRuleHelpToolWindow>()).Returns(ruleDescriptionToolWindow.Object);

var showRuleInBrowser = new Mock<IShowRuleInBrowser>();
var testSubject = CreateEducation(toolWindowService.Object,
ruleMetaDataProvider.Object,
showRuleInBrowser.Object,
ruleHelpXamlBuilder.Object);

// Sanity check - tool window not yet fetched
toolWindowService.Invocations.Should().HaveCount(0);

// Act
testSubject.ShowRuleHelp(ruleId, null, null);

ruleMetaDataProvider.Verify(x => x.GetRuleInfoAsync(ruleId, It.IsAny<Guid?>()), Times.Once);
ruleHelpXamlBuilder.Verify(x => x.Create(ruleInfo, /* todo by SLVS-1630 */ null), Times.Once);
ruleDescriptionToolWindow.Verify(x => x.UpdateContent(flowDocument), Times.Once);
toolWindowService.Verify(x => x.Show(RuleHelpToolWindow.ToolWindowId), Times.Once);

showRuleInBrowser.Invocations.Should().HaveCount(0);
}

[TestMethod]
public void ShowRuleHelp_FailedToDisplayRule_RuleIsShownInBrowser()
{
var toolWindowService = new Mock<IToolWindowService>();
var ruleMetadataProvider = new Mock<IRuleMetaDataProvider>();
var ruleHelpXamlBuilder = new Mock<IRuleHelpXamlBuilder>();
var showRuleInBrowser = new Mock<IShowRuleInBrowser>();

var ruleId = new SonarCompositeRuleId("repoKey", "ruleKey");

var ruleInfo = Mock.Of<IRuleInfo>();
ruleMetadataProvider.Setup(x => x.GetRuleInfoAsync(It.IsAny<SonarCompositeRuleId>(), It.IsAny<Guid?>())).ReturnsAsync(ruleInfo);

ruleHelpXamlBuilder.Setup(x => x.Create(ruleInfo, /* todo by SLVS-1630 */ null)).Throws(new Exception("some layout error"));

var testSubject = CreateEducation(
toolWindowService.Object,
ruleMetadataProvider.Object,
showRuleInBrowser.Object,
ruleHelpXamlBuilder.Object);

toolWindowService.Reset(); // Called in the constructor, so need to reset to clear the list of invocations

testSubject.ShowRuleHelp(ruleId, null, /* todo by SLVS-1630 */null);

ruleMetadataProvider.Verify(x => x.GetRuleInfoAsync(ruleId, It.IsAny<Guid?>()), Times.Once);
showRuleInBrowser.Verify(x => x.ShowRuleDescription(ruleId), Times.Once);

// should have attempted to build the rule, but failed
ruleHelpXamlBuilder.Invocations.Should().HaveCount(1);
toolWindowService.Invocations.Should().HaveCount(1);
}

[TestMethod]
public void ShowRuleHelp_UnknownRule_RuleIsShownInBrowser()
{
var toolWindowService = new Mock<IToolWindowService>();
var ruleMetadataProvider = new Mock<IRuleMetaDataProvider>();
var ruleHelpXamlBuilder = new Mock<IRuleHelpXamlBuilder>();
var showRuleInBrowser = new Mock<IShowRuleInBrowser>();

var unknownRule = new SonarCompositeRuleId("known", "xxx");
ruleMetadataProvider.Setup(x => x.GetRuleInfoAsync(unknownRule, It.IsAny<Guid?>())).ReturnsAsync((IRuleInfo)null);

var testSubject = CreateEducation(
toolWindowService.Object,
ruleMetadataProvider.Object,
showRuleInBrowser.Object,
ruleHelpXamlBuilder.Object);

toolWindowService.Reset(); // Called in the constructor, so need to reset to clear the list of invocations

testSubject.ShowRuleHelp(unknownRule, null, /* todo by SLVS-1630 */ null);

ruleMetadataProvider.Verify(x => x.GetRuleInfoAsync(unknownRule, It.IsAny<Guid?>()), Times.Once);
showRuleInBrowser.Verify(x => x.ShowRuleDescription(unknownRule), Times.Once);

// Should not have attempted to build the rule
ruleHelpXamlBuilder.Invocations.Should().HaveCount(0);
toolWindowService.Invocations.Should().HaveCount(0);
}

[TestMethod]
public void ShowRuleHelp_FilterableIssueProvided_CallsGetRuleInfoForIssue()
{
var toolWindowService = new Mock<IToolWindowService>();
var ruleMetadataProvider = new Mock<IRuleMetaDataProvider>();
var ruleHelpXamlBuilder = new Mock<IRuleHelpXamlBuilder>();
var showRuleInBrowser = new Mock<IShowRuleInBrowser>();
var issueId = Guid.NewGuid();
var ruleId = new SonarCompositeRuleId("repoKey", "ruleKey");
ruleMetadataProvider.Setup(x => x.GetRuleInfoAsync(ruleId, issueId)).ReturnsAsync((IRuleInfo)null);
var testSubject = CreateEducation(
toolWindowService.Object,
ruleMetadataProvider.Object,
showRuleInBrowser.Object,
ruleHelpXamlBuilder.Object);

testSubject.ShowRuleHelp(ruleId,issueId, null);

ruleMetadataProvider.Verify(x => x.GetRuleInfoAsync(ruleId, issueId), Times.Once);
}

private Education CreateEducation(IToolWindowService toolWindowService = null,
IRuleMetaDataProvider ruleMetadataProvider = null,
IShowRuleInBrowser showRuleInBrowser = null,
IRuleHelpXamlBuilder ruleHelpXamlBuilder = null)
{
toolWindowService ??= Mock.Of<IToolWindowService>();
ruleMetadataProvider ??= Mock.Of<IRuleMetaDataProvider>();
showRuleInBrowser ??= Mock.Of<IShowRuleInBrowser>();
ruleHelpXamlBuilder ??= Mock.Of<IRuleHelpXamlBuilder>();
var logger = new TestLogger(logToConsole: true);
var threadHandling = new NoOpThreadHandler();

return new Education(toolWindowService, ruleMetadataProvider, showRuleInBrowser, logger, ruleHelpXamlBuilder, threadHandling);
}
testSubject.ShowRuleHelp(knownRule, issueId, null);

ruleMetadataProvider.Received(1).GetRuleInfoAsync(knownRule, issueId);
}

private void GetRuleInfoAsync(IRuleInfo returnedRuleInfo) => ruleMetadataProvider.GetRuleInfoAsync(Arg.Any<SonarCompositeRuleId>(), Arg.Any<Guid?>()).Returns(returnedRuleInfo);

private void VerifyGetsRuleInfoForCorrectRuleId(SonarCompositeRuleId ruleId) => ruleMetadataProvider.Received(1).GetRuleInfoAsync(ruleId, Arg.Any<Guid?>());

private void VerifyRuleShownInBrowser(SonarCompositeRuleId ruleId) => showRuleInBrowser.Received(1).ShowRuleDescription(ruleId);

private void VerifyRuleNotShownInBrowser() => showRuleInBrowser.ReceivedCalls().Should().HaveCount(0);

private void VerifyToolWindowShown() => toolWindowService.Received(1).Show(RuleHelpToolWindow.ToolWindowId);

private void VerifyAttemptsToBuildRuleButFails()
{
ruleHelpXamlBuilder.ReceivedCalls().Should().HaveCount(1);
toolWindowService.ReceivedCalls().Should().HaveCount(1);
}

private void VerifyNotAttemptsBuildRule()
{
ruleHelpXamlBuilder.ReceivedCalls().Should().HaveCount(0);
toolWindowService.ReceivedCalls().Should().HaveCount(0);
}

private void VerifyRuleIsDisplayedInIde(FlowDocument flowDocument)
{
ruleHelpXamlBuilder.Received(1).Create(ruleInfo, /* todo by SLVS-1630 */ null);
ruleDescriptionToolWindow.Received(1).UpdateContent(flowDocument);
VerifyToolWindowShown();
}

private FlowDocument MockFlowDocument()
{
var flowDocument = Substitute.For<FlowDocument>();
ruleHelpXamlBuilder.Create(ruleInfo, /* todo by SLVS-1630 */ null).Returns(flowDocument);
return flowDocument;
}
}
Loading