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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
|
stages:
- build
- test
- analyze
- publish
- qa
default:
image: registry.gitlab.com/gitlab-org/gitlab-build-images/debian-${DEBIAN_VERSION}-golang-${GO_VERSION}-rust-${RUST_VERSION}:git-2.36
tags:
- gitlab-org
interruptible: true
variables:
FF_USE_FASTZIP: "true"
FF_NETWORK_PER_BUILD: "true"
DEBIAN_VERSION: "bullseye"
UBI_VERSION: "8.6"
CACHE_PREFIX: "debian-${DEBIAN_VERSION}"
# We use Gitaly's Git version by default.
GIT_VERSION: "default"
GO_VERSION: "1.20"
RUBY_VERSION: "3.1"
RUST_VERSION: "1.65"
POSTGRES_VERSION: "12-alpine"
PGBOUNCER_VERSION: "1.17.0"
GOCACHE: "${CI_PROJECT_DIR}/_build/cache/go-build"
GOMODCACHE: "${CI_PROJECT_DIR}/_build/cache/go-mod"
# We run the build as an untrusted user in a source directory owned by
# "root". Running Git commands in that repository will thus fail due to
# Git's `safe.directory` protections, and that in turns breaks the Go
# build. We work around this by telling Go to not embed VCS information in
# the binaries.
GOFLAGS: "-buildvcs=false -modcacherw"
# Run tests with an intercepted home directory so that we detect cases where
# Gitaly picks up the gitconfig even though it ought not to.
GITALY_TESTING_INTERCEPT_HOME: "YesPlease"
# TEST_UID is the user ID we use to run tests in an unprivileged way. 9999 is
# chosen as a semi-random value so as to not interfer with any preexisting
# users.
TEST_UID: 9999
include:
- template: Security/License-Scanning.gitlab-ci.yml
- template: Security/SAST.gitlab-ci.yml
- template: Security/Dependency-Scanning.gitlab-ci.yml
- template: Security/Secret-Detection.gitlab-ci.yml
- project: 'gitlab-org/quality/pipeline-common'
file:
- '/ci/danger-review.yml'
workflow:
rules:
- if: $CI_MERGE_REQUEST_IID
- if: $CI_COMMIT_TAG
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
- if: '$CI_COMMIT_BRANCH =~ /^[\d-]+-stable$/'
.cache_deps:
cache: &cache_deps_configuration
key:
files:
- .gitlab-ci.yml
- Makefile
prefix: ${CACHE_PREFIX}-git-${GIT_VERSION}
paths:
- _build/deps
- _build/tools
policy: pull
.cache_go:
cache: &cache_go_configuration
key:
files:
- .gitlab-ci.yml
- go.sum
prefix: ${CACHE_PREFIX}-go-${GO_VERSION}
paths:
- ${GOCACHE}
- ${GOMODCACHE}
policy: pull
.test_template: &test_definition
needs: []
stage: test
cache:
- *cache_deps_configuration
- *cache_go_configuration
services:
- name: postgres:${POSTGRES_VERSION}
alias: postgres
command: ["postgres", "-c", "max_connections=500"]
variables: &test_variables
PGHOST: postgres
PGPORT: 5432
PGUSER: postgres
POSTGRES_DB: praefect_test
POSTGRES_HOST_AUTH_METHOD: trust
TEST_JUNIT_REPORT: "${CI_PROJECT_DIR}/_build/reports/tests-junit.xml"
TEST_COVERAGE_DIR: "${CI_PROJECT_DIR}/_build/reports/coverage"
TEST_JSON_REPORT: "${CI_PROJECT_DIR}/_build/reports/test-report.json"
TEST_LOG_DIR: "${CI_PROJECT_DIR}/_build/reports/test-logs"
TEST_OPTIONS: "-count=1 -timeout=20m" # a number of tests may exceed the default 10m
before_script: &test_before_script
- go version
script:
# Create the build directory for the unprivileged user that we're running
# tests as. This is required because the source directory itself is owned
# by `root`.
- install --directory --owner=${TEST_UID} --group=${TEST_UID} _build
# But the actual tests should run unprivileged. This assures that we pay
# proper attention to permission bits and that we don't modify the source
# directory.
- setpriv --reuid=${TEST_UID} --regid=${TEST_UID} --clear-groups --no-new-privs make ${TEST_TARGET} $(test "${GIT_VERSION}" = default && echo WITH_BUNDLED_GIT=YesPlease)
coverage: /^total:\t+\(statements\)\t+\d+\.\d+%$/
after_script: &test_after_script
- go run "${CI_PROJECT_DIR}/tools/panic-parser"
- |
echo -e "section_start:$(date +%s):coverage[collapsed=true]\r\e[0KCode Coverage"
go tool cover -func "${TEST_COVERAGE_DIR}/all.merged"
echo -e "section_end:$(date +%s):coverage\r\e[0K"
artifacts: &test_artifacts
paths:
- ${TEST_LOG_DIR}
reports:
junit: ${TEST_JUNIT_REPORT}
coverage_report:
coverage_format: cobertura
path: ${TEST_COVERAGE_DIR}/cobertura.xml
when: always
expire_in: 1 week
.rules_should_test: &rules_should_test
- if: $CI_MERGE_REQUEST_IID
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
- if: '$CI_COMMIT_BRANCH =~ /^[\d-]+-stable$/'
.rules_run_on_merge: &rules_run_on_merge
# We only execute these rules in the main Gitaly repository. This is
# because jobs which run conditionally when being merged may depend on
# specific runners that aren't available in any other repository.
- if: $CI_PROJECT_PATH != "gitlab-org/gitaly"
when: manual
allow_failure: true
# Automatically run the job when the default branch is changing, e.g. due
# to a direct push.
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
# Automatically run the job when a merge request gets queued for merge.
- if: $CI_MERGE_REQUEST_EVENT_TYPE == "merge_train"
# Otherwise, allow for manually scheduling the job in the context of a
# merge request.
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
when: manual
allow_failure: true
danger-review:
needs: []
stage: build
allow_failure: true
variables:
GITLAB_DANGERFILES_VERSION: "3.1.0"
build:
needs: []
stage: build
cache:
- <<: *cache_deps_configuration
policy: pull-push
- <<: *cache_go_configuration
policy: pull-push
script:
- go version
# Build the binaries as unprivileged user so that we can reuse the cache
# for our "test" targets, which also run unprivileged.
- install --directory --owner=${TEST_UID} --group=${TEST_UID} _build
- setpriv --reuid=${TEST_UID} --regid=${TEST_UID} --clear-groups --no-new-privs make build $(test "${GIT_VERSION}" = default && echo build-bundled-git || echo build-git)
- go run ./tools/test-boot ${TEST_BOOT_ARGS}
parallel:
matrix:
- GO_VERSION: [ "1.19", "1.20" ]
TEST_BOOT_ARGS: "--bundled-git"
- GIT_VERSION: "v2.40.0"
build:binaries:
needs: []
stage: build
cache:
- *cache_deps_configuration
- *cache_go_configuration
only:
- tags
script:
# Just in case we start running CI builds on other architectures in future
- go version
- make -j$(nproc) build
- cd _build && sha256sum bin/* | tee checksums.sha256.txt
artifacts:
paths:
- _build/checksums.sha256.txt
- _build/bin/
name: "${CI_JOB_NAME}:go-${GO_VERSION}-git-${GIT_VERSION}"
expire_in: 6 months
parallel:
matrix:
- GO_VERSION: [ "1.19", "1.20" ]
test:
<<: *test_definition
parallel:
matrix:
# The following jobs all test with our default Git version, which is
# using bundled Git binaries.
- GO_VERSION: [ "1.19", "1.20" ]
TEST_TARGET: test
- TEST_TARGET: [ test-with-praefect, race-go, test-wal, test-with-praefect-wal]
# We also verify that things work as expected with a non-bundled Git
# version matching our minimum required Git version.
- TEST_TARGET: test
GIT_VERSION: "v2.40.0"
# Execute tests with our minimum required Postgres version, as well. If
# the minimum version changes, please change this to the new minimum
# version. Furthermore, please make sure to update the minimum required
# version in `datastore.CheckPostgresVersion()`.
- POSTGRES_VERSION: "11-alpine"
TEST_TARGET: [ test, test-with-praefect ]
rules:
- *rules_should_test
test:pgbouncer:
<<: *test_definition
services:
- name: postgres:${POSTGRES_VERSION}
alias: postgres
command: ["postgres", "-c", "max_connections=500"]
- name: bitnami/pgbouncer:${PGBOUNCER_VERSION}
alias: pgbouncer
variables:
<<: *test_variables
# The following variables are used by PgBouncer to connect to Postgres.
POSTGRESQL_HOST: "${PGHOST}"
POSTGRESQL_PORT: "${PGPORT}"
POSTGRESQL_USERNAME: "${PGUSER}"
# These variables define how PgBouncer itself is configured
PGBOUNCER_AUTH_TYPE: trust
PGBOUNCER_AUTH_USER: "${PGUSER}"
PGBOUNCER_DATABASE: "*"
PGBOUNCER_IGNORE_STARTUP_PARAMETERS: extra_float_digits
PGBOUNCER_POOL_MODE: transaction
PGBOUNCER_MAX_DB_CONNECTIONS: 100
# And these are finally used by Gitaly's tests.
PGHOST_PGBOUNCER: pgbouncer
PGPORT_PGBOUNCER: 6432
# We need to enable per-build networking such that the PgBouncer service
# can reach Postgres.
TEST_TARGET: "test-with-praefect"
rules:
- *rules_should_test
test:nightly:
<<: *test_definition
variables:
<<: *test_variables
SKIP_OVERRIDING_GIT_VERSION: "YesPlease"
parallel:
matrix:
- GIT_VERSION: [ "master", "next" ]
TEST_TARGET: [ test, test-with-praefect ]
rules:
- if: '$CI_PIPELINE_SOURCE == "schedule"'
- when: manual
allow_failure: true
test:praefect_smoke:
<<: *test_definition
script:
- make -j$(nproc)
- envsubst < _support/config.praefect.toml.ci-sql-test > config.praefect.toml
- ./_build/bin/praefect -config config.praefect.toml sql-ping
- ./_build/bin/praefect -config config.praefect.toml sql-migrate
rules:
- *rules_should_test
test:sha256:
<<: *test_definition
parallel:
matrix:
- TEST_TARGET: [ test, test-with-praefect ]
GITALY_TESTING_ENABLE_SHA256: "YesPlease"
rules:
- *rules_should_test
test:fips:
<<: *test_definition
image: registry.gitlab.com/gitlab-org/gitlab-build-images/ubi-${UBI_VERSION}-golang-${GO_VERSION}-rust-${RUST_VERSION}:git-2.36
tags:
- fips
cache:
- <<: *cache_deps_configuration
policy: pull-push
- <<: *cache_go_configuration
policy: pull-push
variables:
<<: *test_variables
CACHE_PREFIX: ubi-${UBI_VERSION}
before_script:
- test "$(cat /proc/sys/crypto/fips_enabled)" = "1" || (echo "System is not running in FIPS mode" && exit 1)
- chmod +t /tmp
- *test_before_script
parallel:
matrix:
- TEST_TARGET: [ test, test-with-praefect ]
FIPS_MODE: "YesPlease"
GO_VERSION: ["1.19"]
rules:
# Automatically run the job when the FIPS label is set.
- if: $CI_MERGE_REQUEST_LABELS =~ /FIPS/
- *rules_run_on_merge
test:macos:
image: macos-12-xcode-14
tags:
- shared-macos-amd64
needs: []
allow_failure: true
stage: test
cache:
- <<: *cache_deps_configuration
policy: pull-push
- <<: *cache_go_configuration
policy: pull-push
variables:
<<: *test_variables
CACHE_PREFIX: macos-12-xcode-14
PGDATA: /usr/local/var/postgres
PGHOST: localhost
PGUSER: gitlab
before_script:
- brew uninstall go
- brew install cmake go@${GO_VERSION}
# Older Go versions may be keg-only and thus aren't linked into `PATH` by
# default. We need to override this mechanism to force this specific Go
# version to become active.
- brew link --force go@${GO_VERSION}
- sw_vers
- go version
- pg_ctl --version
- ulimit -n 4096 # The default of 256 can lead to 'too many open files' errors when running parallel tests
- pg_ctl -D /usr/local/var/postgres start > /tmp/postgres.log
- pg_ctl status
- createdb -U $PGUSER $POSTGRES_DB
- make -j$(nproc) build prepare-tests
script:
- make test-go
after_script:
- *test_after_script
rules:
- *rules_run_on_merge
artifacts:
<<: *test_artifacts
verify:docs:
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.20.2-markdownlint-0.32.2-markdownlint2-0.5.1
needs: []
stage: analyze
script:
- make lint-docs
rules:
- *rules_should_test
verify:
needs: []
stage: analyze
cache:
- *cache_deps_configuration
- *cache_go_configuration
script:
# Download the dependencies in case there was no cache hit, otherwise
# golang-ci lint will timeout downloading them.
- go mod download
- make -j$(nproc) verify
artifacts:
paths:
- _build/proto.diff
- proto/go/gitalypb/*
when: on_failure
rules:
- *rules_should_test
dbschema:
needs: []
stage: analyze
cache:
- *cache_deps_configuration
- *cache_go_configuration
services:
# The database version we use must match the version of `pg_dump` we have
# available in the build image.
- postgres:11.13-alpine
variables:
<<: *test_variables
script:
- make dump-database-schema no-changes
artifacts:
paths:
- _support/praefect-schema.sql
when: on_failure
rules:
- *rules_should_test
semgrep-sast:
needs: []
stage: analyze
cache:
- *cache_go_configuration
rules:
- if: $SAST_DISABLED
when: never
- *rules_should_test
license_scanning:
needs: []
stage: analyze
rules:
- if: $LICENSE_SCANNING_DISABLED
when: never
- *rules_should_test
variables:
LICENSE_FINDER_CLI_OPTS: '--aggregate-paths=.'
secret_detection:
needs: []
stage: analyze
rules:
- if: $SECRET_DETECTION_DISABLED
when: never
- *rules_should_test
build-proto-gem:
needs: []
image: ruby:${RUBY_VERSION}
stage: publish
before_script: []
variables:
BUILD_GEM_OPTIONS: --skip-verify-tag
script:
- make build-proto-gem
rules:
- when: manual
allow_failure: true
artifacts:
paths:
- _build/gitaly.gem
expire_in: 1 month
publish-proto-gem:
needs: []
image: ruby:${RUBY_VERSION}
stage: publish
before_script: []
script:
- make publish-proto-gem
rules:
- if: '$CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_NAMESPACE == "gitlab-org" && $CI_COMMIT_TAG'
pages:
needs: []
stage: publish
allow_failure: true
script:
- make build-proto-docs
- mv _build/proto-docs public
artifacts:
paths:
- public
rules:
- *rules_run_on_merge
build-package-and-qa:
needs: []
stage: qa
trigger:
project: gitlab-org/build/omnibus-gitlab-mirror
strategy: depend
variables:
ALTERNATIVE_SOURCES: "true"
GITALY_SERVER_VERSION: $CI_COMMIT_SHA
GITALY_SERVER_ALTERNATIVE_REPO: $CI_PROJECT_URL
ee: "true"
rules:
- if: $CI_MERGE_REQUEST_IID
changes:
- go.sum
variables:
BUILD_ON_ALL_OS: "true"
MANUAL_QA_TEST: "true"
allow_failure: false
- when: manual
allow_failure: true
qa:nightly-praefect-migration-test:
needs: []
stage: qa
trigger:
project: gitlab-org/quality/praefect-migration-testing
rules:
- if: '$CI_PIPELINE_SOURCE == "schedule"'
|