org.jmockring.annotation.DynamicContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jmockring-core Show documentation

jmockring - Java test MOCKing tool for spRING. A test harness tool for projects using the following technology stack: - Java 6+ - Spring 3.1 or greater as a DI/Deployment container - JUnit 4 and Mockito for testing - Jetty/Servlet API 3.0 for web app (war) deployment - for testing only Main features: 1) Partial Spring context deployment with automatic bean mocking for unavailable beans 2) Bootstrapping embedded Jetty server via JUnit runners 3) Configurable web application contexts 4) Automatic injection of Spring beans and mocks in JUnit tests via Java5 annotations

The newest version!

/*
 * Copyright (c) 2013, Pavel Lechev
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without modification,
 *    are permitted provided that the following conditions are met:
 *
 *     1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *     2) Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *     3) Neither the name of the Pavel Lechev nor the names of its contributors may be used to endorse or promote
 *        products derived from this software without specific prior written permission.
 *
 *    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *    IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.jmockring.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.EventListener;
import javax.servlet.http.HttpServlet;

/**
 * @author Pavel Lechev
 * @version 0.0.1
 * @date 31/12/12
 */
@Target(ElementType.TYPE)
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface DynamicContext {

    /**
     * REQUIRED:
     * 
     * Comma separated locations of .xml Spring configuration files.
     * 

     * IMPORTANT Maven build notice:
     * 

     * In Maven, the execution will happen inside a test context, all resources will be provisioned giving priority to the `test/resources` folders.
     *
     * @return
     * @see Server#bootstrap()
     */
    String[] springContextLocations();

    /**
     * If provided, the platform.webserver.configuration.ServerConfiguration#secured will be set to TRUE
     * 

     * This allows to conditionally run the server in secure or non-secure mode, depending on the needs of the tests.
     *
     * @return
     */
    String[] securityContextLocations() default {};

    /**
     * Context path for the web application.  Default "/"
     *
     * @return
     */
    String contextPath() default Server.DEFAULT_CONTEXT_PATH;

    /**
     * Default is true.
     * 

     * Set to false to disable the {@link org.jmockring.spring.mock.BeanAutoMockPostProcessor}.
     * 

     * Note that this post-processor will not be configured in the context, so if there are missing bean definitions
     * the context startup will fail.
     *
     * @return
     */
    boolean autoMocks() default true;

    /**
     * Representation of web.xml's <servlet> and <servlet-mapping> tags.
     *
     * @return
     */
    Servlet[] servlets() default {@Servlet(servletClass = HttpServlet.class)};

    /**
     * Representation of web.xml's <filter> and <filter-mapping> tags.
     * 

     * Ordering of the filters here is significant - similarly to doing it in web.xml
     *
     * @return
     */
    Filter[] filters() default {};


    /**
     * Representation of web.xml's <context-param> tag.
     *
     * @return
     */
    Param[] contextParams() default {};

    /**
     * Representation of web.xml's <listener> tag.
     * 

     * Allows defining additional listeners to bootstrap frameworks upon servlet initialisation.
     *
     * @return
     */
    Class[] listeners() default {};

    /**
     * List of patterns specifying the XML context files to exclude from the created {@link org.springframework.context.ApplicationContext}.
     * 

     * This allows to load partial Spring context, which will trigger the auto-mocking of the missing beans thus allowing layered testing,
     * e.g. skip the repository context to test MVC+services without the need to connect to database.
     *
     * @return
     */
    String[] excludedConfigLocations() default {};

    /**
     * Add additional properties.
     * 

     * The properties will be at the top of the Spring environment properties source so they can override anything in the production config.
     * 

     * When specifying the location do not use Spring's `classpath:` prefix - simply use the classpath relative location, e.g. `/path/to/test-config.properties`
     *
     * @return
     */
    String propertiesLocation() default "";

    /**
     * Specify classes or interfaces whose beans should always be mocked even if
     * real bean definition exists in the context.
     * 
     * While generally we use auto-mocking for the omitted bean definitions, it is sometimes useful to
     * force mocks on certain beans which would otherwise be part of the context in their real form.
     *
     * @return
     */
    Class[] forcedMockTypes() default {};

    /**
     * For web apps this points to the static resources folder.
     *
     * @return
     */
    String staticResourcesPath() default "";


    /**
     * The path to WAR file or the root folder of the web application.
     *
     * @return
     */
    String webApp() default "";

}