forked from kubernetes/kubernetes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathverify-prometheus-imports.sh
executable file
·153 lines (142 loc) · 6.62 KB
/
verify-prometheus-imports.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
#!/usr/bin/env bash
# Copyright 2021 The Kubernetes Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This script validates that only a restricted set of packages are importing
# github.com/prometheus/*
# NOTE: this is not the same as verify-imports which can only verify
# that within a particular package the imports made are allowed.
#
# This is also not the same thing as verify-import-boss, which is pretty
# powerful for specifying restricted imports but does not scale to checking
# the entire source tree well and is only enabled for specific packages.
#
# See: https://github.com/kubernetes/kubernetes/issues/99876
set -o errexit
set -o nounset
set -o pipefail
KUBE_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
source "${KUBE_ROOT}/hack/lib/init.sh"
source "${KUBE_ROOT}/hack/lib/util.sh"
# See: https://github.com/kubernetes/kubernetes/issues/89267
allowed_prometheus_importers=(
./cluster/images/etcd-version-monitor/etcd-version-monitor.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/timing_histogram.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/timing_histogram_test.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/timing_histogram_vec.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/weighted_histogram.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/weighted_histogram_test.go
./staging/src/k8s.io/component-base/metrics/prometheusextension/weighted_histogram_vec.go
./staging/src/k8s.io/component-base/metrics/buckets.go
./staging/src/k8s.io/component-base/metrics/collector.go
./staging/src/k8s.io/component-base/metrics/collector_test.go
./staging/src/k8s.io/component-base/metrics/counter.go
./staging/src/k8s.io/component-base/metrics/counter_test.go
./staging/src/k8s.io/component-base/metrics/desc.go
./staging/src/k8s.io/component-base/metrics/gauge.go
./staging/src/k8s.io/component-base/metrics/gauge_test.go
./staging/src/k8s.io/component-base/metrics/histogram.go
./staging/src/k8s.io/component-base/metrics/histogram_test.go
./staging/src/k8s.io/component-base/metrics/http.go
./staging/src/k8s.io/component-base/metrics/labels.go
./staging/src/k8s.io/component-base/metrics/legacyregistry/registry.go
./staging/src/k8s.io/component-base/metrics/metric.go
./staging/src/k8s.io/component-base/metrics/opts.go
./staging/src/k8s.io/component-base/metrics/processstarttime_others.go
./staging/src/k8s.io/component-base/metrics/registry.go
./staging/src/k8s.io/component-base/metrics/registry_test.go
./staging/src/k8s.io/component-base/metrics/summary.go
./staging/src/k8s.io/component-base/metrics/testutil/metrics.go
./staging/src/k8s.io/component-base/metrics/testutil/metrics_test.go
./staging/src/k8s.io/component-base/metrics/testutil/promlint.go
./staging/src/k8s.io/component-base/metrics/testutil/testutil.go
./staging/src/k8s.io/component-base/metrics/timing_histogram_test.go
./staging/src/k8s.io/component-base/metrics/value.go
./staging/src/k8s.io/component-base/metrics/wrappers.go
./test/e2e/apimachinery/flowcontrol.go
./test/e2e_node/mirror_pod_grace_period_test.go
./test/e2e/node/pods.go
./test/e2e_node/resource_metrics_test.go
./test/instrumentation/main_test.go
./test/integration/apiserver/flowcontrol/concurrency_test.go
./test/integration/apiserver/flowcontrol/concurrency_util_test.go
./test/integration/metrics/metrics_test.go
)
# Go imports always involve a double quoted string of the package path
# https://golang.org/ref/spec#Import_declarations
#
# If you *really* need a string literal that looks like "github.com/prometheus/.*"
# somewhere else that actually isn't an import, you can use backticks / a raw
# string literal instead (which cannot be used in imports, only double quotes).
#
# NOTE: we previously had an implementation that checked for an actual import
# as a post-processing step on the matching files, which is cheap enough and
# accurate, except that it's difficult to guarantee we check for all supported
# GOOS, GOARCH, and other build tags, and we want to prevent all imports.
# So we dropped this, in favor of only the grep call.
# See: https://github.com/kubernetes/kubernetes/pull/100552
really_failing_files=()
all_failing_files=()
while IFS='' read -r filepath; do
# convert from file to package, and only insert unique results
# we want to minimize the amount of `go list` calls we need to make
if ! kube::util::array_contains "$filepath" "${allowed_prometheus_importers[@]}"; then
# record a failure if not
really_failing_files+=("$filepath")
fi
all_failing_files+=("$filepath")
done < <(cd "${KUBE_ROOT}" && grep \
--exclude-dir={_output,vendor} \
--include='*.go' \
-R . \
-l \
-Ee '"github.com/prometheus/.*"' \
| LC_ALL=C sort -u)
# check for any files we're allowing to fail that are no longer failing, so we
# can enforce that the list shrinks
allowed_but_not_failing=()
for allowed_file in "${allowed_prometheus_importers[@]}"; do
if ! kube::util::array_contains "$allowed_file" "${all_failing_files[@]}"; then
allowed_but_not_failing+=("$allowed_file")
fi
done
# we will exit with this at the end of the script depending on the checks below
exit_code=0
# check for files we've allow-listed that no longer need to be
if [ -n "${allowed_but_not_failing[*]}" ]; then
{
echo "ERROR: Some files allow-listed to import prometheus are no longer failing and should be removed."
echo "Please remove these files from allowed_prometheus_importers in hack/verify-prometheus-imports.sh"
echo ""
echo "Non-failing but allow-listed files:"
for non_failing_file in "${allowed_but_not_failing[@]}"; do
echo " ${non_failing_file}"
done
} >&2
exit_code=1
fi
# check for files that fail but are not allow-listed
if [ -n "${really_failing_files[*]}" ]; then
{
echo "ERROR: Some files are importing packages under github.com/prometheus/* but are not allow-listed to do so."
echo ""
echo "See: https://github.com/kubernetes/kubernetes/issues/89267"
echo ""
echo "Failing files:"
for failing_file in "${really_failing_files[@]}"; do
echo " ${failing_file}"
done
} >&2
exit_code=2
fi
exit "$exit_code"