tests/org.eclipse.ease.lang.python.py4j.test/src/org/eclipse/ease/lang/python/py4j/Py4JEngineTestBase.java

/*******************************************************************************
 * Copyright (c) 2016 Kichwa Coders and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * Contributors:
 *     Jonah Graham (Kichwa Coders) - initial API and implementation
 *******************************************************************************/
package org.eclipse.ease.lang.python.py4j;

import static org.junit.jupiter.api.Assertions.assertTrue;

import org.eclipse.ease.IReplEngine;
import org.eclipse.ease.Script;
import org.eclipse.ease.ScriptResult;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;

public abstract class Py4JEngineTestBase extends EaseTestBase {

	protected IReplEngine fEngine;
	protected ByteArrayPrintStream fErrorStream;
	protected ByteArrayPrintStream fOutputStream;

	@BeforeEach
	public void setUp() throws Exception {
		fEngine = createEngine();
		fEngine.setTerminateOnIdle(false);
		fErrorStream = ((ByteArrayPrintStream) fEngine.getErrorStream());
		fOutputStream = ((ByteArrayPrintStream) fEngine.getOutputStream());
	}

	@AfterEach
	public void tearDown() throws Exception {
		fEngine.setTerminateOnIdle(true);
		assertEngineTerminated(fEngine);
		fErrorStream.assertNoOutput();
		fOutputStream.assertNoOutput();
	}

	protected ScriptResult push(String line, boolean expectMore) throws Exception {
		final ScriptResult result = executeCode(line, true);
		if (expectMore) {
			assertTrue(result.get() instanceof String);
			assertTrue(result.get().toString().startsWith("..."));
		}
		return result;
	}

	protected ScriptResult executeCode(String code, boolean shellMode) throws Exception {
		final Script scriptFromShell = new Script("test code", code, shellMode);
		final ScriptResult result = fEngine.execute(scriptFromShell);
		fEngine.schedule();

		return result;
	}

	/**
	 * Evaluate the given expression by printing the str and return the standard output.
	 */
	protected String printExpression(String expression) throws Exception {
		final Script scriptFromShell = new Script("test code", "import sys; sys.stdout.write(str(" + expression + ")); sys.stdout.flush()", false);
		final ScriptResult result = fEngine.execute(scriptFromShell);
		fEngine.schedule();

		assertResultIsNone(result);
		/* TODO: Until Bug 493677 is resolved we need a delay here to ensure data has been received by the stream gobbler */
		Thread.sleep(1000);
		return fOutputStream.getAndClearOutput();
	}

}