| // Copyright 2006 The Bazel Authors. All rights reserved. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| package com.google.devtools.build.lib.syntax.util; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| import static org.junit.Assert.fail; |
| |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.truth.Ordered; |
| import com.google.devtools.build.lib.events.Event; |
| import com.google.devtools.build.lib.events.EventCollector; |
| import com.google.devtools.build.lib.events.EventKind; |
| import com.google.devtools.build.lib.events.ExtendedEventHandler; |
| import com.google.devtools.build.lib.events.util.EventCollectionApparatus; |
| import com.google.devtools.build.lib.packages.BazelLibrary; |
| import com.google.devtools.build.lib.packages.BazelStarlarkContext; |
| import com.google.devtools.build.lib.packages.PackageFactory; |
| import com.google.devtools.build.lib.packages.SymbolGenerator; |
| import com.google.devtools.build.lib.syntax.EvalException; |
| import com.google.devtools.build.lib.syntax.EvalUtils; |
| import com.google.devtools.build.lib.syntax.Expression; |
| import com.google.devtools.build.lib.syntax.Mutability; |
| import com.google.devtools.build.lib.syntax.ParserInput; |
| import com.google.devtools.build.lib.syntax.SkylarkUtils; |
| import com.google.devtools.build.lib.syntax.SkylarkUtils.Phase; |
| import com.google.devtools.build.lib.syntax.StarlarkFile; |
| import com.google.devtools.build.lib.syntax.StarlarkThread; |
| import com.google.devtools.build.lib.syntax.SyntaxError; |
| import com.google.devtools.build.lib.syntax.ValidationEnvironment; |
| import com.google.devtools.build.lib.testutil.TestConstants; |
| import com.google.devtools.build.lib.testutil.TestMode; |
| import java.util.LinkedList; |
| import java.util.List; |
| import java.util.Map; |
| import org.junit.Before; |
| |
| /** |
| * Base class for test cases that use parsing and evaluation services. |
| */ |
| public class EvaluationTestCase { |
| private EventCollectionApparatus eventCollectionApparatus = |
| new EventCollectionApparatus(EventKind.ALL_EVENTS); |
| private TestMode testMode = TestMode.SKYLARK; |
| protected StarlarkThread thread; |
| protected Mutability mutability = Mutability.create("test"); |
| |
| @Before |
| public final void initialize() throws Exception { |
| thread = newStarlarkThread(); |
| } |
| |
| /** |
| * Creates a standard StarlarkThread for tests in the BUILD language. No PythonPreprocessing, |
| * mostly empty mutable StarlarkThread. |
| */ |
| public StarlarkThread newBuildStarlarkThread() { |
| StarlarkThread thread = |
| StarlarkThread.builder(mutability) |
| .useDefaultSemantics() |
| .setGlobals(BazelLibrary.GLOBALS) |
| .setEventHandler(getEventHandler()) |
| .build(); |
| |
| SkylarkUtils.setPhase(thread, Phase.LOADING); |
| |
| new BazelStarlarkContext( |
| TestConstants.TOOLS_REPOSITORY, |
| /* fragmentNameToClass= */ null, |
| /* repoMapping= */ ImmutableMap.of(), |
| new SymbolGenerator<>(new Object()), |
| /* analysisRuleLabel= */ null) |
| .storeInThread(thread); |
| |
| return thread; |
| } |
| |
| /** |
| * Creates a new StarlarkThread suitable for the test case. Subclasses may override it to fit |
| * their purpose and e.g. call newBuildStarlarkThread or newStarlarkThread; or they may play with |
| * the testMode to run tests in either or both kinds of StarlarkThread. Note that all |
| * StarlarkThread-s may share the same Mutability, so don't close it. |
| * |
| * @return a fresh StarlarkThread. |
| */ |
| public StarlarkThread newStarlarkThread() throws Exception { |
| return newStarlarkThreadWithSkylarkOptions(); |
| } |
| |
| protected StarlarkThread newStarlarkThreadWithSkylarkOptions(String... skylarkOptions) |
| throws Exception { |
| return newStarlarkThreadWithBuiltinsAndSkylarkOptions(ImmutableMap.of(), skylarkOptions); |
| } |
| |
| protected StarlarkThread newStarlarkThreadWithBuiltinsAndSkylarkOptions( |
| Map<String, Object> builtins, String... skylarkOptions) throws Exception { |
| if (testMode == null) { |
| throw new IllegalArgumentException( |
| "TestMode is null. Please set a Testmode via setMode() or set the " |
| + "StarlarkThread manually by overriding newStarlarkThread()"); |
| } |
| return testMode.createStarlarkThread(getEventHandler(), builtins, skylarkOptions); |
| } |
| |
| /** |
| * Sets the specified {@code TestMode} and tries to create the appropriate {@code StarlarkThread} |
| * |
| * @param testMode |
| * @throws Exception |
| */ |
| protected void setMode(TestMode testMode, String... skylarkOptions) throws Exception { |
| this.testMode = testMode; |
| thread = newStarlarkThreadWithSkylarkOptions(skylarkOptions); |
| } |
| |
| protected void setMode(TestMode testMode, Map<String, Object> builtins, |
| String... skylarkOptions) throws Exception { |
| this.testMode = testMode; |
| thread = newStarlarkThreadWithBuiltinsAndSkylarkOptions(builtins, skylarkOptions); |
| } |
| |
| protected void enableSkylarkMode(Map<String, Object> builtins, |
| String... skylarkOptions) throws Exception { |
| setMode(TestMode.SKYLARK, builtins, skylarkOptions); |
| } |
| |
| protected void enableSkylarkMode(String... skylarkOptions) throws Exception { |
| setMode(TestMode.SKYLARK, skylarkOptions); |
| } |
| |
| protected void enableBuildMode(String... skylarkOptions) throws Exception { |
| setMode(TestMode.BUILD, skylarkOptions); |
| } |
| |
| public ExtendedEventHandler getEventHandler() { |
| return eventCollectionApparatus.reporter(); |
| } |
| |
| public StarlarkThread getStarlarkThread() { |
| return thread; |
| } |
| // TODO(adonovan): don't let subclasses inherit vaguely specified "helpers". |
| // Separate all the tests clearly into tests of the scanner, parser, resolver, |
| // and evaluation. |
| |
| /** Parses an expression. */ |
| protected final Expression parseExpression(String... lines) throws SyntaxError { |
| return Expression.parse(ParserInput.fromLines(lines)); |
| } |
| |
| public EvaluationTestCase update(String varname, Object value) throws Exception { |
| thread.update(varname, value); |
| return this; |
| } |
| |
| public Object lookup(String varname) throws Exception { |
| return thread.moduleLookup(varname); |
| } |
| |
| // TODO(adonovan): this function does far too much: |
| // - two forms, exec(file) or exec(file)+eval(expression). |
| // - two modes, BUILD vs Skylark. |
| // - parse + validate + BUILD dialect checks + execute. |
| // Break the tests down into tests of just the scanner, parser, validator, build dialect checks, |
| // or execution, and assert that all passes except the one of interest succeed. |
| // All BUILD-dialect stuff belongs in bazel proper (lib.packages), not here. |
| public Object eval(String... lines) throws Exception { |
| ParserInput input = ParserInput.fromLines(lines); |
| StarlarkFile file = StarlarkFile.parse(input); |
| ValidationEnvironment.validateFile( |
| file, thread.getGlobals(), thread.getSemantics(), testMode == TestMode.BUILD); |
| if (testMode == TestMode.SKYLARK) { // .bzl and other dialects |
| if (!file.ok()) { |
| throw new SyntaxError(file.errors()); |
| } |
| } else { |
| // For BUILD mode, validation events are reported but don't (yet) |
| // prevent execution. We also apply BUILD dialect syntax checks. |
| Event.replayEventsOn(getEventHandler(), file.errors()); |
| PackageFactory.checkBuildSyntax(file, getEventHandler()); |
| } |
| return EvalUtils.execOrEval(file, thread); |
| } |
| |
| public void checkEvalError(String msg, String... input) throws Exception { |
| try { |
| eval(input); |
| fail("Expected error '" + msg + "' but got no error"); |
| } catch (SyntaxError | EvalException | EventCollectionApparatus.FailFastException e) { |
| assertThat(e).hasMessageThat().isEqualTo(msg); |
| } |
| } |
| |
| public void checkEvalErrorContains(String msg, String... input) throws Exception { |
| try { |
| eval(input); |
| fail("Expected error containing '" + msg + "' but got no error"); |
| } catch (SyntaxError | EvalException | EventCollectionApparatus.FailFastException e) { |
| assertThat(e).hasMessageThat().contains(msg); |
| } |
| } |
| |
| public void checkEvalErrorDoesNotContain(String msg, String... input) throws Exception { |
| try { |
| eval(input); |
| } catch (SyntaxError | EvalException | EventCollectionApparatus.FailFastException e) { |
| assertThat(e).hasMessageThat().doesNotContain(msg); |
| } |
| } |
| |
| // Forward relevant methods to the EventCollectionApparatus |
| public EvaluationTestCase setFailFast(boolean failFast) { |
| eventCollectionApparatus.setFailFast(failFast); |
| return this; |
| } |
| |
| public EvaluationTestCase assertNoWarningsOrErrors() { |
| eventCollectionApparatus.assertNoWarningsOrErrors(); |
| return this; |
| } |
| |
| public EventCollector getEventCollector() { |
| return eventCollectionApparatus.collector(); |
| } |
| |
| public Event assertContainsError(String expectedMessage) { |
| return eventCollectionApparatus.assertContainsError(expectedMessage); |
| } |
| |
| public Event assertContainsWarning(String expectedMessage) { |
| return eventCollectionApparatus.assertContainsWarning(expectedMessage); |
| } |
| |
| public Event assertContainsDebug(String expectedMessage) { |
| return eventCollectionApparatus.assertContainsDebug(expectedMessage); |
| } |
| |
| public EvaluationTestCase clearEvents() { |
| eventCollectionApparatus.clear(); |
| return this; |
| } |
| |
| /** |
| * Encapsulates a separate test which can be executed by a {@code TestMode} |
| */ |
| protected interface Testable { |
| public void run() throws Exception; |
| } |
| |
| /** |
| * Base class for test cases that run in specific modes (e.g. Build and/or Skylark) |
| */ |
| protected abstract class ModalTestCase { |
| private final SetupActions setup; |
| |
| protected ModalTestCase() { |
| setup = new SetupActions(); |
| } |
| |
| /** |
| * Allows the execution of several statements before each following test |
| * @param statements The statement(s) to be executed |
| * @return This {@code ModalTestCase} |
| */ |
| public ModalTestCase setUp(String... statements) { |
| setup.registerEval(statements); |
| return this; |
| } |
| |
| /** |
| * Allows the update of the specified variable before each following test |
| * @param name The name of the variable that should be updated |
| * @param value The new value of the variable |
| * @return This {@code ModalTestCase} |
| */ |
| public ModalTestCase update(String name, Object value) { |
| setup.registerUpdate(name, value); |
| return this; |
| } |
| |
| /** |
| * Evaluates two parameters and compares their results. |
| * @param statement The statement to be evaluated |
| * @param expectedEvalString The expression of the expected result |
| * @return This {@code ModalTestCase} |
| * @throws Exception |
| */ |
| public ModalTestCase testEval(String statement, String expectedEvalString) throws Exception { |
| runTest(createComparisonTestable(statement, expectedEvalString, true)); |
| return this; |
| } |
| |
| /** |
| * Evaluates the given statement and compares its result to the expected object |
| * @param statement |
| * @param expected |
| * @return This {@code ModalTestCase} |
| * @throws Exception |
| */ |
| public ModalTestCase testStatement(String statement, Object expected) throws Exception { |
| runTest(createComparisonTestable(statement, expected, false)); |
| return this; |
| } |
| |
| /** |
| * Evaluates the given statement and compares its result to the collection of expected objects |
| * without considering their order |
| * @param statement The statement to be evaluated |
| * @param items The expected items |
| * @return This {@code ModalTestCase} |
| * @throws Exception |
| */ |
| public ModalTestCase testCollection(String statement, Object... items) throws Exception { |
| runTest(collectionTestable(statement, false, items)); |
| return this; |
| } |
| |
| /** |
| * Evaluates the given statement and compares its result to the collection of expected objects |
| * while considering their order |
| * @param statement The statement to be evaluated |
| * @param items The expected items, in order |
| * @return This {@code ModalTestCase} |
| * @throws Exception |
| */ |
| public ModalTestCase testExactOrder(String statement, Object... items) throws Exception { |
| runTest(collectionTestable(statement, true, items)); |
| return this; |
| } |
| |
| /** |
| * Evaluates the given statement and checks whether the given error message appears |
| * @param expectedError The expected error message |
| * @param statements The statement(s) to be evaluated |
| * @return This ModalTestCase |
| * @throws Exception |
| */ |
| public ModalTestCase testIfExactError(String expectedError, String... statements) |
| throws Exception { |
| runTest(errorTestable(true, expectedError, statements)); |
| return this; |
| } |
| |
| /** |
| * Evaluates the given statement and checks whether an error that contains the expected message |
| * occurs |
| * @param expectedError |
| * @param statements |
| * @return This ModalTestCase |
| * @throws Exception |
| */ |
| public ModalTestCase testIfErrorContains(String expectedError, String... statements) |
| throws Exception { |
| runTest(errorTestable(false, expectedError, statements)); |
| return this; |
| } |
| |
| /** |
| * Looks up the value of the specified variable and compares it to the expected value |
| * @param name |
| * @param expected |
| * @return This ModalTestCase |
| * @throws Exception |
| */ |
| public ModalTestCase testLookup(String name, Object expected) throws Exception { |
| runTest(createLookUpTestable(name, expected)); |
| return this; |
| } |
| |
| /** |
| * Creates a Testable that checks whether the evaluation of the given statement leads to the |
| * expected error |
| * @param statements |
| * @param error |
| * @param exactMatch If true, the error message has to be identical to the expected error |
| * @return An instance of Testable that runs the error check |
| */ |
| protected Testable errorTestable( |
| final boolean exactMatch, final String error, final String... statements) { |
| return new Testable() { |
| @Override |
| public void run() throws Exception { |
| if (exactMatch) { |
| checkEvalError(error, statements); |
| } else { |
| checkEvalErrorContains(error, statements); |
| } |
| } |
| }; |
| } |
| |
| /** |
| * Creates a testable that checks whether the evaluation of the given statement leads to a list |
| * that contains exactly the expected objects |
| * @param statement The statement to be evaluated |
| * @param ordered Determines whether the order of the elements is checked as well |
| * @param expected Expected objects |
| * @return An instance of Testable that runs the check |
| */ |
| protected Testable collectionTestable( |
| final String statement, final boolean ordered, final Object... expected) { |
| return new Testable() { |
| @Override |
| public void run() throws Exception { |
| Ordered tmp = assertThat((Iterable<?>) eval(statement)).containsExactly(expected); |
| |
| if (ordered) { |
| tmp.inOrder(); |
| } |
| } |
| }; |
| } |
| |
| /** |
| * Creates a testable that compares the evaluation of the given statement to a specified result |
| * |
| * @param statement The statement to be evaluated |
| * @param expected Either the expected object or an expression whose evaluation leads to the |
| * expected object |
| * @param expectedIsExpression Signals whether {@code expected} is an object or an expression |
| * @return An instance of Testable that runs the comparison |
| */ |
| protected Testable createComparisonTestable( |
| final String statement, final Object expected, final boolean expectedIsExpression) { |
| return new Testable() { |
| @Override |
| public void run() throws Exception { |
| Object actual = eval(statement); |
| Object realExpected = expected; |
| |
| // We could also print the actual object and compare the string to the expected |
| // expression, but then the order of elements would matter. |
| if (expectedIsExpression) { |
| realExpected = eval((String) expected); |
| } |
| |
| assertThat(actual).isEqualTo(realExpected); |
| } |
| }; |
| } |
| |
| /** |
| * Creates a Testable that looks up the given variable and compares its value to the expected |
| * value |
| * @param name |
| * @param expected |
| * @return An instance of Testable that does both lookup and comparison |
| */ |
| protected Testable createLookUpTestable(final String name, final Object expected) { |
| return new Testable() { |
| @Override |
| public void run() throws Exception { |
| assertThat(lookup(name)).isEqualTo(expected); |
| } |
| }; |
| } |
| |
| /** |
| * Executes the given Testable |
| * @param testable |
| * @throws Exception |
| */ |
| protected void runTest(Testable testable) throws Exception { |
| run(new TestableDecorator(setup, testable)); |
| } |
| |
| protected abstract void run(Testable testable) throws Exception; |
| } |
| |
| /** |
| * A simple decorator that allows the execution of setup actions before running a {@code Testable} |
| */ |
| static class TestableDecorator implements Testable { |
| private final SetupActions setup; |
| private final Testable decorated; |
| |
| public TestableDecorator(SetupActions setup, Testable decorated) { |
| this.setup = setup; |
| this.decorated = decorated; |
| } |
| |
| /** |
| * Executes all stored actions and updates plus the actual {@code Testable} |
| */ |
| @Override |
| public void run() throws Exception { |
| setup.executeAll(); |
| decorated.run(); |
| } |
| } |
| |
| /** |
| * A container for collection actions that should be executed before a test |
| */ |
| class SetupActions { |
| private List<Testable> setup; |
| |
| public SetupActions() { |
| setup = new LinkedList<>(); |
| } |
| |
| /** |
| * Registers a variable that has to be updated before a test |
| * |
| * @param name |
| * @param value |
| */ |
| public void registerUpdate(final String name, final Object value) { |
| setup.add( |
| new Testable() { |
| @Override |
| public void run() throws Exception { |
| EvaluationTestCase.this.update(name, value); |
| } |
| }); |
| } |
| |
| /** |
| * Registers a statement for evaluation prior to a test |
| * |
| * @param statements |
| */ |
| public void registerEval(final String... statements) { |
| setup.add( |
| new Testable() { |
| @Override |
| public void run() throws Exception { |
| EvaluationTestCase.this.eval(statements); |
| } |
| }); |
| } |
| |
| /** |
| * Executes all stored actions and updates |
| * @throws Exception |
| */ |
| public void executeAll() throws Exception { |
| for (Testable testable : setup) { |
| testable.run(); |
| } |
| } |
| } |
| |
| /** |
| * A class that executes each separate test in both modes (Build and Skylark) |
| */ |
| protected class BothModesTest extends ModalTestCase { |
| private final String[] skylarkOptions; |
| |
| public BothModesTest(String... skylarkOptions) { |
| this.skylarkOptions = skylarkOptions; |
| } |
| |
| /** |
| * Executes the given Testable in both Build and Skylark mode |
| */ |
| @Override |
| protected void run(Testable testable) throws Exception { |
| enableSkylarkMode(skylarkOptions); |
| try { |
| testable.run(); |
| } catch (Exception e) { |
| throw new Exception("While in Skylark mode", e); |
| } |
| |
| enableBuildMode(skylarkOptions); |
| try { |
| testable.run(); |
| } catch (Exception e) { |
| throw new Exception("While in Build mode", e); |
| } |
| } |
| } |
| |
| /** |
| * A class that runs all tests in Build mode |
| */ |
| protected class BuildTest extends ModalTestCase { |
| private final String[] skylarkOptions; |
| |
| public BuildTest(String... skylarkOptions) { |
| this.skylarkOptions = skylarkOptions; |
| } |
| |
| @Override |
| protected void run(Testable testable) throws Exception { |
| enableBuildMode(skylarkOptions); |
| testable.run(); |
| } |
| } |
| |
| /** |
| * A class that runs all tests in Skylark mode |
| */ |
| protected class SkylarkTest extends ModalTestCase { |
| private final String[] skylarkOptions; |
| private final Map<String, Object> builtins; |
| |
| public SkylarkTest(String... skylarkOptions) { |
| this(ImmutableMap.of(), skylarkOptions); |
| } |
| |
| public SkylarkTest(Map<String, Object> builtins, String... skylarkOptions) { |
| this.builtins = builtins; |
| this.skylarkOptions = skylarkOptions; |
| } |
| |
| @Override |
| protected void run(Testable testable) throws Exception { |
| enableSkylarkMode(builtins, skylarkOptions); |
| testable.run(); |
| } |
| } |
| } |