Skip to content

Commit

Permalink
Renable code coverage collection in unit tests, including on Travis.
Browse files Browse the repository at this point in the history 
When code coverage is not being collected, just issue a single 'go test'
command, as is already done. Go will internally parallize execution.

When code coverage is being collected, it is necessary to issue separate
'go test' commands for each package, since Go does not support
collecting coverage across packages. Using xargs -P will parallelize
these invocations, however, speeding up test execution.
The number of simultaneous processes to use can be specified with
KUBE_COVERPROCS.

Update Travis config to pass along the number of CPUs to use for running
tests.
  • Loading branch information
@ixdy
ixdy committed Mar 2, 2015
1 parent 148ce12 commit fbd11a1
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 32 deletions.
3 changes: 2 additions & 1 deletion .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ go:

install:
- if ! go get code.google.com/p/go.tools/cmd/cover; then go get golang.org/x/tools/cmd/cover; fi
- go get github.com/mattn/goveralls
- ./hack/travis/install-etcd.sh
- ./hack/verify-gofmt.sh
- ./hack/verify-boilerplate.sh
Expand All @@ -14,7 +15,7 @@ install:
- ./hack/build-go.sh

script:
- KUBE_RACE="-race" KUBE_COVER="-cover -covermode=atomic" KUBE_TIMEOUT='-timeout 60s' ./hack/test-go.sh "" -p=4
- KUBE_RACE="-race" KUBE_COVER="y" KUBE_GOVERALLS_BIN="$HOME/gopath/bin/goveralls" KUBE_TIMEOUT='-timeout 60s' KUBE_COVERPROCS=8 ./hack/test-go.sh -- -p=2
- PATH=$HOME/gopath/bin:./third_party/etcd:$PATH ./hack/test-cmd.sh
- PATH=$HOME/gopath/bin:./third_party/etcd:$PATH ./hack/verify-gendocs.sh
- PATH=$HOME/gopath/bin:./third_party/etcd:$PATH ./hack/test-integration.sh
Expand Down
2 changes: 1 addition & 1 deletion hack/benchmark-go.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ set -o pipefail

KUBE_ROOT=$(dirname "${BASH_SOURCE}")/..

KUBE_COVER=" " KUBE_RACE=" " "${KUBE_ROOT}/hack/test-go.sh" "" -test.run="^X" -benchtime=1s -bench=. -benchmem
KUBE_COVER="" KUBE_RACE=" " "${KUBE_ROOT}/hack/test-go.sh" -- -test.run="^X" -benchtime=1s -bench=. -benchmem
87 changes: 57 additions & 30 deletions hack/test-go.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,22 @@ kube::test::find_dirs() {
-o -wholename './target' \
-o -wholename '*/third_party/*' \
-o -wholename '*/Godeps/*' \
-o -wholename '*/contrib/podex/*' \
-o -wholename '*/contrib/podex/*' \
\) -prune \
\) -name '*_test.go' -print0 | xargs -0n1 dirname | sed 's|^\./||' | sort -u
)
}

kube::test::find_pkgs() {
kube::test::find_dirs | xargs -n1 printf "${KUBE_GO_PACKAGE}/%s\n"
}

# -covermode=atomic becomes default with -race in Go >=1.3
KUBE_TIMEOUT=${KUBE_TIMEOUT:--timeout 120s}
KUBE_COVER=${KUBE_COVER:-} # use KUBE_COVER="-cover -covermode=atomic" for full coverage
KUBE_COVER=${KUBE_COVER:-n} # set to 'y' to enable coverage collection
KUBE_COVERMODE=${KUBE_COVERMODE:-atomic}
# How many 'go test' instances to run simultaneously when running tests in
# coverage mode.
KUBE_COVERPROCS=${KUBE_COVERPROCS:-4}
KUBE_RACE=${KUBE_RACE:-} # use KUBE_RACE="-race" to enable race testing
# Set to the goveralls binary path to report coverage results to Coveralls.io.
KUBE_GOVERALLS_BIN=${KUBE_GOVERALLS_BIN:-}

kube::test::usage() {
kube::log::usage_from_stdin <<EOF
Expand Down Expand Up @@ -102,8 +104,13 @@ for arg; do
testcases+=("${arg}")
fi
done
if [[ ${#testcases[@]} -eq 0 ]]; then
testcases=($(kube::test::find_dirs))
fi
set -- "${testcases[@]+${testcases[@]}}"

# TODO: this should probably be refactored to avoid code duplication with the
# coverage version.
if [[ $iterations -gt 1 ]]; then
if [[ $# -eq 0 ]]; then
set -- $(kube::test::find_dirs)
Expand Down Expand Up @@ -135,33 +142,53 @@ if [[ $iterations -gt 1 ]]; then
fi
fi

if [[ -n "${1-}" ]]; then
cover_report_dir=""
if [[ -n "${KUBE_COVER}" ]]; then
cover_report_dir="/tmp/k8s_coverage/$(kube::util::sortable_date)"
kube::log::status "Saving coverage output in '${cover_report_dir}'"
fi

for arg; do
trap 'exit 1' SIGINT
pkg=${KUBE_GO_PACKAGE}/${arg}

cover_params=()
if [[ -n "${KUBE_COVER}" ]]; then
mkdir -p "${cover_report_dir}/${arg}"
cover_params=(${KUBE_COVER} -coverprofile="${cover_report_dir}/${arg}/coverage.out")
fi
# If we're not collecting coverage, run all requested tests with one 'go test'
# command, which is much faster.
if [[ ! ${KUBE_COVER} =~ ^[yY]$ ]]; then
kube::log::status "Running unit tests without code coverage"
go test "${goflags[@]:+${goflags[@]}}" \
${KUBE_RACE} ${KUBE_TIMEOUT} "${@+${@/#/${KUBE_GO_PACKAGE}/}}"
exit 0
fi

# Create coverage report directories.
cover_report_dir="/tmp/k8s_coverage/$(kube::util::sortable_date)"
cover_profile="coverage.out" # Name for each individual coverage profile
kube::log::status "Saving coverage output in '${cover_report_dir}'"
mkdir -p "${@+${@/#/${cover_report_dir}/}}"

# Run all specified tests, collecting coverage results. Go currently doesn't
# support collecting coverage across multiple packages at once, so we must issue
# separate 'go test' commands for each package and then combine at the end.
# To speed things up considerably, we can at least use xargs -P to run multiple
# 'go test' commands at once.
printf "%s\n" "${@}" | xargs -I{} -n1 -P${KUBE_COVERPROCS} \
go test "${goflags[@]:+${goflags[@]}}" \
${KUBE_RACE} \
${KUBE_TIMEOUT} \
-cover -covermode="${KUBE_COVERMODE}" \
-coverprofile="${cover_report_dir}/{}/${cover_profile}" \
"${cover_params[@]+${cover_params[@]}}" \
"${pkg}"
done
exit 0
"${KUBE_GO_PACKAGE}/{}"

combined_cover_profile="${cover_report_dir}/combined-coverage.out"
{
# The combined coverage profile needs to start with a line indicating which
# coverage mode was used (set, count, or atomic). This line is included in
# each of the coverage profiles generated when running 'go test -cover', but
# we strip these lines out when combining so that there's only one.
echo "mode: ${KUBE_COVERMODE}"

# Include all coverage reach data in the combined profile, but exclude the
# 'mode' lines, as there should be only one.
find "${cover_report_dir}" -name "${cover_profile}" |
xargs -r grep -h -v "^mode:" || true
} >"${combined_cover_profile}"

coverage_html_file="${cover_report_dir}/combined-coverage.html"
go tool cover -html="${combined_cover_profile}" -o="${coverage_html_file}"
kube::log::status "Combined coverage report: ${coverage_html_file}"

if [[ -x "${KUBE_GOVERALLS_BIN}" ]]; then
${KUBE_GOVERALLS_BIN} -coverprofile="${combined_cover_profile}" || true
fi

kube::test::find_pkgs | xargs go test "${goflags[@]:+${goflags[@]}}" \
${KUBE_RACE} \
${KUBE_TIMEOUT} \
${KUBE_COVER}

0 comments on commit fbd11a1

Please sign in to comment.