com.thesett.junit.extensions.SetupTaskHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of junit-toolkit Show documentation

JUnit Toolkit enhances JUnit with performance testing, asymptotic behaviour analysis, and concurrency testing.

There is a newer version: 0.9.52

/*
 * Copyright The Sett Ltd, 2005 to 2014.
 *
 * Licensed 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 com.thesett.junit.extensions;

import java.util.LinkedList;
import java.util.Queue;

import com.thesett.common.util.StackQueue;

/**
 * SetupTaskHandler implements a task stack. It can be used, by delegation, as a base implementation for tests that want
 * to have configurable setup/teardown task stacks. Typically it is up to the test implementation to decide whether the
 * stack is executed in the setup/teardown methods or in the threadSetup/threadTeaddown methods.
 *
 * 
 * CRC Card Responsibilities  Collaborations
 * 
 Handle injection of set up tasks.
 * 
 Handle injection of tear down tasks.
 * 
 Run set up tasks in chain order.
 * 
 Run tear down tasks in reverse chain order.
 * 
 *
 * @author Rupert Smith
 */
public class SetupTaskHandler implements SetupTaskAware
{
    /** Holds the set up tasks. */
    final Queue setups = new LinkedList();

    /** Holds the tear down tasks. */
    final Queue teardowns = new StackQueue();

    /**
     * Adds the specified task to the tests setup.
     *
     * @param task The task to add to the tests setup.
     */
    public void chainSetupTask(Runnable task)
    {
        setups.offer(task);
    }

    /**
     * Adds the specified task to the tests tear down.
     *
     * @param task The task to add to the tests tear down.
     */
    public void chainTearDownTask(Runnable task)
    {
        teardowns.offer(task);
    }

    /** Runs the set up tasks in the order that they way chained. */
    public void runSetupTasks()
    {
        while (!setups.isEmpty())
        {
            setups.remove().run();
        }
    }

    /** Runs the tear down tasks in the reverse of the order in which they were chained. */
    public void runTearDownTasks()
    {
        while (!teardowns.isEmpty())
        {
            teardowns.remove().run();
        }
    }
}

Responsibilities	Collaborations *
Handle injection of set up tasks. *
Handle injection of tear down tasks. *
Run set up tasks in chain order. *
Run tear down tasks in reverse chain order. *