iframe-proxy | Sunbelt Computer Software

93 lines (86 loc) · 2.83 KB

/**

* @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"

op instanceof NotEq and result = "assertNotEqual"

op instanceof Lt and result = "assertLess"

op instanceof LtE and result = "assertLessEqual"

op instanceof Gt and result = "assertGreater"

op instanceof GtE and result = "assertGreaterEqual"

op instanceof In and result = "assertIn"

op instanceof NotIn and result = "assertNotIn"

op instanceof Is and result = "assertIs"

op instanceof IsNot and result = "assertIsNot"

)

callToAssertOnComparison(this, "assertFalse", op) and

(

op instanceof NotEq and result = "assertEqual"

op instanceof Eq and result = "assertNotEqual"

op instanceof GtE and result = "assertLess"

op instanceof Gt and result = "assertLessEqual"

op instanceof LtE and result = "assertGreater"

op instanceof Lt and result = "assertGreaterEqual"

op instanceof NotIn and result = "assertIn"

op instanceof In and result = "assertNotIn"

op instanceof IsNot and result = "assertIs"

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."

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

ImpreciseAssert.ql

Latest commit

History

ImpreciseAssert.ql

File metadata and controls