test 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641
  1. #!/usr/bin/env bash
  2. #
  3. # Run all etcd tests
  4. # ./test
  5. # ./test -v
  6. #
  7. #
  8. # Run specified test pass
  9. #
  10. # $ PASSES=unit ./test
  11. # $ PASSES=integration ./test
  12. #
  13. #
  14. # Run tests for one package
  15. # Each pass has different default timeout, if you just run tests in one package or 1 test case then you can set TIMEOUT
  16. # flag for different expectation
  17. #
  18. # $ PASSES=unit PKG=./wal TIMEOUT=1m ./test
  19. # $ PASSES=integration PKG=client/integration TIMEOUT=1m ./test
  20. #
  21. #
  22. # Run specified unit tests in one package
  23. # To run all the tests with prefix of "TestNew", set "TESTCASE=TestNew ";
  24. # to run only "TestNew", set "TESTCASE="\bTestNew\b""
  25. #
  26. # $ PASSES=unit PKG=./wal TESTCASE=TestNew TIMEOUT=1m ./test
  27. # $ PASSES=unit PKG=./wal TESTCASE="\bTestNew\b" TIMEOUT=1m ./test
  28. # $ PASSES=integration PKG=client/integration TESTCASE="\bTestV2NoRetryEOF\b" TIMEOUT=1m ./test
  29. #
  30. #
  31. # Run code coverage
  32. # COVERDIR must either be a absolute path or a relative path to the etcd root
  33. # $ COVERDIR=coverage PASSES="build_cov cov" ./test
  34. set -e
  35. source ./build
  36. # build before setting up test GOPATH
  37. if [[ "${PASSES}" == *"functional"* ]]; then
  38. ./functional/build
  39. fi
  40. if [ -z "$PASSES" ]; then
  41. PASSES="fmt bom dep build unit"
  42. fi
  43. USERPKG=${PKG:-}
  44. # Invoke ./tests/cover.test.bash for HTML output
  45. COVER=${COVER:-"-cover"}
  46. # Hack: gofmt ./ will recursively check the .git directory. So use *.go for gofmt.
  47. IGNORE_PKGS="(vendor/|etcdserverpb|rafttest|gopath.proto|v3lockpb|v3electionpb)"
  48. INTEGRATION_PKGS="(integration|tests/e2e|contrib|functional)"
  49. # all github.com/coreos/etcd/whatever pkgs that are not auto-generated / tools
  50. # shellcheck disable=SC1117
  51. PKGS=$(find . -name \*.go | while read -r a; do dirname "$a"; done | sort | uniq | grep -vE "$IGNORE_PKGS" | grep -vE "(tools/|contrib/|tests/e2e|pb)" | sed "s|\.|${REPO_PATH}|g" | xargs echo)
  52. # pkg1,pkg2,pkg3
  53. PKGS_COMMA=${PKGS// /,}
  54. # shellcheck disable=SC1117
  55. TEST_PKGS=$(find . -name \*_test.go | while read -r a; do dirname "$a"; done | sort | uniq | grep -vE "$IGNORE_PKGS" | sed "s|\./||g")
  56. # shellcheck disable=SC1117
  57. FORMATTABLE=$(find . -name \*.go | while read -r a; do echo "$(dirname "$a")/*.go"; done | sort | uniq | grep -vE "$IGNORE_PKGS" | sed "s|\./||g")
  58. TESTABLE_AND_FORMATTABLE=$(echo "$TEST_PKGS" | grep -vE "$INTEGRATION_PKGS")
  59. # check if user provided PKG override
  60. if [ -z "${USERPKG}" ]; then
  61. TEST=$TESTABLE_AND_FORMATTABLE
  62. FMT=$FORMATTABLE
  63. else
  64. # strip out leading dotslashes and trailing slashes from PKG=./foo/
  65. TEST=${USERPKG/#./}
  66. TEST=${TEST/#\//}
  67. TEST=${TEST/%\//}
  68. # only run gofmt on packages provided by user
  69. FMT="$TEST"
  70. fi
  71. # shellcheck disable=SC2206
  72. FMT=($FMT)
  73. # prepend REPO_PATH to each local package
  74. split=$TEST
  75. TEST=""
  76. for a in $split; do TEST="$TEST ${REPO_PATH}/${a}"; done
  77. # shellcheck disable=SC2206
  78. TEST=($TEST)
  79. # TODO: 'client' pkg fails with gosimple from generated files
  80. # TODO: 'rafttest' is failing with unused
  81. STATIC_ANALYSIS_PATHS=$(find . -name \*.go | while read -r a; do dirname "$a"; done | sort | uniq | grep -vE "$IGNORE_PKGS" | grep -v 'client')
  82. # shellcheck disable=SC2206
  83. STATIC_ANALYSIS_PATHS=($STATIC_ANALYSIS_PATHS)
  84. if [ -z "$GOARCH" ]; then
  85. GOARCH=$(go env GOARCH);
  86. fi
  87. # determine the number of CPUs to use for Go tests
  88. TEST_CPUS="1,2,4"
  89. if [ ! -z "${CPU}" ]; then
  90. TEST_CPUS="${CPU}"
  91. fi
  92. echo "Running with" "${TEST_CPUS}"
  93. # determine whether target supports race detection
  94. if [ "$GOARCH" == "amd64" ]; then
  95. RACE="--race"
  96. fi
  97. RUN_ARG=""
  98. if [ ! -z "${TESTCASE}" ]; then
  99. RUN_ARG="-run=${TESTCASE}"
  100. fi
  101. function unit_pass {
  102. echo "Running unit tests..."
  103. GO_TEST_FLAG=""
  104. if [ "${VERBOSE}" == "1" ]; then
  105. GO_TEST_FLAG="-v"
  106. fi
  107. if [ "${VERBOSE}" == "2" ]; then
  108. GO_TEST_FLAG="-v"
  109. export CLIENT_DEBUG=1
  110. fi
  111. if [ "${RUN_ARG}" == "" ]; then
  112. RUN_ARG="-run=Test"
  113. fi
  114. # check if user provided time out, especially useful when just run one test case
  115. # expectation could be different
  116. USERTIMEOUT=""
  117. if [ -z "${TIMEOUT}" ]; then
  118. USERTIMEOUT="3m"
  119. else
  120. USERTIMEOUT="${TIMEOUT}"
  121. fi
  122. go test ${GO_TEST_FLAG} -timeout "${USERTIMEOUT}" "${COVER}" ${RACE} -cpu "${TEST_CPUS}" ${RUN_ARG} "$@" "${TEST[@]}"
  123. }
  124. function integration_pass {
  125. echo "Running integration tests..."
  126. # check if user provided time out, especially useful when just run one test case
  127. # expectation could be different
  128. USERTIMEOUT=""
  129. if [ -z "${TIMEOUT}" ]; then
  130. USERTIMEOUT="20m"
  131. else
  132. USERTIMEOUT="${TIMEOUT}"
  133. fi
  134. # if TESTCASE and PKG set, run specified test case in specified PKG
  135. # if TESTCASE set, PKG not set, run specified test case in all integration and integration_extra packages
  136. # if TESTCASE not set, PKG set, run all test cases in specified package
  137. # if TESTCASE not set, PKG not set, run all tests in all integration and integration_extra packages
  138. if [ -z "${TESTCASE}" ] && [ -z "${USERPKG}" ]; then
  139. go test -timeout "${USERTIMEOUT}" -v -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/integration"
  140. integration_extra "$@"
  141. else
  142. if [ -z "${USERPKG}" ]; then
  143. INTEGTESTPKG=("${REPO_PATH}/integration"
  144. "${REPO_PATH}/client/integration"
  145. "${REPO_PATH}/clientv3/integration"
  146. "${REPO_PATH}/contrib/raftexample"
  147. "${REPO_PATH}/store")
  148. else
  149. INTEGTESTPKG=("${TEST[@]}")
  150. fi
  151. go test -timeout "${USERTIMEOUT}" -v -cpu "${TEST_CPUS}" "${RUN_ARG}" "$@" "${INTEGTESTPKG[@]}"
  152. fi
  153. }
  154. function integration_extra {
  155. go test -timeout 1m -v ${RACE} -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/client/integration"
  156. go test -timeout 25m -v ${RACE} -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/clientv3/integration"
  157. go test -timeout 1m -v -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/contrib/raftexample"
  158. go test -timeout 5m -v ${RACE} -tags v2v3 "$@" "${REPO_PATH}/etcdserver/v2store"
  159. go test -timeout 1m -v ${RACE} -cpu "${TEST_CPUS}" -run=Example "$@" "${TEST[@]}"
  160. }
  161. function functional_pass {
  162. # Clean up any data and logs from previous runs
  163. rm -rf /tmp/etcd-functional-* /tmp/etcd-functional-*.backup
  164. for a in 1 2 3; do
  165. ./bin/etcd-agent --network tcp --address 127.0.0.1:${a}9027 &
  166. pid="$!"
  167. agent_pids="${agent_pids} $pid"
  168. done
  169. for a in 1 2 3; do
  170. echo "Waiting for 'etcd-agent' on ${a}9027..."
  171. while ! nc -z localhost ${a}9027; do
  172. sleep 1
  173. done
  174. done
  175. echo "functional test START!"
  176. ./bin/etcd-tester --config ./functional.yaml && echo "'etcd-tester' succeeded"
  177. ETCD_TESTER_EXIT_CODE=$?
  178. echo "ETCD_TESTER_EXIT_CODE:" ${ETCD_TESTER_EXIT_CODE}
  179. # shellcheck disable=SC2206
  180. agent_pids=($agent_pids)
  181. kill -s TERM "${agent_pids[@]}" || true
  182. if [[ "${ETCD_TESTER_EXIT_CODE}" -ne "0" ]]; then
  183. echo "--- FAIL: exit code" ${ETCD_TESTER_EXIT_CODE}
  184. exit ${ETCD_TESTER_EXIT_CODE}
  185. fi
  186. echo "functional test PASS!"
  187. }
  188. function cov_pass {
  189. echo "Running code coverage..."
  190. # install gocovmerge before running code coverage from github.com/wadey/gocovmerge
  191. # gocovmerge merges coverage files
  192. if ! which gocovmerge >/dev/null; then
  193. echo "gocovmerge not installed"
  194. exit 255
  195. fi
  196. if [ -z "$COVERDIR" ]; then
  197. echo "COVERDIR undeclared"
  198. exit 255
  199. fi
  200. if [ ! -f "bin/etcd_test" ]; then
  201. echo "etcd_test binary not found"
  202. exit 255
  203. fi
  204. mkdir -p "$COVERDIR"
  205. # run code coverage for unit and integration tests
  206. GOCOVFLAGS="-covermode=set -coverpkg ${PKGS_COMMA} -v -timeout 20m"
  207. # shellcheck disable=SC2206
  208. GOCOVFLAGS=($GOCOVFLAGS)
  209. failed=""
  210. for t in $(echo "${TEST_PKGS}" | grep -vE "(tests/e2e|functional)"); do
  211. tf=$(echo "$t" | tr / _)
  212. # cache package compilation data for faster repeated builds
  213. go test "${GOCOVFLAGS[@]}" -i "${REPO_PATH}/$t" || true
  214. # uses -run=Test to skip examples because clientv3/ example tests will leak goroutines
  215. go test "${GOCOVFLAGS[@]}" -run=Test -coverprofile "$COVERDIR/${tf}.coverprofile" "${REPO_PATH}/$t" || failed="$failed $t"
  216. done
  217. # v2v3 tests
  218. go test -tags v2v3 "${GOCOVFLAGS[@]}" -coverprofile "$COVERDIR/store-v2v3.coverprofile" "${REPO_PATH}/clientv3/integration" || failed="$failed store-v2v3"
  219. # proxy tests
  220. go test -tags cluster_proxy "${GOCOVFLAGS[@]}" -coverprofile "$COVERDIR/proxy_integration.coverprofile" "${REPO_PATH}/integration" || failed="$failed proxy-integration"
  221. go test -tags cluster_proxy "${GOCOVFLAGS[@]}" -coverprofile "$COVERDIR/proxy_clientv3.coverprofile" "${REPO_PATH}/clientv3/integration" || failed="$failed proxy-clientv3/integration"
  222. # run code coverage for e2e tests
  223. # use 30m timeout because e2e coverage takes longer
  224. # due to many tests cause etcd process to wait
  225. # on leadership transfer timeout during gracefully shutdown
  226. echo Testing tests/e2e without proxy...
  227. go test -tags cov -timeout 30m -v "${REPO_PATH}/tests/e2e" || failed="$failed tests/e2e"
  228. echo Testing tests/e2e with proxy...
  229. go test -tags "cov cluster_proxy" -timeout 30m -v "${REPO_PATH}/tests/e2e" || failed="$failed tests/e2e-proxy"
  230. # incrementally merge to get coverage data even if some coverage files are corrupted
  231. # optimistically assume etcdserver package's coverage file is OK since gocovmerge
  232. # expects to start with a non-empty file
  233. cp "$COVERDIR"/etcdserver.coverprofile "$COVERDIR"/cover.out
  234. for f in "$COVERDIR"/*.coverprofile; do
  235. echo "merging test coverage file ${f}"
  236. gocovmerge "$f" "$COVERDIR"/cover.out >"$COVERDIR"/cover.tmp || failed="$failed $f"
  237. if [ -s "$COVERDIR"/cover.tmp ]; then
  238. mv "$COVERDIR"/cover.tmp "$COVERDIR"/cover.out
  239. fi
  240. done
  241. # strip out generated files (using GNU-style sed)
  242. sed --in-place '/generated.go/d' "$COVERDIR"/cover.out || true
  243. # held failures to generate the full coverage file, now fail
  244. if [ -n "$failed" ]; then
  245. for f in $failed; do
  246. echo "--- FAIL:" "$f"
  247. done
  248. exit 255
  249. fi
  250. }
  251. function e2e_pass {
  252. echo "Running e2e tests..."
  253. # check if user provided time out, especially useful when just run one test case
  254. # expectation could be different
  255. USERTIMEOUT=""
  256. if [ -z "${TIMEOUT}" ]; then
  257. USERTIMEOUT="20m"
  258. else
  259. USERTIMEOUT="${TIMEOUT}"
  260. fi
  261. go test -timeout "${USERTIMEOUT}" -v -cpu "${TEST_CPUS}" "${RUN_ARG}" "$@" "${REPO_PATH}/tests/e2e"
  262. }
  263. function integration_e2e_pass {
  264. echo "Running integration and e2e tests..."
  265. go test -timeout 20m -v -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/tests/e2e" &
  266. e2epid="$!"
  267. go test -timeout 20m -v -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/integration" &
  268. intpid="$!"
  269. wait $e2epid
  270. wait $intpid
  271. integration_extra "$@"
  272. }
  273. function grpcproxy_pass {
  274. go test -timeout 20m -v ${RACE} -tags cluster_proxy -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/integration"
  275. go test -timeout 20m -v ${RACE} -tags cluster_proxy -cpu "${TEST_CPUS}" "$@" "${REPO_PATH}/clientv3/integration"
  276. go test -timeout 20m -v -tags cluster_proxy "$@" "${REPO_PATH}/tests/e2e"
  277. }
  278. function release_pass {
  279. rm -f ./bin/etcd-last-release
  280. # to grab latest patch release; bump this up for every minor release
  281. UPGRADE_VER=$(git tag -l --sort=-version:refname "v3.3.*" | head -1)
  282. if [ -n "$MANUAL_VER" ]; then
  283. # in case, we need to test against different version
  284. UPGRADE_VER=$MANUAL_VER
  285. fi
  286. if [[ -z ${UPGRADE_VER} ]]; then
  287. UPGRADE_VER="v3.3.0"
  288. echo "fallback to" ${UPGRADE_VER}
  289. fi
  290. local file="etcd-$UPGRADE_VER-linux-$GOARCH.tar.gz"
  291. echo "Downloading $file"
  292. set +e
  293. curl --fail -L "https://github.com/coreos/etcd/releases/download/$UPGRADE_VER/$file" -o "/tmp/$file"
  294. local result=$?
  295. set -e
  296. case $result in
  297. 0) ;;
  298. *) echo "--- FAIL:" ${result}
  299. exit $result
  300. ;;
  301. esac
  302. tar xzvf "/tmp/$file" -C /tmp/ --strip-components=1
  303. mkdir -p ./bin
  304. mv /tmp/etcd ./bin/etcd-last-release
  305. }
  306. function shellcheck_pass {
  307. if which shellcheck >/dev/null; then
  308. shellcheckResult=$(shellcheck -fgcc build test scripts/*.sh 2>&1 || true)
  309. if [ -n "${shellcheckResult}" ]; then
  310. echo -e "shellcheck checking failed:\\n${shellcheckResult}"
  311. exit 255
  312. fi
  313. fi
  314. }
  315. function markdown_you_pass {
  316. # eschew you
  317. yous=$(find . -name \*.md -exec grep -E --color "[Yy]ou[r]?[ '.,;]" {} + | grep -v /v2/ || true)
  318. if [ ! -z "$yous" ]; then
  319. echo -e "found 'you' in documentation:\\n${yous}"
  320. exit 255
  321. fi
  322. }
  323. function markdown_marker_pass {
  324. # TODO: check other markdown files when marker handles headers with '[]'
  325. if which marker >/dev/null; then
  326. markerResult=$(marker --skip-http --root ./Documentation 2>&1 || true)
  327. if [ -n "${markerResult}" ]; then
  328. echo -e "marker checking failed:\\n${markerResult}"
  329. exit 255
  330. fi
  331. else
  332. echo "Skipping marker..."
  333. fi
  334. }
  335. function goword_pass {
  336. if which goword >/dev/null; then
  337. # get all go files to process
  338. gofiles=$(find "${FMT[@]}" -iname '*.go' 2>/dev/null)
  339. # shellcheck disable=SC2206
  340. gofiles_all=($gofiles)
  341. # ignore tests and protobuf files
  342. # shellcheck disable=SC1117
  343. gofiles=$(echo "${gofiles_all[@]}" | sort | uniq | sed "s/ /\n/g" | grep -vE "(\\_test.go|\\.pb\\.go)")
  344. # shellcheck disable=SC2206
  345. gofiles=($gofiles)
  346. # only check for broken exported godocs
  347. gowordRes=$(goword -use-spell=false "${gofiles[@]}" | grep godoc-export | sort)
  348. if [ ! -z "$gowordRes" ]; then
  349. echo -e "goword checking failed:\\n${gowordRes}"
  350. exit 255
  351. fi
  352. # check some spelling
  353. gowordRes=$(goword -ignore-file=.words clientv3/{*,*/*}.go 2>&1 | grep spell | sort)
  354. if [ ! -z "$gowordRes" ]; then
  355. echo -e "goword checking failed:\\n${gowordRes}"
  356. exit 255
  357. fi
  358. else
  359. echo "Skipping goword..."
  360. fi
  361. }
  362. function gofmt_pass {
  363. fmtRes=$(gofmt -l -s -d "${FMT[@]}")
  364. if [ -n "${fmtRes}" ]; then
  365. echo -e "gofmt checking failed:\\n${fmtRes}"
  366. exit 255
  367. fi
  368. }
  369. function govet_pass {
  370. vetRes=$(go vet "${TEST[@]}")
  371. if [ -n "${vetRes}" ]; then
  372. echo -e "govet checking failed:\\n${vetRes}"
  373. exit 255
  374. fi
  375. }
  376. function govet_shadow_pass {
  377. fmtpkgs=$(for a in "${FMT[@]}"; do dirname "$a"; done | sort | uniq | grep -v "\\.")
  378. # shellcheck disable=SC2206
  379. fmtpkgs=($fmtpkgs)
  380. vetRes=$(go tool vet -all -shadow "${fmtpkgs[@]}" 2>&1 | grep -v '/gw/' || true)
  381. if [ -n "${vetRes}" ]; then
  382. echo -e "govet -all -shadow checking failed:\\n${vetRes}"
  383. exit 255
  384. fi
  385. }
  386. function gosimple_pass {
  387. if which gosimple >/dev/null; then
  388. gosimpleResult=$(gosimple "${STATIC_ANALYSIS_PATHS[@]}" 2>&1 || true)
  389. if [ -n "${gosimpleResult}" ]; then
  390. echo -e "gosimple checking failed:\\n${gosimpleResult}"
  391. exit 255
  392. fi
  393. else
  394. echo "Skipping gosimple..."
  395. fi
  396. }
  397. function unused_pass {
  398. if which unused >/dev/null; then
  399. unusedResult=$(unused "${STATIC_ANALYSIS_PATHS[@]}" 2>&1 || true)
  400. if [ -n "${unusedResult}" ]; then
  401. echo -e "unused checking failed:\\n${unusedResult}"
  402. exit 255
  403. fi
  404. else
  405. echo "Skipping unused..."
  406. fi
  407. }
  408. function staticcheck_pass {
  409. if which staticcheck >/dev/null; then
  410. staticcheckResult=$(staticcheck "${STATIC_ANALYSIS_PATHS[@]}" 2>&1 || true)
  411. if [ -n "${staticcheckResult}" ]; then
  412. # TODO: resolve these after go1.8 migration
  413. # See https://github.com/dominikh/go-tools/tree/master/cmd/staticcheck
  414. STATIC_CHECK_MASK="SA(1012|1019|2002)"
  415. if echo "${staticcheckResult}" | grep -vE "$STATIC_CHECK_MASK"; then
  416. echo -e "staticcheck checking failed:\\n${staticcheckResult}"
  417. exit 255
  418. else
  419. suppressed=$(echo "${staticcheckResult}" | sed 's/ /\n/g' | grep "(SA" | sort | uniq -c)
  420. echo -e "staticcheck suppressed warnings:\\n${suppressed}"
  421. fi
  422. fi
  423. else
  424. echo "Skipping staticcheck..."
  425. fi
  426. }
  427. function ineffassign_pass {
  428. if which ineffassign >/dev/null; then
  429. ineffassignResult=$(ineffassign "${STATIC_ANALYSIS_PATHS[@]}" 2>&1 || true)
  430. if [ -n "${ineffassignResult}" ]; then
  431. echo -e "ineffassign checking failed:\\n${ineffassignResult}"
  432. exit 255
  433. fi
  434. else
  435. echo "Skipping ineffassign..."
  436. fi
  437. }
  438. function nakedret_pass {
  439. if which nakedret >/dev/null; then
  440. nakedretResult=$(nakedret "${STATIC_ANALYSIS_PATHS[@]}" 2>&1 || true)
  441. if [ -n "${nakedretResult}" ]; then
  442. echo -e "nakedret checking failed:\\n${nakedretResult}"
  443. exit 255
  444. fi
  445. else
  446. echo "Skipping nakedret..."
  447. fi
  448. }
  449. function license_header_pass {
  450. licRes=""
  451. files=$(find . -type f -iname '*.go' ! -path './vendor/*' ! -path './gopath.proto/*')
  452. for file in $files; do
  453. if ! head -n3 "${file}" | grep -Eq "(Copyright|generated|GENERATED)" ; then
  454. licRes="${licRes}"$(echo -e " ${file}")
  455. fi
  456. done
  457. if [ -n "${licRes}" ]; then
  458. echo -e "license header checking failed:\\n${licRes}"
  459. exit 255
  460. fi
  461. }
  462. function receiver_name_pass {
  463. # shellcheck disable=SC1117
  464. recvs=$(grep 'func ([^*]' {*,*/*,*/*/*}.go | grep -Ev "(generated|pb/)" | tr ':' ' ' | \
  465. awk ' { print $2" "$3" "$4" "$1 }' | sed "s/[a-zA-Z\.]*go//g" | sort | uniq | \
  466. grep -Ev "(Descriptor|Proto|_)" | awk ' { print $3" "$4 } ' | sort | uniq -c | grep -v ' 1 ' | awk ' { print $2 } ')
  467. if [ -n "${recvs}" ]; then
  468. # shellcheck disable=SC2206
  469. recvs=($recvs)
  470. for recv in "${recvs[@]}"; do
  471. echo "Mismatched receiver for $recv..."
  472. grep "$recv" "${FMT[@]}" | grep 'func ('
  473. done
  474. exit 255
  475. fi
  476. }
  477. function commit_title_pass {
  478. git log --oneline "$(git merge-base HEAD master)"...HEAD | while read -r l; do
  479. commitMsg=$(echo "$l" | cut -f2- -d' ')
  480. if [[ "$commitMsg" == Merge* ]]; then
  481. # ignore "Merge pull" commits
  482. continue
  483. fi
  484. if [[ "$commitMsg" == Revert* ]]; then
  485. # ignore revert commits
  486. continue
  487. fi
  488. pkgPrefix=$(echo "$commitMsg" | cut -f1 -d':')
  489. spaceCommas=$(echo "$commitMsg" | sed 's/ /\n/g' | grep -c ',$' || echo 0)
  490. commaSpaces=$(echo "$commitMsg" | sed 's/,/\n/g' | grep -c '^ ' || echo 0)
  491. if [[ $(echo "$commitMsg" | grep -c ":..*") == 0 || "$commitMsg" == "$pkgPrefix" || "$spaceCommas" != "$commaSpaces" ]]; then
  492. echo "$l"...
  493. echo "Expected commit title format '<package>{\", \"<package>}: <description>'"
  494. echo "Got: $l"
  495. exit 255
  496. fi
  497. done
  498. }
  499. function fmt_pass {
  500. toggle_failpoints disable
  501. for p in shellcheck \
  502. markdown_you \
  503. markdown_marker \
  504. goword \
  505. gofmt \
  506. govet \
  507. govet_shadow \
  508. gosimple \
  509. unused \
  510. staticcheck \
  511. ineffassign \
  512. nakedret \
  513. license_header \
  514. receiver_name \
  515. commit_title \
  516. ; do
  517. echo "'$p' started at $(date)"
  518. "${p}"_pass "$@"
  519. echo "'$p' completed at $(date)"
  520. done
  521. }
  522. function bom_pass {
  523. if ! which license-bill-of-materials >/dev/null; then
  524. return
  525. fi
  526. echo "Checking bill of materials..."
  527. license-bill-of-materials \
  528. --override-file bill-of-materials.override.json \
  529. github.com/coreos/etcd github.com/coreos/etcd/etcdctl >bom-now.json || true
  530. if ! diff bill-of-materials.json bom-now.json; then
  531. echo "vendored licenses do not match given bill of materials"
  532. exit 255
  533. fi
  534. rm bom-now.json
  535. }
  536. function dep_pass {
  537. echo "Checking package dependencies..."
  538. # don't pull in etcdserver package
  539. pushd clientv3 >/dev/null
  540. badpkg="(etcdserver$|mvcc$|backend$|grpc-gateway)"
  541. deps=$(go list -f '{{ .Deps }}' | sed 's/ /\n/g' | grep -E "${badpkg}" || echo "")
  542. popd >/dev/null
  543. if [ ! -z "$deps" ]; then
  544. echo -e "clientv3 has masked dependencies:\\n${deps}"
  545. exit 255
  546. fi
  547. }
  548. function build_cov_pass {
  549. out="bin"
  550. if [ -n "${BINDIR}" ]; then out="${BINDIR}"; fi
  551. go test -tags cov -c -covermode=set -coverpkg="$PKGS_COMMA" -o "${out}/etcd_test"
  552. go test -tags cov -c -covermode=set -coverpkg="$PKGS_COMMA" -o "${out}/etcdctl_test" "${REPO_PATH}/etcdctl"
  553. }
  554. # fail fast on static tests
  555. function build_pass {
  556. echo "Checking build..."
  557. GO_BUILD_FLAGS="-v" etcd_build
  558. GO_BUILD_FLAGS="-v" tools_build
  559. }
  560. for pass in $PASSES; do
  561. echo "Starting '$pass' pass at $(date)"
  562. "${pass}"_pass "$@"
  563. echo "Finished '$pass' pass at $(date)"
  564. done
  565. echo "Success"