a407771eaf
This catches scenarios where we forgot to prefix the error with return. One of our contributors occasionally made this typo, and since core go vet didn't (surprisingly) catch it, we should add a test! It also adds a simple check for import naming aliases. Expanding this test to add other cases and check for differently named values might make sense.
94 lines
2.6 KiB
Bash
Executable File
94 lines
2.6 KiB
Bash
Executable File
#!/bin/bash
|
|
# check that go vet passes
|
|
|
|
echo running "$0"
|
|
|
|
#ROOT="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )" # dir!
|
|
ROOT=$(dirname "${BASH_SOURCE}")/..
|
|
cd "${ROOT}"
|
|
. test/util.sh
|
|
|
|
failures=''
|
|
function run-test()
|
|
{
|
|
$@ || failures=$( [ -n "$failures" ] && echo "$failures\\n$@" || echo "$@" )
|
|
}
|
|
|
|
GO_VERSION=($(go version))
|
|
|
|
function simplify-gocase() {
|
|
if grep 'case _ = <-' "$1"; then
|
|
return 1 # 'case _ = <- can be simplified to: case <-'
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
function token-coloncheck() {
|
|
# add quotes to avoid matching three X's
|
|
if grep -Ei "[\/]+[\/]+[ ]*(FIXME[^:]|TODO[^:]|X"'X'"X[^:])" "$1"; then
|
|
return 1 # tokens must end with a colon
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
function naked-error() {
|
|
# the $ before the \t magically makes grep match the tab somehow...
|
|
if grep $'\terrors.New(' "$1"; then # missing a leading return
|
|
return 1
|
|
fi
|
|
if grep $'\tfmt.Errorf(' "$1"; then # missing a leading return
|
|
return 1
|
|
fi
|
|
if grep $'\terrwrap.Wrap' "$1"; then # missing a leading return
|
|
return 1
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
function consistent-imports() {
|
|
if grep $'\t"github.com/pkg/errors"' "$1"; then # import as errwrap
|
|
return 1
|
|
fi
|
|
if grep $'\t"github.com/hashicorp/go-multierror"' "$1"; then # import as multierr
|
|
return 1
|
|
fi
|
|
if grep $'\t"github.com/purpleidea/mgmt/engine/util"' "$1"; then # import as engineUtil
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
# loop through directories in an attempt to scan each go package
|
|
for dir in `find . -maxdepth 5 -type d -not -path './old/*' -not -path './old' -not -path './tmp/*' -not -path './tmp' -not -path './.*' -not -path './vendor/*'`; do
|
|
match="$dir/*.go"
|
|
#echo "match is: $match"
|
|
if ! ls $match &>/dev/null; then
|
|
#echo "skipping: $match"
|
|
continue # no *.go files found
|
|
fi
|
|
#echo "matching: $match"
|
|
if [[ -z $(echo "${GO_VERSION[2]}" | grep -E 'go1.2|go1.3|go1.4|go1.5|go1.6|go1.7|go1.8') ]]; then
|
|
# workaround go vet issues by adding the new -source flag (go1.9+)
|
|
run-test go vet -source "$match" || fail_test "go vet -source did not pass pkg"
|
|
else
|
|
run-test go vet "$match" || fail_test "go vet did not pass pkg" # since it doesn't output an ok message on pass
|
|
fi
|
|
done
|
|
|
|
# loop through individual *.go files
|
|
for file in `find . -maxdepth 3 -type f -name '*.go' -not -path './old/*' -not -path './tmp/*'`; do
|
|
run-test grep 'log.' "$file" | grep '\\n"' && fail_test 'no newline needed in log.Printf()' # no \n needed in log.Printf()
|
|
run-test simplify-gocase "$file"
|
|
run-test token-coloncheck "$file"
|
|
run-test naked-error "$file"
|
|
run-test consistent-imports "$file"
|
|
done
|
|
|
|
if [[ -n "$failures" ]]; then
|
|
echo 'FAIL'
|
|
echo 'The following tests have failed:'
|
|
echo -e "$failures"
|
|
echo
|
|
exit 1
|
|
fi
|
|
echo 'PASS'
|