ide/terminal.nb/test/unit/src/org/netbeans/modules/terminal/TestSupport.java - netbeans - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

 package org.netbeans.modules.terminal;

 import java.awt.BorderLayout;
 import java.awt.event.ActionEvent;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import javax.swing.AbstractAction;
 import javax.swing.Action;
 import javax.swing.ImageIcon;
 import javax.swing.JComponent;
 import javax.swing.JFrame;
 import javax.swing.SwingUtilities;
 import org.netbeans.junit.NbTestCase;
 import org.netbeans.modules.terminal.api.ui.TerminalContainer;
 import org.netbeans.modules.terminal.ioprovider.TerminalIOProvider;
 import org.netbeans.modules.terminal.ioprovider.TerminalInputOutput;
 import org.netbeans.modules.terminal.test.IOTest;
 import org.openide.util.Exceptions;
 import org.openide.util.ImageUtilities;
 import org.openide.windows.IOContainer;
 import org.openide.windows.IOProvider;
 import org.openide.windows.InputOutput;

 /**
  *
  * @author ivan
  */
 public class TestSupport extends NbTestCase {

     private JFrame frame;

     protected Action dummyAction;
     protected IOProvider ioProvider;
     protected IOContainer ioContainer;
     protected JComponent actualContainer;
     protected InputOutput io;

     protected boolean defaultContainer = false;
     // LATER: my IOContainer doesn't do well with output2 IOProvider
     protected boolean defaultProvider = false;

     private static final int quantuum = 100;
     private static final boolean interactive = false;


     static class DummyAction extends AbstractAction {
 	public DummyAction() {
 	    super("Dummy");
 	    String iconResource = "org/netbeans/modules/terminal/sunsky.png";
 	    ImageIcon icon = ImageUtilities.loadImageIcon(iconResource, false);
 	    this.putValue(SMALL_ICON, icon);
 	}

 	@Override
 	public void actionPerformed(ActionEvent e) {
 	    throw new UnsupportedOperationException("Not supported yet.");
 	}
     }

     public TestSupport(String testName) {
 	super(testName);
     }

     @Override
     protected void setUp() throws Exception {
 	setUp(true);
     }

     protected void setUp(boolean select) throws Exception {
 	System.out.printf("TestSupport.setUp()\n");

 	if (defaultContainer) {
 	    ioContainer = IOContainer.getDefault();
 	    actualContainer = defaultContainer(ioContainer);
 	} else {
 	    TerminalContainer tc = TerminalContainer.create(null, "Test");
 	    actualContainer = tc;
 	    ioContainer = tc.ioContainer();
 	}

         SwingUtilities.invokeAndWait(new Runnable() {
 	    @Override
             public void run() {

 		frame = new JFrame();
 		frame.getContentPane().setLayout(new BorderLayout());
 		frame.getContentPane().add(actualContainer, BorderLayout.CENTER);
 		frame.setBounds(20, 20, 700, 300);
 		frame.setVisible(true);

 	    }
 	});

 	if (defaultProvider) {
 	    ioProvider = IOProvider.getDefault();
 	    assertNotNull ("Could not find IOProvider", ioProvider);
 	} else {
 	    ioProvider = IOProvider.get("Terminal");
 	    assertNotNull ("Could not find IOProvider", ioProvider);
             //this check is really strange as terminal CAN be default, why not?
 	    assertTrue("Got provider which is not TerminalIOProvider", (ioProvider instanceof TerminalIOProvider));
 	}

 	dummyAction = new DummyAction();
 	Action[] actions = new Action[] {dummyAction};

 	io = ioProvider.getIO("test", actions, ioContainer);
 	assertNotNull ("Could not get InputOutput", io);
 	if (select) {
 	    io.select();
 	    sleep(1);	// give select time to take effect
 	}
     }

     @Override
     protected void tearDown() throws Exception {
 	System.out.printf("TestSupport.tearDown()\n");

 	// some tests null it out
 	if (io != null)
 	    io.closeInputOutput();
 	if (dummyAction != null)
 	    dummyAction = null;
 	io = null;
 	ioProvider = null;
 	ioContainer = null;
 	actualContainer = null;

         SwingUtilities.invokeAndWait(new Runnable() {
 	    @Override
             public void run() {
 		frame.dispose();
 		frame = null;
 	    }
 	});
     }

     /**
      * Sleep 100 milliseconds
      */
     private static void mSleep(int amount) {
 	try {
 	    Thread.sleep(amount);
 	} catch(InterruptedException x) {
 	    fail("sleep interrupted");
 	}
     }

     /**
      * Issue a dummy invokeAndWait(). This assures that any Tasks
      * issued prior to this have run.
      */
     private void yieldToEDT() {
 	// flag to give some work to 'run)(' so JIT optimizer
 	// doesn't optimize it away.
 	final boolean[] flag = new boolean[] { false};
 	try {
 	    SwingUtilities.invokeAndWait(new Runnable() {
 		@Override
 		public void run() {
 		    flag[0] = true;
 		}
 	    });
 	} catch (InterruptedException ex) {
 	    Exceptions.printStackTrace(ex);
 	} catch (InvocationTargetException ex) {
 	    Exceptions.printStackTrace(ex);
 	}
 	assert flag[0] == true;
     }

     /**
      * Ensure that all submitted Tasks have been processed and that the
      * disconnect continuation has run within the given time.
      * Uses invokeAndWait().
      * @param seconds Timeout.
      */
     protected final void sleep(int seconds) {
 	int mSeconds = seconds * 1000;	// milliseconds
 	for (int t = 0; t < mSeconds; t += quantuum) {
 	    mSleep(quantuum);
 	    yieldToEDT();
 	    if (continuationDone == null)
 		return;
 	    else if (continuationDone == true)
 		return;
 	}
 	fail(String.format("Not synced with Task queue after %d seconds\n", seconds));
     }

     private Boolean continuationDone = null;

     private Runnable continuationInterlock = new Runnable() {
 	@Override
 	public void run() {
 	    continuationDone = Boolean.TRUE;
 	}
     };

     /**
      * Provide a dummy Runnable to be used as the continuation for
      * disconnect(). We reset a flag, the runnable sets the flag and
      * sleep() checks the flag. Sleep needs to check this flag separately
      * because the continuation runs on a dedicated thread, not the EDT.
      * @return
      */
     protected final Runnable continuationInterlock() {
 	continuationDone = Boolean.FALSE;
 	return continuationInterlock;
     }


     /**
      * Ensure that all submitted Tasks have been processed within the given
      * time.
      * Uses IOTest.isQuiescent().
      * @param seconds Timeout.
      */

     protected void OLD_sleep(int seconds) {
 	// isQuiescent() method doesn't work well with MTStress_Test.
 	// While one thread may be checking for outstanding task count being
 	// 0 another thread may be adding Tasks.
 	int mSeconds = seconds * 1000;	// milliseconds
 	if (!interactive && IOTest.isSupported(io)) {
 	    for (int t = 0; t < mSeconds; t += quantuum) {
 		mSleep(quantuum);
 		if (IOTest.isQuiescent(io))
 		    return;
 	    }
 	    fail(String.format("Task queue not empty after %d seconds\n", seconds));
 	} else {
 	    mSleep(mSeconds);
 	}
     }

     /**
      * Use reflection to extract private IOWindow instance so
      * we can embed it in a JFrame.
      */
     private static JComponent defaultContainer(IOContainer ioContainer) {
         JComponent comp = null;
         try {
             try {
                 Field f = ioContainer.getClass().getDeclaredField("provider");
                 f.setAccessible(true);
                 IOContainer.Provider prov = (IOContainer.Provider) f.get(ioContainer);
                 Method m = prov.getClass().getDeclaredMethod("impl", new Class[0]);
                 m.setAccessible(true);
                 comp = (JComponent) m.invoke(prov);
             } catch (InvocationTargetException ex) {
                 Exceptions.printStackTrace(ex);
             } catch (NoSuchMethodException ex) {
                 Exceptions.printStackTrace(ex);
             } catch (IllegalArgumentException ex) {
                 Exceptions.printStackTrace(ex);
             } catch (IllegalAccessException ex) {
                 Exceptions.printStackTrace(ex);
             }
         } catch (NoSuchFieldException ex) {
             Exceptions.printStackTrace(ex);
         } catch (SecurityException ex) {
             Exceptions.printStackTrace(ex);
         }
         return comp;
     }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*/

	package org.netbeans.modules.terminal;

	import java.awt.BorderLayout;
	import java.awt.event.ActionEvent;
	import java.lang.reflect.Field;
	import java.lang.reflect.InvocationTargetException;
	import java.lang.reflect.Method;
	import javax.swing.AbstractAction;
	import javax.swing.Action;
	import javax.swing.ImageIcon;
	import javax.swing.JComponent;
	import javax.swing.JFrame;
	import javax.swing.SwingUtilities;
	import org.netbeans.junit.NbTestCase;
	import org.netbeans.modules.terminal.api.ui.TerminalContainer;
	import org.netbeans.modules.terminal.ioprovider.TerminalIOProvider;
	import org.netbeans.modules.terminal.ioprovider.TerminalInputOutput;
	import org.netbeans.modules.terminal.test.IOTest;
	import org.openide.util.Exceptions;
	import org.openide.util.ImageUtilities;
	import org.openide.windows.IOContainer;
	import org.openide.windows.IOProvider;
	import org.openide.windows.InputOutput;

	/**
	*
	* @author ivan
	*/
	public class TestSupport extends NbTestCase {

	private JFrame frame;

	protected Action dummyAction;
	protected IOProvider ioProvider;
	protected IOContainer ioContainer;
	protected JComponent actualContainer;
	protected InputOutput io;

	protected boolean defaultContainer = false;
	// LATER: my IOContainer doesn't do well with output2 IOProvider
	protected boolean defaultProvider = false;

	private static final int quantuum = 100;
	private static final boolean interactive = false;


	static class DummyAction extends AbstractAction {
	public DummyAction() {
	super("Dummy");
	String iconResource = "org/netbeans/modules/terminal/sunsky.png";
	ImageIcon icon = ImageUtilities.loadImageIcon(iconResource, false);
	this.putValue(SMALL_ICON, icon);
	}

	@Override
	public void actionPerformed(ActionEvent e) {
	throw new UnsupportedOperationException("Not supported yet.");
	}
	}

	public TestSupport(String testName) {
	super(testName);
	}

	@Override
	protected void setUp() throws Exception {
	setUp(true);
	}

	protected void setUp(boolean select) throws Exception {
	System.out.printf("TestSupport.setUp()\n");

	if (defaultContainer) {
	ioContainer = IOContainer.getDefault();
	actualContainer = defaultContainer(ioContainer);
	} else {
	TerminalContainer tc = TerminalContainer.create(null, "Test");
	actualContainer = tc;
	ioContainer = tc.ioContainer();
	}

	SwingUtilities.invokeAndWait(new Runnable() {
	@Override
	public void run() {

	frame = new JFrame();
	frame.getContentPane().setLayout(new BorderLayout());
	frame.getContentPane().add(actualContainer, BorderLayout.CENTER);
	frame.setBounds(20, 20, 700, 300);
	frame.setVisible(true);

	}
	});

	if (defaultProvider) {
	ioProvider = IOProvider.getDefault();
	assertNotNull ("Could not find IOProvider", ioProvider);
	} else {
	ioProvider = IOProvider.get("Terminal");
	assertNotNull ("Could not find IOProvider", ioProvider);
	//this check is really strange as terminal CAN be default, why not?
	assertTrue("Got provider which is not TerminalIOProvider", (ioProvider instanceof TerminalIOProvider));
	}

	dummyAction = new DummyAction();
	Action[] actions = new Action[] {dummyAction};

	io = ioProvider.getIO("test", actions, ioContainer);
	assertNotNull ("Could not get InputOutput", io);
	if (select) {
	io.select();
	sleep(1); // give select time to take effect
	}
	}

	@Override
	protected void tearDown() throws Exception {
	System.out.printf("TestSupport.tearDown()\n");

	// some tests null it out
	if (io != null)
	io.closeInputOutput();
	if (dummyAction != null)
	dummyAction = null;
	io = null;
	ioProvider = null;
	ioContainer = null;
	actualContainer = null;

	SwingUtilities.invokeAndWait(new Runnable() {
	@Override
	public void run() {
	frame.dispose();
	frame = null;
	}
	});
	}

	/**
	* Sleep 100 milliseconds
	*/
	private static void mSleep(int amount) {
	try {
	Thread.sleep(amount);
	} catch(InterruptedException x) {
	fail("sleep interrupted");
	}
	}

	/**
	* Issue a dummy invokeAndWait(). This assures that any Tasks
	* issued prior to this have run.
	*/
	private void yieldToEDT() {
	// flag to give some work to 'run)(' so JIT optimizer
	// doesn't optimize it away.
	final boolean[] flag = new boolean[] { false};
	try {
	SwingUtilities.invokeAndWait(new Runnable() {
	@Override
	public void run() {
	flag[0] = true;
	}
	});
	} catch (InterruptedException ex) {
	Exceptions.printStackTrace(ex);
	} catch (InvocationTargetException ex) {
	Exceptions.printStackTrace(ex);
	}
	assert flag[0] == true;
	}

	/**
	* Ensure that all submitted Tasks have been processed and that the
	* disconnect continuation has run within the given time.
	* Uses invokeAndWait().
	* @param seconds Timeout.
	*/
	protected final void sleep(int seconds) {
	int mSeconds = seconds * 1000; // milliseconds
	for (int t = 0; t < mSeconds; t += quantuum) {
	mSleep(quantuum);
	yieldToEDT();
	if (continuationDone == null)
	return;
	else if (continuationDone == true)
	return;
	}
	fail(String.format("Not synced with Task queue after %d seconds\n", seconds));
	}

	private Boolean continuationDone = null;

	private Runnable continuationInterlock = new Runnable() {
	@Override
	public void run() {
	continuationDone = Boolean.TRUE;
	}
	};

	/**
	* Provide a dummy Runnable to be used as the continuation for
	* disconnect(). We reset a flag, the runnable sets the flag and
	* sleep() checks the flag. Sleep needs to check this flag separately
	* because the continuation runs on a dedicated thread, not the EDT.
	* @return
	*/
	protected final Runnable continuationInterlock() {
	continuationDone = Boolean.FALSE;
	return continuationInterlock;
	}


	/**
	* Ensure that all submitted Tasks have been processed within the given
	* time.
	* Uses IOTest.isQuiescent().
	* @param seconds Timeout.
	*/

	protected void OLD_sleep(int seconds) {
	// isQuiescent() method doesn't work well with MTStress_Test.
	// While one thread may be checking for outstanding task count being
	// 0 another thread may be adding Tasks.
	int mSeconds = seconds * 1000; // milliseconds
	if (!interactive && IOTest.isSupported(io)) {
	for (int t = 0; t < mSeconds; t += quantuum) {
	mSleep(quantuum);
	if (IOTest.isQuiescent(io))
	return;
	}
	fail(String.format("Task queue not empty after %d seconds\n", seconds));
	} else {
	mSleep(mSeconds);
	}
	}

	/**
	* Use reflection to extract private IOWindow instance so
	* we can embed it in a JFrame.
	*/
	private static JComponent defaultContainer(IOContainer ioContainer) {
	JComponent comp = null;
	try {
	try {
	Field f = ioContainer.getClass().getDeclaredField("provider");
	f.setAccessible(true);
	IOContainer.Provider prov = (IOContainer.Provider) f.get(ioContainer);
	Method m = prov.getClass().getDeclaredMethod("impl", new Class[0]);
	m.setAccessible(true);
	comp = (JComponent) m.invoke(prov);
	} catch (InvocationTargetException ex) {
	Exceptions.printStackTrace(ex);
	} catch (NoSuchMethodException ex) {
	Exceptions.printStackTrace(ex);
	} catch (IllegalArgumentException ex) {
	Exceptions.printStackTrace(ex);
	} catch (IllegalAccessException ex) {
	Exceptions.printStackTrace(ex);
	}
	} catch (NoSuchFieldException ex) {
	Exceptions.printStackTrace(ex);
	} catch (SecurityException ex) {
	Exceptions.printStackTrace(ex);
	}
	return comp;
	}
	}