All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.twitter.io.TempFolder.scala Maven / Gradle / Ivy

/*
 * Copyright 2010 Twitter, Inc.
 *
 * 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 com.twitter.io

import java.io.File

/**
 * Test mixin that creates a temporary thread-local folder for a block of code to execute in.
 * The folder is recursively deleted after the test.
 *
 * Note that multiple uses of TempFolder cannot be nested, because the temporary directory
 * is effectively a thread-local global.
 */
trait TempFolder {
  private val _folderName: ThreadLocal[File] = new ThreadLocal[File]

  /**
   * Runs the given block of code with the presence of a temporary folder whose name can be
   * obtained from within the code block by calling folderName.
   *
   * Use of this function may not be nested.
   */
  def withTempFolder(f: => Any): Unit = {
    val tempFolder = System.getProperty("java.io.tmpdir")
    // Note: If we were willing to have a dependency on Guava in util-core
    // we could just use `com.google.common.io.Files.createTempDir()`
    var folder: File = new File(tempFolder, "scala-test-" + System.currentTimeMillis)
    while (!folder.mkdir()) {
      folder = new File(tempFolder, "scala-test-" + System.currentTimeMillis)
    }
    _folderName.set(folder)

    try {
      f
    } finally {
      Files.delete(folder)
    }
  }

  /**
   * @return The current thread's active temporary folder.
   * @note Throws `RuntimeException` if not running within a withTempFolder block
   */
  def folderName: String = { _folderName.get.getPath }

  /**
   * @return The canonical path of the current thread's active temporary folder.
   * @note Throws `RuntimeException` if not running within a withTempFolder block
   */
  def canonicalFolderName: String = { _folderName.get.getCanonicalPath }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy