org.spockframework.spring.SpringExtension 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.runtime.AbstractRunListener;
import org.spockframework.runtime.extension.IGlobalExtension;
import org.spockframework.runtime.model.*;
import org.spockframework.util.*;
import spock.lang.Shared;

import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.Optional;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.annotation.*;
import org.springframework.test.annotation.DirtiesContext.ClassMode;
import org.springframework.test.context.ContextConfiguration;

@NotThreadSafe
public class SpringExtension implements IGlobalExtension {
  // since Spring 3.2.2
  @SuppressWarnings("unchecked")
  private static final Class contextHierarchyClass =
    (Class)ReflectionUtil.loadClassIfAvailable("org.springframework.test.context.ContextHierarchy");

  // since Spring 4.0
  private static final Method findAnnotationDescriptorForTypesMethod;

  // since Spring-Boot 1.4
  @SuppressWarnings("unchecked")
  private static final Class bootstrapWithAnnotation =
    (Class)ReflectionUtil.loadClassIfAvailable("org.springframework.test.context.BootstrapWith");

  static {
    findAnnotationDescriptorForTypesMethod = Optional.ofNullable(ReflectionUtil.loadFirstAvailableClass(
      "org.springframework.test.context.TestContextAnnotationUtils",
      "org.springframework.test.util.MetaAnnotationUtils")
    ).map(annotationUtilsClass -> ReflectionUtil.getMethodBySignature(annotationUtilsClass,
      "findAnnotationDescriptorForTypes", Class.class, Class[].class)
    ).orElse(null);
  }


  @Override
  public void visitSpec(SpecInfo spec) {
    if (!isSpringSpec(spec)) {return;}

    verifySharedFieldsInjection(spec);

    if (!handleProfileValues(spec)) {return;}

    SpringTestContextManager manager = new SpringTestContextManager(spec.getReflection());
    final SpringInterceptor interceptor = new SpringInterceptor(manager);

    spec.addListener(new AbstractRunListener() {
      @Override
      public void error(ErrorInfo error) {
        interceptor.error(error);
      }
    });

    spec.addSetupSpecInterceptor(interceptor);
    spec.addInitializerInterceptor(interceptor);
    spec.addSetupInterceptor(interceptor);
    spec.addCleanupInterceptor(interceptor);
    spec.addCleanupSpecInterceptor(interceptor);
  }

  private boolean isSpringSpec(SpecInfo spec) {
    if (isSpringSpecUsingFindAnnotationDescriptorForTypes(spec)) {return true;}

    if (ReflectionUtil.isAnnotationPresentRecursive(spec.getReflection(), ContextConfiguration.class)) {return true;}

    return (contextHierarchyClass != null
      && ReflectionUtil.isAnnotationPresentRecursive(spec.getReflection(), contextHierarchyClass));
  }

  private boolean isSpringSpecUsingFindAnnotationDescriptorForTypes(SpecInfo spec) {
    return findAnnotationDescriptorForTypesMethod != null
      && ReflectionUtil.invokeMethod(
      null, findAnnotationDescriptorForTypesMethod, spec.getReflection(),
      new Class[]{ContextConfiguration.class, contextHierarchyClass, bootstrapWithAnnotation}) != null;
  }

  private void verifySharedFieldsInjection(SpecInfo spec) {
    if (spec.isAnnotationPresent(EnableSharedInjection.class)) {
      verifySharedFieldsInjectionEnabled(spec);
    } else {
      checkNoSharedFieldsInjected(spec);
    }
  }

  private void verifySharedFieldsInjectionEnabled(SpecInfo spec) {
    if (spec.isAnnotationPresent(DirtiesContext.class)) {
      ClassMode classMode = spec.getAnnotation(DirtiesContext.class).classMode();
      if (classMode == ClassMode.BEFORE_EACH_TEST_METHOD || classMode == ClassMode.AFTER_EACH_TEST_METHOD) {
        throw sharedInjectionWithDirtiesContextException();
      }
    }
    for (FeatureInfo feature : spec.getAllFeatures()) {
      MethodInfo featureMethod = feature.getFeatureMethod();
      if (featureMethod.isAnnotationPresent(DirtiesContext.class)) {
        throw sharedInjectionWithDirtiesContextException();
      }
    }
  }

  private SpringExtensionException sharedInjectionWithDirtiesContextException() {
    return new SpringExtensionException(
      "Shared field injection is not supported if feature methods make context dirty by using @DirtiesContext " +
        "annotation");
  }

  private void checkNoSharedFieldsInjected(SpecInfo spec) {
    for (FieldInfo field : spec.getAllFields()) {
      if (field.getReflection().isAnnotationPresent(Shared.class)
        && (field.getReflection().isAnnotationPresent(Autowired.class)
        // avoid compile-time dependency on optional classes
        || ReflectionUtil.isAnnotationPresent(field.getReflection(), "javax.annotation.Resource")
        || ReflectionUtil.isAnnotationPresent(field.getReflection(), "javax.inject.Inject"))) {
        throw new SpringExtensionException(
          "@Shared field injection is not enabled by default therefore '%s' field cannot be injected. Refer to " +
            "javadoc of %s for information on how to opt-in for @Shared field injection.")
          .withArgs(field.getName(), EnableSharedInjection.class.getName());
      }
    }
  }

  private boolean handleProfileValues(SpecInfo spec) {
    if (!ProfileValueUtils.isTestEnabledInThisEnvironment(spec.getReflection())) {
      spec.setExcluded(true);
      return false;
    }

    for (FeatureInfo feature : spec.getAllFeatures())
      if (!ProfileValueUtils.isTestEnabledInThisEnvironment(
        feature.getFeatureMethod().getReflection(), spec.getReflection())) {feature.setExcluded(true);}

    return true;
  }
}