Merge pull request #18 from codacy/improve-config-file-lookup

Improve config file lookup

Author: rtfpessoa

build.sbt

@@ -20,7 +20,7 @@ libraryDependencies ++= Seq(
   "com.typesafe.play" %% "play-json" % "2.4.8",
   "org.scalatest" %% "scalatest" % "2.2.4" % "test",
   "com.codacy" %% "codacy-plugins-api" % "1.0.11" withSources(),
-  "com.github.pathikrit" %% "better-files" % "2.17.1" withSources()
+  "com.github.pathikrit" %% "better-files" % "3.5.0" withSources()
 )
 
 organizationName := "Codacy"

src/main/scala/codacy/dockerApi/utils/FileHelper.scala

@@ -36,15 +36,22 @@ object FileHelper {
     (these ++ these.filter(_.isDirectory).flatMap(recursiveListFiles)).toList
   }
 
-  def findConfigurationFile(candidates: Set[String], path: Path): Option[Path] = {
-    candidates.flatMap { nativeConfigFileName =>
-      better.files.File(path).listRecursively
-        .filter(f => f.name == nativeConfigFileName)
-        .map(_.path)
-    }
-      .to[List]
-      .sortBy(_.toString.length)
-      .headOption
+  /**
+    * Find the configuration file path
+    *
+    * @param root            path to search recursively
+    * @param configFileNames to match the files while searching
+    * @param maxDepth        to search
+    * @return config file path closest to the root
+    */
+  def findConfigurationFile(root: Path, configFileNames: Set[String], maxDepth: Int = 5): Option[Path] = {
+    val allFiles = better.files.File(root).walk(maxDepth = maxDepth)
+
+    val configFiles: List[Path] = configFileNames.flatMap { nativeConfigFileName =>
+      allFiles.filter(_.name == nativeConfigFileName).map(_.path)
+    }(collection.breakOut)
+
+    configFiles.sortBy(_.toString.length).headOption
   }
 
 }

src/test/scala/codacy/dockerApi/utils/FileHelperTest.scala

@@ -1,5 +1,8 @@
 package codacy.dockerApi.utils
 
+import java.nio.file.Path
+
+import better.files.File
 import org.scalatest._
 
 class FileHelperTest extends FlatSpec with Matchers {
@@ -46,8 +49,40 @@ class FileHelperTest extends FlatSpec with Matchers {
   "FileHelper" should "createTmpFile" in {
     val fileTmp = FileHelper.createTmpFile("foo", "prefix", ".ext").toString
 
-    java.nio.file.Paths.get(fileTmp).getFileName.toString should startWith("prefix")
+    java.nio.file.Paths.get(fileTmp).getFileName.toString should startWith(
+      "prefix")
     fileTmp should endWith(".ext")
     io.Source.fromFile(fileTmp).mkString should be("foo")
   }
+
+  "FileHelper#findConfigurationFile" should "find the configuration file closest to the root" in {
+    (for {
+      root <- File.temporaryDirectory()
+    } yield {
+      root./("test.json").write("content")
+
+      val configFile: Option[Path] =
+        FileHelper.findConfigurationFile(root.path,
+                                         configFileNames = Set("test.json"))
+
+      configFile should be(Option(root./("test.json").path))
+    }).get()
+  }
+
+  "FileHelper#findConfigurationFile" should "not find the configuration file closest to the root if its deeper then 5 in the path" in {
+    (for {
+      root <- File.temporaryDirectory()
+    } yield {
+      val subDirectory: File = root / "one" / "two" / "three" / "four" / "five"
+      subDirectory.createDirectories()
+      subDirectory./("test.json").write("content")
+
+      val configFile: Option[Path] =
+        FileHelper.findConfigurationFile(root.path,
+                                         configFileNames = Set("test.json"))
+
+      configFile should be(Option.empty[Path])
+    }).get()
+  }
+
 }