refactor go dependencies to a separate bzl file (#936)

* refactor go dependencies to a separate bzl file * add simple example that exersises minimal deps in WORKSPACE * fix docs * extend timeout for flaky cloudbluild, reduce timeout for another cloudbuild that has a value that is too high * last doc fixes * removing bolierplate and addressing comments
bazelbuild · Jun 27, 2019 · 80ea3aa · 80ea3aa
1 parent 1bd7593
commit 80ea3aa
Show file tree

Hide file tree

Showing 20 changed files with 286 additions and 141 deletions.
diff --git a/README.md b/README.md
@@ -120,14 +120,21 @@ docker_toolchain_configure(
   client_config="/path/to/docker/client/config",
 )
 
-# This is NOT needed when going through the language lang_image
-# "repositories" function(s).
 load(
     "@io_bazel_rules_docker//repositories:repositories.bzl",
     container_repositories = "repositories",
 )
 container_repositories()
 
+# This is NOT needed when going through the language lang_image
+# "repositories" function(s).
+load(
+    "@io_bazel_rules_docker//repositories:go_repositories.bzl",
+    container_go_deps = "go_deps",
+)
+
+container_go_deps()
+
 load(
     "@io_bazel_rules_docker//container:container.bzl",
     "container_pull",
@@ -325,6 +332,13 @@ for more details.
 To use `cc_image`, add the following to `WORKSPACE`:
 
 ```python
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//cc:image.bzl",
     _cc_image_repos = "repositories",
@@ -375,6 +389,13 @@ and see <a href=#go_image-custom-base>go_image (custom base)</a> example below.
 To use `py_image`, add the following to `WORKSPACE`:
 
 ```python
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//python:image.bzl",
     _py_image_repos = "repositories",
@@ -518,7 +539,13 @@ npm_install(
     package_json = "//:package.json",
 )
 
-# Download base images, etc.
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//nodejs:image.bzl",
     _nodejs_image_repos = "repositories",
@@ -558,16 +585,13 @@ To use `go_image`, add the following to `WORKSPACE`:
 ```python
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
 
-# You *must* import the Go rules before setting up the go_image rules.
-http_archive(
-    name = "io_bazel_rules_go",
-    # Replace with a real SHA256 checksum
-    sha256 = "{SHA256}"
-    # Replace with a real commit SHA
-    strip_prefix = "rules_go-{HEAD}",
-    urls = ["https://github.com/bazelbuild/rules_go/archive/{HEAD}.tar.gz"],
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
 )
 
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//go:image.bzl",
     _go_image_repos = "repositories",
@@ -662,6 +686,13 @@ go_image(
 To use `java_image`, add the following to `WORKSPACE`:
 
 ```python
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//java:image.bzl",
     _java_image_repos = "repositories",
@@ -694,6 +725,13 @@ and see <a href=#go_image-custom-base>go_image (custom base)</a> example.
 To use `war_image`, add the following to `WORKSPACE`:
 
 ```python
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//java:image.bzl",
     _java_image_repos = "repositories",
@@ -752,6 +790,13 @@ load("@io_bazel_rules_scala//scala:scala.bzl", "scala_repositories")
 
 scala_repositories()
 
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//scala:image.bzl",
     _scala_image_repos = "repositories",
@@ -802,6 +847,13 @@ load("@io_bazel_rules_groovy//groovy:groovy.bzl", "groovy_repositories")
 
 groovy_repositories()
 
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//groovy:image.bzl",
     _groovy_image_repos = "repositories",
@@ -852,6 +904,13 @@ load("@io_bazel_rules_rust//rust:repositories.bzl", "rust_repositories")
 
 rust_repositories()
 
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//rust:image.bzl",
     _rust_image_repos = "repositories",
@@ -901,6 +960,13 @@ load("@io_bazel_rules_d//d:d.bzl", "d_repositories")
 
 d_repositories()
 
+load(
+    "@io_bazel_rules_docker//repositories:repositories.bzl",
+    container_repositories = "repositories",
+)
+
+container_repositories()
+
 load(
     "@io_bazel_rules_docker//d:image.bzl",
     _d_image_repos = "repositories",

diff --git a/WORKSPACE b/WORKSPACE
@@ -33,6 +33,13 @@ load(
 
 container_repositories()
 
+load(
+    "//repositories:go_repositories.bzl",
+    container_go_deps = "go_deps",
+)
+
+container_go_deps()
+
 load(
     "//container:new_pull.bzl",
     "new_container_pull",
@@ -253,26 +260,6 @@ load("@io_bazel_rules_groovy//groovy:groovy.bzl", "groovy_repositories")
 
 groovy_repositories()
 
-# For our go_image test.
-http_archive(
-    name = "io_bazel_rules_go",
-    sha256 = "f04d2373bcaf8aa09bccb08a98a57e721306c8f6043a2a0ee610fd6853dcde3d",
-    urls = [
-        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/0.18.6/rules_go-0.18.6.tar.gz",
-        "https://github.com/bazelbuild/rules_go/releases/download/0.18.6/rules_go-0.18.6.tar.gz",
-    ],
-)
-
-load("@io_bazel_rules_go//go:deps.bzl", "go_register_toolchains", "go_rules_dependencies")
-
-go_rules_dependencies()
-
-go_register_toolchains()
-
-load("@bazel_gazelle//:deps.bzl", "gazelle_dependencies", "go_repository")
-
-gazelle_dependencies()
-
 # Have the go_image dependencies for testing.
 load(
     "//go:image.bzl",
@@ -388,15 +375,3 @@ rbe_autoconfig(
 )
 
 # gazelle:repo bazel_gazelle
-
-go_repository(
-    name = "com_github_google_go_containerregistry",
-    commit = "6991786f93129be24f857070fe94754a9ea02a0a",
-    importpath = "github.com/google/go-containerregistry",
-)
-
-go_repository(
-    name = "com_github_pkg_errors",
-    commit = "27936f6d90f9c8e1145f11ed52ffffbfdb9e0af7",
-    importpath = "github.com/pkg/errors",
-)
diff --git a/cc/image.bzl b/cc/image.bzl
@@ -25,8 +25,8 @@ load(
     "app_layer",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -35,10 +35,10 @@ load(":cc.bzl", "DIGESTS")
 def repositories():
     """Import the dependencies for the cc_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     excludes = native.existing_rules().keys()
     if "cc_image_base" not in excludes:

diff --git a/container/go/cloudbuild.yaml b/container/go/cloudbuild.yaml
@@ -14,7 +14,7 @@
 
 # This cloudbuild.yaml file is used to release the go puller binary.
 
-timeout: 21600s
+timeout: 3600s
 options:
     machineType: "N1_HIGHCPU_32"
 

diff --git a/go/image.bzl b/go/image.bzl
@@ -29,8 +29,8 @@ load(
     "app_layer",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -39,10 +39,10 @@ load(":go.bzl", "DIGESTS")
 def repositories():
     """Import the dependencies of the go_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     excludes = native.existing_rules().keys()
     if "go_image_base" not in excludes:

diff --git a/java/image.bzl b/java/image.bzl
@@ -31,8 +31,8 @@ load(
     lang_image = "image",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -48,10 +48,10 @@ load(
 def repositories():
     """Import the dependencies of the java_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     excludes = native.existing_rules().keys()
     if "java_image_base" not in excludes:

diff --git a/nodejs/image.bzl b/nodejs/image.bzl
@@ -28,8 +28,8 @@ load(
     lang_image = "image",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -38,10 +38,10 @@ load(":nodejs.bzl", "DIGESTS")
 def repositories():
     """Import the dependencies of the nodejs_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     excludes = native.existing_rules().keys()
     if "nodejs_image_base" not in excludes:

diff --git a/python/image.bzl b/python/image.bzl
@@ -26,8 +26,8 @@ load(
     "filter_layer",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -36,10 +36,10 @@ load(":python.bzl", "DIGESTS")
 def repositories():
     """Import the dependencies of the py_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     # Register the default py_toolchain for containerized execution
     native.register_toolchains("@io_bazel_rules_docker//toolchains/python:container_py_toolchain")

diff --git a/python3/image.bzl b/python3/image.bzl
@@ -25,8 +25,8 @@ load(
     "app_layer",
 )
 load(
-    "//repositories:repositories.bzl",
-    _repositories = "repositories",
+    "//repositories:go_repositories.bzl",
+    _go_deps = "go_deps",
 )
 
 # Load the resolved digests.
@@ -35,10 +35,10 @@ load(":python3.bzl", "DIGESTS")
 def repositories():
     """Import the dependencies of the py3_image rule.
 
-    Call the core "repositories" function to reduce boilerplate. This is
+    Call the core "go_deps" function to reduce boilerplate. This is
     idempotent if folks call it themselves.
     """
-    _repositories()
+    _go_deps()
 
     # Register the default py_toolchain for containerized execution
     native.register_toolchains("@io_bazel_rules_docker//toolchains/python:container_py_toolchain")