/*
 * Copyright (c) 2015, 2016 Oracle and/or its affiliates. All rights reserved. This
 * code is released under a tri EPL/GPL/LGPL license. You can use it,
 * redistribute it and/or modify it under the terms of the:
 *
 * Eclipse Public License version 1.0
 * GNU General Public License version 2
 * GNU Lesser General Public License version 2.1
 */
package org.jruby.truffle.tck;

import com.oracle.truffle.api.debug.Debugger;
import com.oracle.truffle.api.debug.ExecutionEvent;
import com.oracle.truffle.api.debug.SuspendedEvent;
import com.oracle.truffle.api.frame.FrameSlot;
import com.oracle.truffle.api.frame.MaterializedFrame;
import com.oracle.truffle.api.nodes.Node;
import com.oracle.truffle.api.source.LineLocation;
import com.oracle.truffle.api.source.Source;
import com.oracle.truffle.api.vm.EventConsumer;
import com.oracle.truffle.api.vm.PolyglotEngine;
import com.oracle.truffle.api.vm.PolyglotEngine.Value;
import org.jruby.truffle.RubyContext;
import org.jruby.truffle.RubyLanguage;
import org.jruby.truffle.language.control.JavaException;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.LinkedList;
import java.util.Objects;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

public class RubyDebugTest {

    private Debugger debugger;
    private final LinkedList<Runnable> run = new LinkedList<>();
    private SuspendedEvent suspendedEvent;
    private Throwable ex;
    private ExecutionEvent executionEvent;
    private PolyglotEngine engine;
    private final ByteArrayOutputStream out = new ByteArrayOutputStream();
    private final ByteArrayOutputStream err = new ByteArrayOutputStream();

    @Before
    public void before() throws IOException {
        suspendedEvent = null;
        executionEvent = null;

        engine = PolyglotEngine.newBuilder().setOut(out).setErr(err)
                .onEvent(new EventConsumer<ExecutionEvent>(ExecutionEvent.class) {

            @Override
            protected void on(ExecutionEvent event) {
                executionEvent = event;
                debugger = executionEvent.getDebugger();
                performWork();
                executionEvent = null;
            }

        }).onEvent(new EventConsumer<SuspendedEvent>(SuspendedEvent.class) {

            @Override
            protected void on(SuspendedEvent event) {
                suspendedEvent = event;
                performWork();
                suspendedEvent = null;
            }

        }).build();

        engine.eval(Source.fromFileName("src/test/ruby/init.rb"));

        run.clear();
    }

    @After
    public void dispose() {
        if (engine != null) {
            //engine.dispose();
        }
    }

    @Test
    public void testBreakpoint() throws Throwable {
        final Source factorial = createFactorial();

        run.addLast(new Runnable() {

            @Override
            public void run() {
                try {
                    assertNull(suspendedEvent);
                    assertNotNull(executionEvent);
                    LineLocation returnOne = factorial.createLineLocation(3);
                    debugger.setLineBreakpoint(0, returnOne, false);
                    executionEvent.prepareContinue();
                } catch (IOException e) {
                    throw new JavaException(e);
                }
            }

        });

        engine.eval(factorial);

        assertExecutedOK("Algorithm loaded");

        run.addLast(new Runnable() {

            @Override
            public void run() {
                //fail("the breakpoint should hit instead");
            }

        });

        assertLocation(3, "1",
                        "n", 1,
                        "nMinusOne", null,
                        "nMOFact", null,
                        "res", null);

        continueExecution();

        final Value main = engine.findGlobalSymbol("main");
        assertNotNull( "main method found", main);
        Value value = main.execute();
        Number n = value.as(Number.class);
        assertNotNull(n);
        assertEquals("Factorial computed OK", 2, n.intValue());
        assertExecutedOK("Algorithm computed OK: " + n + "; Checking if it stopped at the breakpoint");
    }

    @Test
    public void stepInStepOver() throws Throwable {
        final Source factorial = createFactorial();
        engine.eval(factorial);

        run.addLast(new Runnable() {

            @Override
            public void run() {
                assertNull(suspendedEvent);
                assertNotNull(executionEvent);
                executionEvent.prepareStepInto();
            }

        });

        assertLocation(13, "res = fac(2)", "res", null);
        stepInto(1);
        assertLocation(2, "if n <= 1",
                        "n", 2,
                        "nMinusOne", null,
                        "nMOFact", null,
                        "res", null);
        stepOver(1);
        assertLocation(5, "nMinusOne = n - 1",
                        "n", 2,
                        "nMinusOne", null,
                        "nMOFact", null,
                        "res", null);
        stepOver(1);
        assertLocation(6, "nMOFact = fac(nMinusOne)",
                        "n", 2,
                        "nMinusOne", 1,
                        "nMOFact", null,
                        "res", null);
        stepOver(1);
        assertLocation(7, "res = n * nMOFact",
                        "n", 2, "nMinusOne", 1,
                        "nMOFact", 1,
                        "res", null);
        stepOut();
        assertLocation(13, "res = fac(2)" + System.lineSeparator()
            + "  puts res" + System.lineSeparator() // wrong!?
            + "  res", // wrong!?
                        "res", 2);

        continueExecution();

        Value value = engine.findGlobalSymbol("main").execute();

        Number n = value.as(Number.class);

        assertNotNull(n);
        assertEquals("Factorial computed OK", 2, n.intValue());
        assertExecutedOK("Stepping went OK");
    }

    private void performWork() {
        try {
            if (ex == null && !run.isEmpty()) {
                Runnable c = run.removeFirst();
                c.run();
            }
        } catch (Throwable e) {
            ex = e;
        }
    }

    private void stepOver(final int size) {
        run.addLast(new Runnable() {

            public void run() {
                suspendedEvent.prepareStepOver(size);
            }

        });
    }

    private void stepOut() {
        run.addLast(new Runnable() {

            public void run() {
                suspendedEvent.prepareStepOut();
            }

        });
    }

    private void continueExecution() {
        run.addLast(new Runnable() {

            public void run() {
                suspendedEvent.prepareContinue();
            }

        });
    }

    private void stepInto(final int size) {
        run.addLast(new Runnable() {

            public void run() {
                suspendedEvent.prepareStepInto(size);
            }

        });
    }

    private void assertLocation(final int line, final String code, final Object... expectedFrame) {
        run.addLast(new Runnable() {

            public void run() {
                assertNotNull(suspendedEvent);
                final int currentLine = suspendedEvent.getNode().getSourceSection().getLineLocation().getLineNumber();
                assertEquals(line, currentLine);
                final String currentCode = suspendedEvent.getNode().getSourceSection().getCode().trim();
                assertEquals(code, currentCode);
                final MaterializedFrame frame = suspendedEvent.getFrame();

                assertEquals(expectedFrame.length / 2, frame.getFrameDescriptor().getSize());

                for (int i = 0; i < expectedFrame.length; i = i + 2) {
                    String expectedIdentifier = (String) expectedFrame[i];
                    Object expectedValue = expectedFrame[i + 1];
                    FrameSlot slot = frame.getFrameDescriptor().findFrameSlot(expectedIdentifier);
                    assertNotNull(slot);
                    Object value = frame.getValue(slot);

                    if (Objects.equals(expectedValue, value)) {
                        continue;
                    }

                    Node findContextNode = RubyLanguage.INSTANCE.unprotectedCreateFindContextNode();
                    RubyContext context = RubyLanguage.INSTANCE.unprotectedFindContext(findContextNode);

                    if (value == context.getCoreLibrary().getNilObject()) {
                        value = null;
                    }

                    assertEquals(expectedValue, value);
                }

                run.removeFirst().run();
            }

        });
    }

    private void assertExecutedOK(String msg) throws Throwable {
        assertTrue(getErr(), getErr().isEmpty());

        if (ex != null) {
            if (ex instanceof AssertionError) {
                throw ex;
            } else {
                throw new AssertionError(msg + ". Error during execution ", ex);
            }
        }

        assertTrue(msg + ". Assuming all requests processed: " + run, run.isEmpty());
    }

    private static Source createFactorial() throws IOException {
        return Source.fromFileName("src/test/ruby/factorial.rb");
    }

    private final String getErr() {
        try {
            err.flush();
        } catch (IOException e) {
        }
        return new String(err.toByteArray());
    }

}
