/*******************************************************************************
 *
 * Copyright (c) 2004-2009 Oracle Corporation.
 *
 * 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:
 * 
 *    Kohsuke Kawaguchi
 *
 *
 *******************************************************************************/ 

package org.jvnet.hudson.test.recipes;

import org.jvnet.hudson.test.HudsonTestCase;

import java.lang.annotation.Documented;
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import java.lang.annotation.Retention;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Target;
import java.lang.annotation.Annotation;
import java.io.File;

import junit.framework.TestCase;
import hudson.model.Hudson;

/**
 * Meta-annotation for recipe annotations, which controls the test environment
 * set up.
 *
 * @author Kohsuke Kawaguchi
 */
@Retention(RUNTIME)
@Documented
@Target(ANNOTATION_TYPE)
public @interface Recipe {

    /**
     * Specifies the class that sets up the test environment.
     *
     * <p> When a recipe annotation is placed on a test method,
     */
    Class<? extends Runner> value();

    /**
     * The code that implements the recipe semantics.
     *
     * @param <T> The recipe annotation associated with this runner.
     */
    public abstract class Runner<T extends Annotation> {

        /**
         * Called during {@link TestCase#setUp()} to prepare the test
         * environment.
         */
        public void setup(HudsonTestCase testCase, T recipe) throws Exception {
        }

        /**
         * Called right before {@link Hudson#Hudson(File, ServletContext)} is
         * invoked to decorate the hudson home directory.
         */
        public void decorateHome(HudsonTestCase testCase, File home) throws Exception {
        }

        /**
         * Called during {@link TestCase#tearDown()} to shut down the test
         * environment.
         */
        public void tearDown(HudsonTestCase testCase, T recipe) throws Exception {
        }
    }
}