DefaultExamReactor.java

/*
 * Copyright 2010 Toni Menzel.
 *
 * 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 org.ops4j.pax.exam.spi;

import static org.ops4j.pax.exam.CoreOptions.options;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.ops4j.pax.exam.ConfigurationFactory;
import org.ops4j.pax.exam.ExamSystem;
import org.ops4j.pax.exam.Option;
import org.ops4j.pax.exam.TestContainer;
import org.ops4j.pax.exam.TestContainerFactory;
import org.ops4j.pax.exam.TestProbeBuilder;
import org.ops4j.spi.ServiceProviderFinder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Reactor decouples {@link org.ops4j.pax.exam.TestContainer} state from the observer. It is also in
 * control to map probes to their configurations or vice versa. In essence, this implements the
 * Container re-start/re-use policy topic by collecting relevant tests and configurations and
 * passing them to a (user selected factory (see stage()).
 * 
 * @author tonit
 */
public class DefaultExamReactor implements ExamReactor {

    private static final Logger LOG = LoggerFactory.getLogger(DefaultExamReactor.class);

    private final List<Option[]> configurations;
    private final List<TestProbeBuilder> probes;
    private final TestContainerFactory testContainerFactory;

    private final ExamSystem system;

    public DefaultExamReactor(ExamSystem system, TestContainerFactory factory) {
        this.system = system;
        this.configurations = new ArrayList<Option[]>();
        this.probes = new ArrayList<TestProbeBuilder>();
        this.testContainerFactory = factory;
    }

    public synchronized void addConfiguration(Option[] configuration) {
        configurations.add(configuration);
    }

    public synchronized void addProbe(TestProbeBuilder builder) {
        probes.add(builder);
    }

    public synchronized StagedExamReactor stage(StagedExamReactorFactory factory) {
        LOG.debug("Staging reactor with probes: " + probes.size() + " using strategy: " + factory);
        List<TestContainer> containers = new ArrayList<TestContainer>();

        if (configurations.isEmpty()) {
            List<ConfigurationFactory> configurationFactories = ServiceProviderFinder
                .findServiceProviders(ConfigurationFactory.class);
            for (ConfigurationFactory cf : configurationFactories) {
                Option[] configuration = cf.createConfiguration();
                addConfiguration(configuration);
            }
        }
        if (configurations.isEmpty()) {
            LOG.debug("No configuration given. Setting an empty one.");
            configurations.add(options());
        }
        for (Option[] config : configurations) {
            containers.addAll(Arrays.asList(testContainerFactory.create(system.fork(config))));
        }

        return factory.create(containers, probes);
    }

}