blob: 2d79b1c6942422e608d146afce47b5d8432b3ad9 [file] [log] [blame]
khenaidooac637102019-01-14 15:44:34 -05001#!/bin/bash
2
3if [[ `uname -a` = *"Darwin"* ]]; then
4 echo "It seems you are running on Mac. This script does not work on Mac. See https://github.com/grpc/grpc-go/issues/2047"
5 exit 1
6fi
7
8set -ex # Exit on error; debugging enabled.
9set -o pipefail # Fail a pipe if any sub-command fails.
10
11die() {
12 echo "$@" >&2
13 exit 1
14}
15
khenaidooac637102019-01-14 15:44:34 -050016fail_on_output() {
17 tee /dev/stderr | (! read)
18}
19
William Kurkiandaa6bb22019-03-07 12:26:28 -050020# Check to make sure it's safe to modify the user's git repo.
21git status --porcelain | fail_on_output
22
23# Undo any edits made by this script.
24cleanup() {
25 git reset --hard HEAD
26}
27trap cleanup EXIT
28
khenaidooac637102019-01-14 15:44:34 -050029PATH="${GOPATH}/bin:${GOROOT}/bin:${PATH}"
30
31if [[ "$1" = "-install" ]]; then
32 # Check for module support
33 if go help mod >& /dev/null; then
34 go install \
35 golang.org/x/lint/golint \
36 golang.org/x/tools/cmd/goimports \
37 honnef.co/go/tools/cmd/staticcheck \
38 github.com/client9/misspell/cmd/misspell \
39 github.com/golang/protobuf/protoc-gen-go
40 else
41 # Ye olde `go get` incantation.
42 # Note: this gets the latest version of all tools (vs. the pinned versions
43 # with Go modules).
44 go get -u \
45 golang.org/x/lint/golint \
46 golang.org/x/tools/cmd/goimports \
47 honnef.co/go/tools/cmd/staticcheck \
48 github.com/client9/misspell/cmd/misspell \
49 github.com/golang/protobuf/protoc-gen-go
50 fi
51 if [[ -z "${VET_SKIP_PROTO}" ]]; then
52 if [[ "${TRAVIS}" = "true" ]]; then
53 PROTOBUF_VERSION=3.3.0
54 PROTOC_FILENAME=protoc-${PROTOBUF_VERSION}-linux-x86_64.zip
55 pushd /home/travis
56 wget https://github.com/google/protobuf/releases/download/v${PROTOBUF_VERSION}/${PROTOC_FILENAME}
57 unzip ${PROTOC_FILENAME}
58 bin/protoc --version
59 popd
60 elif ! which protoc > /dev/null; then
61 die "Please install protoc into your path"
62 fi
63 fi
64 exit 0
65elif [[ "$#" -ne 0 ]]; then
66 die "Unknown argument(s): $*"
67fi
68
69# - Ensure all source files contain a copyright message.
Scott Baker8461e152019-10-01 14:44:30 -070070(! git grep -L "\(Copyright [0-9]\{4,\} gRPC authors\)\|DO NOT EDIT" -- '*.go')
khenaidooac637102019-01-14 15:44:34 -050071
Stephane Barbarie260a5632019-02-26 16:12:49 -050072# - Make sure all tests in grpc and grpc/test use leakcheck via Teardown.
73(! grep 'func Test[^(]' *_test.go)
74(! grep 'func Test[^(]' test/*.go)
75
khenaidooac637102019-01-14 15:44:34 -050076# - Do not import math/rand for real library code. Use internal/grpcrand for
77# thread safety.
Scott Baker8461e152019-10-01 14:44:30 -070078git grep -l '"math/rand"' -- "*.go" 2>&1 | (! grep -v '^examples\|^stress\|grpcrand\|wrr_test')
khenaidooac637102019-01-14 15:44:34 -050079
80# - Ensure all ptypes proto packages are renamed when importing.
Scott Baker8461e152019-10-01 14:44:30 -070081(! git grep "\(import \|^\s*\)\"github.com/golang/protobuf/ptypes/" -- "*.go")
khenaidooac637102019-01-14 15:44:34 -050082
83# - Check imports that are illegal in appengine (until Go 1.11).
84# TODO: Remove when we drop Go 1.10 support
85go list -f {{.Dir}} ./... | xargs go run test/go_vet/vet.go
86
87# - gofmt, goimports, golint (with exceptions for generated code), go vet.
88gofmt -s -d -l . 2>&1 | fail_on_output
Scott Baker8461e152019-10-01 14:44:30 -070089goimports -l . 2>&1 | (! grep -vE "(_mock|\.pb)\.go") | fail_on_output
khenaidooac637102019-01-14 15:44:34 -050090golint ./... 2>&1 | (! grep -vE "(_mock|\.pb)\.go:")
Scott Baker8461e152019-10-01 14:44:30 -070091go vet -all .
khenaidooac637102019-01-14 15:44:34 -050092
93# - Check that generated proto files are up to date.
94if [[ -z "${VET_SKIP_PROTO}" ]]; then
95 PATH="/home/travis/bin:${PATH}" make proto && \
96 git status --porcelain 2>&1 | fail_on_output || \
97 (git status; git --no-pager diff; exit 1)
98fi
99
100# - Check that our module is tidy.
101if go help mod >& /dev/null; then
102 go mod tidy && \
103 git status --porcelain 2>&1 | fail_on_output || \
104 (git status; git --no-pager diff; exit 1)
105fi
106
107# - Collection of static analysis checks
Scott Baker8461e152019-10-01 14:44:30 -0700108# TODO(dfawley): don't use deprecated functions in examples.
William Kurkiandaa6bb22019-03-07 12:26:28 -0500109staticcheck -go 1.9 -checks 'inherit,-ST1015' -ignore '
110google.golang.org/grpc/balancer.go:SA1019
Scott Baker8461e152019-10-01 14:44:30 -0700111google.golang.org/grpc/balancer/grpclb/grpclb_remote_balancer.go:SA1019
William Kurkiandaa6bb22019-03-07 12:26:28 -0500112google.golang.org/grpc/balancer/roundrobin/roundrobin_test.go:SA1019
Scott Baker8461e152019-10-01 14:44:30 -0700113google.golang.org/grpc/xds/internal/balancer/edsbalancer/balancergroup.go:SA1019
114google.golang.org/grpc/xds/internal/resolver/xds_resolver.go:SA1019
115google.golang.org/grpc/xds/internal/balancer/xds.go:SA1019
116google.golang.org/grpc/xds/internal/balancer/xds_client.go:SA1019
117google.golang.org/grpc/balancer_conn_wrappers.go:SA1019
118google.golang.org/grpc/balancer_test.go:SA1019
William Kurkiandaa6bb22019-03-07 12:26:28 -0500119google.golang.org/grpc/benchmark/benchmain/main.go:SA1019
120google.golang.org/grpc/benchmark/worker/benchmark_client.go:SA1019
Scott Baker8461e152019-10-01 14:44:30 -0700121google.golang.org/grpc/clientconn.go:S1024
122google.golang.org/grpc/clientconn_state_transition_test.go:SA1019
123google.golang.org/grpc/clientconn_test.go:SA1019
124google.golang.org/grpc/examples/features/debugging/client/main.go:SA1019
125google.golang.org/grpc/examples/features/load_balancing/client/main.go:SA1019
William Kurkiandaa6bb22019-03-07 12:26:28 -0500126google.golang.org/grpc/internal/transport/handler_server.go:SA1019
127google.golang.org/grpc/internal/transport/handler_server_test.go:SA1019
Scott Baker8461e152019-10-01 14:44:30 -0700128google.golang.org/grpc/resolver/dns/dns_resolver.go:SA1019
William Kurkiandaa6bb22019-03-07 12:26:28 -0500129google.golang.org/grpc/stats/stats_test.go:SA1019
Scott Baker8461e152019-10-01 14:44:30 -0700130google.golang.org/grpc/test/balancer_test.go:SA1019
William Kurkiandaa6bb22019-03-07 12:26:28 -0500131google.golang.org/grpc/test/channelz_test.go:SA1019
132google.golang.org/grpc/test/end2end_test.go:SA1019
133google.golang.org/grpc/test/healthcheck_test.go:SA1019
khenaidooac637102019-01-14 15:44:34 -0500134' ./...
135misspell -error .