com.oracle.truffle.tck.TruffleTestInvoker Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-tck Show documentation
Show all versions of truffle-tck Show documentation
A collection of tests that can certify language implementation to be compliant
with most recent requirements of the Truffle infrastructure and tooling.
The newest version!
/*
* Copyright (c) 2017, 2022, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must be included in all copies or substantial
* portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.oracle.truffle.tck;
import java.io.Closeable;
import java.lang.annotation.Annotation;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.function.Function;
import org.graalvm.polyglot.Context;
import org.graalvm.polyglot.PolyglotAccess;
import org.graalvm.polyglot.PolyglotException;
import org.junit.Test;
import org.junit.runners.model.FrameworkField;
import org.junit.runners.model.FrameworkMethod;
import org.junit.runners.model.Statement;
import org.junit.runners.model.TestClass;
import com.oracle.truffle.api.CallTarget;
import com.oracle.truffle.api.Truffle;
import com.oracle.truffle.api.TruffleLanguage;
import com.oracle.truffle.api.TruffleLanguage.ContextPolicy;
import com.oracle.truffle.api.TruffleLanguage.Env;
import com.oracle.truffle.api.impl.TVMCI;
import com.oracle.truffle.api.nodes.RootNode;
import com.oracle.truffle.tck.TruffleRunner.Inject;
import com.oracle.truffle.tck.TruffleRunner.RunWithPolyglotRule;
import org.junit.AssumptionViolatedException;
final class TruffleTestInvoker extends TVMCI.TestAccessor {
static TruffleTestInvoker create() {
TVMCI.Test testTvmci = Truffle.getRuntime().getCapability(TVMCI.Test.class);
return new TruffleTestInvoker<>(testTvmci);
}
@TruffleLanguage.Registration(id = "truffletestinvoker", name = "truffletestinvoker", version = "", contextPolicy = ContextPolicy.SHARED)
public static class TruffleTestInvokerLanguage extends TruffleLanguage {
@Override
protected Env createContext(Env env) {
return env;
}
@Override
protected void initializeContext(Env context) throws Exception {
context.exportSymbol("language", context.asGuestValue(this));
context.exportSymbol("env", context.asGuestValue(context));
}
@Override
protected boolean isThreadAccessAllowed(Thread thread, boolean singleThreaded) {
return true;
}
}
private static class TestStatement extends Statement {
private final RunWithPolyglotRule rule;
private final Statement stmt;
TestStatement(RunWithPolyglotRule rule, Statement stmt) {
this.rule = rule;
this.stmt = stmt;
}
@Override
public void evaluate() throws Throwable {
Context prevContext = rule.context;
try (Context context = rule.contextBuilder.allowPolyglotAccess(PolyglotAccess.ALL).build()) {
rule.context = context;
context.initialize("truffletestinvoker");
context.enter();
TruffleLanguage prevLang = rule.testLanguage;
Env prevEnv = rule.testEnv;
try {
rule.testLanguage = context.getPolyglotBindings().getMember("language").asHostObject();
rule.testEnv = context.getPolyglotBindings().getMember("env").asHostObject();
stmt.evaluate();
} catch (Throwable t) {
throw t;
} finally {
rule.testLanguage = prevLang;
rule.testEnv = prevEnv;
context.leave();
}
} catch (PolyglotException pe) {
if (!pe.isCancelled() && !pe.isExit()) {
throw pe;
}
} finally {
rule.context = prevContext;
}
}
}
private TruffleTestInvoker(TVMCI.Test testTvmci) {
super(testTvmci);
}
private interface NodeConstructor extends Function {
}
static class TruffleTestClass extends TestClass {
TruffleTestClass(Class cls) {
super(cls);
}
@Override
protected void scanAnnotatedMembers(Map, List> methodsForAnnotations,
Map, List> fieldsForAnnotations) {
super.scanAnnotatedMembers(methodsForAnnotations, fieldsForAnnotations);
for (List methods : methodsForAnnotations.values()) {
methods.replaceAll(m -> new TruffleFrameworkMethod(this, m.getMethod()));
}
}
}
private static class TruffleFrameworkMethod extends FrameworkMethod {
private final int warmupIterations;
private final NodeConstructor[] nodeConstructors;
TruffleFrameworkMethod(TestClass testClass, Method method) {
super(method);
int paramCount = method.getParameterCount();
if (paramCount == 0) {
// non-truffle test
nodeConstructors = null;
} else {
nodeConstructors = new NodeConstructor[paramCount];
for (int i = 0; i < paramCount; i++) {
Inject testRootNode = findRootNodeAnnotation(method.getParameterAnnotations()[i]);
if (testRootNode != null) {
nodeConstructors[i] = getNodeConstructor(testRootNode, testClass);
}
}
}
TruffleRunner.Warmup warmup = method.getAnnotation(TruffleRunner.Warmup.class);
if (warmup != null) {
warmupIterations = warmup.value();
} else {
warmupIterations = 3;
}
}
boolean hasNodeConstructors() {
return nodeConstructors != null;
}
RootNode[] createTestRootNodes(Object test) {
RootNode[] ret = new RootNode[nodeConstructors.length];
for (int i = 0; i < ret.length; i++) {
if (nodeConstructors[i] != null) {
ret[i] = nodeConstructors[i].apply(test);
}
}
return ret;
}
}
Statement createStatement(String testName, FrameworkMethod method, Object test) {
final TruffleFrameworkMethod truffleMethod = (TruffleFrameworkMethod) method;
if (!truffleMethod.hasNodeConstructors()) {
// non-truffle test
return null;
}
return new Statement() {
@Override
public void evaluate() throws Throwable {
try (C testContext = createTestContext(testName)) {
final RootNode[] testNodes = truffleMethod.createTestRootNodes(test);
ArrayList callTargets = new ArrayList<>(testNodes.length);
for (RootNode testNode : testNodes) {
if (testNode != null) {
callTargets.add(createTestCallTarget(testContext, testNode));
} else {
callTargets.add(null);
}
}
Object[] args = callTargets.toArray();
for (int i = 0; i < truffleMethod.warmupIterations; i++) {
truffleMethod.invokeExplosively(test, args);
}
for (T callTarget : callTargets) {
finishWarmup(testContext, callTarget);
}
truffleMethod.invokeExplosively(test, args);
}
}
};
}
static Statement withTruffleContext(RunWithPolyglotRule rule, Statement stmt) {
return new TestStatement(rule, stmt);
}
private static Inject findRootNodeAnnotation(Annotation[] annotations) {
for (Annotation a : annotations) {
if (a instanceof Inject) {
return (Inject) a;
}
}
return null;
}
private static RuntimeException forwardException(InvocationTargetException ex) {
Throwable cause = ex.getCause();
if (cause instanceof AssumptionViolatedException) {
throw (AssumptionViolatedException) cause;
} else if (cause instanceof AssertionError) {
throw (AssertionError) cause;
} else {
throw new AssertionError(cause);
}
}
private static NodeConstructor getNodeConstructor(Inject annotation, TestClass testClass) {
Class nodeClass = annotation.value();
try {
Constructor cons = nodeClass.getConstructor(testClass.getJavaClass());
return (obj) -> {
try {
return cons.newInstance(obj);
} catch (IllegalAccessException | IllegalArgumentException | InstantiationException ex) {
throw new AssertionError(ex);
} catch (InvocationTargetException ex) {
throw forwardException(ex);
}
};
} catch (NoSuchMethodException e) {
try {
Constructor cons = nodeClass.getConstructor();
return (obj) -> {
try {
return cons.newInstance();
} catch (IllegalAccessException | IllegalArgumentException | InstantiationException ex) {
throw new AssertionError(ex);
} catch (InvocationTargetException ex) {
throw forwardException(ex);
}
};
} catch (NoSuchMethodException ex) {
return null;
}
}
}
static void validateTestMethods(TestClass testClass, List errors) {
List methods = testClass.getAnnotatedMethods(Test.class);
for (FrameworkMethod method : methods) {
method.validatePublicVoid(false, errors);
Annotation[][] parameterAnnotations = method.getMethod().getParameterAnnotations();
Class[] parameterTypes = method.getMethod().getParameterTypes();
for (int i = 0; i < parameterTypes.length; i++) {
if (parameterTypes[i] == CallTarget.class) {
TruffleRunner.Inject testRootNode = findRootNodeAnnotation(parameterAnnotations[i]);
if (testRootNode == null) {
errors.add(new Exception("CallTarget parameter of test method " + method.getName() + " should have @Inject annotation"));
} else {
if (getNodeConstructor(testRootNode, testClass) == null) {
errors.add(new Exception("Node " + testRootNode.value().getName() + " should have a default constructor or a constructor taking a " + testClass.getName()));
}
}
} else {
errors.add(new Exception("Invalid parameter type " + parameterTypes[i].getSimpleName() + " on test method " + method.getName()));
}
}
}
}
}