DebuggerTest.java example

Explorer
eXist-1.4.x-master
/*
 *  eXist Open Source Native XML Database
 *  Copyright (C) 2009 The eXist Project
 *  http://exist-db.org
 *  
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *  
 *  This program 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 Lesser General Public License for more details.
 *  
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *  
 *  $Id: DebuggerTest.java 12465 2010-08-20 09:07:49Z shabanovd $
 */
package org.exist.debugger;

import static org.junit.Assert.*;

import java.io.IOException;
import java.util.List;

import org.exist.debuggee.CommandContinuation;
import org.exist.debugger.model.Breakpoint;
import org.exist.debugger.model.Location;
import org.exist.debugger.model.Variable;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;

/**
 * @author <a href="mailto:shabanovd@gmail.com">Dmitriy Shabanov</a>
 *
 */
public class DebuggerTest implements ResponseListener {
	
	@Test
	public void testConnection() throws IOException {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger = DebuggerImpl.getDebugger();

		Exception exception = null;
		
		//if resource don't exist throw exception
		try {
			debugger.init("http://127.0.0.1:8080/xquery/fibo.xql");
			assertNotNull("The resource don't exist, but debugger din't throw exception.", null);
		} catch (Exception e) {
			exception = e;
		}
		
		assertEquals(exception.getClass().toString(), "class java.io.IOException");
		
		try {
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/fibo.xql");
			assertNotNull("Debugging source can't be NULL.", source);
            source.stop();
		} catch (Exception e) {
			assertNotNull("exception: "+e.getMessage(), null);
		}
	}
	
	@Test
	public void testDebugger() {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger;
		
		try {
			debugger = DebuggerImpl.getDebugger();

			System.out.println("sending init request");
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/fibo.xql");

			assertNotNull("Debugging source can't be NULL.", source);
			
			System.out.println("get stack frames");
			List<Location> stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(15, stack.get(0).getLineBegin());

			System.out.print("sending step-into");
			System.out.print(".");
			source.stepInto(this);
			
			try {
				Thread.sleep(1000); //TODO: query current stage or wait for BREAK status ???
			} catch (InterruptedException e) {
			}

			System.out.println("get stack frames");
			stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(16, stack.get(0).getLineBegin());

			for (int i = 0; i < 9; i++) {
				System.out.print(".");
				source.stepInto(this);
			}
			try {
				Thread.sleep(5000); //TODO: query current stage or wait for BREAK status ???
			} catch (InterruptedException e) {
			}
			System.out.println("=");
			
			System.out.println("get stack frames");
			stack = source.getStackFrames();
			assertEquals(3, stack.size());
			assertEquals(8, stack.get(0).getLineBegin());
			
			assertEquals(24, stack.get(1).getLineBegin());
			assertEquals(78, stack.get(1).getColumnBegin());

			assertEquals(24, stack.get(2).getLineBegin());
			assertEquals(42, stack.get(2).getColumnBegin());
			
			System.out.println("sending get-variables first time");
			List<Variable> vars = source.getVariables();
			
			assertEquals(2, vars.size());
			
			for (Variable var : vars) {
				if (var.getName().equals("n"))
					assertEquals("1", var.getValue());
				else if (var.getName().equals("dbgp:session"))
					assertEquals("default", var.getValue());
			}
			
			System.out.println("sending get-local-variables");
			vars = source.getLocalVariables();
			assertEquals(1, vars.size());
			for (Variable var : vars) {
				assertEquals("n", var.getName());
				assertEquals("1", var.getValue());
			}

			System.out.println("sending get-glocal-variables");
			vars = source.getGlobalVariables();
			assertEquals(1, vars.size());
			for (Variable var : vars) {
				assertEquals("dbgp:session", var.getName());
				assertEquals("default", var.getValue());
			}

			System.out.print("sending step-into & waiting stop status");
			for (int i = 0; i < 7; i++) {
				System.out.print(".");
				source.stepInto();
			}
			System.out.print("=");

			System.out.println("sending get-variables second time");
			vars = source.getVariables();
			
			assertEquals(2, vars.size());
			
			for (Variable var : vars) {
				if (var.getName().equals("n"))
					assertEquals("2", var.getValue());
				else if (var.getName().equals("dbgp:session"))
					assertEquals("default", var.getValue());
			}

			System.out.println("sending step-over");
			source.stepOver(this);

			System.out.println("sending step-out");
			source.stepOut(this);

			System.out.println("sending run");
			source.run(this);

		} catch (IOException e) {
			assertNotNull("IO exception: "+e.getMessage(), null);
		} catch (ExceptionTimeout e) {
			assertNotNull("Timeout exception: "+e.getMessage(), null);
		}
	}

	@Test
	public void testBreakpoints() throws IOException {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger = DebuggerImpl.getDebugger();
		
		try {
			System.out.println("sending init request");
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/fibo.xql");

			assertNotNull("Debugging source can't be NULL.", source);
			
			Breakpoint breakpoint = source.newBreakpoint();
			breakpoint.setLineno(24);
			breakpoint.sync();
			
			source.run();
			
			List<Location> stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(24, stack.get(0).getLineBegin());
			
			breakpoint.remove();

			source.run();
			
		} catch (IOException e) {
			assertNotNull("IO exception: "+e.getMessage(), null);
		} catch (ExceptionTimeout e) {
			assertNotNull("Timeout exception: "+e.getMessage(), null);
		}
	}

	@Test
	public void testLineBreakpoint() throws IOException {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger = DebuggerImpl.getDebugger();
		
		try {
			System.out.println("sending init request");
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/fibo.xql");

			assertNotNull("Debugging source can't be NULL.", source);
			
			Breakpoint breakpoint = source.newBreakpoint();
			breakpoint.setLineno(24);
			breakpoint.sync();
			
			source.run();
			
			List<Location> stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(24, stack.get(0).getLineBegin());
			
			source.stepInto();

			stack = source.getStackFrames();
			assertEquals(3, stack.size());
			assertEquals(8, stack.get(0).getLineBegin());

			source.stop();
			
		} catch (IOException e) {
			assertNotNull("IO exception: "+e.getMessage(), null);
		} catch (ExceptionTimeout e) {
			assertNotNull("Timeout exception: "+e.getMessage(), null);
		}
	}

	@Test
	public void testEvaluation() throws IOException {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger = DebuggerImpl.getDebugger();
		
		try {
			System.out.println("sending init request");
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/fibo.xql");

			assertNotNull("Debugging source can't be NULL.", source);
			
			Breakpoint breakpoint = source.newBreakpoint();
			breakpoint.setLineno(24);
			breakpoint.sync();
			
			String res = source.evaluate("$dbgp:session");
			assertNull(res);

			res = source.evaluate("let $seq := (98.5, 98.3, 98.9) return count($seq)");
			assertEquals("3", res);

			//xquery engine have problem here, because context not copied correctly
//			res = source.evaluate("f:fibo(2)");
//			System.out.println(res);
			
			source.run();
			
			List<Location> stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(24, stack.get(0).getLineBegin());
			
			breakpoint.remove();

			source.stop();
			
		} catch (IOException e) {
			assertNotNull("IO exception: "+e.getMessage(), null);
		} catch (ExceptionTimeout e) {
			assertNotNull("Timeout exception: "+e.getMessage(), null);
		}
	}

    @Test
	public void testEvaluation2() throws IOException {
		assertNotNull("Database wasn't initilised.", database);

		Debugger debugger = DebuggerImpl.getDebugger();

		try {
			System.out.println("sending init request");
			DebuggingSource source = debugger.init("http://127.0.0.1:8080/exist/xquery/debug-test.xql");

			assertNotNull("Debugging source can't be NULL.", source);

			Breakpoint breakpoint = source.newBreakpoint();
			breakpoint.setLineno(19);
			breakpoint.sync();

			source.run();

			List<Location> stack = source.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(19, stack.get(0).getLineBegin());

            String res = source.evaluate("$t:XML");
			assertNotNull(res);
            System.out.println("$t:XML: " + res);
            assertEquals("<root><a id=\"a1\"/><b id=\"b1\" type=\"t\"/><c id=\"c1\">text</c><d id=\"d1\"><e>text</e></d></root>", res);
			breakpoint.remove();

			source.stop();

		} catch (IOException e) {
			assertNotNull("IO exception: "+e.getMessage(), null);
		} catch (ExceptionTimeout e) {
			assertNotNull("Timeout exception: "+e.getMessage(), null);
		}
	}

	@Test
	public void testResourceNotExistOrNotRunnable() throws IOException {
		assertNotNull("Database wasn't initilised.", database);
		
		Debugger debugger = DebuggerImpl.getDebugger();
		
		Exception exception = null;
		
		try {
			System.out.println("sending init request");
			debugger.init("http://127.0.0.1:8080/exist/logo.jpg");

			assertTrue("This point should not be reached", false);

		} catch (IOException e) {
			exception = e;
		} catch (ExceptionTimeout e) {
			exception = e;
		}
		assertEquals(exception.getClass().toString(), "class java.io.IOException");

		try {
			System.out.println("sending init request");
			debugger.init("http://127.0.0.1:8080/notExist/fibo.xql");

			assertTrue("This point should not be reached", false);

		} catch (IOException e) {
			exception = e;
		} catch (ExceptionTimeout e) {
			exception = e;
		}
		assertEquals(exception.getClass().toString(), "class java.io.IOException");
	}
	
	@Test
	public void testStepInto() throws Exception {
		String url = "http://127.0.0.1:8080/exist/xquery/json-test.xql";
		for (int i = 0; i < 10; i++) {
			Debugger debugger = DebuggerImpl.getDebugger();

			System.out.println("init "+i);
			DebuggingSource debuggerSource = debugger.init(url);

			System.out.println("send stepInto");
			debuggerSource.stepInto();
			//Thread.sleep(1000);

			System.out.println("send getStackFrames");
			List<Location> stack = debuggerSource.getStackFrames();
			assertEquals(1, stack.size());
			assertEquals(8, stack.get(0).getLineBegin());
			assertEquals(6, stack.get(0).getColumnBegin());

			System.out.println("send stop");
			debuggerSource.stop();
			//Thread.sleep(1000);
			
			System.out.println("stoped");

			DebuggerImpl.shutdownDebugger();
		} 
	}

	static org.exist.start.Main database;

	@BeforeClass
    public static void initDB() {
		database = new org.exist.start.Main("jetty");
		database.run(new String[]{"jetty"});
    }

    @AfterClass
    public static void closeDB() {
       	DebuggerImpl.shutdownDebugger();

       	database.shutdown();
    }

	public void responseEvent(CommandContinuation command, Response response) {
		System.out.println("getResponse command = "+command);
	}
}