1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
* Copyright 2000-2014 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.siyeh.ig.junit;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.InheritanceUtil;
import com.intellij.util.IncorrectOperationException;
import com.intellij.util.containers.ContainerUtil;
import com.siyeh.InspectionGadgetsBundle;
import com.siyeh.ig.BaseInspection;
import com.siyeh.ig.BaseInspectionVisitor;
import com.siyeh.ig.InspectionGadgetsFix;
import com.siyeh.ig.psiutils.ExpressionUtils;
import com.siyeh.ig.psiutils.TypeUtils;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import java.util.Set;
/**
* @author Bas Leijdekkers
*/
public abstract class MisorderedAssertEqualsArgumentsInspectionBase extends BaseInspection {
@NonNls
private static final Set<String> methodNames =
ContainerUtil.newHashSet("assertEquals", "assertEqualsNoOrder", "assertNotEquals", "assertArrayEquals", "assertSame",
"assertNotSame", "failNotSame", "failNotEquals");
public abstract boolean checkTestNG();
@Override
@NotNull
public final String getDisplayName() {
return InspectionGadgetsBundle.message("misordered.assert.equals.arguments.display.name");
}
@Override
@NotNull
protected final String buildErrorString(Object... infos) {
return InspectionGadgetsBundle.message("misordered.assert.equals.arguments.problem.descriptor");
}
@Override
public final InspectionGadgetsFix buildFix(Object... infos) {
return new FlipArgumentsFix();
}
private static class FlipArgumentsFix extends InspectionGadgetsFix {
@Override
@NotNull
public String getFamilyName() {
return getName();
}
@Override
@NotNull
public String getName() {
return InspectionGadgetsBundle.message("misordered.assert.equals.arguments.flip.quickfix");
}
@Override
public void doFix(Project project, ProblemDescriptor descriptor) throws IncorrectOperationException {
final PsiElement methodNameIdentifier = descriptor.getPsiElement();
final PsiElement parent = methodNameIdentifier.getParent();
if (parent == null) {
return;
}
final PsiMethodCallExpression callExpression = (PsiMethodCallExpression)parent.getParent();
if (callExpression == null) {
return;
}
final PsiReferenceExpression methodExpression = callExpression.getMethodExpression();
final PsiMethod method = (PsiMethod)methodExpression.resolve();
if (method == null) {
return;
}
final PsiClass containingClass = method.getContainingClass();
final boolean junit;
if (InheritanceUtil.isInheritor(containingClass, "org.testng.Assert")) {
junit = false;
}
else if (InheritanceUtil.isInheritor(containingClass, "org.testng.AssertJUnit") ||
InheritanceUtil.isInheritor(containingClass, "junit.framework.Assert") ||
InheritanceUtil.isInheritor(containingClass, "org.junit.Assert")) {
junit = true;
}
else {
return;
}
final PsiParameterList parameterList = method.getParameterList();
final PsiParameter[] parameters = parameterList.getParameters();
final PsiType stringType = TypeUtils.getStringType(callExpression);
final PsiType parameterType1 = parameters[0].getType();
final PsiExpressionList argumentList = callExpression.getArgumentList();
final PsiExpression[] arguments = argumentList.getExpressions();
final PsiExpression expectedArgument;
final PsiExpression actualArgument;
if (junit) {
if (parameterType1.equals(stringType) && parameters.length > 2) {
expectedArgument = arguments[1];
actualArgument = arguments[2];
}
else {
expectedArgument = arguments[0];
actualArgument = arguments[1];
}
}
else {
actualArgument = arguments[0];
expectedArgument = arguments[1];
}
final PsiElement copy = expectedArgument.copy();
expectedArgument.replace(actualArgument);
actualArgument.replace(copy);
}
}
@Override
public final BaseInspectionVisitor buildVisitor() {
return new MisorderedAssertEqualsParametersVisitor();
}
private class MisorderedAssertEqualsParametersVisitor extends BaseInspectionVisitor {
@Override
public void visitMethodCallExpression(@NotNull PsiMethodCallExpression expression) {
super.visitMethodCallExpression(expression);
final PsiReferenceExpression methodExpression = expression.getMethodExpression();
@NonNls final String methodName = methodExpression.getReferenceName();
if (!methodNames.contains(methodName)) {
return;
}
final PsiMethod method = expression.resolveMethod();
if (method == null || method.hasModifierProperty(PsiModifier.PRIVATE)) {
return;
}
final PsiExpressionList argumentList = expression.getArgumentList();
final PsiExpression[] arguments = argumentList.getExpressions();
if (arguments.length < 2) {
return;
}
final PsiType stringType = TypeUtils.getStringType(expression);
final PsiClass containingClass = method.getContainingClass();
final PsiExpression expectedArgument;
final PsiExpression actualArgument;
if (checkTestNG() ?
InheritanceUtil.isInheritor(containingClass, "org.testng.AssertJUnit") :
InheritanceUtil.isInheritor(containingClass, "junit.framework.Assert") ||
InheritanceUtil.isInheritor(containingClass, "org.junit.Assert")) {
final PsiType firstArgumentType = arguments[0].getType();
if (stringType.equals(firstArgumentType) && arguments.length > 2) {
expectedArgument = arguments[1];
actualArgument = arguments[2];
}
else {
expectedArgument = arguments[0];
actualArgument = arguments[1];
}
} else if (checkTestNG() && InheritanceUtil.isInheritor(containingClass, "org.testng.Assert")){
expectedArgument = arguments[1];
actualArgument = arguments[0];
} else {
return;
}
if (expectedArgument == null || actualArgument == null) {
return;
}
if (looksLikeExpectedArgument(expectedArgument) || !looksLikeExpectedArgument(actualArgument)) {
return;
}
registerMethodCallError(expression);
}
private boolean looksLikeExpectedArgument(PsiExpression expression) {
if (ExpressionUtils.computeConstantExpression(expression) != null) {
return true;
}
if (expression instanceof PsiReferenceExpression) {
final PsiReferenceExpression referenceExpression = (PsiReferenceExpression)expression;
final PsiElement target = referenceExpression.resolve();
if (target instanceof PsiEnumConstant) {
return true;
}
if ((target instanceof PsiField)) {
final PsiField field = (PsiField)target;
if (field.hasModifierProperty(PsiModifier.STATIC) && field.hasModifierProperty(PsiModifier.FINAL)) {
return true;
}
}
}
return false;
}
}
}
|
