Skip to content

Wait for the decoration jobs instead of sleeping a fixed time #4287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vogella wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Wait for the decoration jobs instead of sleeping a fixed time #4287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions ...ts.navigator/src/org/eclipse/ui/tests/navigator/DecorationSchedulerRaceConditionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
package org.eclipse.ui.tests.navigator;

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

import java.util.concurrent.Semaphore;

Expand All @@ -29,6 +30,7 @@
import org.eclipse.ui.IDecoratorManager;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.internal.WorkbenchMessages;
import org.eclipse.ui.internal.decorators.DecoratorManager;
import org.eclipse.ui.tests.harness.util.DisplayHelper;
import org.eclipse.ui.tests.navigator.extension.DecorationSchedulerRaceConditionTestDecorator;
import org.eclipse.ui.tests.navigator.util.TestWorkspace;
Expand All @@ -42,7 +44,7 @@
public class DecorationSchedulerRaceConditionTest extends NavigatorTestBase {

private static final long TIMEOUT_DECORATOR = 2000;
private static final long TIMEOUT_UPDATE_JOB = 500;
private static final long TIMEOUT_UPDATE_JOB = 5000;

private static final String DECORATION_TEXT_1 = "**1**";
private static final String DECORATION_TEXT_2 = "**2**";
Expand Down Expand Up @@ -71,6 +73,17 @@ protected boolean condition() {
}
};

/**
* Waits for the decoration jobs, including the update job that applies the
* results to the viewer, to finish. The update job runs in the UI thread, so the
* event loop has to keep spinning instead of joining the job family.
*/
private static void waitForDecorationUpdate() {
boolean idle = DisplayHelper.waitForCondition(Display.getCurrent(), TIMEOUT_UPDATE_JOB,
() -> Job.getJobManager().find(DecoratorManager.FAMILY_DECORATE).length == 0);
assertTrue(idle, "decoration did not finish within " + TIMEOUT_UPDATE_JOB + "ms");
}

private IProject p1Project;
private IProject p2Project;

Expand All @@ -94,8 +107,7 @@ public void setUp() throws CoreException {
manager.setEnabled("org.eclipse.ui.tests.navigator.bug417255Decorator", true);

waitForP1Decoration.waitForCondition(Display.getCurrent(), TIMEOUT_DECORATOR); // wait for decorator to run
DisplayHelper.sleep(Display.getCurrent(), TIMEOUT_UPDATE_JOB); // wait for update job following decoration to
// run
waitForDecorationUpdate();

// make sure that initial decoration ran successfully
TreeItem[] rootItems = _viewer.getTree().getItems();
Expand Down Expand Up @@ -156,7 +168,7 @@ public void testBug417255raceConditionDuringDecoration() throws Exception {

// And finally wait for decorator job to finish and the update job following
// decoration to run
DisplayHelper.sleep(Display.getCurrent(), TIMEOUT_UPDATE_JOB);
waitForDecorationUpdate();

TreeItem[] rootItemsAfter = _viewer.getTree().getItems();
assertEquals(TestWorkspace.P1_PROJECT_NAME + DECORATION_TEXT_3, rootItemsAfter[0].getText());
Expand Down Expand Up @@ -195,7 +207,7 @@ public void scheduled(IJobChangeEvent event) {
waitForP1Decoration.waitForCondition(Display.getCurrent(), TIMEOUT_DECORATOR); // wait for decorator to run

// wait for update job following decoration to run
DisplayHelper.sleep(Display.getCurrent(), TIMEOUT_UPDATE_JOB);
waitForDecorationUpdate();

TreeItem[] rootItemsAfter = _viewer.getTree().getItems();
assertEquals(TestWorkspace.P1_PROJECT_NAME + DECORATION_TEXT_3, rootItemsAfter[0].getText());
Expand Down
Loading