-
Notifications
You must be signed in to change notification settings - Fork 2
/
do
executable file
·305 lines (257 loc) · 8.16 KB
/
do
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
#!/usr/bin/env bash
set -eu -o pipefail
reportDir="test-reports"
GORELEASER_VERSION="v2.1.0"
GOTESTSUM_VERSION="1.12.0"
GOLANGCI_LINT_VERSION="1.62.0"
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_build="Build the Go binaries and archives"
build() {
set -x
[[ -f ./bin/goreleaser ]] || install-go-bin "github.com/goreleaser/gorelease/v2r@latest"
VERSION="${GORELEASER_VERSION}" \
BUILD_VERSION="${BUILD_VERSION:-dev}" ./bin/goreleaser \
--clean \
--config "${BUILD_CONFIG:-./.goreleaser/binaries.yaml}" \
--skip=validate "$@"
echo "${BUILD_VERSION:-dev}" | tee ./target/version.txt
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_images="Build and push the Docker images and manifests."
images() {
set -x
[[ -f ./bin/goreleaser ]] || install-go-bin "github.com/goreleaser/goreleaser/v2@latest"
skip="${SKIP_PUSH:-true}"
SKIP_PUSH="${skip}" \
SKIP_PUSH_TEST_AGENT="${SKIP_PUSH_TEST_AGENT:-${skip}}" \
IMAGE_TAG_SUFFIX="${IMAGE_TAG_SUFFIX:-""}" \
PICARD_VERSION="${PICARD_VERSION:-agent}" \
VERSION="${GORELEASER_VERSION}" \
./bin/goreleaser \
--clean \
--config "${BUILD_CONFIG:-./.goreleaser/dockers.yaml}" \
--skip=validate "$@"
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_images_for_server="Build and push the Docker images and manifests for supported server versions."
images-for-server() {
MAJOR_SERVER_VERSION=4
MINOR_VERSION_START=4
MINOR_VERSION_END=8
for minor in $(seq ${MINOR_VERSION_START} ${MINOR_VERSION_END}); do
if [ "${minor}" -eq "${MINOR_VERSION_END}" ]; then
branch="main"
else
branch="server-${MAJOR_SERVER_VERSION}.${minor}"
fi
git -C "${SERVER_REPO_PATH:?'server repo path required'}" checkout "${branch}"
picard_version="$(yq .circleci/picard -r "${SERVER_REPO_PATH}/images.yaml")"
echo "Building for build-agent version ${picard_version}"
PICARD_VERSION=${picard_version} \
IMAGE_TAG_SUFFIX="-server-${MAJOR_SERVER_VERSION}.${minor}" \
SKIP_PUSH_TEST_AGENT='true' \
./do images
done
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_lint="Run golanci-lint to lint go files."
lint() {
if [ ! -d "./bin" ]; then
install-devtools
fi
eval "./bin/golangci-lint run ${1:-}"
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_lint_report="Run golanci-lint to lint Go files and generate an XML report."
lint-report() {
output="${reportDir}/lint.xml"
echo "Storing results as JUnit XML in ${output}" >&2
mkdir -p "${reportDir}"
lint "--timeout 5m --out-format junit-xml | tee ${output}"
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_test="Run the tests"
test() {
command -v ./bin/gotestsum || install-go-bin "gotest.tools/gotestsum@v${GOTESTSUM_VERSION}"
mkdir -p "${reportDir}"
# -count=1 is used to forcibly disable test result caching
./bin/gotestsum --junitfile="${reportDir}/junit.xml" -- -race -count=1 "${@:-./...}"
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_smoke_tests="Run the smoke tests"
smoke-tests() {
GOTESTSUM_FORMAT="${GOTESTSUM_FORMAT:-standard-verbose}" \
test -test.timeout=20m -tags smoke ./internal/testing/ci/smoke
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_go_mod_tidy="Run 'go mod tidy' to clean up module files."
go-mod-tidy() {
go mod tidy -v
}
# Attempt to download go binary tools from github correctly
# go binary releases are somewhat consistent thanks to goreleaser
# however they're not actually that consistent, so this is a pain
# if this is causing more problems than it solves, throw it away
install-github-binary() {
local org=$1 # github org
local repo=$2 # github repo == binary name
local vs=$3 # version separator in tarball filename
local winext=$4 # archive extension on windows
local version=$5 # desired version number
if ./bin/$repo --version | grep "$version" >/dev/null; then
return
fi
local os=$(go env GOHOSTOS)
local arch=$(go env GOARCH)
local ext='.tar.gz'
if [[ "$os" = "windows" ]]; then
local ext="$winext"
fi
local unpack='tar xvzf'
if [[ "$ext" = ".zip" ]]; then
local unpack='unzip'
fi
local tmp=$(mktemp -d ${TMPDIR:-/tmp/}do-install-github-binary.XXXXXX)
trap "{ rm -rf $tmp; }" EXIT
set -x
mkdir -p ./bin
curl --fail --location --output "$tmp/download" \
"https://github.com/$org/$repo/releases/download/v${version}/${repo}${vs}${version}${vs}${os}${vs}${arch}${ext}"
pushd "$tmp"
$unpack "$tmp/download"
popd
local binary=$(find "$tmp" -name "$repo*" -type f)
chmod +x "$binary"
mv "$binary" ./bin/
}
install-go-bin() {
for pkg in "${@}"; do
GOBIN="${PWD}/bin" go install "${pkg}" &
done
wait
}
# shellcheck disable=SC2034
help_install_devtools="Install tools that other tasks expect into ./bin"
install-devtools() {
install-github-binary golangci golangci-lint '-' '.zip' "${GOLANGCI_LINT_VERSION}"
install-github-binary gotestyourself gotestsum '_' '.tar.gz' "${GOTESTSUM_VERSION}"
if [[ "${CI:-}" == "true" ]]; then
echo "Run GoReleaser via bash script in CI"
curl -sfL https://goreleaser.com/static/run -o ./bin/goreleaser --create-dirs && chmod +x ./bin/goreleaser
else
echo "Installing GoReleaser via go install"
install-go-bin "github.com/goreleaser/goreleaser/v2@latest"
fi
}
help-text-intro() {
echo "
DO
A set of simple repetitive tasks that adds minimally
to standard tools used to build and test the service.
(e.g. go and docker)
"
}
### START FRAMEWORK ###
# Do Version 0.0.4
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_completion="Print shell completion function for this script.
Usage: $0 completion SHELL"
completion() {
local shell
shell="${1-}"
if [ -z "$shell" ]; then
echo "Usage: $0 completion SHELL" 1>&2
exit 1
fi
case "$shell" in
bash)
(
echo
echo '_dotslashdo_completions() { '
# shellcheck disable=SC2016
echo ' COMPREPLY=($(compgen -W "$('"$0"' list)" "${COMP_WORDS[1]}"))'
echo '}'
echo 'complete -F _dotslashdo_completions '"$0"
)
;;
zsh)
cat <<EOF
_dotslashdo_completions() {
local -a subcmds
subcmds=()
DO_HELP_SKIP_INTRO=1 $0 help | while read line; do
EOF
cat <<'EOF'
cmd=$(cut -f1 <<< $line)
cmd=$(awk '{$1=$1};1' <<< $cmd)
desc=$(cut -f2- <<< $line)
desc=$(awk '{$1=$1};1' <<< $desc)
subcmds+=("$cmd:$desc")
done
_describe 'do' subcmds
}
compdef _dotslashdo_completions do
EOF
;;
fish)
cat <<EOF
complete -e -c do
complete -f -c do
for line in (string split \n (DO_HELP_SKIP_INTRO=1 $0 help))
EOF
cat <<'EOF'
set cmd (string split \t $line)
complete -c do -a $cmd[1] -d $cmd[2]
end
EOF
;;
esac
}
list() {
declare -F | awk '{print $3}'
}
# This variable is used, but shellcheck can't tell.
# shellcheck disable=SC2034
help_help="Print help text, or detailed help for a task."
help() {
local item
item="${1-}"
if [ -n "${item}" ]; then
local help_name
help_name="help_${item//-/_}"
echo "${!help_name-}"
return
fi
if [ -z "${DO_HELP_SKIP_INTRO-}" ]; then
type -t help-text-intro >/dev/null && help-text-intro
fi
for item in $(list); do
local help_name text
help_name="help_${item//-/_}"
text="${!help_name-}"
[ -n "$text" ] && printf "%-30s\t%s\n" "$item" "$(echo "$text" | head -1)"
done
}
case "${1-}" in
list) list ;;
"" | "help") help "${2-}" ;;
*)
if ! declare -F "${1}" >/dev/null; then
printf "Unknown target: %s\n\n" "${1}"
help
exit 1
else
"$@"
fi
;;
esac
### END FRAMEWORK ###