Repository navigation
Expand file tree
/
Copy pathImpreciseAssert.ql
More file actions
93 lines (86 loc) · 2.83 KB
/
Copy pathImpreciseAssert.ql
File metadata and controls
93 lines (86 loc) · 2.83 KB
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
/**
* @name Imprecise assert
* @description Using 'assertTrue' or 'assertFalse' rather than a more specific assertion can give uninformative failure messages.
* @kind problem
* @tags quality
* maintainability
* readability
* @problem.severity recommendation
* @sub-severity high
* @precision very-high
* @id py/imprecise-assert
*/
import python
/* Helper predicate for CallToAssertOnComparison class */
predicate callToAssertOnComparison(Call call, string assertName, Cmpop op) {
call.getFunc().(Attribute).getName() = assertName and
(assertName = "assertTrue" or assertName = "assertFalse") and
exists(Compare cmp |
cmp = call.getArg(0) and
/* Exclude complex comparisons like: a < b < c */
not exists(cmp.getOp(1)) and
op = cmp.getOp(0)
)
}
class CallToAssertOnComparison extends Call {
CallToAssertOnComparison() { callToAssertOnComparison(this, _, _) }
Cmpop getOperator() { callToAssertOnComparison(this, _, result) }
string getMethodName() { callToAssertOnComparison(this, result, _) }
string getBetterName() {
exists(Cmpop op |
callToAssertOnComparison(this, "assertTrue", op) and
(
op instanceof Eq and result = "assertEqual"
or
op instanceof NotEq and result = "assertNotEqual"
or
op instanceof Lt and result = "assertLess"
or
op instanceof LtE and result = "assertLessEqual"
or
op instanceof Gt and result = "assertGreater"
or
op instanceof GtE and result = "assertGreaterEqual"
or
op instanceof In and result = "assertIn"
or
op instanceof NotIn and result = "assertNotIn"
or
op instanceof Is and result = "assertIs"
or
op instanceof IsNot and result = "assertIsNot"
)
or
callToAssertOnComparison(this, "assertFalse", op) and
(
op instanceof NotEq and result = "assertEqual"
or
op instanceof Eq and result = "assertNotEqual"
or
op instanceof GtE and result = "assertLess"
or
op instanceof Gt and result = "assertLessEqual"
or
op instanceof LtE and result = "assertGreater"
or
op instanceof Lt and result = "assertGreaterEqual"
or
op instanceof NotIn and result = "assertIn"
or
op instanceof In and result = "assertNotIn"
or
op instanceof IsNot and result = "assertIs"
or
op instanceof Is and result = "assertIsNot"
)
)
}
}
from CallToAssertOnComparison call
where
/* Exclude cases where an explicit message is provided*/
not exists(call.getArg(1))
select call,
call.getMethodName() + "(a " + call.getOperator().getSymbol() + " b) " +
"cannot provide an informative message. Using " + call.getBetterName() +
"(a, b) instead will give more informative messages."