Split up dockerfile with templates (#34)

Author: chatton

.evergreen.yml

@@ -86,7 +86,7 @@ functions:
           - quay_user_name
           - quay_password
           - image
-          - dockerfile
+          - image_type
         working_dir: mongodb-kubernetes-operator
         binary: scripts/ci/build_and_push_image.sh
 
@@ -98,7 +98,7 @@ tasks:
       - func: clone
       - func: build_and_push_image
         vars:
-          dockerfile: docker/Dockerfile.operator
+          image_type: operator
           image: quay.io/mongodb/community-operator-dev:${version_id}
 
   - name: build_e2e_image
@@ -108,8 +108,18 @@ tasks:
       - func: clone
       - func: build_and_push_image
         vars:
-          dockerfile: docker/Dockerfile.e2e
           image: quay.io/mongodb/community-operator-e2e:${version_id}
+          image_type: e2e
+
+  - name: build_testrunner_image
+    priority: 60
+    exec_timeout_secs: 600
+    commands:
+      - func: clone
+      - func: build_and_push_image
+        vars:
+          image: quay.io/mongodb/community-operator-testrunner:${version_id}
+          image_type: testrunner
 
   - name: unit_tests
     commands:
@@ -157,6 +167,8 @@ buildvariants:
         variant: init_test_run
       - name: build_e2e_image
         variant: init_test_run
+      - name: build_testrunner_image
+        variant: init_test_run
     tasks:
       - name: e2e_test_replica_set
       - name: e2e_test_replica_set_readiness_probe
@@ -169,3 +181,4 @@ buildvariants:
     tasks:
       - name: build_operator_image
       - name: build_e2e_image
+      - name: build_testrunner_image

docker/Dockerfile.e2e

@@ -0,0 +1,67 @@
+import jinja2
+import argparse
+
+
+def operator_params():
+    return {
+        "builder": True,
+        "builder_image": "golang",
+        "base_image": "registry.access.redhat.com/ubi8/ubi-minimal:latest",
+    }
+
+
+def test_runner_params():
+    return {
+        "builder": True,
+        "builder_image": "golang", # TODO: make this image smaller. There were errors using alpine
+        "base_image": "registry.access.redhat.com/ubi8/ubi-minimal:latest",
+    }
+
+
+def e2e_params():
+    return {
+        "base_image": "golang", # TODO: make this image smaller, error: 'exec: "gcc": executable file not found in $PATH' with golang:alpine
+    }
+
+
+def unit_test_params():
+    return {
+        "base_image": "golang",
+    }
+
+
+def render(image_name):
+    param_dict = {
+        "unittest": unit_test_params(),
+        "e2e": e2e_params(),
+        "testrunner": test_runner_params(),
+        "operator": operator_params(),
+    }
+
+    if image_name not in param_dict:
+        raise ValueError(
+            "Image name: {} is invalid. Valid values are {}".format(
+                image_name, param_dict.keys()
+            )
+        )
+
+    env = jinja2.Environment()
+    env.loader = jinja2.FileSystemLoader(searchpath="docker/templates")
+    return env.get_template("Dockerfile.{}".format(image_name)).render(
+        param_dict[image_name]
+    )
+
+
+def parse_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("image", help="Type of image for the Dockerfile")
+    return parser.parse_args()
+
+
+def main():
+    args = parse_args()
+    print(render(args.image))
+
+
+if __name__ == "__main__":
+    main()

docker/Dockerfile.unittest

@@ -0,0 +1 @@
+jinja2==2.11.2

docker/dockerfile_generator.py

@@ -0,0 +1,5 @@
+{% extends "Dockerfile.template" %}
+
+{% block command -%}
+CMD ["/bin/operator-sdk", "test", "local",  "./test/e2e",  "--namespace", "default", "--verbose", "--kubeconfig", "/etc/config/kubeconfig" ]
+{% endblock -%}

docker/requirements.txt

@@ -1,30 +1,17 @@
-FROM golang AS builder
-
-ENV OPERATOR_SDK_VERSION v0.15.2
-ENV GO111MODULE=on
-ENV GOFLAGS="-mod=vendor"
-ENV GOPATH ""
-
-RUN curl -LO https://github.com/operator-framework/operator-sdk/releases/download/${OPERATOR_SDK_VERSION}/operator-sdk-${OPERATOR_SDK_VERSION}-x86_64-linux-gnu \
-    && mv operator-sdk-${OPERATOR_SDK_VERSION}-x86_64-linux-gnu /bin/operator-sdk \
-    && chmod +x /bin/operator-sdk
-
-COPY go.mod go.sum ./
-RUN go mod download
-
-ADD . .
-
-RUN go mod vendor && /bin/operator-sdk generate k8s
+{% extends "Dockerfile.template" %}
 
+{% block build_binary -%}
 # TODO: This build takes longer than it needs to and can still be optimized
 RUN go build -o build/_output/bin/mongodb-kubernetes-operator -mod=vendor github.com/mongodb/mongodb-kubernetes-operator/cmd/manager
 
 ENV manifest_version=4.2
 RUN mkdir -p /content/ \
         && chmod -R +r /content/ \
         && curl --fail --retry 3 -o /content/version_manifest.json "https://opsmanager.mongodb.com/static/version_manifest/${manifest_version}.json"
+{% endblock -%}
 
-FROM registry.access.redhat.com/ubi8/ubi-minimal:latest
+{% block build_second_stage -%}
+FROM {{base_image}}
 
 ENV OPERATOR=/usr/local/bin/mongodb-kubernetes-operator \
     USER_UID=1001 \
@@ -37,6 +24,9 @@ COPY --from=builder /content/version_manifest.json /usr/local/version_manifest.j
 
 RUN  /usr/local/bin/user_setup
 
-ENTRYPOINT ["/usr/local/bin/entrypoint"]
-
 USER ${USER_UID}
+{% endblock -%}
+
+{% block command -%}
+ENTRYPOINT ["/usr/local/bin/entrypoint"]
+{% endblock -%}

docker/templates/Dockerfile.e2e

@@ -1,4 +1,12 @@
-FROM golang AS builder
+{% if builder %}
+FROM {{builder_image}} AS builder
+
+{% else %}
+FROM {{base_image}}
+{% endif %}
+
+{% block packages -%}
+{% endblock -%}
 
 ENV OPERATOR_SDK_VERSION v0.15.2
 ENV GO111MODULE=on
@@ -16,15 +24,13 @@ ADD . .
 
 RUN go mod vendor && /bin/operator-sdk generate k8s
 
-RUN go build cmd/testrunner/main.go
-
-FROM registry.access.redhat.com/ubi8/ubi-minimal:latest
-
-# copy the testrunner binary
-COPY --from=builder /go/main runner
+# build the binary
+{% block build_binary -%}
+{% endblock -%}
 
-# add yaml files required by the test runner
-ADD deploy/ deploy/
-ADD test/ test/
+# build and second stage image if necessary
+{% block build_second_stage -%}
+{% endblock -%}
 
-CMD ["./runner"]
+{% block command -%}
+{% endblock -%}

docker/Dockerfile.operator renamed to docker/templates/Dockerfile.operator

@@ -0,0 +1,20 @@
+{% extends "Dockerfile.template" %}
+
+{% block build_binary -%}
+RUN go build cmd/testrunner/main.go
+{% endblock -%}
+
+{% block build_second_stage -%}
+FROM {{base_image}}
+
+# copy the testrunner binary
+COPY --from=builder /go/main runner
+
+# add yaml files required by the test runner
+ADD deploy/ deploy/
+ADD test/ test/
+{% endblock -%}
+
+{% block command -%}
+CMD ["./runner"]
+{% endblock -%}

docker/Dockerfile.testrunner renamed to docker/templates/Dockerfile.template

@@ -0,0 +1,5 @@
+{% extends "Dockerfile.template" %}
+
+{% block command -%}
+CMD ["go", "test", "./pkg/..."]
+{% endblock -%}