kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Fix daemon start/stop logic in hack/make/* scripts

Browse source 
From the Bash manual's `set -e` description:
(https://www.gnu.org/software/bash/manual/bashref.html#index-set)

> Exit immediately if a pipeline (see Pipelines), which may consist of a
> single simple command (see Simple Commands), a list (see Lists), or a
> compound command (see Compound Commands) returns a non-zero status.
> The shell does not exit if the command that fails is part of the
> command list immediately following a while or until keyword, part of
> the test in an if statement, part of any command executed in a && or
> || list except the command following the final && or ||, any command
> in a pipeline but the last, or if the command’s return status is being
> inverted with !. If a compound command other than a subshell returns a
> non-zero status because a command failed while -e was being ignored,
> the shell does not exit.

Additionally, further down:

> If a compound command or shell function executes in a context where -e
> is being ignored, none of the commands executed within the compound
> command or function body will be affected by the -e setting, even if
> -e is set and a command returns a failure status. If a compound
> command or shell function sets -e while executing in a context where
> -e is ignored, that setting will not have any effect until the
> compound command or the command containing the function call
> completes.

Thus, the only way to have our `.integration-daemon-stop` script
actually run appropriately to clean up our daemon on test/script failure
is to use `trap ... EXIT`, which we traditionally avoid because it does
not have any stacking capabilities, but in this case is a reasonable
compromise because it's going to be the only script using it (for now,
at least; we can evaluate more complex solutions in the future if they
actually become necessary).

The alternatives were much less reasonable.  One is to have the entire
complex chains in any script wanting to use `.integration-daemon-start`
/ `.integration-daemon-stop` be chained together with `&&` in an `if`
block, which is untenable.  The other I could think of was taking the
body of these scripts out into separate scripts, essentially meaning
we'd need two files for each of these, which further complicates the
maintenance.

Add to that the fact that our `trap ... EXIT` is scoped to the enclosing
subshell (`( ... )`) and we're in even more reasonable territory with
this pattern.

Signed-off-by: Andrew "Tianon" Page <admwiggin@gmail.com>
This commit is contained in:
Tianon Gravi 2015-04-17 16:19:34 -06:00
parent fa3e2dd45e
commit 929af4c38d
5 changed files with 65 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
hack/make/.integration-daemon-start
View file

@ -25,6 +25,7 @@ if [ -z "$DOCKER_TEST_HOST" ]; then
--pidfile "$DEST/docker.pid" \ --pidfile "$DEST/docker.pid" \
&> "$DEST/docker.log" &> "$DEST/docker.log"
) & ) &
trap "source '${MAKEDIR}/.integration-daemon-stop'" EXIT # make sure that if the script exits unexpectedly, we stop this daemon we just started
else else
export DOCKER_HOST="$DOCKER_TEST_HOST" export DOCKER_HOST="$DOCKER_TEST_HOST"
fi fi

2
hack/make/.integration-daemon-stop
View file

@ -1,5 +1,7 @@
#!/bin/bash #!/bin/bash
trap - EXIT # reset EXIT trap applied in .integration-daemon-start
for pidFile in $(find "$DEST" -name docker.pid); do for pidFile in $(find "$DEST" -name docker.pid); do
pid=$(set -x; cat "$pidFile") pid=$(set -x; cat "$pidFile")
( set -x; kill "$pid" ) ( set -x; kill "$pid" )

112
hack/make/build-deb
View file

@ -7,76 +7,64 @@ DEST=$1
( (
source "${MAKEDIR}/.integration-daemon-start" source "${MAKEDIR}/.integration-daemon-start"
# we need to wrap up everything in between integration-daemon-start and # TODO consider using frozen images for the dockercore/builder-deb tags
# integration-daemon-stop to make sure we kill the daemon and don't hang,
# even and especially on test failures
didFail=
if ! {
set -e
# TODO consider using frozen images for the dockercore/builder-deb tags debVersion="${VERSION//-/'~'}"
# if we have a "-dev" suffix or have change in Git, let's make this package version more complex so it works better
if [[ "$VERSION" == *-dev ]] || [ -n "$(git status --porcelain)" ]; then
gitUnix="$(git log -1 --pretty='%at')"
gitDate="$(date --date "@$gitUnix" +'%Y%m%d.%H%M%S')"
gitCommit="$(git log -1 --pretty='%h')"
gitVersion="git${gitDate}.0.${gitCommit}"
# gitVersion is now something like 'git20150128.112847.0.17e840a'
debVersion="$debVersion~$gitVersion"
debVersion="${VERSION//-/'~'}" # $ dpkg --compare-versions 1.5.0 gt 1.5.0~rc1 && echo true || echo false
# if we have a "-dev" suffix or have change in Git, let's make this package version more complex so it works better # true
if [[ "$VERSION" == *-dev ]] || [ -n "$(git status --porcelain)" ]; then # $ dpkg --compare-versions 1.5.0~rc1 gt 1.5.0~git20150128.112847.17e840a && echo true || echo false
gitUnix="$(git log -1 --pretty='%at')" # true
gitDate="$(date --date "@$gitUnix" +'%Y%m%d.%H%M%S')" # $ dpkg --compare-versions 1.5.0~git20150128.112847.17e840a gt 1.5.0~dev~git20150128.112847.17e840a && echo true || echo false
gitCommit="$(git log -1 --pretty='%h')" # true
gitVersion="git${gitDate}.0.${gitCommit}"
# gitVersion is now something like 'git20150128.112847.0.17e840a'
debVersion="$debVersion~$gitVersion"
# $ dpkg --compare-versions 1.5.0 gt 1.5.0~rc1 && echo true || echo false # ie, 1.5.0 > 1.5.0~rc1 > 1.5.0~git20150128.112847.17e840a > 1.5.0~dev~git20150128.112847.17e840a
# true fi
# $ dpkg --compare-versions 1.5.0~rc1 gt 1.5.0~git20150128.112847.17e840a && echo true || echo false
# true
# $ dpkg --compare-versions 1.5.0~git20150128.112847.17e840a gt 1.5.0~dev~git20150128.112847.17e840a && echo true || echo false
# true
# ie, 1.5.0 > 1.5.0~rc1 > 1.5.0~git20150128.112847.17e840a > 1.5.0~dev~git20150128.112847.17e840a debSource="$(awk -F ': ' '$1 == "Source" { print $2; exit }' hack/make/.build-deb/control)"
debMaintainer="$(awk -F ': ' '$1 == "Maintainer" { print $2; exit }' hack/make/.build-deb/control)"
debDate="$(date --rfc-2822)"
# if go-md2man is available, pre-generate the man pages
./docs/man/md2man-all.sh -q || true
# TODO decide if it's worth getting go-md2man in _each_ builder environment to avoid this
# TODO add a configurable knob for _which_ debs to build so we don't have to modify the file or build all of them every time we need to test
for dir in contrib/builder/deb/*/; do
version="$(basename "$dir")"
suite="${version##*-}"
image="dockercore/builder-deb:$version"
if ! docker inspect "$image" &> /dev/null; then
( set -x && docker build -t "$image" "$dir" )
fi fi
debSource="$(awk -F ': ' '$1 == "Source" { print $2; exit }' hack/make/.build-deb/control)" mkdir -p "$DEST/$version"
debMaintainer="$(awk -F ': ' '$1 == "Maintainer" { print $2; exit }' hack/make/.build-deb/control)" cat > "$DEST/$version/Dockerfile.build" <<-EOF
debDate="$(date --rfc-2822)" FROM $image
WORKDIR /usr/src/docker
# if go-md2man is available, pre-generate the man pages COPY . /usr/src/docker
./docs/man/md2man-all.sh -q || true RUN ln -sfv hack/make/.build-deb debian
# TODO decide if it's worth getting go-md2man in _each_ builder environment to avoid this RUN { echo '$debSource (${debVersion}-0~${suite}) $suite; urgency=low'; echo; echo ' * Version: $VERSION'; echo; echo " -- $debMaintainer $debDate"; } > debian/changelog && cat >&2 debian/changelog
RUN dpkg-buildpackage -uc -us
# TODO add a configurable knob for _which_ debs to build so we don't have to modify the file or build all of them every time we need to test EOF
for dir in contrib/builder/deb/*/; do cp -a "$DEST/$version/Dockerfile.build" . # can't use $DEST because it's in .dockerignore...
version="$(basename "$dir")" tempImage="docker-temp/build-deb:$version"
suite="${version##*-}" ( set -x && docker build -t "$tempImage" -f Dockerfile.build . )
docker run --rm "$tempImage" bash -c 'cd .. && tar -c *_*' | tar -xvC "$DEST/$version"
image="dockercore/builder-deb:$version" docker rmi "$tempImage"
if ! docker inspect "$image" &> /dev/null; then done
( set -x && docker build -t "$image" "$dir" )
fi
mkdir -p "$DEST/$version"
cat > "$DEST/$version/Dockerfile.build" <<-EOF
FROM $image
WORKDIR /usr/src/docker
COPY . /usr/src/docker
RUN ln -sfv hack/make/.build-deb debian
RUN { echo '$debSource (${debVersion}-0~${suite}) $suite; urgency=low'; echo; echo ' * Version: $VERSION'; echo; echo " -- $debMaintainer $debDate"; } > debian/changelog && cat >&2 debian/changelog
RUN dpkg-buildpackage -uc -us
EOF
cp -a "$DEST/$version/Dockerfile.build" . # can't use $DEST because it's in .dockerignore...
tempImage="docker-temp/build-deb:$version"
( set -x && docker build -t "$tempImage" -f Dockerfile.build . )
docker run --rm "$tempImage" bash -c 'cd .. && tar -c *_*' | tar -xvC "$DEST/$version"
docker rmi "$tempImage"
done
}; then
didFail=1
fi
# clean up after ourselves # clean up after ourselves
rm -f Dockerfile.build rm -f Dockerfile.build
source "${MAKEDIR}/.integration-daemon-stop" source "${MAKEDIR}/.integration-daemon-stop"
) 2>&1 | tee -a "$DEST/test.log"
[ -z "$didFail" ] # "set -e" ftw
) 2>&1 | tee -a $DEST/test.log

26
hack/make/test-docker-py
View file

@ -7,24 +7,14 @@ DEST=$1
( (
source "${MAKEDIR}/.integration-daemon-start" source "${MAKEDIR}/.integration-daemon-start"
# we need to wrap up everything in between integration-daemon-start and dockerPy='/docker-py'
# integration-daemon-stop to make sure we kill the daemon and don't hang, [ -d "$dockerPy" ] || {
# even and especially on test failures dockerPy="$DEST/docker-py"
didFail= git clone https://github.com/docker/docker-py.git "$dockerPy"
if ! { }
dockerPy='/docker-py'
[ -d "$dockerPy" ] || {
dockerPy="$DEST/docker-py"
git clone https://github.com/docker/docker-py.git "$dockerPy"
}
# exporting PYTHONPATH to import "docker" from our local docker-py # exporting PYTHONPATH to import "docker" from our local docker-py
test_env PYTHONPATH="$dockerPy" python "$dockerPy/tests/integration_test.py" test_env PYTHONPATH="$dockerPy" python "$dockerPy/tests/integration_test.py"
}; then
didFail=1
fi
source "${MAKEDIR}/.integration-daemon-stop" source "${MAKEDIR}/.integration-daemon-stop"
) 2>&1 | tee -a "$DEST/test.log"
[ -z "$didFail" ] # "set -e" ftw
) 2>&1 | tee -a $DEST/test.log

18
hack/make/test-integration-cli
View file

@ -11,21 +11,11 @@ bundle_test_integration_cli() {
( (
source "${MAKEDIR}/.integration-daemon-start" source "${MAKEDIR}/.integration-daemon-start"
# we need to wrap up everything in between integration-daemon-start and source "${MAKEDIR}/.ensure-frozen-images"
# integration-daemon-stop to make sure we kill the daemon and don't hang, source "${MAKEDIR}/.ensure-httpserver"
# even and especially on test failures source "${MAKEDIR}/.ensure-emptyfs"
didFail=
if ! {
source "${MAKEDIR}/.ensure-frozen-images"
source "${MAKEDIR}/.ensure-httpserver"
source "${MAKEDIR}/.ensure-emptyfs"
bundle_test_integration_cli bundle_test_integration_cli
}; then
didFail=1
fi
source "${MAKEDIR}/.integration-daemon-stop" source "${MAKEDIR}/.integration-daemon-stop"
[ -z "$didFail" ] # "set -e" ftw
) 2>&1 | tee -a "$DEST/test.log" ) 2>&1 | tee -a "$DEST/test.log"