.gitlab-ci.yml

stages:
  - style_check
  - build
  - lint
  - integration_test
  - deploy

# Job description helpers

.in_ubuntu:
  image: ubuntu:latest
  variables:
    DEBIAN_FRONTEND: 'noninteractive'

.with_ubuntu_builddeps:
  before_script:
    - apt-get update && apt-get -y install gcc g++ git ninja-build cmake catch2 pkg-config

.with_ubuntu_testdeps:
  before_script:
    - apt-get update && apt-get -y install build-essential qemu-system-x86 grub2-common grub-pc-bin grub-efi-amd64-bin mtools ovmf xorriso python3 python3-pexpect netcat

.in_latest_fedora:
  # See #242.
  image: fedora:37

.with_fedora_builddeps:
  before_script:
    - dnf -y update && dnf -y install clang gcc gcc-c++ cmake catch-devel libasan libasan-static libubsan libubsan-static ninja-build

.with_fedora_testdeps:
  before_script:
    - dnf -y update && dnf -y install libasan libubsan qemu-system-x86 edk2-ovmf grub2-tools grub2-tools-extra grub2-pc-modules grub2-efi-x64-modules unifont-fonts mtools xorriso python3 python3-pexpect netcat
    # The stock installation of the tools fails with errors about this font
    - grub2-mkfont -o /usr/share/grub/unicode.pf2 /usr/share/fonts/unifont/unifont.ttf

.only_for_releases:
  only:
    - tags
    - /^[\d-]+-release$/
  artifacts:
    expire_in: 5 year

.except_for_releases:
  except:
    - tags
    - /^[\d-]+-release$/
  artifacts:
    expire_in: 1 week

.build_variant_with_ninja:
  stage: build
  script:
    - cmake -B build -S . -G Ninja -DCMAKE_BUILD_TYPE=$BUILD_TYPE
    - ninja -C build
    - ninja -C build test
  artifacts:
    expire_in: 1 week
    paths:
      - build/src/hypervisor
      - build/src/hypervisor.elf32

.build_variant_with_make:
  stage: build
  script:
    - cmake -B build -S . -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=$BUILD_TYPE
    - make -C build
    - make -C build test
  artifacts:
    expire_in: 1 week
    paths:
      - build/src/hypervisor
      - build/src/hypervisor.elf32

.build_release:
  variables:
    BUILD_TYPE: 'Release'
  extends:
    - .build_variant_with_ninja

.build_debug:
  variables:
    BUILD_TYPE: 'Debug'
  extends:
    - .build_variant_with_ninja

.integration_test_variant:
  tags:
    - kvm
  stage: integration_test
  script:
    - ./test/integration/qemu-boot build/src/hypervisor.elf32
    - ./tools/gen_usb.sh grub_image.iso build/src/hypervisor.elf32 tools/grub.cfg.tmpl
    # On Fedora, the default memory size leads to a memory map that is
    # too fragmented for Grub to find enough contiguous memory.
    #
    # See #218 for the issue that is workarounded and #219 for a
    # longer term solution.
    - ./test/integration/qemu-boot grub_image.iso --memory 3192 --disk-image
    - ./test/integration/qemu-boot grub_image.iso --memory 3192 --disk-image --uefi

# Stylecheck Job description

style_check:clang-format:
  stage: style_check
  tags:
    - native-nix-v2
  script:
    - nix-build nix/release.nix -A hedron.stylecheck

# Build Job descriptions

build:fedora-release:
  extends:
    - .in_latest_fedora
    - .with_fedora_builddeps
    - .build_release
    - .except_for_releases

build:fedora-debug:
  extends:
    - .in_latest_fedora
    - .with_fedora_builddeps
    - .build_debug
    - .except_for_releases

build:fedora-clang:
  variables:
    CXX: 'clang++'
    CC: 'clang'
  extends:
    - .in_latest_fedora
    - .with_fedora_builddeps
    - .build_debug
    - .except_for_releases

build:ubuntu:
  extends:
    - .in_ubuntu
    - .with_ubuntu_builddeps
    - .build_release
    - .except_for_releases

build:ubuntu-make:
  stage: build
  variables:
      BUILD_TYPE: 'Debug'
  extends:
    - .in_ubuntu
    - .with_ubuntu_builddeps
    - .build_variant_with_make
    - .except_for_releases

# Lint Job Description

lint:clang-tidy:
  needs: []
  stage: lint
  tags:
    - native-nix-v2
  script:
    - nix-build nix/release.nix -A hedron.clang-tidy

# Integration Test Decriptions

integration_test:fedora-release:
  dependencies:
    - build:fedora-release
  extends:
    - .in_latest_fedora
    - .with_fedora_testdeps
    - .integration_test_variant
    - .except_for_releases

integration_test:fedora-debug:
  dependencies:
    - build:fedora-debug
  extends:
    - .in_latest_fedora
    - .with_fedora_testdeps
    - .integration_test_variant
    - .except_for_releases

integration_test:fedora-clang:
  dependencies:
    - build:fedora-clang
  extends:
    - .in_latest_fedora
    - .with_fedora_testdeps
    - .integration_test_variant
    - .except_for_releases

integration_test:ubuntu:
  dependencies:
    - build:ubuntu
  extends:
    - .in_ubuntu
    - .with_ubuntu_testdeps
    - .integration_test_variant
    - .except_for_releases

# This target builds and executes all of the above and more on NixOS,
# so we put it in the integration test phase.
integration_test:nixos:
  stage: integration_test
  needs: []
  tags:
    - native-nix-v2
  script:
    - mkdir -p output
    # Workaround Gitlab CI not archiving across symlinks
    - mkdir -p output/compilers/
    - cp -r $(nix-build --no-out-link nix/release.nix -A hedron.builds) output/compilers/
    - mkdir -p output/integration-test/
    # We limit integration test builds to low concurrency to avoid
    # overloading the build box and timing out.
    - cp -r $(nix-build -j1 --no-out-link nix/release.nix -A hedron.integration-test) output/integration-test/
    - mkdir -p output/coverage/
    - cp -r $(nix-build --no-out-link nix/release.nix -A hedron.coverage) output/coverage/
  artifacts:
    expire_in: 1 week
    paths:
      - output/

# Deployments

pages:
  stage: deploy
  script:
    - mkdir -p public/
    - nix-build ./nix/release.nix -A hedron.docs
    - cp -R result/* public/
  artifacts:
    paths:
      - public
  tags:
    - native-nix-v2
  only:
    - master
  needs: []