forked from secureCodeBox/secureCodeBox
-
Notifications
You must be signed in to change notification settings - Fork 0
930 lines (770 loc) · 27 KB
/
ci.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
# SPDX-FileCopyrightText: the secureCodeBox authors
#
# SPDX-License-Identifier: Apache-2.0
name: "CI"
on:
push:
branches:
- main
- v[0-9]+.x
pull_request:
schedule:
- cron: "15 2 * * *" # Nightly-Build at 2:15 AM UTC
# The CI runs on ubuntu-22.04; More info about the installed software is found here:
# https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-Readme.md
env:
# ---- Language Versions ----
GO_VERSION: "1.19"
PYTHON_VERSION: "3.9.16"
NVM_VERSION: "0.39.3" # Does not need to be updated as often as the Node.js version or the NPM version
KIND_NODE_IMAGE: "kindest/node:v1.27.3@sha256:9dd3392d79af1b084671b05bcf65b21de476256ad1dcc853d9f3b10b4ac52dde"
KIND_BINARY_VERSION: "v0.20.0"
KUBECTL_VERSION: "v1.27.4"
HELM_VERSION: "v3.12.2"
jobs:
# ---- NVM Setup ----
# It is more efficient to do the installation process of nvm only once and upload it as an archive.
# This can later be imported and extracted quickly in the hooks/scanners testing containers.
# It also ensures that we pull from an external source to install nvm only once, instead of x number of hooks + y number of scanners
nvm-setup:
name: "Configuration"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- name: Install nvm and Node.js
run: |
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v${{ env.NVM_VERSION }}/install.sh | bash
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
nvm install "$(cat .nvmrc)"
- name: Archive nvm and Node.js
run: |
tar czf nvm-node.tar.gz -C $HOME .nvm
- name: Upload nvm and Node.js
uses: actions/upload-artifact@v3
with:
name: nvm-node
path: ./nvm-node.tar.gz
retention-days: 1
k8s-setup:
name: "Setup Kind & Kubectl & Helm"
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- name: Install Kind
run: |
curl -Lo ./kind https://kind.sigs.k8s.io/dl/${{ env.KIND_BINARY_VERSION }}/kind-linux-amd64
chmod +x ./kind
- name: Install Kubectl
run: |
curl -Lo ./kubectl curl -LO https://dl.k8s.io/release/${{ env.KUBECTL_VERSION }}/bin/linux/amd64/kubectl
chmod +x ./kubectl
- name: Install Helm
run: |
curl -Lo ./helm.tar.gz https://get.helm.sh/helm-${{ env.HELM_VERSION }}-linux-amd64.tar.gz
tar -xzf ./helm.tar.gz
chmod +x ./linux-amd64/helm
- name: Archive Kind
uses: actions/upload-artifact@v3
with:
name: kind
path: ./kind
- name: Archive Kubectl
uses: actions/upload-artifact@v3
with:
name: kubectl
path: ./kubectl
- name: Archive Helm
uses: actions/upload-artifact@v3
with:
name: helm
path: ./linux-amd64/helm
# ---- Unit-Test ----
# ---- Unit-Test | Java ----
unit-java:
name: "Unit-Test | Java"
runs-on: ubuntu-22.04
strategy:
matrix:
unit: ["persistence-defectdojo"]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-java@v1
with:
java-version: "17" # The JDK version to make available on the path.
java-package: jdk # (jre, jdk, or jdk+fx) - defaults to jdk
architecture: x64 # (x64 or x86) - defaults to x64
- run: |
cd hooks/${{ matrix.unit }}/hook/
./gradlew test
# ---- Build Stage ----
# ---- Build Stage | Operator & Lurker ----
operator:
name: "Build | Operator"
runs-on: ubuntu-22.04
strategy:
matrix:
component: ["operator", "lurker"]
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Go Setup
uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
- name: Lint Go Code
working-directory: ./${{ matrix.component }}
run: |
go fmt ./...
go vet ./...
- name: Build Container Image
working-directory: ./operator
run: make docker-build
- name: Export Container Image
working-directory: ./operator
run: make docker-export-${{ matrix.component }}
- name: Upload Image As Artifact
uses: actions/upload-artifact@v3
with:
name: ${{ matrix.component }}-image
path: ./operator/${{ matrix.component }}.tar
retention-days: 1
# ---- Build Stage | AutoDiscovery ----
auto-discovery-kubernetes:
name: "AutoDiscovery | Kubernetes"
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Go Setup
uses: actions/setup-go@v2
with:
go-version: ${{ env.GO_VERSION }}
- name: Lint Go Code
working-directory: ./auto-discovery/kubernetes
run: |
go fmt ./...
go vet ./...
- name: Test
working-directory: ./auto-discovery/kubernetes/
run: make test
- name: Build Container Image
working-directory: ./auto-discovery/kubernetes/
run: make docker-build
- name: Export Container Image
working-directory: ./auto-discovery/kubernetes/
run: make docker-export
- name: Upload Image As Artifact
uses: actions/upload-artifact@v3
with:
name: auto-discovery-image
path: ./auto-discovery/kubernetes/auto-discovery-kubernetes.tar
retention-days: 1
# ---- Build Stage | AutoDiscovery | PullSecretExtractor ----
auto-discovery-kubernetes-secret-extraction-container:
name: "Autodiscovery | Kubernetes | SecretExtractionInitContainer"
runs-on: ubuntu-22.04
needs:
- nvm-setup
- k8s-setup
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Python Version
uses: actions/setup-python@v4
with:
python-version: "${{ env.PYTHON_VERSION }}"
- name: Download nvm and Node.js
uses: actions/download-artifact@v3
with:
name: nvm-node
path: nvm-node
- name: Extract nvm and Node.js
run: |
tar xzf nvm-node/nvm-node.tar.gz -C $HOME
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
nvm use
- name: Download Kind
uses: actions/download-artifact@v3
with:
name: kind
path: ./kind
- name: Download Kubectl
uses: actions/download-artifact@v3
with:
name: kubectl
path: ./kubectl
- name: Download Helm
uses: actions/download-artifact@v3
with:
name: helm
path: ./helm
- name: Make binaries globally available
run: |
chmod +x ./kind/kind && sudo mv ./kind/kind /usr/local/bin/kind
chmod +x ./kubectl/kubectl && sudo mv ./kubectl/kubectl /usr/local/bin/kubectl
chmod +x ./helm/helm && sudo mv ./helm/helm /usr/local/bin/helm
- name: Verify tools
run: |
kind version
kubectl version || true
helm version
- name: Unit Tests
working-directory: ./auto-discovery/kubernetes/pull-secret-extractor
run: make unit-test
- name: Build Container Image
working-directory: ./auto-discovery/kubernetes/pull-secret-extractor
run: make docker-build
- name: Export Container Image
working-directory: ./auto-discovery/kubernetes/pull-secret-extractor
run: make docker-export
- name: Upload Image As Artifact
uses: actions/upload-artifact@v3
with:
name: auto-discovery-pull-secret-extractor
path: ./auto-discovery/kubernetes/pull-secret-extractor/auto-discovery-secret-extractor.tar
retention-days: 1
- name: "Start kind cluster"
run: |
kind version
kind create cluster --wait 3m --image "$KIND_NODE_IMAGE"
- name: "Inspect kind cluster"
run: |
kubectl config current-context
kubectl get node
- name: "Run integration tests"
working-directory: ./auto-discovery/kubernetes/pull-secret-extractor
run: |
make integration-test
# ---- Build Stage | SDK Matrix ----
sdk:
name: "Build | SDKs"
runs-on: ubuntu-22.04
strategy:
matrix:
sdk:
- parser-sdk
- hook-sdk
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Build Image
working-directory: ./${{ matrix.sdk }}/nodejs
run: make docker-build-sdk
- name: Export Image
working-directory: ./${{ matrix.sdk }}/nodejs
run: make docker-export-sdk
- name: Upload Artifact
uses: actions/upload-artifact@v3
with:
name: ${{ matrix.sdk }}-image
path: ./${{ matrix.sdk }}/nodejs/${{ matrix.sdk }}.tar
retention-days: 1
# ---- Test | Scanners ----
test-scanners:
name: "Test | Scanner ${{ matrix.unit }}"
needs:
- sdk
- operator
- nvm-setup
- k8s-setup
runs-on: ubuntu-22.04
strategy:
fail-fast: false
matrix:
unit:
- amass
- cmseek
- doggo
- ffuf
- git-repo-scanner
- gitleaks
- kubeaudit
- kube-hunter
- ncrack
- nikto
- nmap
- nuclei
- screenshooter
- semgrep
- ssh-audit
- ssh-scan
- sslyze
- trivy
- typo3scan
- whatweb
- wpscan
- zap
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Download nvm and Node.js
uses: actions/download-artifact@v3
with:
name: nvm-node
path: nvm-node
- name: Extract nvm and Node.js
run: |
tar xzf nvm-node/nvm-node.tar.gz -C $HOME
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
nvm use
- name: Download Kind
uses: actions/download-artifact@v3
with:
name: kind
path: ./kind
- name: Download Kubectl
uses: actions/download-artifact@v3
with:
name: kubectl
path: ./kubectl
- name: Download Helm
uses: actions/download-artifact@v3
with:
name: helm
path: ./helm
- name: Make binaries globally available
run: |
chmod +x ./kind/kind && sudo mv ./kind/kind /usr/local/bin/kind
chmod +x ./kubectl/kubectl && sudo mv ./kubectl/kubectl /usr/local/bin/kubectl
chmod +x ./helm/helm && sudo mv ./helm/helm /usr/local/bin/helm
- name: Verify tools
run: |
kind version
kubectl version || true
helm version
- name: Install Dependencies
working-directory: ./scanners/${{ matrix.unit }}/
run: make install-deps
- name: Unit Tests
working-directory: ./scanners/${{ matrix.unit }}/
run: make unit-tests
- name: Download Parser SDK Image
uses: actions/download-artifact@v3
with:
name: parser-sdk-image
path: /tmp
- name: Load Parser SDK Image
run: |
docker load --input /tmp/parser-sdk.tar
docker images | grep sdk
- name: Build Images
working-directory: ./scanners/${{ matrix.unit }}/
run: make docker-build
- name: Export Docker Images
working-directory: ./scanners/${{ matrix.unit }}/
run: make docker-export
- name: "Start kind cluster"
run: |
kind version
kind create cluster --wait 3m --image "$KIND_NODE_IMAGE"
- name: "Inspect kind cluster"
run: |
kubectl config current-context
kubectl get node
- name: Download Operator Image
uses: actions/download-artifact@v3
with:
name: operator-image
path: ./operator
- name: Download Lurker Image
uses: actions/download-artifact@v3
with:
name: lurker-image
path: ./operator
- name: Import Operator & Lurker Image to kind cluster
working-directory: ./operator
run: make kind-import
- name: Kind Import ${{ matrix.unit }} Image to kind cluster
working-directory: ./scanners/${{ matrix.unit }}/
run: make kind-import
- name: Deploy Operator Chart to kind cluster
working-directory: ./operator
run: |
make helm-deploy
- name: Deploy ${{ matrix.unit }} Chart to kind cluster
working-directory: ./scanners/${{ matrix.unit }}/
run: make deploy
- name: Deploy Test Dependencies
working-directory: ./scanners/${{ matrix.unit }}/
run: make deploy-test-deps
- name: Start Integration Tests
working-directory: ./scanners/${{ matrix.unit }}/
run: make integration-tests
# ---- Debuging Cluster on Failure ----
- name: Inspect Post Failure
if: failure()
run: |
echo "List all 'HelmCharts' in all namespaces"
helm list --all-namespaces
echo "List all 'Scans' in all namespaces"
kubectl get scans -o wide --all-namespaces
echo "List all 'Jobs' in all namespaces"
kubectl get jobs -o wide --all-namespaces
echo "List all 'Pods' in all namespaces"
kubectl get pods -o wide --all-namespaces
echo "List all 'Services' in all namespaces"
kubectl get services -o wide --all-namespaces
echo "Describe Pods in 'integration-tests' namespace"
kubectl describe pod -n integration-tests
- name: "Inspect Operator"
if: failure()
run: |
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get deployments
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get pods
echo "Operator Startup Logs"
kubectl -n securecodebox-system logs deployment/securecodebox-controller-manager
# ---- Build | Scanners | Custom Scanner | Nightly Build ----
# This Section contains Scanners that are developed by the secureCodeBox project or require a nightly build
# The tag for these images will be the Semver of the release
zap-advanced:
name: "Zap-advanced integration-test"
if: ${{ github.event_name == 'schedule' }}
needs:
- sdk
- operator
- nvm-setup
- k8s-setup
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Download nvm and Node.js
uses: actions/download-artifact@v3
with:
name: nvm-node
path: ./nvm-node
- name: Extract nvm and Node.js
run: |
tar xzf nvm-node/nvm-node.tar.gz -C $HOME
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
nvm use
- name: Download Kind
uses: actions/download-artifact@v3
with:
name: kind
path: ./kind
- name: Download Kubectl
uses: actions/download-artifact@v3
with:
name: kubectl
path: ./kubectl
- name: Download Helm
uses: actions/download-artifact@v3
with:
name: helm
path: ./helm
- name: Make binaries globally available
run: |
chmod +x ./kind/kind && sudo mv ./kind/kind /usr/local/bin/kind
chmod +x ./kubectl/kubectl && sudo mv ./kubectl/kubectl /usr/local/bin/kubectl
chmod +x ./helm/helm && sudo mv ./helm/helm /usr/local/bin/helm
- name: Verify tools
run: |
kind version
kubectl version || true
helm version
- name: Install Dependencies
working-directory: ./scanners/zap-advanced/
run: make install-deps
- name: Unit Tests
working-directory: ./scanners/zap-advanced/
run: make unit-tests
- name: Download Parser SDK Image
uses: actions/download-artifact@v3
with:
name: parser-sdk-image
path: /tmp
- name: Load Parser SDK Image
run: |
docker load --input /tmp/parser-sdk.tar
docker images | grep sdk
- name: Build Images
working-directory: ./scanners/zap-advanced/
run: make docker-build
- name: Export Docker Images
working-directory: ./scanners/zap-advanced/
run: make docker-export
- name: "Start kind cluster"
run: |
kind version
kind create cluster --wait 3m --image "$KIND_NODE_IMAGE"
- name: "Inspect kind cluster"
run: |
kubectl config current-context
kubectl get node
- name: Download Operator Image
uses: actions/download-artifact@v3
with:
name: operator-image
path: ./operator
- name: Download Lurker Image
uses: actions/download-artifact@v3
with:
name: lurker-image
path: ./operator
- name: Import Operator & Lurker Image
working-directory: ./operator
run: make kind-import
- name: Kind Import Images
working-directory: ./scanners/zap-advanced/
run: make kind-import
- name: Install Operator
working-directory: ./operator
run: |
make helm-deploy
- name: Deploy zap-advanced
working-directory: ./scanners/zap-advanced/
run: make deploy
- name: Deploy Test Dependencies
working-directory: ./scanners/zap-advanced/
run: make deploy-test-deps
- name: Start Integration Tests
working-directory: ./scanners/zap-advanced/
run: make integration-tests
# ---- Debuging Cluster on Failure ----
- name: Inspect Post Failure
if: failure()
run: |
echo "List all 'HelmCharts' in all namespaces"
helm list --all-namespaces
echo "List all 'Scans' in all namespaces"
kubectl get scans -o wide --all-namespaces
echo "List all 'Jobs' in all namespaces"
kubectl get jobs -o wide --all-namespaces
echo "List all 'Pods' in all namespaces"
kubectl get pods -o wide --all-namespaces
echo "List all 'Services' in all namespaces"
kubectl get services -o wide --all-namespaces
echo "Describe Pods in 'integration-tests' namespace"
kubectl describe pod -n integration-tests
- name: "Inspect Operator"
if: failure()
run: |
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get deployments
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get pods
echo "Operator Startup Logs"
kubectl -n securecodebox-system logs deployment/securecodebox-controller-manager
- name: Notify Slack Dev Channel
if: failure()
uses: slackapi/[email protected]
with:
payload: |
{
"text": "GitHub Action build result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}",
"blocks": [
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "GitHub Action build result: ${{ job.status }}\n${{ github.event.pull_request.html_url || github.event.head_commit.url }}"
}
}
]
}
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_DEVELOPMENT_CHANNEL }}
SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
# ---- Test | Hooks ----
test-hooks:
name: Test | Hook ${{ matrix.hook }}
needs:
- operator
- nvm-setup
- k8s-setup
runs-on: ubuntu-22.04
strategy:
matrix:
hook:
- cascading-scans
- generic-webhook
- persistence-azure-monitor
# - persistence-elastic # Fails on the CI due to insufficient cpu as mentioned in issue #1165
- update-field-hook
- finding-post-processing
- notification
# - persistence-static-report (WIP)
steps:
- uses: actions/checkout@master
- name: "Start kind cluster"
run: |
kind version
kind create cluster --wait 3m --image "$KIND_NODE_IMAGE"
- name: "Inspect kind cluster"
run: |
kubectl config current-context
kubectl get node
# ---- Install Operator & Create Namespaces ----
- name: Download Operator Image
uses: actions/download-artifact@v3
with:
name: operator-image
path: ./operator
- name: Download Lurker Image
uses: actions/download-artifact@v3
with:
name: lurker-image
path: ./operator
- name: Import Operator & Lurker Image
working-directory: ./operator
run: make kind-import
- name: "Install Operator"
working-directory: ./operator
run: make helm-deploy
# ---- Operator Health Check ----
- name: "Inspect Operator"
run: |
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get deployments
echo "Pods in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get pods
echo "Operator Startup Logs"
kubectl -n securecodebox-system logs deployment/securecodebox-controller-manager
- name: "Create 'demo-targets' namespace"
run: "kubectl create namespace demo-targets"
# ---- Import Parser SDK Artifact
- name: Download Parser SDK Image
uses: actions/download-artifact@v3
with:
name: parser-sdk-image
path: /tmp
- name: Load Parser SDK Image
run: |
docker load --input /tmp/parser-sdk.tar
docker images | grep sdk
# ---- Import Hook SDK Artifact
- name: Download Hook SDK Image
uses: actions/download-artifact@v3
with:
name: hook-sdk-image
path: /tmp
- name: Load Parser SDK Image
run: |
docker load --input /tmp/hook-sdk.tar
docker images | grep sdk
# ---- K8s Cluster Setup ---- #
- name: Download Kind
uses: actions/download-artifact@v3
with:
name: kind
path: ./kind
- name: Download Kubectl
uses: actions/download-artifact@v3
with:
name: kubectl
path: ./kubectl
- name: Download Helm
uses: actions/download-artifact@v3
with:
name: helm
path: ./helm
- name: Make binaries globally available
run: |
chmod +x ./kind/kind && sudo mv ./kind/kind /usr/local/bin/kind
chmod +x ./kubectl/kubectl && sudo mv ./kubectl/kubectl /usr/local/bin/kubectl
chmod +x ./helm/helm && sudo mv ./helm/helm /usr/local/bin/helm
- name: Verify tools
run: |
kind version
kubectl version || true
helm version
# ----- Build Test-Scan ScanType Image ----
- name: Build Images
working-directory: ./scanners/test-scan/
run: make docker-build
- name: Export Docker Images
working-directory: ./scanners/test-scan/
run: make docker-export
- name: Kind import
working-directory: ./scanners/test-scan/
run: make kind-import
- name: Test-scan deploy
working-directory: ./scanners/test-scan/
run: make deploy
# ----- Build Hook Image ----
- name: Build Images
working-directory: ./hooks/${{ matrix.hook }}
run: make docker-build
- name: Export Docker Images
working-directory: ./hooks/${{ matrix.hook }}
run: make docker-export
- name: Kind import
working-directory: ./hooks/${{ matrix.hook }}
run: make kind-import
- name: Download nvm and Node.js
uses: actions/download-artifact@v3
with:
name: nvm-node
path: ./nvm-node
- name: Extract nvm and Node.js
run: |
tar xzf nvm-node/nvm-node.tar.gz -C $HOME
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
nvm use
- name: "Install Test Dependencies"
working-directory: ./hooks
run: npm ci
# ---- Unit-Test ----
- name: "Run Unit Tests"
working-directory: ./hooks/${{ matrix.hook }}
run: make unit-tests
# ---- Integration-Test ----
- name: Deploy ${{ matrix.hook }}
working-directory: ./hooks/${{ matrix.hook }}
run: make deploy
- name: Deploy Test Dependencies
working-directory: ./hooks/${{ matrix.hook }}
run: make deploy-test-deps
- name: "Run Integration Test"
working-directory: ./hooks/${{ matrix.hook }}
run: make integration-tests
# ---- Debuging Cluster on Failure ----
- name: Inspect Post Failure
if: failure()
run: |
echo "List all 'HelmCharts' in all namespaces"
helm list --all-namespaces
echo "List all 'Scans' in all namespaces"
kubectl get scans -o wide --all-namespaces
echo "List all 'Jobs' in all namespaces"
kubectl get jobs -o wide --all-namespaces
echo "List all 'Pods' in all namespaces"
kubectl get pods -o wide --all-namespaces
echo "List all 'Services' in all namespaces"
kubectl get services -o wide --all-namespaces
echo "Describe Pods in 'integration-tests' namespace"
kubectl describe pod -n integration-tests
- name: "Inspect Operator"
if: failure()
run: |
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get deployments
echo "Deployment in namespace 'securecodebox-system'"
kubectl -n securecodebox-system get pods
echo "Operator Startup Logs"
kubectl -n securecodebox-system logs deployment/securecodebox-controller-manager
- name: Test-scan integration-tests
working-directory: ./scanners/test-scan/
run: |
helm -n integration-tests upgrade --install test-scan . \
--set="scanner.image.repository=docker.io/securecodebox/scanner-test-scan" \
--set="parser.image.repository=docker.io/securecodebox/parser-test-scan" \
--set="parser.image.tag=sha-$(git rev-parse --short HEAD)" \
--set="scanner.image.tag=sha-$(git rev-parse --short HEAD)" \
--set="parser.env[0].name=CRASH_ON_FAILED_VALIDATION" \
--set-string="parser.env[0].value=true" \
--set="parser.env[1].name=PRODUCE_INVALID_FINDINGS" \
--set-string="parser.env[1].value=true"
make integration-tests
# ---- Clean UP ----
- name: "Delete kind cluster"
run: |
kind delete cluster