changeset 18988:cca166aa28c0

Truffle/Tools: unit tests for new framework and tool instances
author Michael Van De Vanter <michael.van.de.vanter@oracle.com>
date Tue, 27 Jan 2015 20:27:25 -0800
parents ac114ad31cdd
children acd822f17ef5
files graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/CoverageTrackerTest.java graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/LineToProbesMapTest.java graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/NodeExecCounterTest.java graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/TestNodes.java graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/TruffleToolTest.java
diffstat 5 files changed, 715 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/CoverageTrackerTest.java	Tue Jan 27 20:27:25 2015 -0800
@@ -0,0 +1,114 @@
+/*
+ * Copyright (c) 2015, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.truffle.api.test.tools;
+
+import static com.oracle.truffle.api.test.tools.TestNodes.*;
+import static org.junit.Assert.*;
+
+import org.junit.*;
+
+import com.oracle.truffle.api.instrument.*;
+import com.oracle.truffle.api.nodes.*;
+import com.oracle.truffle.api.tools.*;
+
+public class CoverageTrackerTest {
+
+    @Test
+    public void testNoExecution() {
+        final CoverageTracker tool = new CoverageTracker();
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+        tool.install();
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+        tool.setEnabled(false);
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+        tool.setEnabled(true);
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+        tool.reset();
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+        tool.dispose();
+        assertEquals(tool.getCounts().entrySet().size(), 0);
+    }
+
+    @Test
+    public void testToolCreatedTooLate() {
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+        final CoverageTracker tool = new CoverageTracker();
+        tool.install();
+        assertEquals(13, expr13rootNode.execute(null));
+        assertTrue(tool.getCounts().isEmpty());
+        tool.dispose();
+    }
+
+    @Test
+    public void testToolInstalledcTooLate() {
+        final CoverageTracker tool = new CoverageTracker();
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+        tool.install();
+        assertEquals(13, expr13rootNode.execute(null));
+        assertTrue(tool.getCounts().isEmpty());
+        tool.dispose();
+    }
+
+    @Test
+    public void testCountingCoverage() {
+        final CoverageTracker tool = new CoverageTracker();
+        tool.install();
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+
+        // Not probed yet.
+        assertEquals(13, expr13rootNode.execute(null));
+        assertTrue(tool.getCounts().isEmpty());
+
+        final Node addNode = expr13rootNode.getChildren().iterator().next();
+        final Probe probe = addNode.probe();
+
+        // Probed but not tagged yet.
+        assertEquals(13, expr13rootNode.execute(null));
+        assertTrue(tool.getCounts().isEmpty());
+
+        probe.tagAs(StandardSyntaxTag.STATEMENT, "fake statement for testing");
+
+        // Counting now; execute once
+        assertEquals(13, expr13rootNode.execute(null));
+
+        final Long[] longs1 = tool.getCounts().get(addNode.getSourceSection().getSource());
+        assertNotNull(longs1);
+        assertEquals(longs1.length, 2);
+        assertNull(longs1[0]);  // Line 1 is empty (text lines are 1-based)
+        assertEquals(1L, longs1[1].longValue());  // Expression is on line 2
+
+        // Execute 99 more times
+        for (int i = 0; i < 99; i++) {
+            assertEquals(13, expr13rootNode.execute(null));
+        }
+
+        final Long[] longs100 = tool.getCounts().get(addNode.getSourceSection().getSource());
+        assertNotNull(longs100);
+        assertEquals(longs100.length, 2);
+        assertNull(longs100[0]);
+        assertEquals(100L, longs100[1].longValue());
+
+        tool.dispose();
+    }
+
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/LineToProbesMapTest.java	Tue Jan 27 20:27:25 2015 -0800
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2015, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.truffle.api.test.tools;
+
+import static com.oracle.truffle.api.test.tools.TestNodes.*;
+import static org.junit.Assert.*;
+
+import org.junit.*;
+
+import com.oracle.truffle.api.instrument.*;
+import com.oracle.truffle.api.nodes.*;
+import com.oracle.truffle.api.source.*;
+import com.oracle.truffle.api.tools.*;
+
+public class LineToProbesMapTest {
+
+    @Test
+    public void testToolCreatedTooLate() {
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+        final Node addNode = expr13rootNode.getChildren().iterator().next();
+        final Probe probe = addNode.probe();
+        final LineLocation lineLocation = probe.getProbedSourceSection().getLineLocation();
+        assertEquals(lineLocation, expr13Line2);
+
+        final LineToProbesMap tool = new LineToProbesMap();
+        tool.install();
+
+        assertNull(tool.findFirstProbe(expr13Line1));
+        assertNull(tool.findFirstProbe(expr13Line2));
+        tool.dispose();
+    }
+
+    @Test
+    public void testToolInstalledTooLate() {
+        final LineToProbesMap tool = new LineToProbesMap();
+
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+        final Node addNode = expr13rootNode.getChildren().iterator().next();
+        final Probe probe = addNode.probe();
+        final LineLocation lineLocation = probe.getProbedSourceSection().getLineLocation();
+        assertEquals(lineLocation, expr13Line2);
+
+        tool.install();
+
+        assertNull(tool.findFirstProbe(expr13Line1));
+        assertNull(tool.findFirstProbe(expr13Line2));
+        tool.dispose();
+    }
+
+    @Test
+    public void testMapping() {
+        final LineToProbesMap tool = new LineToProbesMap();
+        tool.install();
+
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+        final Node addNode = expr13rootNode.getChildren().iterator().next();
+        final Probe probe = addNode.probe();
+        final LineLocation lineLocation = probe.getProbedSourceSection().getLineLocation();
+        assertEquals(lineLocation, expr13Line2);
+
+        assertNull(tool.findFirstProbe(expr13Line1));
+        assertEquals(tool.findFirstProbe(expr13Line2), probe);
+        tool.dispose();
+    }
+
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/NodeExecCounterTest.java	Tue Jan 27 20:27:25 2015 -0800
@@ -0,0 +1,165 @@
+/*
+ * Copyright (c) 2015, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.truffle.api.test.tools;
+
+import static com.oracle.truffle.api.test.tools.TestNodes.*;
+import static org.junit.Assert.*;
+
+import org.junit.*;
+
+import com.oracle.truffle.api.*;
+import com.oracle.truffle.api.instrument.*;
+import com.oracle.truffle.api.nodes.*;
+import com.oracle.truffle.api.test.tools.TestNodes.TestAddNode;
+import com.oracle.truffle.api.test.tools.TestNodes.TestValueNode;
+import com.oracle.truffle.api.tools.*;
+import com.oracle.truffle.api.tools.NodeExecCounter.NodeExecutionCount;
+
+public class NodeExecCounterTest {
+
+    @Test
+    public void testNoExecution() {
+        final NodeExecCounter tool = new NodeExecCounter();
+        assertEquals(tool.getCounts().length, 0);
+        tool.install();
+        assertEquals(tool.getCounts().length, 0);
+        tool.setEnabled(false);
+        assertEquals(tool.getCounts().length, 0);
+        tool.setEnabled(true);
+        assertEquals(tool.getCounts().length, 0);
+        tool.reset();
+        assertEquals(tool.getCounts().length, 0);
+        tool.dispose();
+        assertEquals(tool.getCounts().length, 0);
+    }
+
+    @Test
+    public void testToolCreatedTooLate() {
+        final CallTarget expr13callTarget = createExpr13TestCallTarget();
+        final NodeExecCounter tool = new NodeExecCounter();
+        tool.install();
+        assertEquals(13, expr13callTarget.call());
+        assertEquals(tool.getCounts().length, 0);
+        tool.dispose();
+    }
+
+    @Test
+    public void testToolInstalledcTooLate() {
+        final NodeExecCounter tool = new NodeExecCounter();
+        final CallTarget expr13callTarget = createExpr13TestCallTarget();
+        tool.install();
+        assertEquals(13, expr13callTarget.call());
+        assertEquals(tool.getCounts().length, 0);
+        tool.dispose();
+    }
+
+    @Test
+    public void testCountingAll() {
+        final NodeExecCounter tool = new NodeExecCounter();
+        tool.install();
+        final CallTarget expr13callTarget = createExpr13TestCallTarget();
+
+        // execute once
+        assertEquals(13, expr13callTarget.call());
+        final NodeExecutionCount[] count1 = tool.getCounts();
+        assertNotNull(count1);
+        assertEquals(count1.length, 2);
+        for (NodeExecutionCount count : count1) {
+            final Class<?> class1 = count.nodeClass();
+            final long executionCount = count.executionCount();
+            if (class1 == TestAddNode.class) {
+                assertEquals(executionCount, 1);
+            } else if (class1 == TestValueNode.class) {
+                assertEquals(executionCount, 2);
+            } else {
+                fail();
+            }
+        }
+
+        // Execute 99 more times
+        for (int i = 0; i < 99; i++) {
+            assertEquals(13, expr13callTarget.call());
+        }
+        final NodeExecutionCount[] counts100 = tool.getCounts();
+        assertNotNull(counts100);
+        assertEquals(counts100.length, 2);
+        for (NodeExecutionCount count : counts100) {
+            final Class<?> class1 = count.nodeClass();
+            final long executionCount = count.executionCount();
+            if (class1 == TestAddNode.class) {
+                assertEquals(executionCount, 100);
+            } else if (class1 == TestValueNode.class) {
+                assertEquals(executionCount, 200);
+            } else {
+                fail();
+            }
+        }
+
+        tool.dispose();
+    }
+
+    @Test
+    public void testCountingTagged() {
+        final NodeExecCounter tool = new NodeExecCounter(StandardSyntaxTag.STATEMENT);
+        tool.install();
+        final RootNode expr13rootNode = createExpr13TestRootNode();
+
+        // Not probed yet.
+        assertEquals(13, expr13rootNode.execute(null));
+        assertEquals(tool.getCounts().length, 0);
+
+        final Node addNode = expr13rootNode.getChildren().iterator().next();
+        final Probe probe = addNode.probe();
+
+        // Probed but not tagged yet.
+        assertEquals(13, expr13rootNode.execute(null));
+        assertEquals(tool.getCounts().length, 0);
+
+        probe.tagAs(StandardSyntaxTag.STATEMENT, "fake statement for testing");
+
+        // Counting now; execute once
+        assertEquals(13, expr13rootNode.execute(null));
+        final NodeExecutionCount[] counts1 = tool.getCounts();
+        assertNotNull(counts1);
+        assertEquals(counts1.length, 1);
+        final NodeExecutionCount count1 = counts1[0];
+        assertNotNull(count1);
+        assertEquals(count1.nodeClass(), addNode.getClass());
+        assertEquals(count1.executionCount(), 1);
+
+        // Execute 99 more times
+        for (int i = 0; i < 99; i++) {
+            assertEquals(13, expr13rootNode.execute(null));
+        }
+
+        final NodeExecutionCount[] counts100 = tool.getCounts();
+        assertNotNull(counts100);
+        assertEquals(counts100.length, 1);
+        final NodeExecutionCount count100 = counts100[0];
+        assertNotNull(count100);
+        assertEquals(count100.nodeClass(), addNode.getClass());
+        assertEquals(count100.executionCount(), 100);
+
+        tool.dispose();
+    }
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/TestNodes.java	Tue Jan 27 20:27:25 2015 -0800
@@ -0,0 +1,221 @@
+/*
+ * Copyright (c) 2015, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.truffle.api.test.tools;
+
+import com.oracle.truffle.api.*;
+import com.oracle.truffle.api.frame.*;
+import com.oracle.truffle.api.instrument.*;
+import com.oracle.truffle.api.instrument.ProbeNode.WrapperNode;
+import com.oracle.truffle.api.nodes.*;
+import com.oracle.truffle.api.source.*;
+
+/**
+ * Nodes and an {@linkplain CallTarget executable ASTs} for testing.
+ */
+public class TestNodes {
+
+    /**
+     * A fake source used for testing: empty line 1, expression on line 2.
+     */
+    public static final Source expr13Source = Source.fromText("\n6+7\n", "Test Source: expression on line 2 that evaluates to 13");
+    public static final LineLocation expr13Line1 = expr13Source.createLineLocation(1);
+    public static final LineLocation expr13Line2 = expr13Source.createLineLocation(2);
+
+    /**
+     * An executable addition expression that evaluates to 13.
+     */
+    public static CallTarget createExpr13TestCallTarget() {
+        final RootNode rootNode = createExpr13TestRootNode();
+        return Truffle.getRuntime().createCallTarget(rootNode);
+    }
+
+    /**
+     * Root holding an addition expression that evaluates to 13.
+     */
+    public static RootNode createExpr13TestRootNode() {
+        final TestLanguageNode ast = createExpr13AST();
+        final TestRootNode rootNode = new TestRootNode(ast);
+        rootNode.adoptChildren();
+        return rootNode;
+    }
+
+    /**
+     * Addition expression that evaluates to 13, with faked source attribution.
+     */
+    public static TestLanguageNode createExpr13AST() {
+        final SourceSection leftSourceSection = expr13Source.createSection("left", 1, 1);
+        final TestValueNode leftValueNode = new TestValueNode(6, leftSourceSection);
+        final SourceSection rightSourceSection = expr13Source.createSection("right", 3, 1);
+        final TestValueNode rightValueNode = new TestValueNode(7, rightSourceSection);
+        final SourceSection exprSourceSection = expr13Source.createSection("expr", 1, 3);
+        return new TestAddNode(leftValueNode, rightValueNode, exprSourceSection);
+    }
+
+    public abstract static class TestLanguageNode extends Node {
+        public abstract Object execute(VirtualFrame frame);
+
+        public TestLanguageNode() {
+        }
+
+        public TestLanguageNode(SourceSection srcSection) {
+            super(srcSection);
+        }
+
+        @Override
+        public boolean isInstrumentable() {
+            return true;
+        }
+
+        @Override
+        public WrapperNode createWrapperNode() {
+            return new TestWrapperNode(this);
+        }
+    }
+
+    @NodeInfo(cost = NodeCost.NONE)
+    public static class TestWrapperNode extends TestLanguageNode implements WrapperNode {
+        @Child private TestLanguageNode child;
+        @Child private ProbeNode probeNode;
+
+        public TestWrapperNode(TestLanguageNode child) {
+            assert !(child instanceof TestWrapperNode);
+            this.child = child;
+        }
+
+        @Override
+        public String instrumentationInfo() {
+            return "Wrapper node for testing";
+        }
+
+        @Override
+        public boolean isInstrumentable() {
+            return false;
+        }
+
+        @Override
+        public void insertProbe(ProbeNode newProbeNode) {
+            this.probeNode = newProbeNode;
+        }
+
+        @Override
+        public Probe getProbe() {
+            try {
+                return probeNode.getProbe();
+            } catch (IllegalStateException e) {
+                throw new IllegalStateException("Cannot call getProbe() on a wrapper that has no probe");
+            }
+        }
+
+        @Override
+        public Node getChild() {
+            return child;
+        }
+
+        @Override
+        public Object execute(VirtualFrame frame) {
+            probeNode.enter(child, frame);
+            Object result;
+
+            try {
+                result = child.execute(frame);
+                probeNode.returnValue(child, frame, result);
+            } catch (KillException e) {
+                throw (e);
+            } catch (Exception e) {
+                probeNode.returnExceptional(child, frame, e);
+                throw (e);
+            }
+
+            return result;
+        }
+    }
+
+    /**
+     * Truffle requires that all guest languages to have a {@link RootNode} which sits atop any AST
+     * of the guest language. This is necessary since creating a {@link CallTarget} is how Truffle
+     * completes an AST. The root nodes serves as our entry point into a program.
+     */
+    public static class TestRootNode extends RootNode {
+        @Child private TestLanguageNode body;
+
+        /**
+         * This constructor emulates the global machinery that applies registered probers to every
+         * newly created AST. Global registry is not used, since that would interfere with other
+         * tests run in the same environment.
+         */
+        public TestRootNode(TestLanguageNode body) {
+            super(null);
+            this.body = body;
+        }
+
+        @Override
+        public Object execute(VirtualFrame frame) {
+            return body.execute(frame);
+        }
+
+        @Override
+        public boolean isCloningAllowed() {
+            return true;
+        }
+
+        @Override
+        public void applyInstrumentation() {
+            Probe.applyASTProbers(body);
+        }
+    }
+
+    public static class TestValueNode extends TestLanguageNode {
+        private final int value;
+
+        public TestValueNode(int value) {
+            this.value = value;
+        }
+
+        public TestValueNode(int value, SourceSection srcSection) {
+            super(srcSection);
+            this.value = value;
+        }
+
+        @Override
+        public Object execute(VirtualFrame frame) {
+            return new Integer(this.value);
+        }
+    }
+
+    public static class TestAddNode extends TestLanguageNode {
+        @Child private TestLanguageNode leftChild;
+        @Child private TestLanguageNode rightChild;
+
+        public TestAddNode(TestValueNode leftChild, TestValueNode rightChild, SourceSection sourceSection) {
+            super(sourceSection);
+            this.leftChild = insert(leftChild);
+            this.rightChild = insert(rightChild);
+        }
+
+        @Override
+        public Object execute(VirtualFrame frame) {
+            return new Integer(((Integer) leftChild.execute(frame)).intValue() + ((Integer) rightChild.execute(frame)).intValue());
+        }
+    }
+
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/graal/com.oracle.truffle.api.test/src/com/oracle/truffle/api/test/tools/TruffleToolTest.java	Tue Jan 27 20:27:25 2015 -0800
@@ -0,0 +1,129 @@
+/*
+ * Copyright (c) 2015, 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
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package com.oracle.truffle.api.test.tools;
+
+import static org.junit.Assert.*;
+
+import org.junit.*;
+
+import com.oracle.truffle.api.instrument.*;
+
+/**
+ * Test the basic life cycle properties shared by all instances of {@link TruffleTool}.
+ */
+public class TruffleToolTest {
+
+    @Test
+    public void testEmptyLifeCycle() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        assertFalse(tool.isEnabled());
+        tool.install();
+        assertTrue(tool.isEnabled());
+        tool.reset();
+        assertTrue(tool.isEnabled());
+        tool.setEnabled(false);
+        assertFalse(tool.isEnabled());
+        tool.reset();
+        assertFalse(tool.isEnabled());
+        tool.setEnabled(true);
+        assertTrue(tool.isEnabled());
+        tool.reset();
+        assertTrue(tool.isEnabled());
+        tool.dispose();
+        assertFalse(tool.isEnabled());
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testNotYetInstalled1() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.reset();
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testNotYetInstalled2() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.setEnabled(true);
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testNotYetInstalled3() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.dispose();
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testAlreadyInstalled() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.install();
+        tool.install();
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testAlreadyDisposed1() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.install();
+        tool.dispose();
+        tool.install();
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testAlreadyDisposed2() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.install();
+        tool.dispose();
+        tool.reset();
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testAlreadyDisposed3() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.install();
+        tool.dispose();
+        tool.setEnabled(true);
+    }
+
+    @Test(expected = IllegalStateException.class)
+    public void testAlreadyDisposed4() {
+        final DummyTruffleTool tool = new DummyTruffleTool();
+        tool.install();
+        tool.dispose();
+        tool.dispose();
+    }
+
+    private static final class DummyTruffleTool extends TruffleTool {
+
+        @Override
+        protected boolean internalInstall() {
+            return true;
+        }
+
+        @Override
+        protected void internalReset() {
+        }
+
+        @Override
+        protected void internalDispose() {
+        }
+
+    }
+}