scalafix.testkit.TestkitPath.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalafix-testkit_2.13.15 Show documentation
testkit
The newest version!
package scalafix.testkit

import java.nio.charset.StandardCharsets
import java.nio.file.FileSystems

import scala.meta.inputs.Input
import scala.meta.internal.io.FileIO
import scala.meta.io.AbsolutePath
import scala.meta.io.RelativePath

/**
 * An input file for a testkit test.
 *
 * @param input
 *   the absolute path to the input file.
 * @param testPath
 *   the input file relativized by input source directory (but including its
 *   last subpath). Used to compute the test name and the expected output file.
 * @param semanticdbPath
 *   the input file relativized by the SemanticDB sourceroot. Used to compute
 *   the path to the SemanticDB payload.
 */
final class TestkitPath(
    val input: AbsolutePath,
    val testPath: RelativePath,
    val semanticdbPath: RelativePath
) {
  def testName: String = testPath.toURI(isDirectory = false).toString
  def toInput: Input =
    Input.VirtualFile(testName, FileIO.slurp(input, StandardCharsets.UTF_8))
  def resolveOutput(props: TestkitProperties): Either[String, AbsolutePath] = {
    val testPathStripped =
      RelativePath(testPath.toNIO.subpath(1, testPath.toNIO.getNameCount))
    val candidates =
      props.outputSourceDirectories.map(dir => dir.resolve(testPathStripped)) ++
        // for backwards compatibility, try the old output directory
        props.outputSourceDirectories.map(dir => dir.resolve(testPath))
    def tried: String = candidates.mkString("\n  ", "\n  ", "")
    candidates.filter(_.isFile) match {
      case head :: Nil =>
        Right(head)
      case Nil =>
        Left(s"Missing output file for $testPath: $tried")
      case _ =>
        Left(s"Ambiguous output file for $testPath: $tried")
    }
  }
}

object TestkitPath {
  private val isScalaFile =
    FileSystems.getDefault.getPathMatcher("glob:**.scala")
  def fromProperties(props: TestkitProperties): List[TestkitPath] = {
    props.inputSourceDirectories.flatMap { sourceDirectory =>
      val ls = FileIO.listAllFilesRecursively(sourceDirectory)
      val scalaFiles = ls.files.filter(path => isScalaFile.matches(path.toNIO))
      scalaFiles.map { scalaFile =>
        val input = sourceDirectory.resolve(scalaFile)
        val testPath =
          input.toRelative(AbsolutePath(sourceDirectory.toNIO.getParent))
        val semanticdbPath = input.toRelative(props.sourceroot)
        new TestkitPath(input, testPath, semanticdbPath)
      }
    }
  }
}