public void FunctionReturnValueNotUsed_QuickFixWorks_Interface()
{
const string inputInterfaceCode =
@"Public Function Test() As Integer
End Function";
const string expectedInterfaceCode =
@"Public Sub Test()
End Sub";
const string inputImplementationCode1 =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string inputImplementationCode2 =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string callSiteCode =
@"
Public Function Baz()
Dim testObj As IFoo
Set testObj = new Bar
testObj.Test
End Function";
var builder = new MockVbeBuilder();
var vbe = builder.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
.AddComponent("IFoo", ComponentType.ClassModule, inputInterfaceCode)
.AddComponent("Bar", ComponentType.ClassModule, inputImplementationCode1)
.AddComponent("Bar2", ComponentType.ClassModule, inputImplementationCode2)
.AddComponent("TestModule", ComponentType.StandardModule, callSiteCode)
.AddProjectToVbeBuilder().Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
new ConvertToProcedureQuickFix(state).Fix(inspectionResults.First());
var component = vbe.Object.VBProjects[0].VBComponents[0];
Assert.AreEqual(expectedInterfaceCode, state.GetRewriter(component).GetText());
}
}
public void FunctionReturnValueNotUsed_QuickFixWorks_NoInterface_ManyBodyStatements()
{
const string inputCode =
@"Function foo(ByRef fizz As Boolean) As Boolean
fizz = True
goo
label1:
foo = fizz
End Function
Sub goo()
End Sub";
const string expectedCode =
@"Sub foo(ByRef fizz As Boolean)
fizz = True
goo
label1:
End Sub
Sub goo()
End Sub";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock <ISinks>().Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new FunctionReturnValueNotUsedInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
string actual = module.Lines();
Assert.AreEqual(expectedCode, actual);
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_IgnoresBuiltInFunctions()
{
const string inputCode =
@"Public Sub Dummy()
MsgBox ""Test""
Workbooks.Add
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_ReturnsResult_NoReturnValueAssignment()
{
const string inputCode =
@"Public Function Foo() As Integer
End Function
Public Sub Bar()
Foo
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_ReturnValueAssignment()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Public Sub Baz()
TestVal = Foo(""Test"")
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_QuickFixWorks_NoInterface()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Boolean
If True Then
Foo = _
True
Else
Foo = False
End If
End Function";
const string expectedCode =
@"Public Sub Foo(ByVal bar As String)
If True Then
Else
End If
End Sub";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState());
parser.Parse();
if (parser.State.Status == ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new FunctionReturnValueNotUsedInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
string actual = module.Lines();
Assert.AreEqual(expectedCode, actual);
}
public void GivenInterfaceImplementationMember_ReturnsNoResult()
{
const string interfaceCode =
@"Public Function Test() As Integer
End Function";
const string implementationCode =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string callSiteCode =
@"
Public Sub Baz()
Dim testObj As IFoo
Set testObj = new Bar()
Dim result As Integer
result = testObj.Test()
End Sub";
//Arrange
var builder = new MockVbeBuilder();
var projectBuilder = builder.ProjectBuilder("TestProject", vbext_ProjectProtection.vbext_pp_none);
projectBuilder.AddComponent("IFoo", vbext_ComponentType.vbext_ct_ClassModule, interfaceCode);
projectBuilder.AddComponent("Bar", vbext_ComponentType.vbext_ct_ClassModule, implementationCode);
projectBuilder.AddComponent("TestModule", vbext_ComponentType.vbext_ct_StdModule, callSiteCode);
var vbe = projectBuilder.MockVbeBuilder().Build();
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState());
parser.Parse();
if (parser.State.Status == ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new FunctionReturnValueNotUsedInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_Ignored_DoesNotReturnResult_AddressOf()
{
const string inputCode =
@"'@Ignore FunctionReturnValueNotUsed
Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Public Sub Bar()
Bar AddressOf Foo
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.IsFalse(inspectionResults.Any());
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_RecursiveFunction()
{
const string inputCode =
@"Public Function Factorial(ByVal n As Long) As Long
If n <= 1 Then
Factorial = 1
Else
Factorial = Factorial(n - 1) * n
End If
End Function";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_ReturnsResult_AddressOf()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Public Sub Bar()
Bar AddressOf Foo
End Sub";
IVBComponent component;
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out component);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(1, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_ReturnsResult_CallWithoutAssignment()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Public Sub Bar()
Foo ""Test""
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(1, inspectionResults.Count());
}
}
public void FunctionReturnValueNotUsed_IgnoreQuickFixWorks()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Boolean
End Function
Public Sub Goo()
Foo ""test""
End Sub";
const string expectedCode =
@"'@Ignore FunctionReturnValueNotUsed
Public Function Foo(ByVal bar As String) As Boolean
End Function
Public Sub Goo()
Foo ""test""
End Sub";
//Arrange
var builder = new MockVbeBuilder();
VBComponent component;
var vbe = builder.BuildFromSingleStandardModule(inputCode, out component);
var project = vbe.Object.VBProjects.Item(0);
var module = project.VBComponents.Item(0).CodeModule;
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState(new Mock <ISinks>().Object));
parser.Parse(new CancellationTokenSource());
if (parser.State.Status >= ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new FunctionReturnValueNotUsedInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.Single(s => s is IgnoreOnceQuickFix).Fix();
Assert.AreEqual(expectedCode, module.Lines());
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_MultipleConsecutiveCalls()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Public Sub Baz()
Foo Foo(Foo(""Bar""))
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_ForEachStatement()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Sub Bar(ByVal fizz As Boolean)
End Sub
Public Sub Baz()
For Each Bar In Foo
Next Bar
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
var state = MockParser.CreateAndParse(vbe.Object);
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults();
Assert.AreEqual(0, inspectionResults.Count());
}
public void FunctionReturnValueNotUsed_DoesNotReturnResult_ArgumentFunctionCall()
{
const string inputCode =
@"Public Function Foo(ByVal bar As String) As Integer
Foo = 42
End Function
Sub Bar(ByVal fizz As Boolean)
End Sub
Public Sub Baz()
Bar Foo(""Test"")
End Sub";
var vbe = MockVbeBuilder.BuildFromSingleStandardModule(inputCode, out _);
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void ChainedMemberAccess_ReturnsNoResult()
{
const string inputCode = @"
Public Function GetIt(x As Long) As Object
End Function
Public Sub Baz()
GetIt(1).Select
End Sub";
var builder = new MockVbeBuilder();
var vbe = builder.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
.AddComponent("TestModule", ComponentType.StandardModule, inputCode)
.AddProjectToVbeBuilder().Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void GivenInterfaceImplementationMember_ReturnsNoResult()
{
const string interfaceCode =
@"Public Function Test() As Integer
End Function";
const string implementationCode =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string callSiteCode =
@"
Public Sub Baz()
Dim testObj As IFoo
Set testObj = new Bar
Dim result As Integer
result = testObj.Test
End Sub";
var builder = new MockVbeBuilder();
var vbe = builder.ProjectBuilder("TestProject", ProjectProtection.Unprotected)
.AddComponent("IFoo", ComponentType.ClassModule, interfaceCode)
.AddComponent("Bar", ComponentType.ClassModule, implementationCode)
.AddComponent("TestModule", ComponentType.StandardModule, callSiteCode)
.AddProjectToVbeBuilder().Build();
using (var state = MockParser.CreateAndParse(vbe.Object))
{
var inspection = new FunctionReturnValueNotUsedInspection(state);
var inspectionResults = inspection.GetInspectionResults(CancellationToken.None);
Assert.AreEqual(0, inspectionResults.Count());
}
}
public void InspectionType()
{
var inspection = new FunctionReturnValueNotUsedInspection(null);
Assert.AreEqual(CodeInspectionType.CodeQualityIssues, inspection.InspectionType);
}
public void FunctionReturnValueNotUsed_QuickFixWorks_Interface()
{
const string inputInterfaceCode =
@"Public Function Test() As Integer
End Function";
const string expectedInterfaceCode =
@"Public Sub Test()
End Sub";
const string inputImplementationCode1 =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string expectedImplementationCode1 =
@"Implements IFoo
Public Sub IFoo_Test()
End Sub";
const string inputImplementationCode2 =
@"Implements IFoo
Public Function IFoo_Test() As Integer
IFoo_Test = 42
End Function";
const string expectedImplementationCode2 =
@"Implements IFoo
Public Sub IFoo_Test()
End Sub";
const string callSiteCode =
@"
Public Function Baz()
Dim testObj As IFoo
Set testObj = new Bar()
testObj.Test
End Function";
//Arrange
var builder = new MockVbeBuilder();
var projectBuilder = builder.ProjectBuilder("TestProject", vbext_ProjectProtection.vbext_pp_none);
projectBuilder.AddComponent("IFoo", vbext_ComponentType.vbext_ct_ClassModule, inputInterfaceCode);
projectBuilder.AddComponent("Bar", vbext_ComponentType.vbext_ct_ClassModule, inputImplementationCode1);
projectBuilder.AddComponent("Bar2", vbext_ComponentType.vbext_ct_ClassModule, inputImplementationCode2);
projectBuilder.AddComponent("TestModule", vbext_ComponentType.vbext_ct_StdModule, callSiteCode);
var vbe = projectBuilder.MockVbeBuilder().Build();
var mockHost = new Mock <IHostApplication>();
mockHost.SetupAllProperties();
var parser = MockParser.Create(vbe.Object, new RubberduckParserState());
parser.Parse();
if (parser.State.Status == ParserState.Error)
{
Assert.Inconclusive("Parser Error");
}
var inspection = new FunctionReturnValueNotUsedInspection(parser.State);
var inspectionResults = inspection.GetInspectionResults();
inspectionResults.First().QuickFixes.First().Fix();
var project = vbe.Object.VBProjects.Item(0);
var interfaceModule = project.VBComponents.Item(0).CodeModule;
string actualInterface = interfaceModule.Lines();
Assert.AreEqual(expectedInterfaceCode, actualInterface, "Interface");
var implementationModule1 = project.VBComponents.Item(1).CodeModule;
string actualImplementation1 = implementationModule1.Lines();
//Assert.AreEqual(expectedImplementationCode1, actualImplementation1, "Implementation1");
var implementationModule2 = project.VBComponents.Item(2).CodeModule;
string actualImplementation2 = implementationModule2.Lines();
//Assert.AreEqual(expectedImplementationCode2, actualImplementation2, "Implementation2");
}
