.gitlab-ci.yml

---
stages:
    - builds
    - functional_test
    - code_quality_test
    - publish

image: buildpack-deps:bookworm

variables:
  GIT_SUBMODULE_STRATEGY: recursive

build-posix-debug:
    stage: builds
    when: always
    script:
        - make werror=yes verbose=yes

build-posix-release:
    stage: builds
    when: always
    script:
        - make -j4 type=release optimize=yes werror=yes verbose=yes

build-clang-posix-debug:
    stage: builds
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - make werror=yes verbose=yes TOOLCHAIN=clang

build-clang-posix-release:
    stage: builds
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - make type=release optimize=yes werror=yes verbose=yes TOOLCHAIN=clang

build-nix-x86_64-linux:
    stage: builds
    when: always
    image: nixos/nix:2.18.1
    script:
        - nix build --experimental-features 'nix-command flakes' '.?submodules=1#ud3tn'
        - nix build --experimental-features 'nix-command flakes' '.?submodules=1#pyd3tn'
        - nix build --experimental-features 'nix-command flakes' '.?submodules=1#python-ud3tn-utils'

build-posix-arm64-debug:
    extends: build-posix-debug
    tags: ["arm64"]

build-posix-arm64-release:
    extends: build-posix-release
    tags: ["arm64"]

build-clang-posix-arm64-debug:
    extends: build-clang-posix-debug
    tags: ["arm64"]
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm-arm64

build-clang-posix-arm64-release:
    extends: build-clang-posix-release
    tags: ["arm64"]
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm-arm64

build-posix-macos-debug:
    extends: build-posix-debug
    tags: ["macos"]

build-posix-macos-release:
    extends: build-posix-release
    tags: ["macos"]

build-freebsd:
    extends: build-posix-debug
    tags: ["freebsd"]
    script:
        - gmake werror=yes verbose=yes

build-library:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - make posix-lib
        - gcc -I include/ -c components/daemon/main.c
        - gcc -o ud3tn -L. main.o -l:build/posix/libud3tn.so
        - ./ud3tn --allow-remote-config &
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration

unit-test-posix-debug:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build TOOLCHAIN=clang sanitize-strict=yes unittest-posix
        - cd /ud3tn_build
        - ASAN_OPTIONS=detect_leaks=0 UBSAN_OPTIONS=print_stacktrace=1 timeout 60 build/posix/testud3tn

unit-test-posix-release:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build type=release sanitize-strict=yes unittest-posix
        - cd /ud3tn_build
        - ASAN_OPTIONS=detect_leaks=0 UBSAN_OPTIONS=print_stacktrace=1 timeout 60 build/posix/testud3tn

unit-test-posix-arm64:
    extends: unit-test-posix-debug
    tags: ["arm64"]
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm-arm64

unit-test-posix-macos:
    stage: functional_test
    when: always
    tags: ["macos"]
    script:
        - make unittest-posix -j4 sanitize-strict=yes
        - ASAN_OPTIONS=detect_leaks=0 UBSAN_OPTIONS=print_stacktrace=1 gtimeout 60 build/posix/testud3tn

unit-test-posix-freebsd:
    stage: functional_test
    when: always
    tags: ["freebsd"]
    script:
        - gmake unittest-posix sanitize-strict=yes
        - ASAN_OPTIONS=detect_leaks=0 UBSAN_OPTIONS=print_stacktrace=1 timeout 60 build/posix/testud3tn

.integration-test-posix:
    stage: functional_test
    when: always
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build TOOLCHAIN=clang sanitize-strict=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID

integration-test-posix-python-3.8:
    extends: .integration-test-posix
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm

integration-test-posix-python-3.12:
    extends: .integration-test-posix
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.12-bookworm

integration-test-posix-thread-sanitizer:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build TOOLCHAIN=clang sanitize=thread sanitize-strict=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID

integration-test-posix-release:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build type=release optimize=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - build/posix/ud3tn --allow-remote-config &
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration

integration-test-posix-arm64:
    extends: .integration-test-posix
    tags: ["arm64"]
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm-arm64

integration-test-posix-macos:
    stage: functional_test
    when: always
    tags: ["macos"]
    script:
        - make posix -j4 sanitize-strict=yes optimize=yes
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - make virtualenv
        - source .venv/bin/activate
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID

aap-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - rm -f ./ud3tn.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn & UD3TN1_PID=$!
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - python tools/aap/aap_test.py
        - kill -TERM $UD3TN1_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN1_PID
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn -e "dtn://ud3tn2.dtn/" -a '::1' -p 4242 -S ud3tn2.aap2.socket & UD3TN2_PID=$!
        - while ! nc -z localhost 4242; do sleep 0.1; done
        - python tools/aap/aap_test.py --tcp '::1' 4242
        - kill -TERM $UD3TN2_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN2_PID

aap2-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - rm -f ./ud3tn.aap2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn & UD3TN1_PID=$!
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - python tools/aap2/aap2_ping.py dtn://ud3tn.dtn/echo -t 1 -c 1
        - python tools/aap2/aap2_ping.py dtn://ud3tn.dtn/1 -a 1 -t 1 -c 1
        - (sleep 1 && python tools/aap2/aap2_send.py -a 1 -s secret dtn://ud3tn.dtn/1 hello) & timeout 3 python tools/aap2/aap2_receive.py -a 1 -s secret -c 1 --verify-pl hello
        - kill -TERM $UD3TN1_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN1_PID

ion-ipn-bpv6-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ion-interop:3.7.4
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/ion_interoperability/minimal_forwarding_test/run.sh 6 ipn

ion-ipn-bpv7-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ion-interop:4.1.2
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/ion_interoperability/minimal_forwarding_test/run.sh 7 ipn

ione-ipn-bpv7-interoperability-test:
    extends: ion-ipn-bpv7-interoperability-test
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ione-interop:1.0.1

ion-dtn-bpv6-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ion-interop:3.7.4
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/ion_interoperability/minimal_forwarding_test/run.sh 6 dtn

ion-dtn-bpv7-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ion-interop:4.1.2
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/ion_interoperability/minimal_forwarding_test/run.sh 7 dtn

ione-dtn-bpv7-interoperability-test:
    extends: ion-dtn-bpv7-interoperability-test
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ione-interop:1.0.1

hdtn-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/hdtn-interop:1.0.0
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/run_hdtn_test.sh

dtn7-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/dtn7-interop:0.19.0-732d1a0
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/dtn7_interoperability/run_dtn7_test.sh

mtcp-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! nc -z localhost 4224; do sleep 0.1; done
        - python tools/cla/mtcp_test.py -t mtcp --payload TESTPAYLOAD &
        - timeout -v 5 python tools/cla/mtcp_sink.py --count 1 --verify-pl TESTPAYLOAD
        - sleep 0.2
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID

fragment-reassembly-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn1.socket
        - rm -f ./ud3tn2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn -c "mtcp:*,4222" -e "dtn://ud3tn1.dtn/" -s ud3tn1.socket -S ud3tn1.aap2.socket & UD3TN1_PID=$!
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn -c "mtcp:*,4223" -e "dtn://ud3tn2.dtn/" -s ud3tn2.socket -S ud3tn2.aap2.socket & UD3TN2_PID=$!
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! nc -z localhost 4222; do sleep 0.1; done
        - while ! nc -z localhost 4223; do sleep 0.1; done
        - while ! [ -r ./ud3tn1.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn2.socket ]; do sleep 0.1; done
        - python tools/aap/aap_config.py --socket ud3tn1.socket --schedule 2 1 140 --schedule 4 1 140 dtn://ud3tn2.dtn/ mtcp:localhost:4223
        - python tools/aap/aap_send.py --socket ud3tn1.socket dtn://ud3tn2.dtn/sink THISISAVERYLONGBUNDLEPAYLOADWHICHWILLBEFRAGMENTED -v
        - timeout -v 5 python tools/aap/aap_receive.py --socket ud3tn2.socket --agentid sink --count 1 --verify-pl THISISAVERYLONGBUNDLEPAYLOADWHICHWILLBEFRAGMENTED --newline -vv
        - kill -TERM $UD3TN1_PID
        - kill -TERM $UD3TN2_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN1_PID
        - wait $UD3TN2_PID

ipv6-compatibility-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        # IPv6 and IPv4
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn -c "mtcp:::,4222" -e "dtn://ud3tn1.dtn/" -a '::' -p 4242 -S ud3tn1.aap2.socket & UD3TN1_PID=$!
        # IPv4-only
        - UBSAN_OPTIONS=print_stacktrace=1 build/posix/ud3tn -c "mtcp:::,4223" -e "dtn://ud3tn2.dtn/" -a '127.0.0.1' -p 4243 -S ud3tn2.aap2.socket & UD3TN2_PID=$!
        # Create venv and wait for uD3TN ports to be open
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! nc -z localhost 4222; do sleep 0.1; done
        - while ! nc -z localhost 4223; do sleep 0.1; done
        - while ! nc -z localhost 4242; do sleep 0.1; done
        - while ! nc -z localhost 4243; do sleep 0.1; done
        # Check v6 via AAP to ud3tn1 and via MTCP to ud3tn2
        - python tools/aap/aap_config.py --tcp '::1' 4242 --schedule 2 1 140 --schedule 4 1 140 dtn://ud3tn2.dtn/ 'mtcp:[::1]:4223'
        # Check v4 via AAP to ud3tn1
        - python tools/aap/aap_send.py --tcp 127.0.0.1 4242 dtn://ud3tn2.dtn/sink PAYLOAD -v
        # Check v4 reception of the correct bundle at ud3tn2
        - timeout -v 5 python tools/aap/aap_receive.py --tcp 127.0.0.1 4243 --agentid sink --count 1 --verify-pl PAYLOAD --newline -vv
        # Check that v6 does _not_ work on ud3tn2
        - "if timeout -v 1 python tools/aap/aap_test.py --tcp '::1' 4243; then echo 'Error: Should not be able to connect via IPv6 here.'; false; else true; fi"
        - kill -TERM $UD3TN1_PID
        - kill -TERM $UD3TN2_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN1_PID
        - wait $UD3TN2_PID

bibe-internal-forwarding-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize-strict=yes
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/functional/bibe_internal_forwarding_test/run.sh

ion-bibe-interoperability-test:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ion-interop:4.1.2
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build sanitize=yes "CFLAGS=-DBIBE_CL_DRAFT_1_COMPATIBILITY=1"
        - cd /ud3tn_build
        - source /ud3tn_venv/bin/activate
        - bash test/ion_interoperability/bibe_forwarding_test/run.sh

ione-bibe-interoperability-test:
    extends: ion-bibe-interoperability-test
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ione-interop:1.0.1

data-decoder-test:
    stage: functional_test
    when: always
    script:
        - make clean
        - make data-decoder
        - build/posix/ud3tndecode -7 test/decoder/examples/bpv7_test/bpv7_1.bin
        - build/posix/ud3tndecode -6 test/decoder/examples/bpv6_test/bpv6_1.bin
        - build/posix/ud3tndecode -s test/decoder/examples/spp_test/spp_1.bin
        - build/posix/ud3tndecode -a test/decoder/examples/aap_test/test_aap_ping_packet.bin
        - build/posix/ud3tndecode -a test/decoder/examples/aap_test/test_aap_sendbundle_packet.bin
        - build/posix/ud3tndecode -a test/decoder/examples/aap_test/test_aap_sendconfirm_packet.bin
        - build/posix/ud3tndecode -a test/decoder/examples/aap_test/test_aap_welcome_packet.bin

unit-test-valgrind:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - make unittest-posix
        - valgrind --leak-check=no --error-exitcode=1 build/posix/testud3tn

integration-test-valgrind-memory-check:
    stage: functional_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - UBSAN_OPTIONS=print_stacktrace=1 valgrind --leak-check=yes --error-exitcode=1 --errors-for-leak-kinds=definite build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID

license-check:
    stage: code_quality_test
    when: always
    script:
        - bash tools/analysis/license-check.sh

stylecheck:
    stage: code_quality_test
    when: always
    image: perl:5
    script:
        - make check-style

python-stylecheck:
    stage: code_quality_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - source /ud3tn_venv/bin/activate
        - pip install -e "pyd3tn"
        - pip install -e "python-ud3tn-utils"
        - pip install -e "python-ud3tn-utils"
        - python -m flake8 pyd3tn python-ud3tn-utils test/integration tools/aap tools/aap2 tools/cla --max-complexity=12 --exclude=generated

coverage-test:
    stage: code_quality_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - project_dir="$(pwd)"
        - bash test/dockerfiles/prepare_for_test.sh . /ud3tn_build coverage=yes
        - cd /ud3tn_build
        - rm -f ./ud3tn.socket ./ud3tn.aap2.socket
        - make unittest-posix coverage=yes
        - timeout 60 build/posix/testud3tn
        - build/posix/ud3tn --allow-remote-config & UD3TN_PID=$!
        - source /ud3tn_venv/bin/activate
        - while ! [ -r ./ud3tn.socket ]; do sleep 0.1; done
        - while ! [ -r ./ud3tn.aap2.socket ]; do sleep 0.1; done
        - pytest test/integration
        - kill -TERM $UD3TN_PID
        - echo "Waiting for uD3TN to exit gracefully - if it doesn't, check for sanitizer warnings."
        - wait $UD3TN_PID
        - gcovr --xml-pretty --exclude-unreachable-branches --gcov-ignore-parse-errors --print-summary -o coverage.xml --root .
        - cp -v coverage.xml "$project_dir/"
    coverage: /^\s*lines:\s*\d+.\d+\%/
    artifacts:
        name: ${CI_JOB_NAME}-${CI_COMMIT_REF_NAME}-${CI_COMMIT_SHA}
        expire_in: 2 days
        reports:
            coverage_report:
                coverage_format: cobertura
                path: coverage.xml

clang-tidy-posix-debug:
    stage: code_quality_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - make ccmds-posix -j4
        - bash ./tools/analysis/clang-check.sh "clang-tidy-13 --use-color" "posix"

clang-tidy-posix-release:
    stage: code_quality_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - make ccmds-posix -j4 type=release
        - bash ./tools/analysis/clang-check.sh "clang-tidy-13 --use-color" "posix"

cppcheck-static-analyzer:
    stage: code_quality_test
    when: always
    image: registry.gitlab.com/d3tn/ud3tn-docker-images/ci-python-clang:3.8-bookworm
    script:
        - cppcheck --enable=warning --error-exitcode=2 --inline-suppr -I include -I external/tinycbor/src -I external/util/include components

publish-docker-image:
    stage: publish
    rules:
        - if: '$CI_COMMIT_TAG =~ /^v[0-9]+(.[0-9]+)+$/'
          when: always
    image:
        # See https://docs.gitlab.com/ee/ci/docker/using_kaniko.html
        name: gcr.io/kaniko-project/executor:debug
        entrypoint: [""]
    variables:
        CI_REGISTRY_IMAGE: registry.gitlab.com/d3tn/ud3tn-docker-images/ud3tn
    script:
        # find out if the docker image *also* should be tagged with "latest"
        - |
          # Download all existing ud3tn docker image tags from the docker image registry
          wget -q "https://gitlab.com/api/v4/projects/23559871/registry/repositories/1616836/tags" -O tags.json

          # Remove some json symbols, introduce line feeds for better filtering
          sed -i -E 's/\]//g; s/\[//g; s/\},?/\n/g' tags.json

          # Remove everything except the docker image tags (latest, v0.9.0, ...)
          sed -i -E 's/(^.*"name":")(.*)(","path.*$)/\2/' tags.json

          # Append the $CI_COMMIT_TAG to the list of tags
          echo "$CI_COMMIT_TAG" >> tags.json

          # Get the numerically highest *version* tag
          highest_version=$(grep -E "v.*" tags.json | sort -rV | head -n1)

          # Build the string $IMAGES that determines what image_name:image_tag the resulting docker image will have
          TAGS="$CI_COMMIT_TAG"
          if [ "$highest_version" = "$CI_COMMIT_TAG" ]; then TAGS="$TAGS latest"; fi
          for TAG in $TAGS; do
            IMAGES="${IMAGES} --destination $CI_REGISTRY_IMAGE:$TAG";
          done;
        - echo $IMAGES
        # Prepare docker image registry access credentials
        - mkdir -p /kaniko/.docker
        - echo "{\"auths\":{\"$CI_REGISTRY\":{\"username\":\"$UD3TN_CI_DOCKER_DEPLOY_USER\",\"password\":\"$UD3TN_CI_DOCKER_DEPLOY_PASSWORD\"}}}" > /kaniko/.docker/config.json
        # Build and push the docker image
        - /kaniko/executor --context $CI_PROJECT_DIR --dockerfile $CI_PROJECT_DIR/dockerfiles/ud3tn --build-arg UD3TN_VERSION=$CI_COMMIT_TAG $IMAGES