SafeReplaceTest.java

/*
 * 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.nodes;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;

import org.junit.Test;

import com.oracle.truffle.api.frame.VirtualFrame;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.nodes.RootNode;

/**
 * Tests optional method for ensuring that a node replacement is type safe. Ordinary node
 * replacement is performed by unsafe assignment of a parent node's child field.
 */
public class SafeReplaceTest {

    @Test
    public void testCorrectReplacement() {
        TestRootNode root = new TestRootNode();
        final TestNode oldChild = new TestNode();
        final TestNode newChild = new TestNode();
        root.child = oldChild;
        assertTrue(oldChild.isSafelyReplaceableBy(newChild));  // No parent node
        root.adoptChildren();
        assertTrue(oldChild.isSafelyReplaceableBy(newChild));   // Now adopted by parent
        // new node
        oldChild.replace(newChild);
        root.execute(null);
        assertEquals(root.executed, 1);
        assertEquals(oldChild.executed, 0);
        assertEquals(newChild.executed, 1);
    }

    @Test
    public void testIncorrectReplacement() {
        TestRootNode root = new TestRootNode();
        final TestNode oldChild = new TestNode();
        root.child = oldChild;
        root.adoptChildren();
        final TestNode newChild = new TestNode();
        final TestNode strayChild = new TestNode();
        assertTrue(strayChild.isSafelyReplaceableBy(newChild)); // Stray not a child of parent
        final WrongTestNode wrongTypeNewChild = new WrongTestNode();
        assertFalse(oldChild.isSafelyReplaceableBy(wrongTypeNewChild));
    }

    private static class TestNode extends Node {

        private int executed;

        public Object execute() {
            executed++;
            return null;
        }
    }

    private static class TestRootNode extends RootNode {

        @Child TestNode child;

        private int executed;

        TestRootNode() {
            super(null);
        }

        @Override
        public Object execute(VirtualFrame frame) {
            executed++;
            child.execute();
            return null;
        }
    }

    private static class WrongTestNode extends Node {
    }

}