Mycila.java

/**
 * Copyright (C) 2008 Mathieu Carbou <mathieu.carbou@gmail.com>
 *
 * 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.mycila.testing.core;

import com.mycila.log.Logger;
import com.mycila.log.Loggers;
import com.mycila.testing.MycilaTestingException;
import static com.mycila.testing.core.api.Ensure.*;
import com.mycila.testing.core.api.Execution;
import com.mycila.testing.core.api.TestContext;

import java.util.IdentityHashMap;
import java.util.Map;

/**
 * Holds the current test context. The context holder contains the current test instance used for each call to
 * plugin methods for preparing instance, before and after test execution.<p/>
 * <p/>
 * You can safely use in your plugin this class to get from anywhere the current test {@link com.mycila.testing.core.api.TestContext}
 *
 * @author Mathieu Carbou (mathieu.carbou@gmail.com)
 */
public final class Mycila {

    private static final Logger LOGGER = Loggers.get(Mycila.class);
    private static final ThreadLocal<Execution> CURRENT_EXECUTION = new InheritableThreadLocal<Execution>();
    private static final Map<Object, TestContext> CONTEXTS = new IdentityHashMap<Object, TestContext>(10000);

    private Mycila() {
    }

    static void registerCurrentExecution(Execution execution) {
        notNull("Execution context", execution);
        LOGGER.debug("Registering Execution Context %s#%s for test %s#%s", execution.step(), execution.method().getName(), execution.context().introspector().testClass().getName(), execution.context().introspector().instance().hashCode());
        CURRENT_EXECUTION.set(execution);
    }

    static void registerContext(TestContext context) {
        notNull("Test context", context);
        LOGGER.debug("Registering Global Test Context for test %s#%s", context.introspector().testClass().getName(), context.introspector().instance().hashCode());
        CONTEXTS.put(context.introspector().instance(), context);
    }

    static void unsetCurrentExecution() {
        if (LOGGER.canDebug()) {
            Execution execution = CURRENT_EXECUTION.get();
            if (execution != null) {
                LOGGER.debug("Removing Execution Context %s#%s for test %s#%s", execution.step(), execution.method().getName(), execution.context().introspector().testClass().getName(), execution.context().introspector().instance().hashCode());
            }
        }
        CURRENT_EXECUTION.remove();
    }

    static void unsetContext(TestContext context) {
        notNull("Test context", context);
        if (CONTEXTS.remove(context.introspector().instance()) != null) {
            LOGGER.debug("Removing Global Test Context for test %s#%s", context.introspector().testClass().getName(), context.introspector().instance().hashCode());
        }
    }

    public static TestContext context(Object testInstance) {
        notNull("Test instance", testInstance);
        TestContext context = CONTEXTS.get(testInstance);
        if (context == null) {
            throw new MycilaTestingException("No Global Test Context available for test %s#%s", testInstance.getClass().getName(), testInstance.hashCode());
        }
        return context;
    }

    /**
     * @return The current execution point
     */
    @SuppressWarnings({"unchecked"})
    public static Execution currentExecution() {
        Execution c = CURRENT_EXECUTION.get();
        if (c == null) {
            throw new IllegalStateException("No Execution context bound to local thread !");
        }
        return c;
    }

}