Allow specifying custom maven repository name (VirtusLab#402)

Resolves VirtusLab#401

Author: lukaszwawrzyk

app/src/main/kotlin/org/virtuslab/bazelsteward/app/AppBuilder.kt

@@ -20,6 +20,7 @@ import org.virtuslab.bazelsteward.bazel.version.BazelVersionDependencyKind
 import org.virtuslab.bazelsteward.bzlmod.BzlModDataExtractor
 import org.virtuslab.bazelsteward.bzlmod.BzlModDependencyKind
 import org.virtuslab.bazelsteward.bzlmod.BzlModRepository
+import org.virtuslab.bazelsteward.config.repo.MavenConfig
 import org.virtuslab.bazelsteward.config.repo.RepoConfigParser
 import org.virtuslab.bazelsteward.core.Environment
 import org.virtuslab.bazelsteward.core.FileFinder
@@ -98,7 +99,8 @@ object AppBuilder {
 
     val repoConfig =
       runBlocking { RepoConfigParser().load(configPath?.let { Path(it) }, repositoryRoot, noInternalConfig) }
-    val mavenDataExtractor = MavenDataExtractor(appConfig.workspaceRoot)
+    val mavenConfig = repoConfig.maven ?: MavenConfig()
+    val mavenDataExtractor = MavenDataExtractor(appConfig.workspaceRoot, mavenConfig.repositoryName)
     val mavenRepository = MavenRepository()
     val updateLogic = UpdateLogic()
     val gitOperations = runBlocking { GitOperations.resolve(appConfig.workspaceRoot, appConfig.baseBranch) }

app/src/main/resources/internal-config.yaml

@@ -5,3 +5,6 @@ update-rules:
   - kinds: bazel-rules
     dependencies: rules_jvm_external
     versioning: 'regex:^(?<major>0|[1-9]\d*)\.(?<minor>0|[1-9]\d*)(?:\.(?<patch>0|[1-9]\d*))?$'
+
+maven:
+  repository-name: maven

app/src/test/kotlin/org/virtuslab/bazelsteward/app/UpdateRulesProviderTest.kt

@@ -83,7 +83,7 @@ class UpdateRulesProviderTest {
     val workspaceRoot = Paths.get(".")
     return listOf(
       BazelVersionDependencyKind(BazelUpdater()),
-      MavenDependencyKind(MavenDataExtractor(workspaceRoot), MavenRepository()),
+      MavenDependencyKind(MavenDataExtractor(workspaceRoot, "maven"), MavenRepository()),
       BzlModDependencyKind(BzlModDataExtractor(workspaceRoot), BzlModRepository()),
       BazelRulesDependencyKind(BazelRulesExtractor(), GithubRulesResolver(GitHub.connectAnonymously())),
     )

app/src/test/kotlin/org/virtuslab/bazelsteward/fixture/DependencyKindsFixture.kt

@@ -18,7 +18,7 @@ import java.nio.file.Paths
 class DependencyKindsFixture(workspaceRoot: Path = Paths.get(".")) {
 
   val bazelVersion = BazelVersionDependencyKind(BazelUpdater())
-  val maven = MavenDependencyKind(MavenDataExtractor(workspaceRoot), MavenRepository())
+  val maven = MavenDependencyKind(MavenDataExtractor(workspaceRoot, "maven"), MavenRepository())
   val bzlmod = BzlModDependencyKind(BzlModDataExtractor(workspaceRoot), BzlModRepository())
   val bazelRules = BazelRulesDependencyKind(
     BazelRulesExtractor(),

docs/docs/configuration/configuration-file/index.md

@@ -83,6 +83,8 @@ post-update-hooks:
       - "WORKSPACE"
     run-for: pull-request
     commit-message: "Apply buildifier"
+maven:
+  repository-name: maven
 ```
 
 ## Rule Resolution

docs/docs/configuration/configuration-file/maven.md

@@ -0,0 +1,38 @@
+---
+layout: default
+title: Post Update Hooks
+parent: Configuration File
+grand_parent: Configuration
+nav_order: 4
+---
+
+# Post Update Hooks
+
+Bazel Steward is able to run arbitrary commands and commit their effects into its pull requests. It is useful for running tools like buildifier or pinning dependencies.
+
+```yaml
+post-update-hooks:
+  - kinds: maven
+    commands:
+      - "REPIN=1 bazel run @unpinned_maven//:pin"
+    files-to-commit:
+      - "maven_install.json"
+    run-for: commit
+  - commands: "buildifier --lint=fix -r ."
+    files-to-commit:
+      - "**/*.bzl"
+      - "**/BUILD.bazel"
+      - "WORKSPACE"
+    run-for: pull-request
+    commit-message: "Apply buildifier"
+```
+
+Available fields:
+  * `commands` (list of strings) <br/>
+    List of commands to run after applying an update. Commands are run separately under `sh -c`
+  * `files to commit` (list of strings) <br/>
+    List of path patterns of files to commit after running the commands (syntax is the same as for `search-paths.path-patterns`).
+  * `run-for` (string) <br/>
+    Scope for running commands.
+    1. `commit` - runs for each commit and includes changes in the commit
+    2. `pull-request` - runs for the whole pull request, after creating all commits. It creates a separate commit with modified files. Message can be configured with the `commit-message` setting.

docs/docs/configuration/configuration-file/post-update-hooks.md

@@ -1,38 +1,22 @@
 ---
 layout: default
-title: Post Update Hooks
+title: Maven Config
 parent: Configuration File
 grand_parent: Configuration
 nav_order: 4
 ---
 
-# Post Update Hooks
+# Maven Config
+Settings specific to rules_jvm_external, i.e. maven dependencies resolution.
 
-Bazel Steward is able to run arbitrary commands and commit their effects into its pull requests. It is useful for running tools like buildifier or pinning dependencies.
 
 ```yaml
-post-update-hooks:
-  - kinds: maven
-    commands:
-      - "REPIN=1 bazel run @unpinned_maven//:pin"
-    files-to-commit:
-      - "maven_install.json"
-    run-for: commit
-  - commands: "buildifier --lint=fix -r ."
-    files-to-commit:
-      - "**/*.bzl"
-      - "**/BUILD.bazel"
-      - "WORKSPACE"
-    run-for: pull-request
-    commit-message: "Apply buildifier"
+maven:
+  repository-name: maven
 ```
 
 Available fields:
-  * `commands` (list of strings) <br/>
-    List of commands to run after applying an update. Commands are run separately under `sh -c`
-  * `files to commit` (list of strings) <br/>
-    List of path patterns of files to commit after running the commands (syntax is the same as for `search-paths.path-patterns`).
-  * `run-for` (string) <br/>
-    Scope for running commands.
-    1. `commit` - runs for each commit and includes changes in the commit
-    2. `pull-request` - runs for the whole pull request, after creating all commits. It creates a separate commit with modified files. Message can be configured with the `commit-message` setting.
+  * `repository-name` (string) <br/>
+    Name of repository where maven dependencies appear, by default it is "maven", i.e. dependencies will be queried
+    under `@maven//...`
+  

e2e/src/test/kotlin/org/virtuslab/bazelsteward/e2e/fixture/E2EBase.kt

@@ -196,7 +196,7 @@ open class E2EBase : IntegrationTestBase() {
     return this.copy(
       dependencyKinds = listOf(
         MavenDependencyKind(
-          MavenDataExtractor(this.workspaceRoot),
+          MavenDataExtractor(this.workspaceRoot, "maven"),
           MockMavenRepository().also(configure),
         ),
       ),

e2e/src/test/resources/rules/rules_jvm_external/WORKSPACE.expected

@@ -8,7 +8,7 @@ http_archive(
     name = "rules_jvm_external",
     sha256 = RULES_JVM_EXTERNAL_SHA,
     strip_prefix = "rules_jvm_external-{}".format(RULES_JVM_EXTERNAL_TAG),
-    url = "https://github.com/bazelbuild/rules_jvm_external/releases/download/5.1/rules_jvm_external-5.1.tar.gz",
+    url = "https://github.com/bazel-contrib/rules_jvm_external/releases/download/5.1/rules_jvm_external-5.1.tar.gz",
 )
 
 load("@rules_jvm_external//:defs.bzl", "maven_install")

kinds/maven/src/main/kotlin/org/virtuslab/bazelsteward/maven/MavenDataExtractor.kt

@@ -5,8 +5,8 @@ import kotlinx.coroutines.withContext
 import org.virtuslab.bazelsteward.core.common.CommandRunner
 import java.nio.file.Path
 
-class MavenDataExtractor(private val workspaceRoot: Path) {
-  private val regexPattern = """<source-file location="(.*):1:1" name="@maven//:%s">"""
+class MavenDataExtractor(private val workspaceRoot: Path, private val bazelRepositoryName: String) {
+  private val regexPattern = """<source-file location="(.*):1:1" name="@$bazelRepositoryName//:%s">"""
 
   suspend fun extract(): MavenData {
     val repositories = extractFromFile("outdated.repositories")
@@ -22,7 +22,7 @@ class MavenDataExtractor(private val workspaceRoot: Path) {
       workspaceRoot,
       "bazel",
       "query",
-      "@maven//:$fileName",
+      "@$bazelRepositoryName//:$fileName",
       "--output",
       "xml",
       "--noshow_progress",

repo-config/src/main/kotlin/org/virtuslab/bazelsteward/config/repo/RepoConfig.kt

@@ -19,13 +19,16 @@ data class RepoConfig(
   val pullRequests: List<PullRequestsConfig> = emptyList(),
   @JsonSetter(nulls = Nulls.AS_EMPTY)
   val postUpdateHooks: List<PostUpdateHooksConfig> = emptyList(),
+  @JsonSetter(nulls = Nulls.AS_EMPTY)
+  val maven: MavenConfig? = null,
 ) {
   fun withFallback(fallback: RepoConfig): RepoConfig {
     return RepoConfig(
       updateRules = updateRules + fallback.updateRules,
       searchPaths = searchPaths + fallback.searchPaths,
       pullRequests = pullRequests + fallback.pullRequests,
       postUpdateHooks = postUpdateHooks + fallback.postUpdateHooks,
+      maven = maven ?: fallback.maven,
     )
   }
 }
@@ -93,3 +96,8 @@ data class PostUpdateHooksConfig(
   val runFor: HookRunFor? = null,
   val commitMessage: String? = null,
 ) : DependencyFilter
+
+data class MavenConfig(
+  @JsonSetter(nulls = Nulls.AS_EMPTY)
+  val repositoryName: String = "maven",
+)