Add authentication file support (bazeltools#293)

* Add authentication file support This is useful to access private repositories * Add parsing test for auth file support
ianoc · Nov 19, 2020 · e921685 · e921685
1 parent dbd90f1
commit e921685
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 38 deletions.
diff --git a/3rdparty/workspace.bzl b/3rdparty/workspace.bzl
@@ -2,22 +2,22 @@
 def _jar_artifact_impl(ctx):
     jar_name = "%s.jar" % ctx.name
     ctx.download(
-        output=ctx.path("jar/%s" % jar_name),
-        url=ctx.attr.urls,
-        sha256=ctx.attr.sha256,
-        executable=False
+        output = ctx.path("jar/%s" % jar_name),
+        url = ctx.attr.urls,
+        sha256 = ctx.attr.sha256,
+        executable = False
     )
-    src_name="%s-sources.jar" % ctx.name
-    srcjar_attr=""
+    src_name = "%s-sources.jar" % ctx.name
+    srcjar_attr = ""
     has_sources = len(ctx.attr.src_urls) != 0
     if has_sources:
         ctx.download(
-            output=ctx.path("jar/%s" % src_name),
-            url=ctx.attr.src_urls,
-            sha256=ctx.attr.src_sha256,
-            executable=False
+            output = ctx.path("jar/%s" % src_name),
+            url = ctx.attr.src_urls,
+            sha256 = ctx.attr.src_sha256,
+            executable = False
         )
-        srcjar_attr ='\n    srcjar = ":%s",' % src_name
+        srcjar_attr = '\n    srcjar = ":%s",' % src_name
 
     build_file_contents = """
 package(default_visibility = ['//visibility:public'])

diff --git a/src/scala/com/github/johnynek/bazel_deps/DepsModel.scala b/src/scala/com/github/johnynek/bazel_deps/DepsModel.scala
@@ -76,6 +76,14 @@ case class Model(
 
     yamlMap(List(opts, deps, reps).collect { case Some(kv) => kv }, 2) + Doc.line
   }
+
+  def hasAuthFile: Boolean = options.exists(_.authFile.nonEmpty)
+  def getAuthFile: Option[String] =
+    options.flatMap(_.authFile).map { auth =>
+      if(auth.startsWith("$"))
+        sys.env.getOrElse(auth.substring(1), s"env var ${auth} not found")
+      else auth
+    }
 }
 
 object Model {
@@ -1222,7 +1230,8 @@ case class Options(
   licenses: Option[Set[String]],
   resolverType: Option[ResolverType],
   strictVisibility: Option[StrictVisibility],
-  buildFileName: Option[String]
+  buildFileName: Option[String],
+  authFile: Option[String]
 ) {
   def isDefault: Boolean =
     versionConflictPolicy.isEmpty &&
@@ -1236,7 +1245,8 @@ case class Options(
     licenses.isEmpty &&
     resolverType.isEmpty &&
     strictVisibility.isEmpty &&
-    buildFileName.isEmpty
+    buildFileName.isEmpty &&
+    authFile.isEmpty
 
   def getLicenses: Set[String] =
     licenses.getOrElse(Set.empty)
@@ -1305,7 +1315,8 @@ case class Options(
         licenses.map { l => list(l.toList.sorted)(quoteDoc) }),
       ("strictVisibility", strictVisibility.map { x => Doc.text(x.enabled.toString)}),
       ("resolverType", resolverType.map(r => quoteDoc(r.asString))),
-      ("buildFileName", buildFileName.map(name => Doc.text(name)))
+      ("buildFileName", buildFileName.map(name => Doc.text(name))),
+      ("authFile", authFile.map(name => Doc.text(name)))
     ).sortBy(_._1)
      .collect { case (k, Some(v)) => (k, v) }
 
@@ -1327,7 +1338,7 @@ object Options {
    * A monoid on options that is just the point-wise monoid
    */
   implicit val optionsMonoid: Monoid[Options] = new Monoid[Options] {
-    val empty = Options(None, None, None, None, None, None, None, None, None, None, None, None)
+    val empty = Options(None, None, None, None, None, None, None, None, None, None, None, None, None)
 
     def combine(a: Options, b: Options): Options = {
       val vcp = Monoid[Option[VersionConflictPolicy]].combine(a.versionConflictPolicy, b.versionConflictPolicy)
@@ -1342,7 +1353,8 @@ object Options {
       val resolverType = Monoid[Option[ResolverType]].combine(a.resolverType, b.resolverType)
       val strictVisibility = Monoid[Option[StrictVisibility]].combine(a.strictVisibility, b.strictVisibility)
       val buildFileName = Monoid[Option[String]].combine(a.buildFileName, b.buildFileName)
-      Options(vcp, tpd, langs, resolvers, trans, headers, resolverCache, namePrefix, licenses, resolverType, strictVisibility, buildFileName)
+      val authFile = Monoid[Option[String]].combine(a.authFile, b.authFile)
+      Options(vcp, tpd, langs, resolvers, trans, headers, resolverCache, namePrefix, licenses, resolverType, strictVisibility, buildFileName, authFile)
     }
   }
 }
diff --git a/src/scala/com/github/johnynek/bazel_deps/Writer.scala b/src/scala/com/github/johnynek/bazel_deps/Writer.scala
@@ -234,7 +234,41 @@ object Writer {
       }
       .mkString("\n")
 
+    val ifAuth : String => String =
+       if(model.hasAuthFile) identity
+       else _ => ""
+
+    val jarArtifactImpl =
+    s"""${
+      if(model.hasAuthFile)
+        s"""|load("@bazel_tools//tools/build_defs/repo:utils.bzl", "read_netrc", "use_netrc")
+            |
+            |def _jar_artifact_impl(ctx):
+            |    netrc = read_netrc(ctx, "${model.getAuthFile.get}")
+            |    auth = use_netrc(netrc, ctx.attr.urls, {})
+            |""".stripMargin
+      else "def _jar_artifact_impl(ctx):"
+       }
+       |    jar_name = "%s.jar" % ctx.name
+       |    ctx.download(
+       |        output = ctx.path("jar/%s" % jar_name),
+       |        url = ctx.attr.urls,
+       |        sha256 = ctx.attr.sha256,
+       |        executable = False${ifAuth(",\n        auth = auth")}
+       |    )
+       |    src_name = "%s-sources.jar" % ctx.name
+       |    srcjar_attr = ""
+       |    has_sources = len(ctx.attr.src_urls) != 0
+       |    if has_sources:${ifAuth("\n        src_auth = use_netrc(netrc, ctx.attr.src_urls, {})")}
+       |        ctx.download(
+       |            output = ctx.path("jar/%s" % src_name),
+       |            url = ctx.attr.src_urls,
+       |            sha256 = ctx.attr.src_sha256,
+       |            executable = False${ifAuth(",\n            auth = src_auth")}
+       |        )""".stripMargin
+
     s"""# Do not edit. bazel-deps autogenerates this file from $depsFile.
+        |$jarArtifactImpl
         |$jarArtifactBackend
         |
         |def list_dependencies():

diff --git a/src/scala/com/github/johnynek/bazel_deps/templates/jar_artifact_backend.bzl b/src/scala/com/github/johnynek/bazel_deps/templates/jar_artifact_backend.bzl
@@ -1,22 +1,4 @@
-def _jar_artifact_impl(ctx):
-    jar_name = "%s.jar" % ctx.name
-    ctx.download(
-        output=ctx.path("jar/%s" % jar_name),
-        url=ctx.attr.urls,
-        sha256=ctx.attr.sha256,
-        executable=False
-    )
-    src_name="%s-sources.jar" % ctx.name
-    srcjar_attr=""
-    has_sources = len(ctx.attr.src_urls) != 0
-    if has_sources:
-        ctx.download(
-            output=ctx.path("jar/%s" % src_name),
-            url=ctx.attr.src_urls,
-            sha256=ctx.attr.src_sha256,
-            executable=False
-        )
-        srcjar_attr ='\n    srcjar = ":%s",' % src_name
+        srcjar_attr = '\n    srcjar = ":%s",' % src_name
 
     build_file_contents = """
 package(default_visibility = ['//visibility:public'])

diff --git a/test/scala/com/github/johnynek/bazel_deps/ModelGenerators.scala b/test/scala/com/github/johnynek/bazel_deps/ModelGenerators.scala
@@ -70,7 +70,7 @@ object ModelGenerators {
     resolverType <- Gen.option(Gen.oneOf(ResolverType.Aether, ResolverType.Coursier))
     strictVisibility <- Gen.option(Gen.oneOf(StrictVisibility(true), StrictVisibility(false)))
     buildFileName <- Gen.option(Gen.oneOf("BUILD", "BUILD.bazel"))
-  } yield Options(vcp, dir, langs, res, trans, heads, cache, prefix, licenses, resolverType, strictVisibility, buildFileName)
+  } yield Options(vcp, dir, langs, res, trans, heads, cache, prefix, licenses, resolverType, strictVisibility, buildFileName, None)
 
   val modelGen: Gen[Model] = for {
     o <- Gen.option(optionGen)

diff --git a/test/scala/com/github/johnynek/bazel_deps/ParseTest.scala b/test/scala/com/github/johnynek/bazel_deps/ParseTest.scala
@@ -49,6 +49,7 @@ class ParseTest extends FunSuite {
                 |  resolverCache: bazel_output_base
                 |  licenses: ["unencumbered", "permissive"]
                 |  buildFileName: "BUILD.bazel"
+                |  authFile: $BAZEL_NETRC
                 |""".stripMargin('|')
 
     assert(Decoders.decodeModel(Yaml, str) ==
@@ -79,7 +80,8 @@ class ParseTest extends FunSuite {
               Some(Set("unencumbered", "permissive")),
               None,
               None,
-              Some("BUILD.bazel"))))))
+              Some("BUILD.bazel"),
+              Some("$BAZEL_NETRC"))))))
   }
   test("parse empty subproject version") {
     val str = """dependencies:
@@ -122,6 +124,7 @@ class ParseTest extends FunSuite {
               None,
               None,
               None,
+              None,
               None)))))
 
     assert(MavenArtifactId(ArtifactOrProject("a"), Subproject("")).asString === "a")

diff --git a/test/scala/com/github/johnynek/bazel_deps/ParseTestCasesTest.scala b/test/scala/com/github/johnynek/bazel_deps/ParseTestCasesTest.scala
@@ -19,7 +19,7 @@ class ParseTestCasesTest extends FunSuite {
     law(model)
 
     val model1 = Model(Dependencies.empty,Some(Replacements.empty),Some(Options(None,None,None,None,None,Some(List()),
-      Some(ResolverCache.Local), Some(NamePrefix("y")), None, None, None, None)))
+      Some(ResolverCache.Local), Some(NamePrefix("y")), None, None, None, None, None)))
     //println(model1.toDoc.render(70))
     law(model1)
   }