Replacement Heuristic

bazel/src/main/kotlin/org/virtuslab/bazelsteward/bazel/BazelVersionFileSearch.kt

@@ -10,6 +10,6 @@ class BazelVersionFileSearch(config: Config) {
   private val fileNames = setOf(".bazelversion", ".bazeliskrc")
 
   val bazelVersionFiles: List<BazelFileSearch.BazelFile> by lazy {
-    config.path.listDirectoryEntries().filter { fileNames.contains(it.name) }.map { BazelFileSearch.BazelFile(it) }
+    config.path.listDirectoryEntries().filter { fileNames.contains(it.name) }.map { BazelFileSearch.BazelFileLazy(it) }
   }
 }

core/src/main/kotlin/org/virtuslab/bazelsteward/core/common/BazelFileSearch.kt

@@ -5,11 +5,18 @@ import java.nio.file.Path
 import kotlin.io.path.readText
 
 class BazelFileSearch(config: Config) {
-  data class BazelFile(val path: Path) {
+  interface BazelFile {
+    val path: Path
     val content: String
+  }
+
+  data class BazelFileLazy(override val path: Path) : BazelFile {
+    override val content: String
       get() = path.readText()
   }
 
+  data class BazelFileTest(override val path: Path, override val content: String) : BazelFile
+
   private val fileNames = setOf("""BUILD.bazel""", "BUILD", "WORKSPACE")
   private val fileSuffix = ".bzl"
 
@@ -22,5 +29,5 @@ class BazelFileSearch(config: Config) {
       .toList()
   }
 
-  val buildDefinitions: List<BazelFile> by lazy { buildPaths.map { BazelFile(it) } }
+  val buildDefinitions: List<BazelFile> by lazy { buildPaths.map { BazelFileLazy(it) } }
 }

core/src/main/kotlin/org/virtuslab/bazelsteward/core/common/FileUpdateSearch.kt

@@ -3,6 +3,8 @@ package org.virtuslab.bazelsteward.core.common
 import org.virtuslab.bazelsteward.core.library.Library
 import org.virtuslab.bazelsteward.core.library.LibraryId
 import org.virtuslab.bazelsteward.core.library.Version
+import org.virtuslab.bazelsteward.core.replacement.VersionHeuristic
+import org.virtuslab.bazelsteward.core.replacement.WholeVersionHeuristic
 import java.nio.file.Path
 
 class FileUpdateSearch {
@@ -23,15 +25,14 @@ class FileUpdateSearch {
     files: List<BazelFileSearch.BazelFile>,
     updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
   ): FileChangeSuggestion? {
-    val markers = updateSuggestion.currentLibrary.id.associatedStrings()
-    val currentVersion = updateSuggestion.currentLibrary.version.value
-    val regex =
-      (markers + currentVersion).map { """(${Regex.escape(it)})""" }.reduce { acc, s -> "$acc.*$s" }.let { Regex(it) }
-    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
-    val versionGroup = matchResult.first.groups[3] ?: return null
-    return FileChangeSuggestion(
-      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    val allHeuristics = listOf(
+      WholeVersionHeuristic(),
+      VersionHeuristic(),
     )
+    for (heuristic in allHeuristics) {
+      heuristic.apply(files, updateSuggestion)?.let { return it }
+    }
+    return null
   }
 
   fun <Lib : LibraryId> searchBazelVersionFiles(

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/Heuristic.kt

@@ -0,0 +1,14 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+interface Heuristic {
+  val name: String
+  fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion?
+}

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/VersionHeuristic.kt

@@ -0,0 +1,25 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+class VersionHeuristic : Heuristic {
+  override val name: String
+    get() = "version"
+
+  override fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion? {
+    val currentVersion = updateSuggestion.currentLibrary.version.value
+    val regex =
+      currentVersion.map { """(${Regex.escape(it.toString())})""" }.reduce { acc, s -> "$acc.*$s" }.let { Regex(it) }
+    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
+    val versionGroup = matchResult.first.groups[0] ?: return null
+    return FileUpdateSearch.FileChangeSuggestion(
+      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    )
+  }
+}

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/WholeVersionHeuristic.kt

@@ -0,0 +1,26 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+class WholeVersionHeuristic : Heuristic {
+  override val name: String
+    get() = "whole-version"
+
+  override fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion? {
+    val markers = updateSuggestion.currentLibrary.id.associatedStrings()
+    val currentVersion = updateSuggestion.currentLibrary.version.value
+    val regex =
+      (markers + currentVersion).map { """(${Regex.escape(it)})""" }.reduce { acc, s -> "$acc.*$s" }.let { Regex(it) }
+    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
+    val versionGroup = matchResult.first.groups[3] ?: return null
+    return FileUpdateSearch.FileChangeSuggestion(
+      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    )
+  }
+}

core/src/test/kotlin/org/virtuslab/bazelsteward/core/replacement/HeuristicTest.kt

@@ -0,0 +1,251 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import io.kotest.matchers.shouldBe
+import org.junit.jupiter.api.Nested
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.config.BumpingStrategy
+import org.virtuslab.bazelsteward.core.library.SemanticVersion
+import org.virtuslab.bazelsteward.core.library.VersioningSchema
+import org.virtuslab.bazelsteward.maven.MavenCoordinates
+import org.virtuslab.bazelsteward.maven.MavenLibraryId
+import kotlin.io.path.Path
+
+class HeuristicTest {
+
+  private fun getBazelFile(fileName: String): BazelFileSearch.BazelFile {
+    val url = this::class.java.classLoader.getResource(fileName)!!
+    return BazelFileSearch.BazelFileTest(Path(url.path), url.readText())
+  }
+
+  @Nested
+  @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+  inner class SearchBuildFilesTest {
+
+    @Test
+    fun `should return right position offset`() {
+      val fileUpdateSearch = FileUpdateSearch()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.7theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result: List<FileUpdateSearch.FileChangeSuggestion> =
+        fileUpdateSearch.searchBuildFiles(files, listOf(updateSuggestion))
+      result[0].position shouldBe 2377
+    }
+
+    @Test
+    fun `should return right position offset with wrong artifact`() {
+      val fileUpdateSearch = FileUpdateSearch()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.10theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result: List<FileUpdateSearch.FileChangeSuggestion> =
+        fileUpdateSearch.searchBuildFiles(files, listOf(updateSuggestion))
+      result[0].position shouldBe 2377
+    }
+
+    @Test
+    fun `should return right position offset without artifact`() {
+      val fileUpdateSearch = FileUpdateSearch()
+      val lib = MavenCoordinates(
+        MavenLibraryId("", ""),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result: List<FileUpdateSearch.FileChangeSuggestion> =
+        fileUpdateSearch.searchBuildFiles(files, listOf(updateSuggestion))
+      result[0].position shouldBe 2377
+    }
+  }
+
+  @Nested
+  @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+  inner class WholeVersionHeuristicTest {
+
+    @Test
+    fun `should return right position WholeVersionHeuristic`() {
+      val wholeVersionHeuristic = WholeVersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.7theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = wholeVersionHeuristic.apply(files, updateSuggestion)!!
+      result.position shouldBe 2377
+    }
+
+    @Test
+    fun `should return right position WholeVersionHeuristic with wrong artifact`() {
+      val wholeVersionHeuristic = WholeVersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.10theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = wholeVersionHeuristic.apply(files, updateSuggestion)
+      result shouldBe null
+    }
+
+    @Test
+    fun `should return right position WholeVersionHeuristic without artifact`() {
+      val wholeVersionHeuristic = WholeVersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("", ""),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = wholeVersionHeuristic.apply(files, updateSuggestion)!!
+      result.position shouldBe 2377
+    }
+  }
+
+  @Nested
+  @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+  inner class VersionHeuristicTest {
+
+    @Test
+    fun `should return right position offset VersionHeuristic`() {
+      val versionHeuristic = VersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.7theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = versionHeuristic.apply(files, updateSuggestion)!!
+      result.position shouldBe 2377
+    }
+
+    @Test
+    fun `should return right position offset VersionHeuristic with wrong artifact`() {
+      val versionHeuristic = VersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.10theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = versionHeuristic.apply(files, updateSuggestion)!!
+      result.position shouldBe 2377
+    }
+
+    @Test
+    fun `should return right position offset VersionHeuristic without artifact`() {
+      val versionHeuristic = VersionHeuristic()
+      val lib = MavenCoordinates(
+        MavenLibraryId("", ""),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val result = versionHeuristic.apply(files, updateSuggestion)!!
+      result.position shouldBe 2377
+    }
+  }
+
+  @Nested
+  @TestInstance(TestInstance.Lifecycle.PER_CLASS)
+  inner class CompareHeuristicTest {
+
+    @Test
+    fun `should return same position offset for WholeVersionHeuristic and VersionHeuristic`() {
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.7theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val wholeVersionHeuristic = WholeVersionHeuristic()
+      val result1 = wholeVersionHeuristic.apply(files, updateSuggestion)!!
+      val versionHeuristic = VersionHeuristic()
+      val result2 = versionHeuristic.apply(files, updateSuggestion)!!
+
+      result1.position shouldBe result2.position
+    }
+
+    @Test
+    fun `should return different position offset for WholeVersionHeuristic and VersionHeuristic`() {
+      val lib = MavenCoordinates(
+        MavenLibraryId("com.10theta", "utilis"),
+        SemanticVersion(2, 3, 5, "", ""),
+        VersioningSchema.SemVer,
+        BumpingStrategy.Default
+      )
+      val suggestedVersion = SemanticVersion(2, 4, 0, "", "")
+      val updateSuggestion = UpdateLogic.UpdateSuggestion(lib, suggestedVersion)
+
+      val files = listOf(getBazelFile("WORKSPACE.bzlignore"))
+
+      val wholeVersionHeuristic = WholeVersionHeuristic()
+      val result1 = wholeVersionHeuristic.apply(files, updateSuggestion)
+      val versionHeuristic = VersionHeuristic()
+      val result2 = versionHeuristic.apply(files, updateSuggestion)!!
+
+      result1 shouldBe null
+      result2.position shouldBe 2377
+    }
+  }
+}

core/src/test/kotlin/org/virtuslab/bazelsteward/resources/BUILD.bazel

@@ -1,5 +1,8 @@
 filegroup(
     name = "resources",
-    srcs = glob([".*.yaml"]),
+    srcs = glob([
+        ".*.yaml",
+        "*.bzlignore",
+    ]),
     visibility = ["//visibility:public"],
 )