[GR-2925] Add test interface to Truffle.

Author: rschatz

CHANGELOG.md

@@ -25,6 +25,7 @@ This changelog summarizes major changes between Truffle versions relevant to lan
 * Added [TruffleInstrument.Registration.services()](http://graalvm.github.io/truffle/javadoc/com/oracle/truffle/api/instrumentation/TruffleInstrument.Registration#services) to support declarative registration of services
 * Deprecated internal class DSLOptions. Will be removed in the next release.
 * Deprecated [Shape.getData()](http://graalvm.github.io/truffle/javadoc/com/oracle/truffle/api/object/Shape.html) and [ObjectType.createShapeData(Shape)](http://graalvm.github.io/truffle/javadoc/com/oracle/truffle/api/object/ObjectType.html) without replacement.
+* Added [TruffleRunner](http://graalvm.github.io/truffle/javadoc/com/oracle/truffle/tck/TruffleRunner.html) JUnit runner for unit testing Truffle compilation.
 
 ## Version 0.24
 1-Mar-2017

truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/impl/DefaultTruffleRuntime.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -60,6 +60,19 @@ public final class DefaultTruffleRuntime implements TruffleRuntime {
     private final ThreadLocal<DefaultFrameInstance> stackTraces = new ThreadLocal<>();
     private final DefaultTVMCI tvmci = new DefaultTVMCI();
 
+    private final TVMCI.Test<CallTarget> testTvmci = new TVMCI.Test<CallTarget>() {
+
+        @Override
+        public CallTarget createTestCallTarget(String testName, RootNode testNode) {
+            return createCallTarget(testNode);
+        }
+
+        @Override
+        public void finishWarmup(CallTarget callTarget) {
+            // do nothing if we have no compiler
+        }
+    };
+
     public DefaultTruffleRuntime() {
     }
 
@@ -183,6 +196,10 @@ void popFrame() {
     }
 
     public <T> T getCapability(Class<T> capability) {
+        if (capability == TVMCI.Test.class) {
+            return capability.cast(testTvmci);
+        }
+
         final Iterator<T> it = ServiceLoader.load(capability).iterator();
         try {
             return it.hasNext() ? it.next() : null;

truffle/com.oracle.truffle.api/src/com/oracle/truffle/api/impl/TVMCI.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -24,6 +24,7 @@
  */
 package com.oracle.truffle.api.impl;
 
+import com.oracle.truffle.api.CallTarget;
 import com.oracle.truffle.api.TruffleLanguage;
 import com.oracle.truffle.api.frame.FrameDescriptor;
 import com.oracle.truffle.api.impl.Accessor.InstrumentSupport;
@@ -37,6 +38,37 @@
  * @since 0.12
  */
 public abstract class TVMCI {
+
+    /**
+     * An interface between the Truffle test runner and hosting virtual machine.
+     *
+     * @param <T> the {@link CallTarget} subclass of the hosting virtual machine
+     *
+     * @since 0.25
+     */
+    public abstract static class Test<T extends CallTarget> {
+
+        /**
+         * Create a call target for the purpose of running a unit test.
+         *
+         * @param testName the name of the unit test
+         * @param testNode the root node containing the test code
+         * @return a call target
+         *
+         * @since 0.25
+         */
+        protected abstract T createTestCallTarget(String testName, RootNode testNode);
+
+        /**
+         * Notify the VM that the warmup is finished, and it should now compile the test code.
+         *
+         * @param callTarget a call target that was created with {@link #createTestCallTarget}
+         *
+         * @since 0.25
+         */
+        protected abstract void finishWarmup(T callTarget);
+    }
+
     /**
      * Only useful for virtual machine implementors.
      *
@@ -132,4 +164,31 @@ protected boolean isCloneUninitializedSupported(RootNode root) {
     protected RootNode cloneUninitialized(RootNode root) {
         return Accessor.nodesAccess().cloneUninitialized(root);
     }
+
+    /**
+     * Accessor for {@link TVMCI#Test} class.
+     *
+     * @param <T>
+     *
+     * @since 0.25
+     */
+    public static class TestAccessor<T extends CallTarget> {
+
+        private final TVMCI.Test<T> testTvmci;
+
+        protected TestAccessor(TVMCI.Test<T> testTvmci) {
+            if (!this.getClass().getPackage().getName().equals("com.oracle.truffle.tck")) {
+                throw new IllegalStateException();
+            }
+            this.testTvmci = testTvmci;
+        }
+
+        protected final T createTestCallTarget(String testName, RootNode testNode) {
+            return testTvmci.createTestCallTarget(testName, testNode);
+        }
+
+        protected final void finishWarmup(T callTarget) {
+            testTvmci.finishWarmup(callTarget);
+        }
+    }
 }