diff options
Diffstat (limited to 'org.eclipse.debug.tests/src/org/eclipse/debug/tests/console/ProcessConsoleManagerTests.java')
| -rw-r--r-- | org.eclipse.debug.tests/src/org/eclipse/debug/tests/console/ProcessConsoleManagerTests.java | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/org.eclipse.debug.tests/src/org/eclipse/debug/tests/console/ProcessConsoleManagerTests.java b/org.eclipse.debug.tests/src/org/eclipse/debug/tests/console/ProcessConsoleManagerTests.java new file mode 100644 index 000000000..93eb5b362 --- /dev/null +++ b/org.eclipse.debug.tests/src/org/eclipse/debug/tests/console/ProcessConsoleManagerTests.java @@ -0,0 +1,131 @@ +/******************************************************************************* + * Copyright (c) 2019 Paul Pazderski and others. + * + * This program and the accompanying materials + * are made available under the terms of the Eclipse Public License 2.0 + * which accompanies this distribution, and is available at + * https://www.eclipse.org/legal/epl-2.0/ + * + * SPDX-License-Identifier: EPL-2.0 + * + * Contributors: + * Paul Pazderski - initial API and implementation + *******************************************************************************/ +package org.eclipse.debug.tests.console; + +import org.eclipse.core.runtime.IStatus; +import org.eclipse.core.runtime.jobs.Job; +import org.eclipse.debug.core.DebugPlugin; +import org.eclipse.debug.core.ILaunch; +import org.eclipse.debug.core.ILaunchListener; +import org.eclipse.debug.core.ILaunchManager; +import org.eclipse.debug.core.model.IProcess; +import org.eclipse.debug.internal.core.LaunchManager; +import org.eclipse.debug.internal.ui.DebugUIPlugin; +import org.eclipse.debug.internal.ui.views.console.ConsoleRemoveAllTerminatedAction; +import org.eclipse.debug.internal.ui.views.console.ProcessConsole; +import org.eclipse.debug.internal.ui.views.console.ProcessConsoleManager; +import org.eclipse.debug.tests.AbstractDebugTest; +import org.eclipse.debug.tests.TestUtil; +import org.eclipse.debug.ui.IDebugUIConstants; +import org.eclipse.ui.console.ConsolePlugin; +import org.eclipse.ui.console.IConsoleManager; + +/** + * Tests the ProcessConsoleManager. + */ +@SuppressWarnings("restriction") +public class ProcessConsoleManagerTests extends AbstractDebugTest { + + public ProcessConsoleManagerTests() { + super(ProcessConsoleManagerTests.class.getSimpleName()); + } + + public ProcessConsoleManagerTests(String name) { + super(name); + } + + /** + * Test addition and removal of a ProcessConsole. It also kind of tests + * {@link LaunchManager} because the ProcessConsoleManager primary works + * through an {@link ILaunchListener} which is honored by this test. + */ + public void testProcessConsoleLifecycle() throws Exception { + // ensure debug UI plugin is started before adding first launch + DebugUIPlugin.getDefault(); + final ILaunchManager launchManager = DebugPlugin.getDefault().getLaunchManager(); + final IConsoleManager consoleManager = ConsolePlugin.getDefault().getConsoleManager(); + final int existingNumConsoles = consoleManager.getConsoles().length; + if (existingNumConsoles > 0) { + // existing consoles must not harm this test but it may be + // interesting in case the test fails + TestUtil.log(IStatus.INFO, getName(), "Found " + existingNumConsoles + " existing consoles on test start."); + } + + ILaunch launch = null; + final MockProcess mockProcess = new MockProcess(MockProcess.RUN_FOREVER); + try { + final IProcess process = mockProcess.toRuntimeProcess(); + launch = process.getLaunch(); + launchManager.addLaunch(launch); + // do not wait on input read job + TestUtil.waitForJobs(getName(), 0, 10000, ProcessConsole.class); + assertEquals("No console was added.", 1, consoleManager.getConsoles().length); + } finally { + mockProcess.destroy(); + } + + if (launch != null) { + launchManager.removeLaunch(launch); + TestUtil.waitForJobs(getName(), 0, 10000); + assertEquals("Console is not removed.", 0, consoleManager.getConsoles().length); + } + } + + /** + * Test problematic scenario where launch is already removed before console + * is created. see https://bugs.eclipse.org/bugs/show_bug.cgi?id=546710#c13 + */ + public void testBug546710_ConsoleCreationRaceCondition() throws Exception { + final ILaunchManager launchManager = DebugPlugin.getDefault().getLaunchManager(); + for (ILaunch existingLaunch : launchManager.getLaunches()) { + assertTrue("Found existing not terminated launch. This should not happen and can interfere this test. Check for leakages in previous run tests.", existingLaunch.isTerminated()); + launchManager.removeLaunch(existingLaunch); + } + + final MockProcess mockProcess1 = new MockProcess(0); + final IProcess process1 = mockProcess1.toRuntimeProcess("FirstMockProcess"); + final MockProcess mockProcess2 = new MockProcess(0); + final IProcess process2 = mockProcess2.toRuntimeProcess("SecondMockProcess"); + final boolean prefRemoveOldLaunches = DebugUIPlugin.getDefault().getPreferenceStore().getBoolean(IDebugUIConstants.PREF_AUTO_REMOVE_OLD_LAUNCHES); + try { + DebugUIPlugin.getDefault().getPreferenceStore().setValue(IDebugUIConstants.PREF_AUTO_REMOVE_OLD_LAUNCHES, true); + // Stop the JobManager to reliable trigger the tested race + // condition. + Job.getJobManager().suspend(); + launchManager.addLaunch(process1.getLaunch()); + launchManager.addLaunch(process2.getLaunch()); + } finally { + Job.getJobManager().resume(); + DebugUIPlugin.getDefault().getPreferenceStore().setValue(IDebugUIConstants.PREF_AUTO_REMOVE_OLD_LAUNCHES, prefRemoveOldLaunches); + } + + ProcessConsoleManager processConsoleManager = DebugUIPlugin.getDefault().getProcessConsoleManager(); + TestUtil.waitForJobs(getName(), 0, 10000); + int openConsoles = 0; + if (processConsoleManager.getConsole(process1) != null) { + openConsoles++; + } + if (processConsoleManager.getConsole(process2) != null) { + openConsoles++; + } + assertEquals("ProcessConsoleManager and LaunchManager got out of sync.", openConsoles, launchManager.getLaunches().length); + + final ConsoleRemoveAllTerminatedAction removeAction = new ConsoleRemoveAllTerminatedAction(); + assertTrue("Remove terminated action should be enabled.", removeAction.isEnabled() || launchManager.getLaunches().length == 0); + removeAction.run(); + TestUtil.waitForJobs(getName(), 0, 10000); + assertNull("First console not removed.", processConsoleManager.getConsole(process1)); + assertNull("Second console not removed.", processConsoleManager.getConsole(process1)); + } +} |