ratpack.test.embed.BaseDirBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ratpack-test Show documentation

Test time support for developing Ratpack applications and extensions

There is a newer version: 2.0.0-rc-1

/*
 * Copyright 2013 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
 *
 *    http://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 ratpack.test.embed;

import com.google.common.io.Files;
import ratpack.test.embed.internal.JarFileBaseDirBuilder;
import ratpack.test.embed.internal.PathBaseDirBuilder;
import ratpack.util.ExceptionUtils;

import java.io.Closeable;
import java.io.File;
import java.nio.file.Path;
import java.util.function.Consumer;

public interface BaseDirBuilder extends Closeable {

  public static BaseDirBuilder tmpDir() {
    return dir(Files.createTempDir());
  }

  public static BaseDirBuilder dir(File dir) {
    return new PathBaseDirBuilder(dir);
  }

  public static BaseDirBuilder tmpJar() {
    return jar(ExceptionUtils.uncheck(() -> File.createTempFile("ratpack", ".jar")));
  }

  public static BaseDirBuilder jar(File jarFile) {
    return new JarFileBaseDirBuilder(jarFile);
  }

  default Path build(Consumer consumer) {
    consumer.accept(this);
    return build();
  }

  /**
   * Returns a path for the given path within the base dir.
   * 
   * All parent directories will be created on demand.
   *
   * @param path The relative path to the path
   * @return A path for the given path
   */
  Path file(String path);

  /**
   * Creates a file with the given string content at the given path within the base dir.
   * 

   * All parent directories will be created on demand.
   *
   * @param path The relative path to the file to create
   * @param content The content to write to the file
   * @return A path for the created file
   */
  Path file(String path, String content);

  /**
   * Creates a directory at the given path within the base dir.
   * 
   * All parent directories will be created on demand.
   *
   * @param path The relative path to the file to create
   * @return A path for the created directory
   */
  Path dir(String path);

  /**
   * Build the baseDir.
   *
   * @return The base dir
   */
  Path build();

}