tests/org.eclipse.core.tests.runtime/src/org/eclipse/core/tests/runtime/jobs/AbstractJobManagerTest.java

/*******************************************************************************
 * Copyright (c) 2003, 2012 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     IBM - Initial API and implementation
 *******************************************************************************/
package org.eclipse.core.tests.runtime.jobs;

import java.util.*;
import org.eclipse.core.internal.jobs.JobManager;
import org.eclipse.core.runtime.jobs.IJobManager;
import org.eclipse.core.runtime.jobs.Job;

/**
 * Base class for tests using IJobManager
 */
public class AbstractJobManagerTest extends AbstractJobTest {
	protected IJobManager manager;
	private FussyProgressProvider progressProvider;

	public AbstractJobManagerTest() {
		super();
	}

	public AbstractJobManagerTest(String name) {
		super(name);
	}

	protected void setUp() throws Exception {
		super.setUp();
		manager = Job.getJobManager();
		progressProvider = new FussyProgressProvider();
		manager.setProgressProvider(progressProvider);
	}

	protected void tearDown() throws Exception {
		super.tearDown();
		progressProvider.sanityCheck();
		manager.setProgressProvider(null);
	}

	/**
	 * Ensure job completes within the given time.
	 * @param job
	 * @param waitTime time in milliseconds
	 */
	protected void waitForCompletion(Job job, int waitTime) {
		int i = 0;
		int tickLength = 10;
		int ticks = waitTime / tickLength;
		while (job.getState() != Job.NONE) {
			sleep(tickLength);
			//sanity test to avoid hanging tests
			if (i++ > ticks) {
				dumpState();
				assertTrue("Timeout waiting for job to complete", false);
			}
		}
	}

	/**
	 * Will return a list (snapshot) of all jobs that are currently running, at
	 * *this* exact moment in time, excluding the calling thread's Job (if it is
	 * within one)
	 * 
	 * @param family
	 *            The job family to search for, or null for all jobs.
	 */
	protected List getRunningJobs(Object family) {
		List jobs = new ArrayList();
		jobs.addAll(Arrays.asList(Job.getJobManager().find(family)));
		for (Iterator iterator = jobs.iterator(); iterator.hasNext();) {
			Job job = (Job) iterator.next();
			if (job.getState() != Job.RUNNING || job.getThread() == Thread.currentThread()) {
				iterator.remove();
			}
		}
		return jobs;
	}

	protected List getJobs(String[] families) {
		if (families == null) {
			return getRunningJobs(null);
		}
		List j = new ArrayList();
		for (int i = 0; i < families.length; i++) {
			String family = families[i];
			j.addAll(getRunningJobs(family));
		}
		return j;
	}

	protected List getFinishedJobs(Job[] jobs) {
		List joblist = new ArrayList(Arrays.asList(jobs));
		for (Iterator iterator = joblist.iterator(); iterator.hasNext();) {
			Job job = (Job) iterator.next();
			if (job.getState() != Job.NONE) {
				iterator.remove();
			}
		}
		return joblist;
	}

	protected void waitForJobsCompletion(Job[] jobs, int waitTime) {
		List<Job> jobList = new ArrayList<Job>(Arrays.asList(jobs));
		int i = 0;
		int tickLength = 10;
		int ticks = waitTime / tickLength;
		while (!jobList.isEmpty()) {
			sleep(tickLength);
			//sanity test to avoid hanging tests
			if (i++ > ticks) {
				dumpState();
				assertTrue("Timeout waiting for job to complete", false);
			}
			for (Iterator<Job> iterator = jobList.iterator(); iterator.hasNext();) {
				if (iterator.next().getState() == Job.NONE)
					iterator.remove();
			}
		}
	}

	protected void waitForJobsCompletion(String[] families, int waitTime) {
		List jobs = getJobs(families);
		int i = 0;
		int tickLength = 10;
		int ticks = waitTime / tickLength;

		while (!jobs.isEmpty()) {
			sleep(tickLength);
			//sanity test to avoid hanging tests
			if (i++ > ticks) {
				dumpState();
				assertTrue("Timeout waiting for job to complete", false);
			}
			jobs = getJobs(families);
		}
	}

	/**
	 * Ensure given job completes within a second.
	 */
	protected void waitForCompletion(Job job) {
		waitForCompletion(job, 1000);
	}

	/**
	 * Extra debugging for bug 109898
	 */
	protected void dumpState() {
		System.out.println("**** BEGIN DUMP JOB MANAGER INFORMATION ****");
		Job[] jobs = Job.getJobManager().find(null);
		for (int j = 0; j < jobs.length; j++)
			System.out.println("" + jobs[j] + " state: " + JobManager.printState(jobs[j]));
		System.out.println("**** END DUMP JOB MANAGER INFORMATION ****");
	}
}