version: 2.1

commands:
  build_board:
    parameters:
      target:
        type: string
      subcommand:
        type: string
    steps:
      - run:
          name: Install dependencies
          command: |
            apt update
            apt install -y build-essential zlib1g-dev uuid-dev libdigest-sha-perl libelf-dev bc bzip2 bison flex git gnupg iasl m4 nasm patch python python2 python3 wget gnat cpio ccache pkg-config cmake libusb-1.0-0-dev autoconf texinfo ncurses-dev doxygen graphviz udev libudev1 libudev-dev automake libtool rsync innoextract
      - run:
          name: Make Board
          command: |
            rm -rf build/<<parameters.target>>/* build/log/* && make V=1 BOARD=<<parameters.target>> <<parameters.subcommand>> || touch ./tmpDir/failed_build
          no_output_timeout: 3h
      - run:
          name: Output build failing logs
          command: |
            if [[ -f ./tmpDir/failed_build ]]; then find ./build/ -name "*.log" -type f -mmin -1|while read log; do echo ""; echo '==>' "$log" '<=='; echo ""; cat $log;done; exit 1;else echo "Not failing. Continuing..."; fi \
      - run:
          name: Output hashes
          command: |
            cat build/<<parameters.target>>/hashes.txt || echo "No hashes for this build step..."\
      - run:
          name: Archiving build logs.
          command: |
             tar zcvf build/<<parameters.target>>/logs.tar.gz build/log/*
      - store_artifacts:
          path: build/<<parameters.target>>

jobs:
  prep_env:
    docker:
      - image: debian:10
    resource_class: large
    steps:
      - run:
          name: Install dependencies
          command: |
            apt update
            apt install -y build-essential zlib1g-dev uuid-dev libdigest-sha-perl libelf-dev bc bzip2 bison flex git gnupg iasl m4 nasm patch python python2 python3 wget gnat cpio ccache pkg-config cmake libusb-1.0-0-dev autoconf texinfo ncurses-dev doxygen graphviz udev libudev1 libudev-dev automake libtool rsync innoextract
      - checkout

      - run:
          name: git reset
          command: |
            git reset --hard "$CIRCLE_SHA1" \

      - run:
          name: Make tmp dir
          command: |
            mkdir ./tmpDir \

      - run:
          name: Creating all modules and patches digest (All modules cache digest)
          command: |
            find ./patches/ ./modules/ -type f | sort -h |xargs sha256sum > ./tmpDir/all_modules_and_patches.sha256sums \

      - run:
          name: Creating coreboot (and associated patches) and musl-cross-make modules digest (musl-cross-make and coreboot cache digest)
          command: |
            find ./modules/coreboot ./modules/musl-cross* ./patches/coreboot* -type f | sort -h | xargs sha256sum > ./tmpDir/coreboot_musl-cross.sha256sums \

      - run:
          name: Creating musl-cross-make and musl-cross-make patches digest (musl-cross-make cache digest)
          command: |
            find modules/musl-cross* -type f | sort -h | xargs sha256sum > ./tmpDir/musl-cross.sha256sums \

      - restore_cache:
          keys:
            #Restore existing cache for matching modules digest, validated to be exactly the same as in github current commit.
            #This cache was made on top of below caches, if previously existing. If no module definition changed, we reuse this one. Otherwise...
            - heads-modules-and-patches-{{ checksum "./tmpDir/all_modules_and_patches.sha256sums" }}{{ .Environment.CACHE_VERSION }}
            #If precedent cache not found, restore cache for coreboot module (and patches) and musl-cross-make digests (bi-yearly modified)
            #Otehrwise....
            - heads-coreboot-musl-cross-{{ checksum "./tmpDir/coreboot_musl-cross.sha256sums" }}{{ .Environment.CACHE_VERSION }}
            #If precedent cache not found. Restore cache for musl-cross-make module digest (rarely modified).
            #Otherwise, we build cleanly.
            - heads-musl-cross-{{ checksum "./tmpDir/musl-cross.sha256sums" }}{{ .Environment.CACHE_VERSION }}
      - run:
          name: Download and neuter xx20 ME (keep generated GBE and extracted IFD in tree)
          command: |
            ./blobs/xx20/download_parse_me.sh

      - run:
          name: Download and neuter xx30 ME (keep generated GBE and extracted IFD in tree)
          # me_cleaner.py present under heads xx30 blobs dir comes from https://github.com/corna/me_cleaner/blob/43612a630c79f3bc6f2653bfe90dfe0b7b137e08/me_cleaner.py
          command: |
            ./blobs/xx30/download_clean_me.sh -m $(readlink -f ./blobs/xx30/me_cleaner.py)

      - persist_to_workspace:
          root: ~/
          paths:
            - .

  build_and_persist:
    docker:
      - image: debian:10
    resource_class: large
    parameters:
      target:
        type: string
      subcommand:
        type: string
    steps:
      - attach_workspace:
          at: ~/
      - build_board:
          target: <<parameters.target>> 
          subcommand: <<parameters.subcommand>>
      - persist_to_workspace:
          root: ~/
          paths:
            - .

  build:
    docker:
      - image: debian:10
    parameters:
      target:
        type: string
      subcommand:
        type: string
    steps:
      - attach_workspace:
          at: ~/
      - build_board:
          target: <<parameters.target>> 
          subcommand: <<parameters.subcommand>>

  save_cache:
    docker:
      - image: debian:10
    steps:
      - attach_workspace:
          at: ~/
      - save_cache:
          #Generate cache for the same musl-cross module definition if hash is not previously existing
          #CircleCI removed their wildcard support, so we have to list precise versions to cache in directory names
          key: heads-musl-cross-{{ checksum "./tmpDir/musl-cross.sha256sums" }}{{ .Environment.CACHE_VERSION }}
          paths:
            - crossgcc
            - build/musl-cross-38e52db8358c043ae82b346a2e6e66bc86a53bc1
      - save_cache:
          #Generate cache for the same coreboot mnd musl-cross-make modules definition if hash is not previously existing
          #CircleCI removed their wildcard support, so we have to list precise versions to cache in directory names
          key: heads-coreboot-musl-cross-{{ checksum "./tmpDir/coreboot_musl-cross.sha256sums" }}{{ .Environment.CACHE_VERSION }}
          paths:
            - build/coreboot-4.11
            - build/coreboot-4.13
            - build/coreboot-4.14
            - build/coreboot-4.15
            - crossgcc
            - build/musl-cross-38e52db8358c043ae82b346a2e6e66bc86a53bc1
      - save_cache:
          #Generate cache for the exact same modules definitions if hash is not previously existing
          key: heads-modules-and-patches-{{ checksum "./tmpDir/all_modules_and_patches.sha256sums" }}{{ .Environment.CACHE_VERSION }}
          paths:
            - packages
            - crossgcc
            - build
            - install

workflows:
  version: 2
  build_and_test:
    jobs:
      - prep_env

# Below, sequentially build one board for each coreboot
# version. The last board in the sequence is the dependency
# for the parallel boards built at the end, and also save_cache.

      # Prerequisites
      - build_and_persist:
          name: heads_musl-cross
          target: x230-hotp-maximized
          subcommand: musl-cross
          requires:
            - prep_env

      # Coreboot 4.13
      - build_and_persist:
          name: x230-hotp-maximized
          target: x230-hotp-maximized
          subcommand: ""
          requires:
            - heads_musl-cross

      # Coreboot 4.11
      #- build_and_persist:
      #    name: librem_l1um
      #    target: librem_l1um
      #    subcommand: ""
      #    requires:
      #      - x230-hotp-maximized

      - save_cache:
          requires:
            - x230-hotp-maximized

#
#
# Those onboarding new boards should add their entries below.
#
#

      - build:
          name: x220-hotp-maximized
          target: x220-hotp-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: x220-maximized
          target: x220-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t420-hotp-maximized
          target: t420-hotp-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t420-maximized
          target: t420-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: x230-flash
          target: x230-flash
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t430-flash
          target: t430-flash
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t430
          target: t430
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t430-hotp-verification
          target: t430-hotp-verification
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: x230
          target: x230
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: x230-hotp-verification
          target: x230-hotp-verification
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t430-hotp-maximized
          target: t430-hotp-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: t430-maximized
          target: t430-maximized
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: qemu-coreboot
          target: qemu-coreboot
          subcommand: ""
          requires:
            - x230-hotp-maximized

      - build:
          name: qemu-coreboot-fbwhiptail
          target: qemu-coreboot-fbwhiptail
          subcommand: ""
          requires:
            - x230-hotp-maximized
      #KGPE-D16 turned off because CircleCI built time needs to be optimized. Kernel doesn't seem to enforce MAKE_JOBS properly
      #- build:
      #    name: kgpe-d16_workstation-usb_keyboard
      #    target: kgpe-d16_workstation-usb_keyboard
      #    subcommand: ""
      #    requires:
      #      - librem_l1um

      #- build:
      #    name: kgpe-d16_server
      #    target: kgpe-d16_server
      #    subcommand: ""
      #    requires:
      #      - librem_l1um

      #- build:
      #    name: kgpe-d16_server-whiptail
      #    target: kgpe-d16_server-whiptail
      #    subcommand: ""
      #    requires:
      #      - librem_l1um

      #- build:
      #    name: kgpe-d16_workstation
      #    target: kgpe-d16_workstation
      #    subcommand: ""
      #    requires:
      #      - librem_l1um

########################
########################
###    OLD STUFF     ###
########################
########################
# linuxboot steps need something to pass in the kernel header path
# skipping for now
#      - run:
#          name: qemu-linuxboot-edk2
#          command: |
#            ./build/make-4.2.1/make \
#                CROSS=/cross/bin/x86_64-linux-musl- \
#                BOARD=qemu-linuxboot \
#                `/bin/pwd`/build/linuxboot-git/build/qemu/.configured \
#                # Run first to avoid too many processes
#
#      - run:
#          name: qemu-linuxboot
#          command: |
#            ./build/make-4.2.1/make \
#                CROSS=/cross/bin/x86_64-linux-musl- \
#                CPUS=16 \
#                V=1 \
#                BOARD=qemu-linuxboot \
#
#      - store-artifacts:
#          path: build/qemu-linuxboot/linuxboot.rom
#      - store-artifacts:
#          path: build/qemu-linuxboot/hashes.txt