spock.lang.TempDir Maven / Gradle / Ivy

Go to download

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

Spock is a testing and specification framework for Java and Groovy applications. What makes it stand out from the crowd is its beautiful and highly expressive specification language. Thanks to its JUnit runner, Spock is compatible with most IDEs, build tools, and continuous integration servers. Spock is inspired from JUnit, jMock, RSpec, Groovy, Scala, Vulcans, and other fascinating life forms.

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

Show newest version

/*
 * Copyright 2024 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 spock.lang;

import org.spockframework.runtime.extension.ExtensionAnnotation;
import org.spockframework.runtime.extension.builtin.TempDirExtension;
import org.spockframework.util.Beta;
import spock.util.io.FileSystemFixture;

import java.io.File;
import java.lang.annotation.*;
import java.nio.file.Path;

/**
 * Generate a temp directory for test, and delete it after test.
 *
 * 
 * {@code @TempDir} can be used to annotate a member field of type {@link File}, {@link Path},
 * or untyped like {@code def}/{@link Object} in a spec class (untyped field will be injected with {@code Path}).
 * 

 * Alternatively, you can use it with any class that has a public constructor with a single {@link File} or {@link Path}
 * parameter, like {@link FileSystemFixture} this way you can use your own utility classes for file manipulation.
 * 

 * If the annotated field is shared, the temp directory will be shared in this spec,
 * otherwise every iteration will have its own temp directory.
 * 

 * Example:
 * 

 * @TempDir
 * File testFile // will inject a File
 *
 * @TempDir
 * Path testPath // will inject a Path
 *
 * @TempDir
 * def testPath // will inject a Path
 *
 * @TempDir
 * FileSystemFixture fsFixture // will inject an instance of FileSystemFixture with the temp path injected via constructor
 * 
 * 
 * Since Spock 2.4, {@code @TempDir} can be used to annotate a method parameter, with the same behavior as the field types.
 * Use this if you want to use a temp directory in a single method only.
 * Valid methods are {@code setup()}, {@code setupSpec()}, or any feature methods.
 *
 * @author dqyuan
 * @since 2.0
 */
@Beta
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.PARAMETER})
@ExtensionAnnotation(TempDirExtension.class)
public @interface TempDir {
  String TEMP_DIR_CLEANUP_PROPERTY = "spock.tempdir.cleanup";

  /**
   * Whether to cleanup the directory after the test.
   *
   * @since 2.3
   */
  CleanupMode cleanup() default CleanupMode.DEFAULT;

  enum CleanupMode {
    /**
     * Use the default cleanup mode, configured via {@link #TEMP_DIR_CLEANUP_PROPERTY} or {@link org.spockframework.tempdir.TempDirConfiguration#cleanup}.
     */
    DEFAULT,
    /**
     * Always cleanup the directory after the test.
     */
    ALWAYS,
    /**
     * Cleanup the directory only if the test has succeeded.
     */
    ON_SUCCESS,
    /**
     * Never cleanup the directory after the test.
     */
    NEVER
  }
}