all: sync with master
This commit is contained in:
Eugene Burkov
@@ -3,19 +3,17 @@
|
||||
# This comment is used to simplify checking local copies of the script. Bump
|
||||
# this number every time a significant change is made to this script.
|
||||
#
|
||||
# AdGuard-Project-Version: 8
|
||||
# AdGuard-Project-Version: 13
|
||||
|
||||
verbose="${VERBOSE:-0}"
|
||||
readonly verbose
|
||||
|
||||
if [ "$verbose" -gt '0' ]
|
||||
then
|
||||
if [ "$verbose" -gt '0' ]; then
|
||||
set -x
|
||||
fi
|
||||
|
||||
# Set $EXIT_ON_ERROR to zero to see all errors.
|
||||
if [ "${EXIT_ON_ERROR:-1}" -eq '0' ]
|
||||
then
|
||||
if [ "${EXIT_ON_ERROR:-1}" -eq '0' ]; then
|
||||
set +e
|
||||
else
|
||||
set -e
|
||||
@@ -23,23 +21,26 @@ fi
|
||||
|
||||
set -f -u
|
||||
|
||||
|
||||
|
||||
# Source the common helpers, including not_found and run_linter.
|
||||
. ./scripts/make/helper.sh
|
||||
|
||||
|
||||
|
||||
# Simple analyzers
|
||||
|
||||
# blocklist_imports is a simple check against unwanted packages. The following
|
||||
# packages are banned:
|
||||
#
|
||||
# * Package errors is replaced by our own package in the
|
||||
# github.com/AdguardTeam/golibs module.
|
||||
# github.com/AdguardTeam/golibs module.
|
||||
#
|
||||
# * Packages golang.org/x/exp/slices and golang.org/x/net/context have been
|
||||
# moved into stdlib.
|
||||
# * Packages log and github.com/AdguardTeam/golibs/log are replaced by
|
||||
# stdlib's new package log/slog and AdGuard's new utilities package
|
||||
# github.com/AdguardTeam/golibs/logutil/slogutil.
|
||||
#
|
||||
# * Package github.com/prometheus/client_golang/prometheus/promauto is not
|
||||
# recommended, as it encourages reliance on global state.
|
||||
#
|
||||
# * Packages golang.org/x/exp/maps, golang.org/x/exp/slices, and
|
||||
# golang.org/x/net/context have been moved into stdlib.
|
||||
#
|
||||
# * Package io/ioutil is soft-deprecated.
|
||||
#
|
||||
@@ -54,48 +55,60 @@ set -f -u
|
||||
#
|
||||
# * Package unsafe is… unsafe.
|
||||
#
|
||||
# If your project needs more exceptions, add and document them. Currently,
|
||||
# there are only two standard exceptions:
|
||||
# Currently, the only standard exception are files generated from protobuf
|
||||
# schemas, which use package reflect. If your project needs more exceptions,
|
||||
# add and document them.
|
||||
#
|
||||
# * Files generated from protobuf schemas, which use package reflect.
|
||||
# NOTE: Flag -H for grep is non-POSIX but all of Busybox, GNU, macOS, and
|
||||
# OpenBSD support it.
|
||||
#
|
||||
# * Windows-specific code caused by golang.org/x/sys/windows API design.
|
||||
# NOTE: Exclude the security_windows.go, because it requires unsafe for the OS
|
||||
# APIs.
|
||||
#
|
||||
# TODO(a.garipov): Add golibs/log.
|
||||
#
|
||||
# TODO(a.garipov): Add deprecated package golang.org/x/exp/maps once all
|
||||
# projects switch to Go 1.23.
|
||||
blocklist_imports() {
|
||||
git grep\
|
||||
-e '[[:space:]]"errors"$'\
|
||||
-e '[[:space:]]"golang.org/x/exp/slices"$'\
|
||||
-e '[[:space:]]"golang.org/x/net/context"$'\
|
||||
-e '[[:space:]]"io/ioutil"$'\
|
||||
-e '[[:space:]]"log"$'\
|
||||
-e '[[:space:]]"reflect"$'\
|
||||
-e '[[:space:]]"sort"$'\
|
||||
-e '[[:space:]]"unsafe"$'\
|
||||
-n\
|
||||
-- '*.go'\
|
||||
':!*.pb.go'\
|
||||
':!./internal/aghos/permission_windows.go'\
|
||||
| sed -e 's/^\([^[:space:]]\+\)\(.*\)$/\1 blocked import:\2/'\
|
||||
|| exit 0
|
||||
find . \
|
||||
-type 'f' \
|
||||
-name '*.go' \
|
||||
'!' '(' \
|
||||
-name '*.pb.go' \
|
||||
-o -path './internal/permcheck/security_windows.go' \
|
||||
')' \
|
||||
-exec \
|
||||
'grep' \
|
||||
'-H' \
|
||||
'-e' '[[:space:]]"errors"$' \
|
||||
'-e' '[[:space:]]"github.com/prometheus/client_golang/prometheus/promauto"$' \
|
||||
'-e' '[[:space:]]"golang.org/x/exp/maps"$' \
|
||||
'-e' '[[:space:]]"golang.org/x/exp/slices"$' \
|
||||
'-e' '[[:space:]]"golang.org/x/net/context"$' \
|
||||
'-e' '[[:space:]]"io/ioutil"$' \
|
||||
'-e' '[[:space:]]"log"$' \
|
||||
'-e' '[[:space:]]"reflect"$' \
|
||||
'-e' '[[:space:]]"sort"$' \
|
||||
'-e' '[[:space:]]"unsafe"$' \
|
||||
'-n' \
|
||||
'{}' \
|
||||
';'
|
||||
}
|
||||
|
||||
# method_const is a simple check against the usage of some raw strings and
|
||||
# numbers where one should use named constants.
|
||||
method_const() {
|
||||
git grep -F\
|
||||
-e '"DELETE"'\
|
||||
-e '"GET"'\
|
||||
-e '"PATCH"'\
|
||||
-e '"POST"'\
|
||||
-e '"PUT"'\
|
||||
-n\
|
||||
-- '*.go'\
|
||||
| sed -e 's/^\([^[:space:]]\+\)\(.*\)$/\1 http method literal:\2/'\
|
||||
|| exit 0
|
||||
find . \
|
||||
-type 'f' \
|
||||
-name '*.go' \
|
||||
-exec \
|
||||
'grep' \
|
||||
'-H' \
|
||||
'-e' '"DELETE"' \
|
||||
'-e' '"GET"' \
|
||||
'-e' '"PATCH"' \
|
||||
'-e' '"POST"' \
|
||||
'-e' '"PUT"' \
|
||||
'-n' \
|
||||
'{}' \
|
||||
';'
|
||||
}
|
||||
|
||||
# underscores is a simple check against Go filenames with underscores. Add new
|
||||
@@ -103,35 +116,34 @@ method_const() {
|
||||
# use of filenames like client_manager.go.
|
||||
underscores() {
|
||||
underscore_files="$(
|
||||
git ls-files '*_*.go'\
|
||||
| grep -F\
|
||||
-e '_bsd.go'\
|
||||
-e '_darwin.go'\
|
||||
-e '_freebsd.go'\
|
||||
-e '_generate.go'\
|
||||
-e '_linux.go'\
|
||||
-e '_next.go'\
|
||||
-e '_openbsd.go'\
|
||||
-e '_others.go'\
|
||||
-e '_test.go'\
|
||||
-e '_unix.go'\
|
||||
-e '_windows.go'\
|
||||
-v\
|
||||
| sed -e 's/./\t\0/'
|
||||
find . \
|
||||
-type 'f' \
|
||||
-name '*_*.go' \
|
||||
'!' '(' -name '*_bsd.go' \
|
||||
-o -name '*_darwin.go' \
|
||||
-o -name '*_freebsd.go' \
|
||||
-o -name '*_generate.go' \
|
||||
-o -name '*_linux.go' \
|
||||
-o -name '*_next.go' \
|
||||
-o -name '*_openbsd.go' \
|
||||
-o -name '*_others.go' \
|
||||
-o -name '*_test.go' \
|
||||
-o -name '*_unix.go' \
|
||||
-o -name '*_windows.go' \
|
||||
')' \
|
||||
-exec 'printf' '\t%s\n' '{}' ';'
|
||||
)"
|
||||
readonly underscore_files
|
||||
|
||||
if [ "$underscore_files" != '' ]
|
||||
then
|
||||
echo 'found file names with underscores:'
|
||||
echo "$underscore_files"
|
||||
if [ "$underscore_files" != '' ]; then
|
||||
printf \
|
||||
'found file names with underscores:\n%s\n' \
|
||||
"$underscore_files"
|
||||
fi
|
||||
}
|
||||
|
||||
# TODO(a.garipov): Add an analyzer to look for `fallthrough`, `goto`, and `new`?
|
||||
|
||||
|
||||
|
||||
# Checks
|
||||
|
||||
run_linter -e blocklist_imports
|
||||
@@ -142,8 +154,6 @@ run_linter -e underscores
|
||||
|
||||
run_linter -e gofumpt --extra -e -l .
|
||||
|
||||
# TODO(a.garipov): golint is deprecated, find a suitable replacement.
|
||||
|
||||
run_linter "${GO:-go}" vet ./...
|
||||
|
||||
run_linter govulncheck ./...
|
||||
@@ -151,129 +161,138 @@ run_linter govulncheck ./...
|
||||
run_linter gocyclo --over 10 .
|
||||
|
||||
# TODO(a.garipov): Enable 10 for all.
|
||||
run_linter gocognit --over='20'\
|
||||
./internal/querylog/\
|
||||
run_linter gocognit --over='20' \
|
||||
./internal/querylog/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='19'\
|
||||
./internal/home/\
|
||||
run_linter gocognit --over='19' \
|
||||
./internal/home/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='18'\
|
||||
./internal/aghtls/\
|
||||
run_linter gocognit --over='18' \
|
||||
./internal/aghtls/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='15'\
|
||||
./internal/aghos/\
|
||||
./internal/filtering/\
|
||||
run_linter gocognit --over='15' \
|
||||
./internal/aghos/ \
|
||||
./internal/filtering/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='14'\
|
||||
./internal/dhcpd\
|
||||
run_linter gocognit --over='14' \
|
||||
./internal/dhcpd \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='13'\
|
||||
./internal/aghnet/\
|
||||
run_linter gocognit --over='13' \
|
||||
./internal/aghnet/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='12'\
|
||||
./internal/filtering/rewrite/\
|
||||
run_linter gocognit --over='12' \
|
||||
./internal/filtering/rewrite/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='11'\
|
||||
./internal/updater/\
|
||||
run_linter gocognit --over='11' \
|
||||
./internal/updater/ \
|
||||
;
|
||||
|
||||
run_linter gocognit --over='10'\
|
||||
./internal/aghalg/\
|
||||
./internal/aghhttp/\
|
||||
./internal/aghrenameio/\
|
||||
./internal/aghtest/\
|
||||
./internal/arpdb/\
|
||||
./internal/client/\
|
||||
./internal/configmigrate/\
|
||||
./internal/dhcpsvc\
|
||||
./internal/dnsforward/\
|
||||
./internal/filtering/hashprefix/\
|
||||
./internal/filtering/rulelist/\
|
||||
./internal/filtering/safesearch/\
|
||||
./internal/ipset\
|
||||
./internal/next/\
|
||||
./internal/rdns/\
|
||||
./internal/schedule/\
|
||||
./internal/stats/\
|
||||
./internal/tools/\
|
||||
./internal/version/\
|
||||
./internal/whois/\
|
||||
./scripts/\
|
||||
run_linter gocognit --over='10' \
|
||||
./internal/aghalg/ \
|
||||
./internal/aghhttp/ \
|
||||
./internal/aghrenameio/ \
|
||||
./internal/aghtest/ \
|
||||
./internal/arpdb/ \
|
||||
./internal/client/ \
|
||||
./internal/configmigrate/ \
|
||||
./internal/dhcpsvc \
|
||||
./internal/dnsforward/ \
|
||||
./internal/filtering/hashprefix/ \
|
||||
./internal/filtering/rulelist/ \
|
||||
./internal/filtering/safesearch/ \
|
||||
./internal/ipset \
|
||||
./internal/next/ \
|
||||
./internal/rdns/ \
|
||||
./internal/schedule/ \
|
||||
./internal/stats/ \
|
||||
./internal/tools/ \
|
||||
./internal/version/ \
|
||||
./internal/whois/ \
|
||||
./scripts/ \
|
||||
;
|
||||
|
||||
run_linter ineffassign ./...
|
||||
|
||||
run_linter unparam ./...
|
||||
|
||||
git ls-files -- 'Makefile' '*.conf' '*.go' '*.mod' '*.sh' '*.yaml' '*.yml'\
|
||||
| xargs misspell --error\
|
||||
| sed -e 's/^/misspell: /'
|
||||
find . \
|
||||
-type 'f' \
|
||||
'(' \
|
||||
-name 'Makefile' \
|
||||
-o -name '*.conf' \
|
||||
-o -name '*.go' \
|
||||
-o -name '*.mod' \
|
||||
-o -name '*.sh' \
|
||||
-o -name '*.yaml' \
|
||||
-o -name '*.yml' \
|
||||
')' \
|
||||
-exec 'misspell' '--error' '{}' '+'
|
||||
|
||||
run_linter nilness ./...
|
||||
|
||||
# TODO(a.garipov): Enable for all.
|
||||
run_linter fieldalignment \
|
||||
./internal/aghalg/\
|
||||
./internal/aghhttp/\
|
||||
./internal/aghos/\
|
||||
./internal/aghrenameio/\
|
||||
./internal/aghtest/\
|
||||
./internal/aghtls/\
|
||||
./internal/arpdb/\
|
||||
./internal/client/\
|
||||
./internal/configmigrate/\
|
||||
./internal/dhcpsvc/\
|
||||
./internal/filtering/hashprefix/\
|
||||
./internal/filtering/rewrite/\
|
||||
./internal/filtering/rulelist/\
|
||||
./internal/filtering/safesearch/\
|
||||
./internal/ipset/\
|
||||
./internal/next/...\
|
||||
./internal/querylog/\
|
||||
./internal/rdns/\
|
||||
./internal/schedule/\
|
||||
./internal/stats/\
|
||||
./internal/updater/\
|
||||
./internal/version/\
|
||||
./internal/whois/\
|
||||
./internal/aghalg/ \
|
||||
./internal/aghhttp/ \
|
||||
./internal/aghos/ \
|
||||
./internal/aghrenameio/ \
|
||||
./internal/aghtest/ \
|
||||
./internal/aghtls/ \
|
||||
./internal/arpdb/ \
|
||||
./internal/client/ \
|
||||
./internal/configmigrate/ \
|
||||
./internal/dhcpsvc/ \
|
||||
./internal/filtering/hashprefix/ \
|
||||
./internal/filtering/rewrite/ \
|
||||
./internal/filtering/rulelist/ \
|
||||
./internal/filtering/safesearch/ \
|
||||
./internal/ipset/ \
|
||||
./internal/next/... \
|
||||
./internal/querylog/ \
|
||||
./internal/rdns/ \
|
||||
./internal/schedule/ \
|
||||
./internal/stats/ \
|
||||
./internal/updater/ \
|
||||
./internal/version/ \
|
||||
./internal/whois/ \
|
||||
;
|
||||
|
||||
run_linter -e shadow --strict ./...
|
||||
|
||||
# TODO(a.garipov): Enable for all.
|
||||
# TODO(e.burkov): Re-enable G115.
|
||||
run_linter gosec --exclude G115 --quiet\
|
||||
./internal/aghalg/\
|
||||
./internal/aghhttp/\
|
||||
./internal/aghnet/\
|
||||
./internal/aghos/\
|
||||
./internal/aghrenameio/\
|
||||
./internal/aghtest/\
|
||||
./internal/arpdb/\
|
||||
./internal/client/\
|
||||
./internal/configmigrate/\
|
||||
./internal/dhcpd/\
|
||||
./internal/dhcpsvc/\
|
||||
./internal/dnsforward/\
|
||||
./internal/filtering/hashprefix/\
|
||||
./internal/filtering/rewrite/\
|
||||
./internal/filtering/rulelist/\
|
||||
./internal/filtering/safesearch/\
|
||||
./internal/ipset/\
|
||||
./internal/next/\
|
||||
./internal/rdns/\
|
||||
./internal/schedule/\
|
||||
./internal/stats/\
|
||||
./internal/tools/\
|
||||
./internal/version/\
|
||||
./internal/whois/\
|
||||
run_linter gosec --exclude G115 --quiet \
|
||||
./internal/aghalg/ \
|
||||
./internal/aghhttp/ \
|
||||
./internal/aghnet/ \
|
||||
./internal/aghos/ \
|
||||
./internal/aghrenameio/ \
|
||||
./internal/aghtest/ \
|
||||
./internal/arpdb/ \
|
||||
./internal/client/ \
|
||||
./internal/configmigrate/ \
|
||||
./internal/dhcpd/ \
|
||||
./internal/dhcpsvc/ \
|
||||
./internal/dnsforward/ \
|
||||
./internal/filtering/hashprefix/ \
|
||||
./internal/filtering/rewrite/ \
|
||||
./internal/filtering/rulelist/ \
|
||||
./internal/filtering/safesearch/ \
|
||||
./internal/ipset/ \
|
||||
./internal/next/ \
|
||||
./internal/rdns/ \
|
||||
./internal/schedule/ \
|
||||
./internal/stats/ \
|
||||
./internal/tools/ \
|
||||
./internal/version/ \
|
||||
./internal/whois/ \
|
||||
;
|
||||
|
||||
run_linter errcheck ./...
|
||||
@@ -287,4 +306,4 @@ windows: GOOS=windows
|
||||
'
|
||||
readonly staticcheck_matrix
|
||||
|
||||
echo "$staticcheck_matrix" | run_linter staticcheck --matrix ./...
|
||||
printf '%s' "$staticcheck_matrix" | run_linter staticcheck --matrix ./...
|
||||
|
||||
Reference in New Issue
Block a user