|
| 1 | +// Copyright 2025 Google LLC |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | +package dev.cel.testing.testrunner; |
| 15 | + |
| 16 | +import static com.google.common.collect.ImmutableList.toImmutableList; |
| 17 | + |
| 18 | +import javax.annotation.concurrent.ThreadSafe; |
| 19 | +import dev.cel.common.CelAbstractSyntaxTree; |
| 20 | +import dev.cel.common.ast.CelExpr; |
| 21 | +import dev.cel.common.ast.CelExpr.ExprKind; |
| 22 | +import dev.cel.common.navigation.CelNavigableAst; |
| 23 | +import dev.cel.common.navigation.CelNavigableExpr; |
| 24 | +import dev.cel.common.types.CelKind; |
| 25 | +import dev.cel.parser.CelUnparserVisitor; |
| 26 | +import dev.cel.runtime.CelEvaluationListener; |
| 27 | +import java.util.ArrayList; |
| 28 | +import java.util.HashMap; |
| 29 | +import java.util.List; |
| 30 | +import java.util.Map; |
| 31 | +import java.util.logging.Logger; |
| 32 | + |
| 33 | +/** |
| 34 | + * A class for managing the coverage index for CEL tests. |
| 35 | + * |
| 36 | + * <p>This class is used to manage the coverage index for CEL tests. It provides a method for |
| 37 | + * getting the coverage index for a given test case. |
| 38 | + */ |
| 39 | +final class CelCoverageIndex { |
| 40 | + private static final Logger logger = Logger.getLogger(CelCoverageIndex.class.getName()); |
| 41 | + |
| 42 | + private CelAbstractSyntaxTree ast; |
| 43 | + private final Map<Long, NodeCoverageStats> nodeCoverageStatsMap = new HashMap<>(); |
| 44 | + |
| 45 | + public void setAst(CelAbstractSyntaxTree ast) { |
| 46 | + this.ast = ast; |
| 47 | + CelNavigableExpr.fromExpr(ast.getExpr()) |
| 48 | + .allNodes() |
| 49 | + .forEach( |
| 50 | + celNavigableExpr -> { |
| 51 | + NodeCoverageStats nodeCoverageStats = new NodeCoverageStats(); |
| 52 | + nodeCoverageStats.isBooleanNode = inferBooleanNodeType(celNavigableExpr.expr()); |
| 53 | + nodeCoverageStatsMap.put(celNavigableExpr.id(), nodeCoverageStats); |
| 54 | + }); |
| 55 | + } |
| 56 | + |
| 57 | + public CelEvaluationListener getEvaluationListener() { |
| 58 | + return new EvaluationListener(this, nodeCoverageStatsMap); |
| 59 | + } |
| 60 | + |
| 61 | + public CoverageReport getCoverageReport() { |
| 62 | + CoverageReport report = new CoverageReport(); |
| 63 | + traverseAndCalculateCoverage( |
| 64 | + CelNavigableAst.fromAst(ast).getRoot(), nodeCoverageStatsMap, true, "", report); |
| 65 | + report.celExpr = new CelUnparserVisitor(ast).unparse(ast.getExpr()); |
| 66 | + logger.info("CEL Expression: " + report.celExpr); |
| 67 | + logger.info("Nodes: " + report.nodes); |
| 68 | + logger.info("Covered Nodes: " + report.coveredNodes); |
| 69 | + logger.info("Branches: " + report.branches); |
| 70 | + logger.info("Covered Boolean Outcomes: " + report.coveredBooleanOutcomes); |
| 71 | + logger.info("Unencountered Nodes: " + report.unencounteredNodes); |
| 72 | + logger.info("Unencountered Branches: " + report.unencounteredBranches); |
| 73 | + return report; |
| 74 | + } |
| 75 | + |
| 76 | + public static final class CoverageReport { |
| 77 | + String celExpr; |
| 78 | + long nodes = 0L; |
| 79 | + long coveredNodes = 0L; |
| 80 | + long branches = 0L; |
| 81 | + long coveredBooleanOutcomes = 0L; |
| 82 | + List<String> unencounteredNodes = new ArrayList<>(); |
| 83 | + List<String> unencounteredBranches = new ArrayList<>(); |
| 84 | + } |
| 85 | + |
| 86 | + /** A class for managing the coverage stats for a CEL node. */ |
| 87 | + private static final class NodeCoverageStats { |
| 88 | + Boolean isBooleanNode = false; |
| 89 | + Boolean covered = false; |
| 90 | + Boolean hasTrueBranch = false; |
| 91 | + Boolean hasFalseBranch = false; |
| 92 | + } |
| 93 | + |
| 94 | + private Boolean inferBooleanNodeType(CelExpr celExpr) { |
| 95 | + return ast.getTypeMap().containsKey(celExpr.id()) |
| 96 | + && ast.getTypeMap().get(celExpr.id()).kind().equals(CelKind.BOOL); |
| 97 | + } |
| 98 | + |
| 99 | + private void traverseAndCalculateCoverage( |
| 100 | + CelNavigableExpr node, |
| 101 | + Map<Long, NodeCoverageStats> statsMap, |
| 102 | + boolean logUnencountered, |
| 103 | + String precedingTabs, |
| 104 | + CoverageReport report) { |
| 105 | + long nodeId = node.id(); |
| 106 | + NodeCoverageStats stats = statsMap.getOrDefault(nodeId, new NodeCoverageStats()); |
| 107 | + report.nodes++; |
| 108 | + |
| 109 | + boolean isInterestingBooleanNode = |
| 110 | + stats.isBooleanNode |
| 111 | + && !node.expr().getKind().equals(ExprKind.Kind.CONSTANT) |
| 112 | + && !(node.expr().getKind().equals(ExprKind.Kind.CALL) |
| 113 | + && node.expr().call().function().equals("cel.@block")); |
| 114 | + |
| 115 | + // Only unparse if the node is interesting (boolean node) and we need to log |
| 116 | + // unencountered nodes. |
| 117 | + String exprText = ""; |
| 118 | + if (isInterestingBooleanNode && logUnencountered) { |
| 119 | + exprText = new CelUnparserVisitor(ast).unparse(node.expr()); |
| 120 | + } |
| 121 | + |
| 122 | + boolean nodeCovered = stats.covered; |
| 123 | + if (nodeCovered) { |
| 124 | + report.coveredNodes++; |
| 125 | + } else if (logUnencountered) { |
| 126 | + if (isInterestingBooleanNode) { |
| 127 | + report.unencounteredNodes.add(String.format("Expression %s", exprText)); |
| 128 | + } |
| 129 | + logUnencountered = false; |
| 130 | + } |
| 131 | + |
| 132 | + if (isInterestingBooleanNode) { |
| 133 | + report.branches += 2; |
| 134 | + if (stats.hasTrueBranch) { |
| 135 | + report.coveredBooleanOutcomes++; |
| 136 | + } else if (logUnencountered) { |
| 137 | + report.unencounteredBranches.add( |
| 138 | + String.format("%sExpression %s: Never evaluated to 'true'", precedingTabs, exprText)); |
| 139 | + precedingTabs += "\t"; |
| 140 | + } |
| 141 | + if (stats.hasFalseBranch) { |
| 142 | + report.coveredBooleanOutcomes++; |
| 143 | + } else if (logUnencountered) { |
| 144 | + report.unencounteredBranches.add( |
| 145 | + String.format("%sExpression %s: Never evaluated to 'false'", precedingTabs, exprText)); |
| 146 | + precedingTabs += "\t"; |
| 147 | + } |
| 148 | + } |
| 149 | + |
| 150 | + for (CelNavigableExpr child : node.children().collect(toImmutableList())) { |
| 151 | + traverseAndCalculateCoverage(child, statsMap, logUnencountered, precedingTabs, report); |
| 152 | + } |
| 153 | + } |
| 154 | + |
| 155 | + @ThreadSafe |
| 156 | + private static final class EvaluationListener implements CelEvaluationListener { |
| 157 | + @ThreadSafe.Suppress( |
| 158 | + reason = |
| 159 | + "This map is only accessed within a single execution at a time, so no race conditions" |
| 160 | + + " will occur.") |
| 161 | + private final Map<Long, NodeCoverageStats> nodeCoverageStatsMap; |
| 162 | + |
| 163 | + @ThreadSafe.Suppress(reason = "CelCoverageIndex is effectively thread-safe for this usage.") |
| 164 | + private final CelCoverageIndex celCoverageIndex; |
| 165 | + |
| 166 | + EvaluationListener( |
| 167 | + CelCoverageIndex celCoverageIndex, Map<Long, NodeCoverageStats> nodeCoverageStatsMap) { |
| 168 | + this.celCoverageIndex = celCoverageIndex; |
| 169 | + this.nodeCoverageStatsMap = nodeCoverageStatsMap; |
| 170 | + } |
| 171 | + |
| 172 | + @Override |
| 173 | + public void callback(CelExpr celExpr, Object evaluationResult) { |
| 174 | + NodeCoverageStats nodeCoverageStats = |
| 175 | + nodeCoverageStatsMap.getOrDefault(celExpr.id(), new NodeCoverageStats()); |
| 176 | + nodeCoverageStats.covered = true; |
| 177 | + nodeCoverageStats.isBooleanNode = celCoverageIndex.inferBooleanNodeType(celExpr); |
| 178 | + if (nodeCoverageStats.isBooleanNode) { |
| 179 | + if (evaluationResult instanceof Boolean) { |
| 180 | + if ((Boolean) evaluationResult) { |
| 181 | + nodeCoverageStats.hasTrueBranch = true; |
| 182 | + } else { |
| 183 | + nodeCoverageStats.hasFalseBranch = true; |
| 184 | + } |
| 185 | + } |
| 186 | + } |
| 187 | + nodeCoverageStatsMap.put(celExpr.id(), nodeCoverageStats); |
| 188 | + } |
| 189 | + } |
| 190 | +} |
0 commit comments