Package org.apache.maven.surefire.junitcore.pc

Class Scheduler

java.lang.Object

org.apache.maven.surefire.junitcore.pc.Scheduler

All Implemented Interfaces:

org.junit.runners.model.RunnerScheduler

public class Scheduler
extends Object
implements org.junit.runners.model.RunnerScheduler

Schedules tests, controls thread resources, awaiting tests and other schedulers finished, and a master scheduler can shutdown slaves.
The scheduler objects should be first created (and wired) and set in runners ParentRunner.setScheduler(org.junit.runners.model.RunnerScheduler).
A new instance of scheduling strategy should be passed to the constructor of this scheduler.

Since:

2.16

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	Scheduler.Controller	If this is a master scheduler, the slaves can stop scheduling by the master through the controller.
class	Scheduler.ShutdownHandler	There is a way to shutdown the hierarchy of schedulers.

Field Summary

Fields

Modifier and Type	Field	Description
private final Balancer	balancer
private final org.junit.runner.Description	description
private boolean	finished
private final ConsoleLogger	logger
private Scheduler.Controller	masterController
private boolean	shutdown
private final Set<Scheduler.Controller>	slaves
private boolean	started
private final SchedulingStrategy	strategy

Constructor Summary

Constructors

Constructor	Description
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, Scheduler masterScheduler, SchedulingStrategy strategy)	Should be used with individual pools on suites, classes and methods, see ParallelComputerBuilder.useSeparatePools().
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, Scheduler masterScheduler, SchedulingStrategy strategy, int concurrency)
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, Scheduler masterScheduler, SchedulingStrategy strategy, Balancer balancer)	Can be used by e.g.
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, SchedulingStrategy strategy)	Use e.g.
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, SchedulingStrategy strategy, int concurrency)	Should be used if schedulers in parallel children and parent use one instance of bounded thread pool.
Scheduler(ConsoleLogger logger, org.junit.runner.Description description, SchedulingStrategy strategy, Balancer balancer)	New instances should be used by schedulers with limited concurrency by balancer against other groups of schedulers.

Method Summary

Modifier and Type	Method	Description
protected void	afterExecute()
protected void	beforeExecute()
private boolean	canSchedule()
protected ShutdownResult	describeStopped(boolean stopNow)	Attempts to stop all actively executing tasks and immediately returns a collection of descriptions of those tasks which have started prior to this call.
void	finished()
protected void	logQuietly(String msg)
protected void	logQuietly(Throwable t)
protected Scheduler.ShutdownHandler	newShutdownHandler()
private boolean	register(Scheduler slave)
void	schedule(Runnable childStatement)
private void	setController(Scheduler.Controller masterController)
protected boolean	shutdownThreadPoolsAwaitingKilled()
private void	stop(Collection<org.junit.runner.Description> executedTests, Collection<org.junit.runner.Description> incompleteTests, boolean tryCancelFutures, boolean stopNow)	Stop/Shutdown/Interrupt scheduler and its children (if any).
private Runnable	wrapTask(Runnable task)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

balancer

private final Balancer balancer

strategy

private final SchedulingStrategy strategy

slaves

private final Set<Scheduler.Controller> slaves

description

private final org.junit.runner.Description description

logger

private final ConsoleLogger logger

shutdown

private volatile boolean shutdown

started

private volatile boolean started

finished

private volatile boolean finished

masterController

private volatile Scheduler.Controller masterController

Constructor Details

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 SchedulingStrategy strategy)

Use e.g. parallel classes have own non-shared thread pool, and methods another pool.
You can use it with one infinite thread pool shared in strategies across all suites, class runners, etc.

Parameters:

logger - console logger

description - JUnit description of class

strategy - scheduling strategy

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 SchedulingStrategy strategy,
 int concurrency)

Should be used if schedulers in parallel children and parent use one instance of bounded thread pool.
Set this scheduler in a e.g. one suite of classes, then every individual class runner should reference Scheduler(ConsoleLogger, org.junit.runner.Description, Scheduler, SchedulingStrategy) or Scheduler(ConsoleLogger, org.junit.runner.Description, Scheduler, SchedulingStrategy, int).

Parameters:

logger - current logger implementation

description - description of current runner

strategy - scheduling strategy with a shared thread pool

concurrency - determines maximum concurrent children scheduled a time via schedule(Runnable)

Throws:

NullPointerException - if null strategy

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 SchedulingStrategy strategy,
 Balancer balancer)

New instances should be used by schedulers with limited concurrency by balancer against other groups of schedulers. The schedulers share one pool.
Unlike in Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy, int) which was limiting the concurrency of children of a runner where this scheduler was set, this balancer is limiting the concurrency of all children in runners having schedulers created by this constructor.

Parameters:

logger - current logger implementation

description - description of current runner

strategy - scheduling strategy which may share threads with other strategy

balancer - determines maximum concurrent children scheduled a time via schedule(Runnable)

Throws:

NullPointerException - if null strategy or balancer

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 Scheduler masterScheduler,
 SchedulingStrategy strategy,
 Balancer balancer)

Can be used by e.g. a runner having parallel classes in use case with parallel suites, classes and methods sharing the same thread pool.

Parameters:

logger - current logger implementation

description - description of current runner

masterScheduler - scheduler sharing own threads with this slave

strategy - scheduling strategy for this scheduler

balancer - determines maximum concurrent children scheduled a time via schedule(Runnable)

Throws:

NullPointerException - if null masterScheduler, strategy or balancer

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 Scheduler masterScheduler,
 SchedulingStrategy strategy,
 int concurrency)

Parameters:

logger - console logger

description - JUnit description of class

masterScheduler - a reference to Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy, int) or Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy)

strategy - scheduling strategy

concurrency - determines maximum concurrent children scheduled a time via schedule(Runnable)

See Also:

• Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy)
• Scheduler(ConsoleLogger, org.junit.runner.Description, SchedulingStrategy, int)

Scheduler

public Scheduler(ConsoleLogger logger,
 org.junit.runner.Description description,
 Scheduler masterScheduler,
 SchedulingStrategy strategy)

Should be used with individual pools on suites, classes and methods, see ParallelComputerBuilder.useSeparatePools().
Cached thread pool is infinite and can be always shared.

Parameters:

logger - console logger

description - JUnit description of class

masterScheduler - parent scheduler

strategy - scheduling strategy

Method Details

setController

private void setController(Scheduler.Controller masterController)

register

private boolean register(Scheduler slave)

Parameters:

slave - a slave scheduler to register

Returns:

true if successfully registered the slave.

canSchedule

private boolean canSchedule()

Returns:

true if new tasks can be scheduled.

logQuietly

protected void logQuietly(Throwable t)

logQuietly

protected void logQuietly(String msg)

describeStopped

protected ShutdownResult describeStopped(boolean stopNow)

Attempts to stop all actively executing tasks and immediately returns a collection of descriptions of those tasks which have started prior to this call.
This scheduler and other registered schedulers will stop, see register(Scheduler). If shutdownNow is set, waiting methods will be interrupted via Thread.interrupt().

Parameters:

stopNow - if true interrupts waiting test methods

Returns:

collection of descriptions started before shutting down

stop

private void stop(Collection<org.junit.runner.Description> executedTests,
 Collection<org.junit.runner.Description> incompleteTests,
 boolean tryCancelFutures,
 boolean stopNow)

Stop/Shutdown/Interrupt scheduler and its children (if any).

Parameters:

executedTests - Started tests which have finished normally or abruptly till called this method.

incompleteTests - Started tests which have finished incomplete due to shutdown.

tryCancelFutures - Useful to set to false if a timeout is specified in plugin config. When the runner of Computer.getSuite(org.junit.runners.model.RunnerBuilder, Class[]) is finished in ParentRunner.run(org.junit.runner.notification.RunNotifier) all the thread-pools created by ParallelComputerBuilder.PC are already dead. See the unit test ParallelComputerBuilder#timeoutAndForcedShutdown().

stopNow - Interrupting tests by ExecutorService.shutdownNow() or Future#cancel(true) or Thread.interrupt().

shutdownThreadPoolsAwaitingKilled

protected boolean shutdownThreadPoolsAwaitingKilled()

beforeExecute

protected void beforeExecute()

afterExecute

protected void afterExecute()

schedule

public void schedule(Runnable childStatement)

Specified by:

schedule in interface org.junit.runners.model.RunnerScheduler

finished

public void finished()

Specified by:

finished in interface org.junit.runners.model.RunnerScheduler

wrapTask

private Runnable wrapTask(Runnable task)

newShutdownHandler

protected Scheduler.ShutdownHandler newShutdownHandler()