|
| 1 | +// Copyright 2024 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 | + |
| 15 | +package dev.cel.policy.testing; |
| 16 | + |
| 17 | +import static com.google.common.base.Strings.isNullOrEmpty; |
| 18 | +import static java.nio.charset.StandardCharsets.UTF_8; |
| 19 | + |
| 20 | +import com.google.common.annotations.VisibleForTesting; |
| 21 | +import com.google.common.base.Ascii; |
| 22 | +import com.google.common.collect.ImmutableMap; |
| 23 | +import com.google.common.io.Resources; |
| 24 | +import dev.cel.bundle.Cel; |
| 25 | +import dev.cel.common.CelAbstractSyntaxTree; |
| 26 | +import dev.cel.common.CelValidationException; |
| 27 | +import dev.cel.runtime.CelEvaluationException; |
| 28 | +import java.io.IOException; |
| 29 | +import java.net.URL; |
| 30 | +import java.util.List; |
| 31 | +import java.util.Map; |
| 32 | +import org.yaml.snakeyaml.LoaderOptions; |
| 33 | +import org.yaml.snakeyaml.Yaml; |
| 34 | +import org.yaml.snakeyaml.constructor.Constructor; |
| 35 | + |
| 36 | +/** |
| 37 | + * Helper to assist with policy testing. |
| 38 | + * |
| 39 | + **/ |
| 40 | +public final class PolicyTestSuiteHelper { |
| 41 | + |
| 42 | + /** |
| 43 | + * TODO |
| 44 | + */ |
| 45 | + public static PolicyTestSuite readTestSuite(String path) throws IOException { |
| 46 | + Yaml yaml = new Yaml(new Constructor(PolicyTestSuite.class, new LoaderOptions())); |
| 47 | + String testContent = readFile(path); |
| 48 | + |
| 49 | + return yaml.load(testContent); |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * TODO |
| 54 | + * @param yamlPath |
| 55 | + * @return |
| 56 | + * @throws IOException |
| 57 | + */ |
| 58 | + public static String readFromYaml(String yamlPath) throws IOException { |
| 59 | + return readFile(yamlPath); |
| 60 | + } |
| 61 | + |
| 62 | + /** |
| 63 | + * TestSuite describes a set of tests divided by section. |
| 64 | + * |
| 65 | + * <p>Visibility must be public for YAML deserialization to work. This is effectively |
| 66 | + * package-private since the outer class is. |
| 67 | + */ |
| 68 | + @VisibleForTesting |
| 69 | + public static final class PolicyTestSuite { |
| 70 | + private String description; |
| 71 | + private List<PolicyTestSection> section; |
| 72 | + |
| 73 | + public void setDescription(String description) { |
| 74 | + this.description = description; |
| 75 | + } |
| 76 | + |
| 77 | + public void setSection(List<PolicyTestSection> section) { |
| 78 | + this.section = section; |
| 79 | + } |
| 80 | + |
| 81 | + public String getDescription() { |
| 82 | + return description; |
| 83 | + } |
| 84 | + |
| 85 | + public List<PolicyTestSection> getSection() { |
| 86 | + return section; |
| 87 | + } |
| 88 | + |
| 89 | + @VisibleForTesting |
| 90 | + public static final class PolicyTestSection { |
| 91 | + private String name; |
| 92 | + private List<PolicyTestCase> tests; |
| 93 | + |
| 94 | + public void setName(String name) { |
| 95 | + this.name = name; |
| 96 | + } |
| 97 | + |
| 98 | + public void setTests(List<PolicyTestCase> tests) { |
| 99 | + this.tests = tests; |
| 100 | + } |
| 101 | + |
| 102 | + public String getName() { |
| 103 | + return name; |
| 104 | + } |
| 105 | + |
| 106 | + public List<PolicyTestCase> getTests() { |
| 107 | + return tests; |
| 108 | + } |
| 109 | + |
| 110 | + @VisibleForTesting |
| 111 | + public static final class PolicyTestCase { |
| 112 | + private String name; |
| 113 | + private Map<String, PolicyTestInput> input; |
| 114 | + private String output; |
| 115 | + |
| 116 | + public void setName(String name) { |
| 117 | + this.name = name; |
| 118 | + } |
| 119 | + |
| 120 | + public void setInput(Map<String, PolicyTestInput> input) { |
| 121 | + this.input = input; |
| 122 | + } |
| 123 | + |
| 124 | + public void setOutput(String output) { |
| 125 | + this.output = output; |
| 126 | + } |
| 127 | + |
| 128 | + public String getName() { |
| 129 | + return name; |
| 130 | + } |
| 131 | + |
| 132 | + public Map<String, PolicyTestInput> getInput() { |
| 133 | + return input; |
| 134 | + } |
| 135 | + |
| 136 | + public String getOutput() { |
| 137 | + return output; |
| 138 | + } |
| 139 | + |
| 140 | + @VisibleForTesting |
| 141 | + public static final class PolicyTestInput { |
| 142 | + private Object value; |
| 143 | + private String expr; |
| 144 | + |
| 145 | + public Object getValue() { |
| 146 | + return value; |
| 147 | + } |
| 148 | + |
| 149 | + public void setValue(Object value) { |
| 150 | + this.value = value; |
| 151 | + } |
| 152 | + |
| 153 | + public String getExpr() { |
| 154 | + return expr; |
| 155 | + } |
| 156 | + |
| 157 | + public void setExpr(String expr) { |
| 158 | + this.expr = expr; |
| 159 | + } |
| 160 | + } |
| 161 | + |
| 162 | + public ImmutableMap<String, Object> toInputMap(Cel cel) |
| 163 | + throws CelValidationException, CelEvaluationException { |
| 164 | + ImmutableMap.Builder<String, Object> inputBuilder = ImmutableMap.builderWithExpectedSize( |
| 165 | + input.size()); |
| 166 | + for (Map.Entry<String, PolicyTestInput> entry : input.entrySet()) { |
| 167 | + String exprInput = entry.getValue().getExpr(); |
| 168 | + if (isNullOrEmpty(exprInput)) { |
| 169 | + inputBuilder.put(entry.getKey(), entry.getValue().getValue()); |
| 170 | + } else { |
| 171 | + CelAbstractSyntaxTree exprInputAst = cel.compile(exprInput).getAst(); |
| 172 | + inputBuilder.put(entry.getKey(), cel.createProgram(exprInputAst).eval()); |
| 173 | + } |
| 174 | + } |
| 175 | + |
| 176 | + return inputBuilder.buildOrThrow(); |
| 177 | + } |
| 178 | + } |
| 179 | + } |
| 180 | + } |
| 181 | + |
| 182 | + |
| 183 | + private static URL getResource(String path) { |
| 184 | + return Resources.getResource(Ascii.toLowerCase(path)); |
| 185 | + } |
| 186 | + |
| 187 | + private static String readFile(String path) throws IOException { |
| 188 | + return Resources.toString(getResource(path), UTF_8); |
| 189 | + } |
| 190 | + |
| 191 | + private PolicyTestSuiteHelper() {} |
| 192 | +} |
0 commit comments