feat(*_image): allow setting env vars (#2031)

* feat(*_image): allow setting env vars

Introduce an `env` parameter in every `*_image` rule, which is a dict
whose keys and values will become environment variables in the resulting
Docker image.

Apply consistent formatting to every rule's docstring (args in the
docstring are now listed in the same order as in the method declaration)
as well as the container structure tests (`metadataTest` keys are now
sorted alphabetically).

cc/image.bzl

@@ -63,16 +63,17 @@ DEFAULT_BASE = select({
     "//conditions:default": "@cc_image_base//image",
 })
 
-def cc_image(name, base = None, deps = [], layers = [], binary = None, **kwargs):
+def cc_image(name, base = None, deps = [], layers = [], env = {}, binary = None, **kwargs):
     """Constructs a container image wrapping a cc_binary target.
 
   Args:
     name: Name of the cc_image target.
     base: Base image to use for the cc_image.
     deps: Dependencies of the cc_image.
-    binary: An alternative binary target to use instead of generating one.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the cc_image.
+    binary: An alternative binary target to use instead of generating one.
     **kwargs: See cc_binary.
   """
     if layers:
@@ -94,6 +95,7 @@ def cc_image(name, base = None, deps = [], layers = [], binary = None, **kwargs)
     app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary,
         visibility = visibility,
         tags = tags,

d/image.bzl

@@ -32,16 +32,17 @@ def repositories():
     """
     _repositories()
 
-def d_image(name, base = None, deps = [], layers = [], binary = None, **kwargs):
+def d_image(name, base = None, deps = [], layers = [], env = {}, binary = None, **kwargs):
     """Constructs a container image wrapping a d_binary target.
 
   Args:
     name: Name of the d_image target.
     base: Base image to use for the d_image.
     deps: Dependencies of the d_image target.
-    binary: An alternative binary target to use instead of generating one.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the d_image.
+    binary: An alternative binary target to use instead of generating one.
     **kwargs: See d_binary.
   """
     if layers:
@@ -63,6 +64,7 @@ def d_image(name, base = None, deps = [], layers = [], binary = None, **kwargs):
     app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary,
         visibility = visibility,
         tags = tags,

go/image.bzl

@@ -89,15 +89,16 @@ STATIC_DEFAULT_BASE = select({
     "//conditions:default": "@go_image_static//image",
 })
 
-def go_image(name, base = None, deps = [], layers = [], binary = None, **kwargs):
+def go_image(name, base = None, deps = [], layers = [], env = {}, binary = None, **kwargs):
     """Constructs a container image wrapping a go_binary target.
 
   Args:
     name: Name of the go_image target.
     base: Base image to use to build the go_image.
     deps: Dependencies of the go image target.
-    binary: An alternative binary target to use instead of generating one.
     layers: Augments "deps" with dependencies that should be put into their own layers.
+    env: Environment variables for the go_image.
+    binary: An alternative binary target to use instead of generating one.
     **kwargs: See go_binary.
   """
     if layers:
@@ -123,6 +124,7 @@ def go_image(name, base = None, deps = [], layers = [], binary = None, **kwargs)
     app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary,
         visibility = visibility,
         tags = tags,

groovy/image.bzl

@@ -32,6 +32,7 @@ def groovy_image(
         srcs = [],
         deps = [],
         layers = [],
+        env = {},
         jvm_flags = [],
         classpath_as_file = None,
         **kwargs):
@@ -44,9 +45,10 @@ def groovy_image(
     srcs: List of groovy source files that will be used to build the binary
           to be included in the groovy_image.
     deps: The dependencies of the groovy_image target.
-    jvm_flags: The flags to pass to the JVM when running the groovy image.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the groovy_image.
+    jvm_flags: The flags to pass to the JVM when running the groovy image.
     **kwargs: See groovy_binary.
   """
     binary_name = name + ".binary"
@@ -84,6 +86,7 @@ def groovy_image(
     jar_app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary_name,
         main_class = main_class,
         jvm_flags = jvm_flags,

java/image.bzl

@@ -214,9 +214,9 @@ def _jar_app_layer_impl(ctx):
         ctx,
         # We use all absolute paths.
         directory = "/",
-        env = {
+        env = dicts.add({
             "JAVA_RUNFILES": "/app",
-        },
+        }, ctx.attr.env),
         file_map = file_map,
         entrypoint = entrypoint,
     )
@@ -266,6 +266,7 @@ def java_image(
         deps = [],
         runtime_deps = [],
         layers = [],
+        env = {},
         jvm_flags = [],
         classpath_as_file = None,
         **kwargs):
@@ -276,9 +277,10 @@ def java_image(
     base: Base image to use for the java image.
     deps: Dependencies of the java image rule.
     runtime_deps: Runtime dependencies of the java image.
-    jvm_flags: Flags to pass to the JVM when running the java image.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the java_image.
+    jvm_flags: Flags to pass to the JVM when running the java image.
     main_class: This parameter is optional. If provided it will be used in the
                 compilation of any additional sources, and as part of the
                 construction of the container entrypoint. If not provided, the
@@ -327,6 +329,7 @@ def java_image(
         jar_layers = layers,
         visibility = visibility,
         tags = tags,
+        env = env,
         args = kwargs.get("args"),
         data = kwargs.get("data"),
         testonly = kwargs.get("testonly"),
@@ -406,7 +409,7 @@ _war_app_layer = rule(
     cfg = _container.image.cfg,
 )
 
-def war_image(name, base = None, deps = [], layers = [], **kwargs):
+def war_image(name, base = None, deps = [], layers = [], env = {}, **kwargs):
     """Builds a container image overlaying the java_library as an exploded WAR.
 
   TODO(mattmoor): For `bazel run` of this to be useful, we need to be able
@@ -419,6 +422,7 @@ def war_image(name, base = None, deps = [], layers = [], **kwargs):
     deps: Dependencies of the way image target.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the war_image.
     **kwargs: See java_library.
   """
     library_name = name + ".library"
@@ -438,6 +442,7 @@ def war_image(name, base = None, deps = [], layers = [], **kwargs):
         base = base,
         library = library_name,
         jar_layers = layers,
+        env = env,
         visibility = visibility,
         tags = tags,
     )

kotlin/image.bzl

@@ -33,23 +33,25 @@ def kt_jvm_image(
         srcs = [],
         deps = [],
         layers = [],
+        env = {},
         jvm_flags = [],
         classpath_as_file = None,
         **kwargs):
     """Builds a container image overlaying the kt_jvm_binary.
 
-    Args:
-        name: Name of the kt_jvm_image target.
-        base: Base image to use for the kt_jvm_image.
-        main_class: The main entrypoint class in the kotlin image.
-        srcs: List of kotlin source files that will be used to build the binary
-            to be included in the kt_jvm_image.
-        deps: The dependencies of the kt_jvm_image target.
-        jvm_flags: The flags to pass to the JVM when running the kotlin image.
-        layers: Augments "deps" with dependencies that should be put into
-            their own layers.
-        **kwargs: See kt_jvm_binary.
-    """
+  Args:
+    name: Name of the kt_jvm_image target.
+    base: Base image to use for the kt_jvm_image.
+    main_class: The main entrypoint class in the kotlin image.
+    srcs: List of kotlin source files that will be used to build the binary
+        to be included in the kt_jvm_image.
+    deps: The dependencies of the kt_jvm_image target.
+    layers: Augments "deps" with dependencies that should be put into
+        their own layers.
+    env: Environment variables for the kt_jvm_image.
+    jvm_flags: The flags to pass to the JVM when running the kotlin image.
+    **kwargs: See kt_jvm_binary.
+  """
     binary_name = name + ".binary"
 
     # This is an inlined copy of kt_jvm_binary so that we properly collect
@@ -83,6 +85,7 @@ def kt_jvm_image(
     jar_app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary_name,
         main_class = main_class,
         jvm_flags = jvm_flags,

nodejs/image.bzl

@@ -116,6 +116,7 @@ def nodejs_image(
         base = None,
         data = [],
         layers = [],
+        env = {},
         binary = None,
         launcher = None,
         launcher_args = None,
@@ -130,6 +131,7 @@ def nodejs_image(
     data: Runtime dependencies of the nodejs_image.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the nodejs_image.
     binary: An alternative binary target to use instead of generating one.
     launcher: The container_image launcher to set.
     launcher_args: The args for the container_image launcher.
@@ -172,6 +174,7 @@ def nodejs_image(
     app_layer(
         name = name,
         base = npm_deps_layer_name,
+        env = env,
         binary = binary,
         visibility = visibility,
         tags = tags,

python/image.bzl

@@ -78,17 +78,18 @@ def py_layer(name, deps, filter = "", **kwargs):
     native.py_library(name = binary_name, deps = deps, **kwargs)
     filter_layer(name = name, dep = binary_name, filter = filter)
 
-def py_image(name, base = None, deps = [], layers = [], **kwargs):
+def py_image(name, base = None, deps = [], layers = [], env = {}, **kwargs):
     """Constructs a container image wrapping a py_binary target.
 
-    Args:
-        name: Name of the py_image target.
-        base: Base image to use in the py_image.
-        deps: Dependencies of the py_image target.
-        layers: Augments "deps" with dependencies that should be put into
-            their own layers.
-        **kwargs: See py_binary.
-    """
+  Args:
+    name: Name of the py_image target.
+    base: Base image to use in the py_image.
+    deps: Dependencies of the py_image target.
+    layers: Augments "deps" with dependencies that should be put into
+        their own layers.
+    env: Environment variables for the py_image.
+    **kwargs: See py_binary.
+  """
     binary_name = name + ".binary"
 
     if "main" not in kwargs:
@@ -117,6 +118,7 @@ def py_image(name, base = None, deps = [], layers = [], **kwargs):
         name = name,
         base = base,
         entrypoint = ["/usr/bin/python"],
+        env = env,
         binary = binary_name,
         visibility = visibility,
         tags = tags,

python3/image.bzl

@@ -73,7 +73,7 @@ DEFAULT_BASE = select({
     "//conditions:default": "@py3_image_base//image",
 })
 
-def py3_image(name, base = None, deps = [], layers = [], **kwargs):
+def py3_image(name, base = None, deps = [], layers = [], env = {}, **kwargs):
     """Constructs a container image wrapping a py_binary target.
 
   Args:
@@ -82,6 +82,7 @@ def py3_image(name, base = None, deps = [], layers = [], **kwargs):
     deps: Dependencies of the py3_image.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the py_image.
     **kwargs: See py_binary.
   """
     binary_name = name + ".binary"
@@ -113,6 +114,7 @@ def py3_image(name, base = None, deps = [], layers = [], **kwargs):
         name = name,
         base = base,
         entrypoint = ["/usr/bin/python"],
+        env = env,
         binary = binary_name,
         visibility = visibility,
         tags = tags,

rust/image.bzl

@@ -32,16 +32,17 @@ def repositories():
     """
     _repositories()
 
-def rust_image(name, base = None, deps = [], layers = [], binary = None, **kwargs):
+def rust_image(name, base = None, deps = [], layers = [], env = {}, binary = None, **kwargs):
     """Constructs a container image wrapping a rust_binary target.
 
-    Args:
-        name: Name of the rust_image target.
-        base: Base image to use for the rust_image.
-        deps: Dependencies of the rust_image target.
-        layers: Augments "deps" with dependencies that should be put into their own layers.
-        binary: An alternative binary target to use instead of generating one.
-        **kwargs: See rust_binary.
+  Args:
+    name: Name of the rust_image target.
+    base: Base image to use for the rust_image.
+    deps: Dependencies of the rust_image target.
+    layers: Augments "deps" with dependencies that should be put into their own layers.
+    env: Environment variables for the rust_image.
+    binary: An alternative binary target to use instead of generating one.
+    **kwargs: See rust_binary.
   """
     if layers:
         # buildifier: disable=print
@@ -63,6 +64,7 @@ def rust_image(name, base = None, deps = [], layers = [], binary = None, **kwarg
     app_layer(
         name = name,
         base = base,
+        env = env,
         binary = binary,
         visibility = visibility,
         tags = tags,

scala/image.bzl

@@ -32,6 +32,7 @@ def scala_image(
         deps = [],
         runtime_deps = [],
         layers = [],
+        env = {},
         jvm_flags = [],
         classpath_as_file = None,
         **kwargs):
@@ -44,9 +45,10 @@ def scala_image(
                 image.
     deps: Dependencies of the scala image target.
     runtime_deps: Runtime dependencies of the scala image.
-    jvm_flags: Flags to pass to the JVM when running the scala image.
     layers: Augments "deps" with dependencies that should be put into
            their own layers.
+    env: Environment variables for the scala_image.
+    jvm_flags: Flags to pass to the JVM when running the scala image.
     **kwargs: See scala_binary.
   """
     binary_name = name + ".binary"
@@ -81,6 +83,7 @@ def scala_image(
         deps = deps,
         runtime_deps = runtime_deps,
         jar_layers = layers,
+        env = env,
         visibility = visibility,
         tags = tags,
         args = kwargs.get("args"),

testdata/BUILD

@@ -886,6 +886,7 @@ java_image(
 war_image(
     name = "war_image",
     srcs = ["Servlet.java"],
+    env = {"WAR_IMAGE_TEST_KEY": "war_image_test_value"},
     layers = [
         ":java_image_library",
         "@javax_servlet_api//jar:jar",

testdata/Servlet.java

@@ -33,5 +33,6 @@ public class Servlet extends HttpServlet {
   public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
       PrintWriter out = resp.getWriter();
       out.println(Library.SayHello());
+      out.printf("WAR_IMAGE_TEST_KEY=%s\n", System.getenv("WAR_IMAGE_TEST_KEY"));
   }
 }

testing/e2e.sh

@@ -77,6 +77,7 @@ function test_war_image() {
   ID=$(docker run -d -p 8080:8080 bazel/testdata:war_image)
   sleep 5
   EXPECT_CONTAINS "$(curl localhost:8080)" "Hello World"
+  EXPECT_CONTAINS "$(curl localhost:8080)" "WAR_IMAGE_TEST_KEY=war_image_test_value"
   docker rm -f "${ID}"
 }
 

tests/container/cc/BUILD

@@ -32,6 +32,7 @@ cc_image(
         "$(location :BUILD)",
     ],
     data = [":BUILD"],
+    env = {"CC_IMAGE_TEST_KEY": "cc_image_test_value"},
     # This creates an empty layer, due to linking.
     layers = [":cc_image_library"],
 )