Skip to content

Fix MissingRaise false positives on Self constructor calls #310

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

Merged
merged 1 commit into from
Nov 3, 2024
Merged

Fix MissingRaise false positives on Self constructor calls #310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
50 changes: 37 additions & 13 deletions delphi-checks/src/main/java/au/com/integradev/delphi/checks/MissingRaiseCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,30 +55,54 @@ public DelphiCheckContext visit(
return context;
}

private boolean isExceptionConstructorInvocation(ExpressionNode expression) {
if (!(expression instanceof PrimaryExpressionNode)
|| !(expression.getChild(0) instanceof NameReferenceNode)) {
return false;
}
private boolean isExceptionType(Type type) {
return type.is(BASE_EXCEPTION) || type.isDescendantOf(BASE_EXCEPTION);
}

NameDeclaration declaration =
((NameReferenceNode) expression.getChild(0)).getLastName().getNameDeclaration();
private RoutineNameDeclaration getConstructor(NameReferenceNode nameReference) {
NameDeclaration declaration = nameReference.getNameDeclaration();
if (!(declaration instanceof RoutineNameDeclaration)) {
return false;
// Not an invocation
return null;
}

RoutineNameDeclaration routineDeclaration = (RoutineNameDeclaration) declaration;
if (routineDeclaration.getRoutineKind() != RoutineKind.CONSTRUCTOR) {
return routineDeclaration.getRoutineKind() == RoutineKind.CONSTRUCTOR
? routineDeclaration
: null;
}

private Type getType(NameReferenceNode nameReference) {
NameDeclaration declaration = nameReference.getNameDeclaration();
if (!(declaration instanceof TypeNameDeclaration)) {
// Type could not be resolved
return null;
}

return ((TypeNameDeclaration) declaration).getType();
}

private boolean isExceptionConstructorInvocation(ExpressionNode expression) {
if (!(expression instanceof PrimaryExpressionNode)
|| !(expression.getChild(0) instanceof NameReferenceNode)) {
// Not a name reference
return false;
}

TypeNameDeclaration typeDecl = routineDeclaration.getTypeDeclaration();
if (typeDecl == null) {
NameReferenceNode lastName = ((NameReferenceNode) expression.getChild(0)).getLastName();
NameReferenceNode prevName = lastName.prevName();
if (prevName == null) {
// Not a qualified reference
return false;
}

Type type = typeDecl.getType();
RoutineNameDeclaration constructorDeclaration = getConstructor(lastName);
if (constructorDeclaration == null) {
// Not a constructor
return false;
}

return type.is(BASE_EXCEPTION) || type.isDescendantOf(BASE_EXCEPTION);
Type constructingType = getType(prevName);
return constructingType != null && isExceptionType(constructingType);
}
}
168 changes: 168 additions & 0 deletions delphi-checks/src/test/java/au/com/integradev/delphi/checks/MissingRaiseCheckTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,172 @@ void testAssignedDescendantExceptionShouldNotAddIssue() {
.appendImpl(" MyError := ECalculatorError.Create(1, 2);"))
.verifyNoIssues();
}

@Test
void testImplicitSelfCallInConstructorShouldNotAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" constructor CreateFmt(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("constructor ECalculatorError.CreateFmt(A: Integer; B: Integer);")
.appendImpl("begin")
.appendImpl(" CreateFmt(A, B);")
.appendImpl("end;"))
.verifyNoIssues();
}

@Test
void testExplicitSelfCallInConstructorShouldNotAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" constructor CreateFmt(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("constructor ECalculatorError.CreateFmt(A: Integer; B: Integer);")
.appendImpl("begin")
.appendImpl(" Self.CreateFmt(A, B);")
.appendImpl("end;"))
.verifyNoIssues();
}

@Test
void testSelfAncestorCallInMethodShouldNotAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" function Add(A: Integer; B: Integer): Integer;")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("function ECalculatorError.Add(A: Integer; B: Integer): Integer;")
.appendImpl("begin")
.appendImpl(" Create('foo');")
.appendImpl("end;"))
.verifyNoIssues();
}

@Test
void testNewInstanceOfAncestorTypeInMethodShouldAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" function Add(A: Integer; B: Integer): Integer;")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("function ECalculatorError.Add(A: Integer; B: Integer): Integer;")
.appendImpl("begin")
.appendImpl(" Exception.Create('foo'); // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

@Test
void testImplicitSelfCallInMethodShouldNotAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" function Add(A: Integer; B: Integer): Integer;")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("function ECalculatorError.Add(A: Integer; B: Integer): Integer;")
.appendImpl("begin")
.appendImpl(" Create(A, B);")
.appendImpl("end;"))
.verifyNoIssues();
}

@Test
void testExplicitSelfCallInMethodShouldNotAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" function Add(A: Integer; B: Integer): Integer;")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("function ECalculatorError.Add(A: Integer; B: Integer): Integer;")
.appendImpl("begin")
.appendImpl(" Self.Create(A, B);")
.appendImpl("end;"))
.verifyNoIssues();
}

@Test
void testNewInstanceOfSelfTypeInMethodShouldAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" function Add(A: Integer; B: Integer): Integer;")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("function ECalculatorError.Add(A: Integer; B: Integer): Integer;")
.appendImpl("begin")
.appendImpl(" ECalculatorError.Create(A, B); // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}

@Test
void testNewInstanceOfSelfTypeInConstructorShouldAddIssue() {
CheckVerifier.newVerifier()
.withCheck(new MissingRaiseCheck())
.withStandardLibraryUnit(sysUtils())
.onFile(
new DelphiTestUnitBuilder()
.appendDecl("uses System.SysUtils;")
.appendDecl("type")
.appendDecl(" ECalculatorError = class(Exception)")
.appendDecl(" public")
.appendDecl(" constructor CreateFmt(A: Integer; B: Integer);")
.appendDecl(" constructor Create(A: Integer; B: Integer);")
.appendDecl(" end;")
.appendImpl("constructor ECalculatorError.CreateFmt(A: Integer; B: Integer);")
.appendImpl("begin")
.appendImpl(" ECalculatorError.Create(A, B); // Noncompliant")
.appendImpl("end;"))
.verifyIssues();
}
}
Loading