org.spockframework.spring.SpringBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spock-spring Show documentation

Spock's Spring Module makes it possible to use Spring's TestContext framework together with Spock. Supports Spring 2.5.x, 3.x, and 4.x.

There is a newer version: 2.4-M4-groovy-4.0

Show newest version

/*
 * Copyright 2017 the original author or authors.
 *
 * 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
 *
 *     https://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.spockframework.spring;

import org.spockframework.util.Beta;

import java.lang.annotation.*;

/**
 * Registers mock/stub/spy as a spring bean in the test context.
 * 
 * Inspired by Springs {@code @MockBean}, but adapted to Spock semantics.
 * 

 * Example: 
 *   @SpringBootTest // @ContextConfiguration works also
 *   class ExampleTests extends Specification {
 *     @SpringBean
 *     Service mockService = Mock()
 *
 *     @SpringBean
 *     Service stubService = Stub() {
 *       stubCall() >> "default interaction can be defined to"
 *     }
 *
 *     @SpringBean
 *     Service spyService = Spy()
 *   }
 *   
 * 
 * Note, that like {@code @MockBean} this will modify your {@code ApplicationContext}
 * an thus will prevent its reuse for other specs.
 * 

 * The created mocks belong to the specification and will not work outside of it.
 * 

 * Only works on fields defined inside a Specification.
 * The field must have the type of the mock, {@code def} or {@code Object}
 * fields don't work and will cause an error.
 * Also, the field must use an initializer (e.g., {@code Service mockService = Mock()})
 * assigning a value in {@code setup} doesn't work and will cause an error.
 * 
 * Requires at least Spring 4.3.3 to work properly, in earlier versions it should be
 * ignored silently.
 *
 * @author Leonard Brünings
 * @since 1.2
 */
@Beta
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface SpringBean {

  /**
   * The name of the bean to register or replace. If not specified the name will either
   * be generated or, if the mock replaces an existing bean, the existing name will be
   * used.
   * @return the name of the bean
   */
  String name() default "";

  /**
   * List of aliases for this bean, use this if you want to have additional names for
   * your bean, but want to keep the logic of using the name of the replaced bean.
   *
   * Note the name of the annotated field is automatically used as alias.
   *
   * @return the alias names
   */
  String[] aliases() default {};
}