-
-
Notifications
You must be signed in to change notification settings - Fork 85
1057 lines (1039 loc) · 42.7 KB
/
tenzir.yaml
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
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
name: Tenzir
on:
workflow_dispatch:
inputs:
upload-static-binary-to-github:
description: "Build the static binary packages and attach to the Workflow Run"
type: boolean
required: false
default: false
push:
branches:
- main
- v*
pull_request:
types:
- opened
- synchronize
merge_group:
types:
- checks_requested
release:
types:
- published
# This section defines how the Tenzir action is enqueued.
concurrency:
# Wait for in-progress runs of this action for the same branch to finish
# before starting, ensuring that a branch is only built once at a time. This
# has a double-purpose: It ensures that caches are always able to pick up work
# from previous builds of the same branch, and it rate-limits the CI to ensure
# it's running smoothly for all users.
group: ${{ github.workflow }}-${{ github.ref }}
# Cancel all in-progress runs of this action for the same pull request.
cancel-in-progress: ${{ github.event_name == 'pull_request' || github.event_name == 'merge_group' }}
env:
CCACHE_MAXSIZE: "5G"
GCP_WORKLOAD_IDP: projects/1057156539039/locations/global/workloadIdentityPools/gh-actions-pool/providers/gh-actions-provider
GCP_SERVICE_ACCOUNT: github-actions@crucial-kayak-261816.iam.gserviceaccount.com
# TODO: cherry-pick permissions
permissions:
actions: write
checks: write
contents: write
deployments: write
id-token: write
issues: write
discussions: write
packages: write
pages: write
pull-requests: write
repository-projects: write
security-events: write
statuses: write
jobs:
configure:
name: Configure
runs-on: ubuntu-20.04
outputs:
version-matrix: ${{ steps.configure.outputs.version-matrix }}
build-version: ${{ steps.configure.outputs.build-version }}
before-sha: ${{ steps.configure.outputs.before-sha }}
before-version: ${{ steps.configure.outputs.before-version }}
release-version: ${{ steps.configure.outputs.release-version }}
ref-slug: ${{ steps.configure.outputs.ref-slug }}
head-ref-slug: ${{ steps.configure.outputs.head-ref-slug }}
base-ref-slug: ${{ steps.configure.outputs.base-ref-slug }}
tenzir-container-ref: ${{ steps.configure.outputs.tenzir-container-ref }}
tenzir-version-build-metadata: ${{ steps.configure.outputs.tenzir-version-build-metadata }}
run-changelog: ${{ steps.configure.outputs.run-changelog }}
run-docs: ${{ steps.configure.outputs.run-docs }}
run-docker-tenzir: ${{ steps.configure.outputs.run-docker-tenzir }}
docker-config: ${{ steps.docker.outputs.docker-config }}
run-regression-tests: ${{ steps.configure.outputs.run-regression-tests }}
run-tenzir-nix: ${{ steps.configure.outputs.run-tenzir-nix }}
nix-matrix: ${{ steps.nix.outputs.nix-matrix }}
run-tenzir: ${{ steps.configure.outputs.run-tenzir }}
run-tenzir-plugins: ${{ steps.configure.outputs.run-tenzir-plugins }}
run-python: ${{ steps.configure.outputs.run-python }}
run-python-package: ${{ steps.configure.outputs.run-python-package }}
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Fetch Tags
run: git fetch origin +refs/tags/*:refs/tags/*
- name: Inject Slug Variables
uses: rlespinasse/github-slug-action@v4
- name: Authenticate to Google Cloud
uses: google-github-actions/auth@v2
with:
workload_identity_provider: ${{ env.GCP_WORKLOAD_IDP }}
service_account: ${{ env.GCP_SERVICE_ACCOUNT }}
- name: Configure GCloud Credentials
uses: google-github-actions/setup-gcloud@v2
- name: Configure
id: configure
run: |
# Create a matrix with Tenzir versions greater or equal than
# limit_version. If the version does not exist yet (e.g., because of
# an intentional break), only check latest. We usually set this to the
# minimum supported version.
limit_version=v4.9.0
if git rev-parse "${limit_version}" --; then
dated_versions=$(git for-each-ref --format="%(creatordate:format:%s)#%(refname:short)" "refs/tags/v[1-9]*" | grep -v '\-rc[0-9]\+$')
dated_limit_version=$(printf "$dated_versions" | grep $limit_version)
# We filter out versions older than limit_version, and a set of
# releases that are known to be broken, e.g., because their upload
# failed in CI.
filtered_versions=$(printf "$dated_versions" | awk '-F#' '{if($0>="'$dated_limit_version'")print$2}' | grep -v 'v4.11.0')
version_matrix="$(printf "$filtered_versions\nlatest\n" | jq -R | jq -sc 'map({version: .})')"
else
version_matrix="$(printf "latest\n" | jq -R | jq -sc 'map({version: .})')"
fi
echo "version-matrix=${version_matrix}" >> $GITHUB_OUTPUT
# Set a bunch of version numbers depending on how we triggered the PR
# so they're consistent between jobs.
version="v$(jq -r '."tenzir-version"' version.json)"
id_sha="${{ github.sha }}"
release_version="${version}"
build_version="${version}+g${id_sha:0:10}"
if [[ "$GITHUB_EVENT_NAME" == "push" ]]; then
before_sha="${{ github.event.before }}"
else
before_sha="$(git merge-base origin/main HEAD)"
fi
before_version="${version}+g${before_sha:0:10}"
echo "build-version=${build_version}" >> $GITHUB_OUTPUT
echo "before-sha=${before_sha}" >> $GITHUB_OUTPUT
echo "before-version=${before_version}" >> $GITHUB_OUTPUT
echo "release-version=${release_version}" >> $GITHUB_OUTPUT
# Inject the branch slugs for cache names.
echo "ref-slug=${GITHUB_REF_SLUG}" >> $GITHUB_OUTPUT
echo "head-ref-slug=${GITHUB_HEAD_REF_SLUG}" >> $GITHUB_OUTPUT
echo "base-ref-slug=${GITHUB_BASE_REF_SLUG}" >> $GITHUB_OUTPUT
if [[ "$GITHUB_EVENT_NAME" == "release" ]]; then
tenzir_version_build_metadata=""
tenzir_docker_version_build_metadata=""
else
tenzir_version_build_metadata="g${id_sha:0:10}"
tenzir_docker_version_build_metadata="${tenzir_version_build_metadata}"
# In Pull Requests we replace the normal commit hash based version
# suffix with the PR number. That way we get stable arguments to
# `docker build`, which is needed for layer caching to work.
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
tenzir_docker_version_build_metadata="pr${{ github.event.number }}"
fi
fi
echo "tenzir-version-build-metadata=${tenzir_version_build_metadata}" >> $GITHUB_OUTPUT
echo "tenzir-docker-version-build-metadata=${tenzir_docker_version_build_metadata}" >> $GITHUB_OUTPUT
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
tenzir_container_ref="${GITHUB_HEAD_REF_SLUG}"
else
tenzir_container_ref="${{ github.sha }}"
fi
echo "tenzir-container-ref=${tenzir_container_ref}" >> $GITHUB_OUTPUT
#################################
######## Decide what jobs to run.
#################################
# TODO: Split this into two steps:
# * Set version variables (above)
# * Enable Jobs (below)
echo "::notice Disable all others so we can selectivly enable again"
echo "run-changelog=false" >> $GITHUB_OUTPUT
echo "run-regression-tests=false" >> $GITHUB_OUTPUT
echo "run-python=false" >> $GITHUB_OUTPUT
echo "run-python-package=false" >> $GITHUB_OUTPUT
echo "run-docs=false" >> $GITHUB_OUTPUT
echo "run-docker-tenzir=false" >> $GITHUB_OUTPUT
echo "run-tenzir-nix=false" >> $GITHUB_OUTPUT
echo "run-tenzir=false" >> $GITHUB_OUTPUT
echo "run-tenzir-plugins=false" >> $GITHUB_OUTPUT
# A little helper to enable all checks.
shopt -s expand_aliases
alias run_all_checks=' \
echo "run-changelog=true" >> $GITHUB_OUTPUT; \
echo "run-regression-tests=true" >> $GITHUB_OUTPUT; \
echo "run-python=true" >> $GITHUB_OUTPUT; \
echo "run-docs=true" >> $GITHUB_OUTPUT; \
echo "run-docker-tenzir=true" >> $GITHUB_OUTPUT; \
echo "run-tenzir-nix=true" >> $GITHUB_OUTPUT; \
echo "run-tenzir=true" >> $GITHUB_OUTPUT; \
echo "run-tenzir-plugins=true" >> $GITHUB_OUTPUT;'
# Run all if this is a release.
if [[ "$GITHUB_EVENT_NAME" == "release" ]]; then
echo "::notice Enabling release jobs"
run_all_checks
# Publish tenzir to Pypi.
echo "run-python-package=true" >> $GITHUB_OUTPUT
exit 0
fi
# Run all checks if this is a push to master or a tag.
if [[ "$GITHUB_EVENT_NAME" == "push" ]]; then
echo "::notice Enabling push jobs"
run_all_checks
exit 0
fi
# Run only what is requested for a workflow dispatch.
if [[ "$GITHUB_EVENT_NAME" == "workflow_dispatch" ]]; then
echo "::notice Enabling workflow dispatch jobs"
if [[ "${{ inputs.upload-static-binary-to-github }}" == "true" ]]; then
echo "run-tenzir-nix=true" >> $GITHUB_OUTPUT
fi
exit 0
fi
# From here on we should be in a pull request.
if [[ "$GITHUB_EVENT_NAME" != "pull_request" ]]; then
echo "::error Unexpected GitHub Event: $GITHUB_EVENT_NAME"
exit 1
fi
echo "::notice Enabling pull request jobs"
echo "::notice sourcing configure helpers"
source ./.github/workflows/configure_helpers.bash
# Run all checks if this file changed.
if is_changed .github/workflows/tenzir.yaml; then
run_all_checks
exit 0
fi
run_if_changed python "python/"
run_if_changed docs "web/" "python/"
run_if_changed changelog "changelog/" "web/" "python/"
TENZIR_SOURCES=(cmake/ CMakeLists.txt libtenzir/ libtenzir_test/ schema/ tools/ tenzir/ tenzir.yaml.example version.json)
run_if_changed tenzir "${TENZIR_SOURCES[@]}"
run_if_changed_default tenzir-plugins $run_tenzir "plugins/" "contrib/tenzir-plugins/"
# The tenzir-plugins job downloads the Tenzir artifact from GCS, so we
# need to run the tenzir job in case it is missing.
if [[ ${run_tenzir_plugins} == "true" && ${run_tenzir} == "false" ]]; then
deb_package="$(echo "tenzir-${before_version}-linux-Release-GCC" | awk '{ print tolower($0) }')"
mac_package="$(echo "tenzir-${before_version}-darwin-Release-Clang" | awk '{ print tolower($0) }')"
if ! gsutil -q stat gs://${{ vars.GCS_BUCKET }}/${deb_package}.tar.gz || \
! gsutil -q stat gs://${{ vars.GCS_BUCKET }}/${mac_package}.tar.gz; then
echo "run-tenzir=true" >> $GITHUB_OUTPUT
run_tenzir=true
fi
fi
run_docker_tenzir="$(any ${run_tenzir} ${run_tenzir_plugins} ${run_python})"
run_if_changed_default docker-tenzir $run_docker_tenzir \
"Dockerfile" ".dockerignore" \
".github/workflows/docker.yaml" \
".github/workflows/docker-config-base.json"
run_if_changed_default regression-tests $run_docker_tenzir
run_if_changed tenzir-nix \
"${TENZIR_SOURCES[@]}" plugins/ contrib/tenzir-plugins/ flake.nix flake.lock nix/ \
".github/workflows/nix.nu" \
".github/workflows/nix.yaml" \
".github/workflows/nix-config-base.json"
- name: Configure Docker
id: docker
if: steps.configure.outputs.run-docker-tenzir == 'true'
run: |
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
tags=("${{ steps.configure.outputs.head-ref-slug }}")
elif [[ "$GITHUB_EVENT_NAME" == "push" ]]; then
tags=('main' "${{ github.sha }}")
elif [[ "$GITHUB_EVENT_NAME" == "release" ]]; then
tags=('latest' "${{ github.sha }}" "${{ steps.configure.outputs.release-version }}")
else
echo "::error unexpected github.event_name: \"${GITHUB_EVENT_NAME}\""
exit 1
fi
docker_config="$(jq -c \
'."version-build-metadata" = $vs | ."tags" = $ARGS.positional' \
.github/workflows/docker-config-base.json \
--arg vs "${{ steps.configure.outputs.tenzir-docker-version-build-metadata }}" \
--args -- "${tags[@]}")"
# Clear push repos in case we're in a PR, but push the community
# edition to ghcr.
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
docker_config="$(jq -c '(.editions[] | .registries) |= [] |
(.editions[] | select(.name == "tenzir" or .name == "tenzir-node") |
.registries) |= ["ghcr.io"]' \
<<< "${docker_config}")"
fi
echo "docker-config=${docker_config}" >> "$GITHUB_OUTPUT"
echo "::notice docker-config = ${docker_config}"
- name: Configure Nix
id: nix
if: steps.configure.outputs.run-tenzir-nix == 'true'
run: |
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
container_tags=("${{ steps.configure.outputs.head-ref-slug }}")
elif [[ "$GITHUB_EVENT_NAME" == "push" ]]; then
container_tags=('main' "${{ github.sha }}")
aliases=('main')
elif [[ "$GITHUB_EVENT_NAME" == "release" ]]; then
container_tags=('latest' "${{ github.sha }}" "${{ steps.configure.outputs.release-version }}")
aliases=('latest')
else
echo "::error unexpected github.event_name: \"${GITHUB_EVENT_NAME}\""
exit 1
fi
nix_config="$(jq -c \
'."container-tags" = $ARGS.positional' \
.github/workflows/nix-config-base.json \
--args -- "${container_tags[@]}")"
nix_config="$(jq -c \
'."aliases" = $ARGS.positional' \
--args -- "${aliases[@]}" \
<<< "${nix_config}")"
if [[ "$GITHUB_REF" == refs/tags/* ]]; then
nix_config="$(jq -c --arg git_tag "${GITHUB_REF#refs/tags/}" \
'."git-tag" = $git_tag' \
<<< "${nix_config}")"
fi
# Clear push repos in case we're in a PR, but push the developer
# edition to ghcr.
if [[ "$GITHUB_EVENT_NAME" == "pull_request" ]]; then
nix_config="$(jq -c '(.editions[] | ."package-stores") |= [] |
(.editions[] | ."image-registries") |= [] |
(.editions[] | select(.name == "tenzir") | ."image-registries") |= ["ghcr.io"]' \
<<< "${nix_config}")"
fi
# Reshape the config so that each edition is in a dedicated config.
# This will be supplied as a matrix to the nix job.
# We do this because the static editions that we build here are
# independent derivations, meaning there is no sharing of build
# products.
nix_matrix="$(jq -c '.aliases as $aliases | ."container-tags" as $tags | ."git-tag" as $git_tag |
.targets = (.editions | map(. as $e |{}|
.editions = [$e] |
.aliases = $aliases |
."container-tags" = $tags |
."git-tag" = $git_tag)
) | .targets | map({"name": .editions[0].name, "config": .})' \
<<< "${nix_config}")"
echo "nix-matrix=${nix_matrix}" >> "$GITHUB_OUTPUT"
echo "::notice nix-matrix = ${nix_matrix}"
policy-enforcement:
name: Policy Enforcement
needs:
- configure
if: github.event_name != 'workflow_dispatch'
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Configure ssh-agent
uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: ${{ secrets.TENZIR_PLUGINS_DEPLOY_KEY }}
- name: Require contrib/tenzir-plugins to be downstream of current `main`
run: |
git submodule update --init contrib/tenzir-plugins
git -C contrib/tenzir-plugins fetch origin main
# Check that the plugins submodule commit is either already merged
# into `main` or descends from current `main`.
git -C contrib/tenzir-plugins merge-base --is-ancestor \
$(git -C contrib/tenzir-plugins rev-parse origin/main) \
$(git -C contrib/tenzir-plugins rev-parse HEAD) || \
git -C contrib/tenzir-plugins merge-base --is-ancestor \
$(git -C contrib/tenzir-plugins rev-parse HEAD) \
$(git -C contrib/tenzir-plugins rev-parse origin/main)
- name: Generate a token
id: generate_token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ vars.TENZIR_AUTOBUMPER_APP_ID }}
private-key: ${{ secrets.TENZIR_AUTOBUMPER_APP_PRIVATE_KEY }}
owner: ${{ github.repository_owner }}
- name: Require an open PR for a submodule bump
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}
run: |
plugins_sha=$(git -C contrib/tenzir-plugins rev-parse HEAD)
plugins_main_sha=$(git -C contrib/tenzir-plugins rev-parse origin/main)
if [ "$plugins_sha" != "$plugins_main_sha" ]; then
pr_number=$(gh pr --repo tenzir/tenzir-plugins list --search $plugins_sha --json number -q .[0].number)
[ $pr_number ] # Assert the pr number was non-empty
fi
- name: Install Nix
uses: cachix/install-nix-action@v26
with:
nix_path: nixpkgs=channel:nixos-unstable
- name: Verify Nix sources are synchronized
run: |
nix/update.sh
git diff --quiet --exit-code || {
echo "Some Nix source references are not aligned with the git submodules."
echo "Please run *nix/update.sh* or apply the following diff directly:"
git diff --exit-code
}
changelog:
name: Changelog
needs:
- configure
if: ${{ needs.configure.outputs.run-changelog == 'true' }}
runs-on: ubuntu-20.04
container: debian:bookworm-slim
steps:
- name: Install git
run: |
apt-get update
apt-get -y install git
- name: Checkout
uses: actions/checkout@v4
- name: Install Dependencies
run: ./scripts/debian/install-dev-dependencies.sh
- name: Configure Build
env:
CC: gcc-12
CXX: g++-12
run: |
cmake -B build -DTENZIR_ENABLE_SKIP_AFTER_CHANGELOG_UPDATE:BOOL=ON
- name: Generate CHANGELOG.md
run: |
cmake --build build --target changelog
- name: Upload CHANGELOG.md
uses: actions/upload-artifact@v4
with:
name: CHANGELOG.md
path: build/CHANGELOG.md
if-no-files-found: error
docs:
needs:
- configure
- changelog
if: ${{ needs.configure.outputs.run-docs == 'true' }}
name: Documentation
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Checkout dotgithub submodule
run: |
git submodule update --init web/.github
- name: Download CHANGELOG.md
uses: actions/download-artifact@v4
with:
name: CHANGELOG.md
- name: Override Stub Changelog
run: |
cp -f CHANGELOG.md web/src/pages/changelog.md
- uses: actions/setup-node@v4
with:
node-version: 16.x
cache-dependency-path: web/yarn.lock
cache: yarn
- name: Install dependencies
working-directory: web
run: yarn install --frozen-lockfile
- name: Build website
working-directory: web
run: |
yarn build
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: web/build
cname: docs.tenzir.com
user_name: tenzir-bot
user_email: engineering@tenzir.com
docker-tenzir:
name: Docker
needs:
- configure
if: needs.configure.outputs.run-docker-tenzir == 'true'
uses: ./.github/workflows/docker.yaml
with:
config: ${{ needs.configure.outputs.docker-config }}
secrets: inherit
openapi-spec:
needs:
- docker-tenzir
- configure
if: needs.configure.outputs.run-docker-tenzir == 'true'
name: OpenAPI Spec
runs-on: ubuntu-20.04
env:
DOCKER_BUILDKIT: 1
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Check OpenAPI Spec
run: |
docker run \
--pull=always --rm \
"ghcr.io/tenzir/tenzir:${{ needs.configure.outputs.tenzir-container-ref }}" \
'openapi | to web/openapi/openapi.yaml'
git diff --quiet --exit-code || {
echo "The OpenAPI Spec is not aligned with the current sources. Please run *tenzir 'openapi | to web/openapi/openapi.yaml'* or apply the following diff directly:"
git diff --exit-code
}
regression-tests:
needs:
- docker-tenzir
- configure
if: needs.configure.outputs.run-regression-tests == 'true'
strategy:
fail-fast: false
matrix:
regression-tests: ${{ fromJson(needs.configure.outputs.version-matrix) }}
name: Regression Tests (${{ matrix.regression-tests.version }})
runs-on: ubuntu-20.04
env:
DOCKER_BUILDKIT: 1
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3
- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Run Regression Tests
run: |
scripts/regression-tests.sh ${{ matrix.regression-tests.version }} ${{ needs.configure.outputs.tenzir-container-ref }}
tenzir-nix:
name: Nix (${{ matrix.config.name }})
needs:
- configure
if: ${{ needs.configure.outputs.run-tenzir-nix == 'true' }}
uses: ./.github/workflows/nix.yaml
strategy:
matrix:
config: ${{ fromJSON(needs.configure.outputs.nix-matrix) }}
with:
config: ${{ toJSON(matrix.config.config) }}
secrets: inherit
tenzir:
needs:
- configure
if: ${{ needs.configure.outputs.run-tenzir == 'true' }}
name: Tenzir (${{ matrix.tenzir.name }})
runs-on: ${{ matrix.tenzir.os }}
container: ${{ matrix.tenzir.container }}
strategy:
fail-fast: false
matrix:
tenzir:
- os: ubuntu-20.04
container: debian:bookworm-slim
name: Debian
compiler: GCC
cc: gcc-12
cxx: g++-12
dependencies-script-path: scripts/debian/install-dev-dependencies.sh
cmake-extra-flags: -DTENZIR_ENABLE_BUNDLED_CAF:BOOL=ON
bundled-plugins:
# We enable some plugins here, because:
# - fluent-bit: The plugin library links to libfluent-bit.so, which
# is built by upstream without support for `dlopen()`, the
# integrated build method used here works around that by linking
# libfluent-bit.so to libtenzir.so directly. The alternative
# workaround of using LD_PRELOAD for the standalone plugin build
# does not work in the GitHub Actions Runner.
# - zmq: The VAST plugin requires it, so for it to pass CI it has
# to be bundled already.
- plugins/fluent-bit
- plugins/zmq
- os: macos-14
container: null
name: macOS
compiler: Clang
cc: clang
cxx: clang++
dependencies-script-path: scripts/macOS/install-dev-dependencies.sh
cmake-extra-flags: -DTENZIR_ENABLE_BUNDLED_CAF:BOOL=ON
bundled-plugins:
# - Parquet uses illegal instructions on macOS in Arrow version
# 14.0.1, so we disable it in the macOS CI. Last checked on
# 2023-12-16.
# - The http-parser package is disabled on Hoembrew, which means
# we cannot build the web plugin on macOS anymore. Last checked
# on 2024-01-31.
- plugins/[^(parquet)(web)]*
- contrib/tenzir-plugins/*
env:
BUILD_DIR: build
CC: ${{ matrix.tenzir.cc }}
CXX: ${{ matrix.tenzir.cxx }}
CCACHE_ABSSTDERR: true
CCACHE_COMPRESS: true
CCACHE_COMPRESSLEVEL: 6
# We're intentionally placing the cache dir outside of `${{ github.workspace }}`
# because that has a weird issue where it switches between `/home/runner` and
# `/__w/` depending on the current context. See https://github.com/actions/checkout/issues/785
# and https://github.com/actions/runner/issues/2058.
# We use `/tmp` because that's writable on both mac and linux runners.
CCACHE_DIR: "/tmp/ccache"
CCACHE_NOHASHDIR: true
CCACHE_SLOPPINESS: "file_macro,time_macros"
CCACHE_UNIFY: true
CMAKE_CXX_COMPILER_LAUNCHER: ccache
CMAKE_C_COMPILER_LAUNCHER: ccache
CMAKE_GENERATOR: Ninja
CMAKE_MAKE_PROGRAM: ninja
DEBIAN_FRONTEND: noninteractive
HOMEBREW_GITHUB_API_TOKEN: ${{ github.token }}
HOMEBREW_NO_ANALYTICS: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
HOMEBREW_NO_AUTO_UPDATE: 1
steps:
- if: ${{ matrix.tenzir.name == 'Debian' }}
name: Install extra dependencies
run: |
apt-get update
apt-get -y install git sudo
- name: Checkout
uses: actions/checkout@v4
- name: Publish tenzir.spdx.json to GitHub Release
if: ${{ github.event_name == 'release' && matrix.tenzir.name == 'Debian' }}
uses: actions/upload-release-asset@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ github.event.release.upload_url }}
asset_path: "tenzir.spdx.json"
asset_name: "tenzir.spdx.json"
asset_content_type: text/plain
- name: Checkout submodules
run: |
git config --global --add safe.directory '*'
git submodule update --init --recursive libtenzir
git submodule update --init --recursive plugins
git submodule update --init --recursive tenzir
- name: Install Dependencies (Debian)
if: ${{ matrix.tenzir.name == 'Debian' }}
run: |
./scripts/debian/install-dev-dependencies.sh
./scripts/debian/install-fluent-bit.sh
- name: Install Dependencies (macOS)
if: ${{ matrix.tenzir.name == 'macOS' }}
run: ./scripts/macOS/install-dev-dependencies.sh
- name: Setup Python
if: ${{ matrix.tenzir.name == 'macOS' }}
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install Nix
uses: cachix/install-nix-action@v26
with:
nix_path: nixpkgs=channel:nixos-unstable
- name: Configure Environment
run: |
PACKAGE_NAME="$(echo "tenzir-${{ needs.configure.outputs.build-version }}-$(uname -s)-Release-${{ matrix.tenzir.compiler }}" | awk '{ print tolower($0) }')"
PUBLISH_NAME="$(echo "tenzir-$(uname -s)-Release-${{ matrix.tenzir.compiler }}" | awk '{ print tolower($0) }')"
echo "PACKAGE_NAME=$PACKAGE_NAME" >> $GITHUB_ENV
echo "PUBLISH_NAME=$PUBLISH_NAME" >> $GITHUB_ENV
- if: ${{ matrix.tenzir.name == 'macOS' }}
name: Setup Homebrew Clang
run: |
llvm_root="$(brew --prefix llvm)"
echo "${llvm_root}/bin" >> $GITHUB_PATH
echo "LDFLAGS=-Wl,-rpath,${llvm_root}" >> $GITHUB_ENV
echo "CPPFLAGS=-isystem ${llvm_root}/include" >> $GITHUB_ENV
echo "CXXFLAGS=-isystem ${llvm_root}/include/c++/v1" >> $GITHUB_ENV
- name: Fetch ccache Cache
uses: actions/cache/restore@v4
with:
# Note that the `path` is implicitly part of the key when looking up cache hits:
# GitHub will only download artifacts that contain files whose locations matches `path`,
# so if the `path` changes nothing will be downloaded even if the key name matches.
path: ${{ env.CCACHE_DIR }}
key: ${{ github.workflow }}-${{ matrix.tenzir.name }}-${{ matrix.tenzir.compiler }}-${{ needs.configure.outputs.ref-slug }}-${{ github.sha }}
restore-keys: |
${{ github.workflow }}-${{ matrix.tenzir.name }}-${{ matrix.tenzir.compiler }}-${{ needs.configure.outputs.ref-slug }}
${{ github.workflow }}-${{ matrix.tenzir.name }}-${{ matrix.tenzir.compiler }}-main
${{ github.workflow }}-${{ matrix.tenzir.name }}-${{ matrix.tenzir.compiler }}
- name: Configure
run: |
echo "$PATH"
python3 --version
python3 -m pip --version
bash --version
"$CC" --version
"$CXX" --version
ccache --version
# Zero the cache statistics (but not the configuration options).
ccache --zero-stats
ccache --show-config
# Setting different values for CMAKE_INSTALL_PREFIX and
# CPACK_PACKAGING_INSTALL_PREFIX is currently not supported and causes
# a warning. We accept this drawback because the package we generate
# here is built specifically as input for the plugin CI jobs and not
# suitable for general use.
cmake -B "$BUILD_DIR" \
-DCMAKE_BUILD_TYPE:STRING="${{ github.event_name == 'pull_request' && 'CI' || 'Release' }}" \
-DCMAKE_INSTALL_PREFIX:STRING="${PWD}/opt/tenzir" \
-DCPACK_GENERATOR:STRING=TGZ \
-DCPACK_PACKAGE_FILE_NAME:STRING="$PACKAGE_NAME" \
-DCPACK_PACKAGING_INSTALL_PREFIX:STRING="/" \
-DTENZIR_PLUGINS:STRING="${{ join(matrix.tenzir.bundled-plugins, ';') }}" \
-DTENZIR_VERSION_BUILD_METADATA:STRING="${{ needs.configure.outputs.tenzir-version-build-metadata }}" \
${{ matrix.tenzir.cmake-extra-flags }}
- name: Compile All Targets
run: |
cmake --build "$BUILD_DIR" --target all --parallel --verbose
- name: Show ccache Statistics
run: |
# Print statistics counter IDs and corresponding values.
ccache --show-stats
# Print statistics about cache compression.
ccache --show-compression
- name: Save ccache Cache
if: always()
uses: actions/cache/save@v4
with:
path: ${{ env.CCACHE_DIR }}
key: ${{ github.workflow }}-${{ matrix.tenzir.name }}-${{ matrix.tenzir.compiler }}-${{ needs.configure.outputs.ref-slug }}-${{ github.sha }}
enableCrossOsArchive: true
- name: Run Unit Tests
env:
CTEST_OUTPUT_ON_FAILURE: YES
# --test-dir is not yet supported in the ctest version we're using here.
working-directory: ${{ env.BUILD_DIR }}
run: |
ctest --parallel
- name: Install
run: |
cmake --install "$BUILD_DIR"
- name: Run Integration Tests
id: integration_tests
run: |
VERBOSE=1 cmake --build "$BUILD_DIR" --target integration -j 1
- name: Publish Integration Test Report
uses: mikepenz/action-junit-report@v4
if: always()
with:
report_paths: report.xml
token: ${{ secrets.GITHUB_TOKEN }}
- name: Package
env:
DESTDIR: ${{ env.PWD }}
run: |
cmake --build "$BUILD_DIR" --target package
- name: Upload Artifact to GitHub
uses: actions/upload-artifact@v4
with:
name: "${{ env.PACKAGE_NAME }}.tar.gz"
path: "${{ env.BUILD_DIR }}/package/${{ env.PACKAGE_NAME }}.tar.gz"
if-no-files-found: error
- name: Authenticate to Google Cloud
if: ${{ github.event_name == 'push' || github.event_name == 'release' }}
uses: google-github-actions/auth@v2
with:
workload_identity_provider: ${{ env.GCP_WORKLOAD_IDP }}
service_account: ${{ env.GCP_SERVICE_ACCOUNT }}
- name: Configure GCloud Credentials
if: ${{ github.event_name == 'push' || github.event_name == 'release' }}
uses: google-github-actions/setup-gcloud@v2
- name: Upload Artifact to GCS
if: ${{ github.event_name == 'push' || github.event_name == 'release' }}
run: |
gsutil -m cp "${{ env.BUILD_DIR }}/package/${{ env.PACKAGE_NAME }}.tar.gz" "gs://${{ vars.GCS_BUCKET }}/${{ env.PACKAGE_NAME }}.tar.gz"
tenzir-plugins:
needs:
- tenzir
- configure
if: >-
always() &&
needs.configure.outputs.run-tenzir-plugins == 'true' &&
!contains(join(needs.*.result, ','), 'failure') &&
!contains(join(needs.*.result, ','), 'cancelled')
runs-on: ${{ matrix.setup.os }}
container: ${{ matrix.setup.container }}
strategy:
fail-fast: false
matrix:
setup:
- os: ubuntu-20.04
name: Debian
container: debian:bookworm-slim
cc: gcc-12
cxx: g++-12
package-suffix: Release-GCC
plugin:
- name: AMQP
target: amqp
path: plugins/amqp
- name: Compaction
target: compaction
path: contrib/tenzir-plugins/compaction
- name: Context
target: context
path: contrib/tenzir-plugins/context
- name: Kafka
target: kafka
path: plugins/kafka
- name: NIC
target: nic
path: plugins/nic
- name: Matcher
target: matcher
path: contrib/tenzir-plugins/matcher
- name: Parquet
target: parquet
path: plugins/parquet
- name: Pipeline Manager
target: pipeline-manager
path: contrib/tenzir-plugins/pipeline-manager
- name: Platform
target: platform
path: contrib/tenzir-plugins/platform
- name: Sigma
target: sigma
path: plugins/sigma
- name: VAST
target: vast
path: contrib/tenzir-plugins/vast
- name: Velociraptor
target: velociraptor
path: plugins/velociraptor
- name: Web
target: web
path: plugins/web
- name: Yara
target: yara
path: plugins/yara
env:
INSTALL_DIR: "${{ github.workspace }}/_install"
BUILD_DIR: "${{ github.workspace }}/_build"
PACKAGE_SUFFIX: ${{ matrix.setup.package-suffix }}
CC: ${{ matrix.setup.cc }}
CXX: ${{ matrix.setup.cxx }}
CMAKE_GENERATOR: Ninja
CMAKE_MAKE_PROGRAM: ninja
CTEST_OUTPUT_ON_FAILURE: YES
DEBIAN_FRONTEND: noninteractive
HOMEBREW_GITHUB_API_TOKEN: ${{ github.token }}
HOMEBREW_NO_ANALYTICS: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
HOMEBREW_NO_AUTO_UPDATE: 1
name: Tenzir Plugins (${{ matrix.plugin.name }}, ${{ matrix.setup.name }})
steps:
- name: Install git, curl, jq (Debian)
if: ${{ matrix.setup.os == 'ubuntu-20.04' }}
run: |
apt-get update
apt-get -y install git curl jq sudo xz-utils
- name: Install Nix
uses: cachix/install-nix-action@v26
with:
nix_path: nixpkgs=channel:nixos-unstable
- name: Add GitHub to the SSH known hosts file
if: ${{ matrix.setup.os == 'ubuntu-20.04' }}
# See https://github.com/webfactory/ssh-agent/issues/174#issuecomment-1486300082.
run: |
mkdir -p -m 0700 /root/.ssh
curl --silent https://api.github.com/meta \
| jq --raw-output '"github.com "+.ssh_keys[]' \
>> /root/.ssh/known_hosts
chmod 600 /root/.ssh/known_hosts
- name: Configure ssh-agent
uses: webfactory/ssh-agent@v0.9.0
with:
ssh-private-key: ${{ secrets.TENZIR_PLUGINS_DEPLOY_KEY }}
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
- name: Install Dependencies (Debian)
if: ${{ matrix.setup.os == 'ubuntu-20.04' }}
run: |
apt-get -y install \
${{ join(matrix.plugin.debian-dependencies, ' ') }} \
apt-transport-https \
curl
./scripts/debian/install-dev-dependencies.sh
./scripts/debian/install-fluent-bit.sh
- name: Determine Tenzir Package Name
id: configure
run: |
build_version=${{ needs.configure.outputs.build-version }}
if ${{ needs.configure.outputs.run-tenzir == 'false' }}; then
build_version=${{ needs.configure.outputs.before-version }}
fi
PACKAGE_NAME="$(echo "tenzir-${build_version}-$(uname -s)-${PACKAGE_SUFFIX}" | awk '{ print tolower($0) }')"
echo "PACKAGE_NAME=$PACKAGE_NAME" >> $GITHUB_ENV
- name: Download Tenzir artifact
if: ${{ needs.configure.outputs.run-tenzir == 'true' }}
uses: actions/download-artifact@v4
with:
name: "${{ env.PACKAGE_NAME }}.tar.gz"
- name: Authenticate to Google Cloud
if: ${{ needs.configure.outputs.run-tenzir == 'false' }}
uses: google-github-actions/auth@v2
with:
workload_identity_provider: ${{ env.GCP_WORKLOAD_IDP }}
service_account: ${{ env.GCP_SERVICE_ACCOUNT }}
- name: Configure GCloud Credentials
if: ${{ needs.configure.outputs.run-tenzir == 'false' }}
uses: google-github-actions/setup-gcloud@v2
- name: Download Tenzir
if: ${{ needs.configure.outputs.run-tenzir == 'false' }}
run: |
gsutil cp "gs://${{ vars.GCS_BUCKET }}/${{ env.PACKAGE_NAME }}.tar.gz" .
- name: Install Tenzir
run: |
mkdir "${INSTALL_DIR}"
tar -C "${INSTALL_DIR}" -xzvf "${PACKAGE_NAME}.tar.gz"
echo "${INSTALL_DIR}/bin" >> $GITHUB_PATH
- name: Configure Build
env:
Tenzir_DIR: "${{ env.INSTALL_DIR }}"
run: |
python3 --version
python3 -m pip --version
cmake --version
cmake -S '${{ matrix.plugin.path }}' -B "$BUILD_DIR"
- name: Build
run: |
cmake --build "$BUILD_DIR" --target all --parallel
- name: Run Unit Tests
env:
CTEST_OUTPUT_ON_FAILURE: 1
# --test-dir is not yet supported in the ctest version we're using here.
working-directory: ${{ env.BUILD_DIR }}
run: |
ctest --parallel
- name: Work around https://github.blog/2022-04-12-git-security-vulnerability-announced/
run: |
# This command is set identically in actions/checkout, but for some
# reason the setting gets removed again later.
git config --global --add safe.directory /__w/tenzir/tenzir
- name: Run Integration Tests
id: integration_tests
run: |
# We don't always have a bats submodule when building plugins, so we
# get it with Nix.
nix --accept-flake-config develop .#integration-test-shell \
--command bash -c "cmake --build \"$BUILD_DIR\" --target integration -j 1"
- name: Publish Integration Test Report
uses: mikepenz/action-junit-report@v4
if: always()
with:
report_paths: report.xml
token: ${{ secrets.GITHUB_TOKEN }}
- name: Install
run: |
cmake --install "$BUILD_DIR" --prefix "$INSTALL_DIR"
echo "${INSTALL_DIR}/bin" >> $GITHUB_PATH
python:
needs:
- configure
- docker-tenzir
if: ${{ needs.configure.outputs.run-python == 'true' }}
name: Python
runs-on: ${{ matrix.os }}
strategy:
matrix:
python-version: ["3.9"]
os: [ubuntu-latest]
env:
DEBIAN_FRONTEND: noninteractive
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Setup Poetry image
uses: abatilo/actions-poetry@v3.0.0
with:
poetry-version: 1.8.2
- name: Run poetry install
working-directory: python
run: |
poetry install -E module
- name: Run unit tests
working-directory: python
run: |
poetry run pytest
- name: Run tests in Docker
working-directory: python
if: matrix.os == 'ubuntu-latest'
run: |
export TENZIR_CONTAINER_REF="${{ needs.configure.outputs.tenzir-container-ref }}"
export TENZIR_CONTAINER_REGISTRY=ghcr.io
./docker-poetry-run.sh pytest
- name: Build package
working-directory: python
run: |