mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-28 18:08:51 +03:00
c77b2a0ce5
Merge in DNS/adguard-home from home-imp-code to master
Squashed commit of the following:
commit 459297e189c55393bf0340dd51ec9608d3475e55
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 10 11:42:34 2023 +0300
home: imp code
commit ab38e1e80fed7b24fe57d4afdc57b70608f65d73
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 10 11:01:23 2023 +0300
all: lint script
commit 7df68b128bf32172ef2e3bf7116f4f72a97baa2b
Merge: bcb482714 db52f7a3a
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 10 10:59:40 2023 +0300
Merge remote-tracking branch 'origin/master' into home-imp-code
commit bcb482714780da882e69c261be08511ea4f36f3b
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 13:48:27 2023 +0300
all: lint script
commit 1c017f27715202ec1f40881f069a96f11f9822e8
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 13:45:25 2023 +0300
all: lint script
commit ee3d427a7d6ee7e377e67c5eb99eebc7fb1e6acc
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 13:44:53 2023 +0300
home: imp code
commit bc50430469123415216e60e178bd8e30fc229300
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 13:12:10 2023 +0300
home: imp code
commit fc07e416aeab2612e68cf0e3f933aaed95931115
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 11:42:32 2023 +0300
aghos: service precheck
commit a68480fd9c4cd6f3c89210bee6917c53074f7a82
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Thu May 4 11:07:05 2023 +0300
home: imp code
commit 61b743a340ac1564c48212452c7a9acd1808d352
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 17:17:21 2023 +0300
all: lint script
commit c6fe620510c4af5b65456e90cb3424831334e004
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 17:16:37 2023 +0300
home: imp code
commit 4b2fb47ea9c932054ccc72b1fd1d11793c93e39c
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 16:55:44 2023 +0300
home: imp code
commit 63df3e2ab58482920a074cfd5f4188e49a0f8448
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 16:25:38 2023 +0300
home: imp code
commit c7f1502f976482c2891e0c64426218b549585e83
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 15:54:30 2023 +0300
home: imp code
commit c64cdaf1c82495bb70d9cdcaf7be9eeee9a7c773
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 14:35:04 2023 +0300
home: imp code
commit a50436e040b3a064ef51d5f936b879fe8de72d41
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 14:24:02 2023 +0300
home: imp code
commit 2b66464f472df732ea27cbbe5ac5c673a13bc14b
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 14:11:53 2023 +0300
home: imp code
commit 713ce2963c210887faa0a06e41e01e4ebbf96894
Author: Dimitry Kolyshev <dkolyshev@adguard.com>
Date: Wed May 3 14:10:54 2023 +0300
home: imp code
208 lines
4.5 KiB
Bash
208 lines
4.5 KiB
Bash
#!/bin/sh
|
|
|
|
# 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: 3
|
|
|
|
verbose="${VERBOSE:-0}"
|
|
readonly verbose
|
|
|
|
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
|
|
set +e
|
|
else
|
|
set -e
|
|
fi
|
|
|
|
set -f -u
|
|
|
|
|
|
|
|
# Source the common helpers, including not_found and run_linter.
|
|
. ./scripts/make/helper.sh
|
|
|
|
|
|
|
|
# Warnings
|
|
|
|
go_version="$( "${GO:-go}" version )"
|
|
readonly go_version
|
|
|
|
go_min_version='go1.19.8'
|
|
go_version_msg="
|
|
warning: your go version (${go_version}) is different from the recommended minimal one (${go_min_version}).
|
|
if you have the version installed, please set the GO environment variable.
|
|
for example:
|
|
|
|
export GO='${go_min_version}'
|
|
"
|
|
readonly go_min_version go_version_msg
|
|
|
|
case "$go_version"
|
|
in
|
|
('go version'*"$go_min_version"*)
|
|
# Go on.
|
|
;;
|
|
(*)
|
|
echo "$go_version_msg" 1>&2
|
|
;;
|
|
esac
|
|
|
|
|
|
|
|
# Simple analyzers
|
|
|
|
# blocklist_imports is a simple check against unwanted packages. The following
|
|
# packages are banned:
|
|
#
|
|
# * Packages errors and log are replaced by our own packages in the
|
|
# github.com/AdguardTeam/golibs module.
|
|
#
|
|
# * Package io/ioutil is soft-deprecated.
|
|
#
|
|
# * Package reflect is often an overkill, and for deep comparisons there are
|
|
# much better functions in module github.com/google/go-cmp. Which is
|
|
# already our indirect dependency and which may or may not enter the stdlib
|
|
# at some point.
|
|
#
|
|
# See https://github.com/golang/go/issues/45200.
|
|
#
|
|
# * Package sort is replaced by golang.org/x/exp/slices.
|
|
#
|
|
# * Package unsafe is… unsafe.
|
|
#
|
|
# * Package golang.org/x/net/context has been moved into stdlib.
|
|
#
|
|
blocklist_imports() {
|
|
git grep\
|
|
-e '[[:space:]]"errors"$'\
|
|
-e '[[:space:]]"io/ioutil"$'\
|
|
-e '[[:space:]]"log"$'\
|
|
-e '[[:space:]]"reflect"$'\
|
|
-e '[[:space:]]"sort"$'\
|
|
-e '[[:space:]]"unsafe"$'\
|
|
-e '[[:space:]]"golang.org/x/net/context"$'\
|
|
-n\
|
|
-- '*.go'\
|
|
| sed -e 's/^\([^[:space:]]\+\)\(.*\)$/\1 blocked import:\2/'\
|
|
|| exit 0
|
|
}
|
|
|
|
# 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 '"POST"'\
|
|
-e '"PUT"'\
|
|
-n\
|
|
-- '*.go'\
|
|
| sed -e 's/^\([^[:space:]]\+\)\(.*\)$/\1 http method literal:\2/'\
|
|
|| exit 0
|
|
}
|
|
|
|
# underscores is a simple check against Go filenames with underscores. Add new
|
|
# build tags and OS as you go. The main goal of this check is to discourage the
|
|
# use of filenames like client_manager.go.
|
|
underscores() {
|
|
underscore_files="$(
|
|
git ls-files '*_*.go'\
|
|
| grep -F\
|
|
-e '_big.go'\
|
|
-e '_bsd.go'\
|
|
-e '_darwin.go'\
|
|
-e '_freebsd.go'\
|
|
-e '_linux.go'\
|
|
-e '_little.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/'
|
|
)"
|
|
readonly underscore_files
|
|
|
|
if [ "$underscore_files" != '' ]
|
|
then
|
|
echo 'found file names with underscores:'
|
|
echo "$underscore_files"
|
|
fi
|
|
}
|
|
|
|
# TODO(a.garipov): Add an analyzer to look for `fallthrough`, `goto`, and `new`?
|
|
|
|
|
|
|
|
# Checks
|
|
|
|
run_linter -e blocklist_imports
|
|
|
|
run_linter -e method_const
|
|
|
|
run_linter -e underscores
|
|
|
|
run_linter -e gofumpt --extra -e -l .
|
|
|
|
# TODO(a.garipov): golint is deprecated, find a suitable replacement.
|
|
|
|
run_linter "$GO" vet ./...
|
|
|
|
run_linter govulncheck ./...
|
|
|
|
# Apply more lax standards to the code we haven't properly refactored yet.
|
|
run_linter gocyclo --over 13 ./internal/querylog
|
|
run_linter gocyclo --over 12 ./internal/dhcpd
|
|
|
|
# Apply the normal standards to new or somewhat refactored code.
|
|
run_linter gocyclo --over 10\
|
|
./internal/aghio/\
|
|
./internal/aghnet/\
|
|
./internal/aghos/\
|
|
./internal/aghtest/\
|
|
./internal/dnsforward/\
|
|
./internal/filtering/\
|
|
./internal/home/\
|
|
./internal/stats/\
|
|
./internal/tools/\
|
|
./internal/updater/\
|
|
./internal/next/\
|
|
./internal/version/\
|
|
./scripts/blocked-services/\
|
|
./scripts/vetted-filters/\
|
|
./scripts/translations/\
|
|
./main.go\
|
|
;
|
|
|
|
run_linter ineffassign ./...
|
|
|
|
run_linter unparam ./...
|
|
|
|
git ls-files -- 'Makefile' '*.go' '*.mod' '*.sh' '*.yaml' '*.yml'\
|
|
| xargs misspell --error
|
|
|
|
run_linter looppointer ./...
|
|
|
|
run_linter nilness ./...
|
|
|
|
# TODO(a.garipov): Add fieldalignment?
|
|
|
|
run_linter -e shadow --strict ./...
|
|
|
|
# TODO(a.garipov): Enable in v0.108.0.
|
|
# run_linter gosec --quiet ./...
|
|
|
|
# TODO(a.garipov): Enable --blank?
|
|
run_linter errcheck --asserts ./...
|
|
|
|
run_linter staticcheck ./...
|