hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Now flag aliases with the 'get' or 'as' prefix that resolve to predicates lacking a return type.

Browse Source 
Co-authored-by: asgerf <asgerf@github.com>
This commit is contained in:
Napalys
2024-12-02 12:43:52 +01:00
parent 67745e6332
commit 7db9b7d758
3 changed files with 37 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
ql/ql/src/queries/style/ValidatePredicateGetReturns.ql
View File

@@ -21,18 +21,17 @@ predicate isGetPredicate(Predicate pred, string prefix) {
} }
/** /**
* Checks if a predicate has a return type. * Checks if a predicate has a return type. This is phrased negatively to not flag unresolved aliases.
*/ */
predicate hasReturnType(Predicate pred) { exists(pred.getReturnTypeExpr()) } predicate hasNoReturnType(Predicate pred) {
not exists(pred.getReturnTypeExpr()) and
/** not pred.(ClasslessPredicate).getAlias() instanceof PredicateExpr
* Checks if a predicate is an alias using getAlias(). or
*/ hasNoReturnType(pred.(ClasslessPredicate).getAlias().(PredicateExpr).getResolvedPredicate())
predicate isAlias(Predicate pred) { exists(pred.(ClasslessPredicate).getAlias()) } }
from Predicate pred, string prefix from Predicate pred, string prefix
where where
isGetPredicate(pred, prefix) and isGetPredicate(pred, prefix) and
not hasReturnType(pred) and hasNoReturnType(pred)
not isAlias(pred)
select pred, "This predicate starts with '" + prefix + "' but does not return a value." select pred, "This predicate starts with '" + prefix + "' but does not return a value."

3
ql/ql/test/queries/style/ValidatePredicateGetReturns/ValidatePredicateGetReturns.expected
View File

@@ -1,3 +1,6 @@
| test.qll:4:11:4:18 | ClasslessPredicate getValue | This predicate starts with 'get' but does not return a value. | | test.qll:4:11:4:18 | ClasslessPredicate getValue | This predicate starts with 'get' but does not return a value. |
| test.qll:25:11:25:28 | ClasslessPredicate getImplementation2 | This predicate starts with 'get' but does not return a value. | | test.qll:25:11:25:28 | ClasslessPredicate getImplementation2 | This predicate starts with 'get' but does not return a value. |
| test.qll:28:11:28:19 | ClasslessPredicate getAlias2 | This predicate starts with 'get' but does not return a value. |
| test.qll:31:11:31:17 | ClasslessPredicate asValue | This predicate starts with 'as' but does not return a value. | | test.qll:31:11:31:17 | ClasslessPredicate asValue | This predicate starts with 'as' but does not return a value. |
| test.qll:48:11:48:19 | ClasslessPredicate getAlias4 | This predicate starts with 'get' but does not return a value. |
| test.qll:61:11:61:22 | ClasslessPredicate getDistance2 | This predicate starts with 'get' but does not return a value. |

27
ql/ql/test/queries/style/ValidatePredicateGetReturns/test.qll
View File

@@ -24,7 +24,7 @@ predicate retrieveValue() { none() }
// NOT OK -- starts with get and does not return value // NOT OK -- starts with get and does not return value
predicate getImplementation2() { none() } predicate getImplementation2() { none() }
// OK -- is an alias // NOT OK -- is an alias for a predicate which does not have a return value
predicate getAlias2 = getImplementation2/0; predicate getAlias2 = getImplementation2/0;
// NOT OK -- starts with as and does not return value // NOT OK -- starts with as and does not return value
@@ -40,3 +40,28 @@ string asString() { result = "string" }
HiddenType getInjectableCompositeActionNode() { HiddenType getInjectableCompositeActionNode() {
exists(HiddenType hidden | result = hidden.toString()) exists(HiddenType hidden | result = hidden.toString())
} }
// OK
predicate implementation4() { none() }
// NOT OK -- is an alias
predicate getAlias4 = implementation4/0;
// OK -- is an alias
predicate alias5 = implementation4/0;
int root() { none() }
predicate edge(int x, int y) { none() }
// OK -- Higher-order predicate
int getDistance(int x) = shortestDistances(root/0, edge/2)(_, x, result)
// NOT OK -- Higher-order predicate that does not return a value even though has 'get' in the name
predicate getDistance2(int x, int y) = shortestDistances(root/0, edge/2)(_, x, y)
// OK
predicate unresolvedAlias = unresolved/0;
// OK -- unresolved alias
predicate getUnresolvedAlias = unresolved/0;