From 70c88896bacbd23752195e715339e9d2c48b04d0 Mon Sep 17 00:00:00 2001 From: Akihiro Suda Date: Tue, 5 Jun 2018 19:18:56 +0900 Subject: [PATCH] initial commit Signed-off-by: Akihiro Suda --- .travis.yml | 29 ++++++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++ README.md | 17 ++++ buildbench | 181 +++++++++++++++++++++++++++++++++++ examples/ex01/Dockerfile | 19 ++++ 5 files changed, 448 insertions(+) create mode 100644 .travis.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100755 buildbench create mode 100644 examples/ex01/Dockerfile diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..8104182 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,29 @@ +sudo: required +dist: trusty + +language: generic + +services: + - docker + +before_install: + - sudo apt-get install -y realpath + +env: + matrix: + - D=./examples/ex01 CSV=ex01.csv N=5 + - D=./moby CSV=moby.csv N=1 REPO=https://github.com/moby/moby.git DISABLE_BUILDAH=1 DISABLE_KANIKO=1 + +# moby/moby is the good example of complex Dockerfile. +# However, as of June 5, 2018, Buildah and Kaniko does not support `FROM anotherstage`. + +script: + - | + if [ ! -z ${REPO} ]; then + git clone ${REPO} ${D} + ( cd ${D} ; git show --summary ) + fi + - echo "travis_fold:start:SCRIPT Testing ${D} ${N} times. CSV=${CSV}" + - ./buildbench ${D} ${CSV} ${N} + - echo "travis_fold:end:SCRIPT Testing ${D} ${N} times. CSV=${CSV}" + - cat ${CSV} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a7a5ac --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Buildbench: benchmark tool for Docker, BuildKit, img, Buildah, and Kaniko + +[![Build Status](https://travis-ci.org/AkihiroSuda/buildbench.svg)](https://travis-ci.org/AkihiroSuda/buildbench) + +## Requirements + +* bash +* realpath +* Docker + +## Usage + +```console +$ ./buildbench ./examples/ex01 out.csv 5 +``` + +* To disable specific builder, please set `DISABLE_DOCKER`, `DISABLE_BUILDKIT`, and so on. diff --git a/buildbench b/buildbench new file mode 100755 index 0000000..0899979 --- /dev/null +++ b/buildbench @@ -0,0 +1,181 @@ +#!/bin/bash + +set -eu -o pipefail +# set -x +export LANG=C LC_ALL=C +cd $(dirname $0) + +### Constants +DOCKER_DAEMON_IMAGE="docker:edge-dind" +DOCKER_CLIENT_IMAGE="docker:edge" +BUILDKIT_IMAGE="tonistiigi/buildkit:latest" +IMG_IMAGE="r.j3ss.co/img:latest" +BUILDAH_IMAGE="containerbuilding/buildah:latest" +KANIKO_IMAGE="gcr.io/kaniko-project/executor:latest" + +### Common +function INFO(){ + echo -e "\e[104m\e[97m[INFO]\e[49m\e[39m $@" +} +function bb::volume_name(){ + echo "buildbench-$1" +} +function bb::container_name(){ + echo "buildbench-$1" +} +function bb::dummy_file_name(){ + echo "buildbench-dummy" +} +function bb::test(){ + local builder="$1" + local dir="$2" + local csv="$3" + local n="$4" + INFO "Initializing ${builder}" + ${builder}::prune || true + ${builder}::init + for i in $(seq 1 ${n});do + INFO "${i} of ${n}: ${builder}: preparing" + rm -f ${dir}/$(bb::dummy_file_name) + ${builder}::prepare + local desc="${i} of ${n}: ${builder} #1 (clean env)" + INFO "${desc}: starting" + local begin=$(date +%s) + ${builder}::build ${dir} + local end=$(date +%s) + local took=$((${end}-${begin})) + INFO "${desc}: done, took ${took} seconds" + echo "${builder}-1,${took},${begin},${end}" >> ${csv} + desc="${i} of ${n}: ${builder} #2 (with dummy modification. cache can be potentially used.)" + date > ${dir}/$(bb::dummy_file_name) + INFO "${desc}: starting" + local begin=$(date +%s) + ${builder}::build ${dir} + local end=$(date +%s) + local took=$((${end}-${begin})) + INFO "${desc}: done, took ${took} seconds" + echo "${builder}-2,${took},${begin},${end}" >> ${csv} + INFO "${i} of ${n}: ${builder}: pruning" + rm -f ${dir}/$(bb::dummy_file_name) + ${builder}::prune + done +} + +### Docker +function docker::init(){ + docker pull ${DOCKER_DAEMON_IMAGE} + docker pull ${DOCKER_CLIENT_IMAGE} + INFO "Docker version" + docker run --rm ${DOCKER_CLIENT_IMAGE} --version +} +function docker::prepare(){ + docker volume create $(bb::volume_name docker) + docker run --privileged --name $(bb::container_name docker) -d -v $(bb::volume_name docker):/var/lib/docker ${DOCKER_DAEMON_IMAGE} +} +function docker::build(){ + local dir="$1" + docker run -v ${dir}:/workspace -w /workspace --rm --link $(bb::container_name docker):docker ${DOCKER_CLIENT_IMAGE} \ + docker build -t foo . +} +function docker::prune(){ + docker rm -f $(bb::container_name docker) + docker volume rm -f $(bb::volume_name docker) +} + +### BuildKit +function buildkit::init(){ + docker pull ${BUILDKIT_IMAGE} + INFO "BuildKit version" + docker run --rm ${BUILDKIT_IMAGE} --version +} +function buildkit::prepare(){ + docker volume create $(bb::volume_name buildkit) + docker run --privileged --name $(bb::container_name buildkit) -d -v $(bb::volume_name buildkit):/var/lib/buildkit -p 1234:1234 ${BUILDKIT_IMAGE} \ + --addr tcp://0.0.0.0:1234 +} +function buildkit::build(){ + local dir="$1" + docker run \ + -v ${dir}:/workspace -w /workspace \ + --rm \ + --link $(bb::container_name buildkit):buildkit \ + -e BUILDKIT_HOST=tcp://buildkit:1234 \ + --entrypoint buildctl \ + ${BUILDKIT_IMAGE} \ + build --frontend=dockerfile.v0 --local context=. --local dockerfile=. +} +function buildkit::prune(){ + docker rm -f $(bb::container_name buildkit) + docker volume rm -f $(bb::volume_name buildkit) +} + +### img +function img::init(){ + docker pull ${IMG_IMAGE} + INFO "img version" + docker run --rm ${IMG_IMAGE} version +} +function img::prepare(){ + docker volume create $(bb::volume_name img) +} +function img::build(){ + local dir="$1" + docker run --privileged -v ${dir}:/workspace -w /workspace --rm -v $(bb::volume_name img):/home/user ${IMG_IMAGE} \ + build -backend overlayfs -t foo . +} +function img::prune(){ + docker volume rm -f $(bb::volume_name img) +} + +### Buildah +function buildah::init(){ + docker pull ${BUILDAH_IMAGE} + INFO "Buildah version" + docker run --rm ${BUILDAH_IMAGE} buildah version +} +function buildah::prepare(){ + docker volume create $(bb::volume_name buildah) +} +function buildah::build(){ + local dir="$1" + docker run --privileged -v ${dir}:/workspace -w /workspace --rm -v $(bb::volume_name buildah):/var/lib/containers/storage ${BUILDAH_IMAGE} \ + buildah --storage-driver overlay bud -t foo . +} +function buildah::prune(){ + docker volume rm -f $(bb::volume_name buildah) +} + +### kaniko +function kaniko::init(){ + docker pull ${KANIKO_IMAGE} + INFO "Kaniko version is unknown" +} +function kaniko::prepare(){ + echo NOP > /dev/null +} +function kaniko::build(){ + local dir="$1" + docker run -v ${dir}:/workspace --rm ${KANIKO_IMAGE} \ + --tarPath /dev/null --destination=foo +} +function kaniko::prune(){ + echo NOP > /dev/null +} + +### Main +if [ "$#" -ne 3 ]; then + echo "Usage: $0 DIR CSV N" + exit 1 +fi +DIR=$(realpath "$1") +CSV="$2" +N="$3" + +for builder in docker buildkit img buildah kaniko; do + disable=DISABLE_$(echo ${builder} | tr a-z A-Z) + if [[ ! -z ${!disable-} ]]; then + INFO "Skipping ${builder}" + else + bb::test ${builder} ${DIR} ${CSV} ${N} + fi +done diff --git a/examples/ex01/Dockerfile b/examples/ex01/Dockerfile new file mode 100644 index 0000000..ad5da37 --- /dev/null +++ b/examples/ex01/Dockerfile @@ -0,0 +1,19 @@ +FROM alpine AS buildc +RUN apk add --no-cache build-base +RUN echo -e "#include \nint main(int ac, char *av[]){printf(\"hello c\\\\n\");return 0;}" | tee /hello.c +COPY . /foo +RUN gcc -o /a.out /hello.c + +# the COPY above SHOULD NOT invalidate the cache for the buildgo stage. + +FROM alpine AS buildgo +RUN apk add --no-cache build-base +RUN apk add --no-cache go +RUN echo -e "package main\nfunc main(){println(\"hello go\")}" | tee /hello.go +RUN go build -o /a.out /hello.go + +FROM alpine +COPY --from=buildc /a.out /hello1 +COPY --from=buildgo /a.out /hello2 + +# Note: as of June 5, 2018, Buildah and Kaniko does not support `FROM anotherstage`