.gitlab-ci.yml

include:
  - template: 'Workflows/MergeRequest-Pipelines.gitlab-ci.yml'


stages:
  - check
  - build
  - test
  - deploy


variables:
  PIO_LIB_FOLDER: libspookyaction
  PIO_PROJ_FOLDER: tests


.pio-cache: &pio-cache
  cache:
    key: ${CI_COMMIT_REF_SLUG}
    paths:
      - "${PIO_PROJ_FOLDER}/.pio"

.rules-changes-sources: &rules-changes-sources
  changes:
    - ${PIO_LIB_FOLDER}/src/**/*
    - ${PIO_LIB_FOLDER}/include/**/*
    - ${PIO_LIB_FOLDER}/examples/**/*
    - ${PIO_PROJ_FOLDER}/src/**/*
    - ${PIO_PROJ_FOLDER}/test/**/*
    - ${PIO_PROJ_FOLDER}/include/**/*
    - ${PIO_PROJ_FOLDER}/lib/**/*
    - cicd/platformio.ini

.rules-changes-cicd: &rules-changes-cicd
  changes:
    - cicd/*
    - .gitlab-ci.yml

.rules-merge-to-master: &rules-merge-to-master
  if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "master"'
  when: always

.rules-master: &rules-master
  if: '$CI_COMMIT_BRANCH == "master"'
  when: always


check format:
  stage: check
  image: alpine
  allow_failure: true
  before_script:
    - apk add --update --no-cache git clang clang-extra-tools
  script:
    - >
      find . -not -path '*/\.*' -and \( -name '*.[hc]' -or -name '*.[hc]pp' \) | while read -r FILE; do
          echo "Formatting $FILE"
          clang-format --style file -i "$FILE"
      done
    - git diff --patch | tee 0001-Clang-format.patch
    - test ! -s 0001-Clang-format.patch
  artifacts:
    paths:
      - 0001-Clang-format.patch
    expire_in: 1 week
    when: on_failure
  rules:
    # Run always, on merge request too
    - when: always


build test firmware:
  stage: build
  image: ${CI_REGISTRY}/proj/testinator/esp32:latest
  <<: *pio-cache
  before_script:
    - cp cicd/platformio.ini "${PIO_PROJ_FOLDER}/platformio.ini"
    - cd "${PIO_PROJ_FOLDER}"
  script:
    # Remove the cached firmwares to ensure we will rebuild
    - rm -f .pio/**/firmware.{bin,elf}
    - pio test -vv --without-uploading --without-testing
  artifacts:
    paths:
      - "${PIO_PROJ_FOLDER}/.pio/**/*.checksum"  # Without this, `pio run` deletes the firmware
      - "${PIO_PROJ_FOLDER}/.pio/**/firmware.bin"
      - "${PIO_PROJ_FOLDER}/.pio/**/firmware.elf"
  rules:
    - when: always


build examples:
  image: ${CI_REGISTRY}/proj/testinator/esp32:latest
  stage: build
  <<: *pio-cache
  script:  # Note that we need to setup sdkconfig.defaults before, so we make our own folder and we manage it ourselves
    - >
      for file in ${PIO_LIB_FOLDER}/examples/*.cpp; do
        BUILD_DIR="$(mktemp -d)"
        cp ${PIO_LIB_FOLDER}/examples/sdkconfig.defaults "${BUILD_DIR}"
        pio ci \
          --build-dir="${BUILD_DIR}" \
          --project-conf=cicd/platformio.ini \
          --lib=${PIO_LIB_FOLDER} \
          --keep-build-dir \
          $file
        rm -rf "${BUILD_DIR}"
      done
  rules:
    # [skip examples] tag for skipping
    - if: '$CI_COMMIT_MESSAGE =~ /skip examples/'
      when: never
    # Run on merge request
    - <<: *rules-merge-to-master
    # But skip by default if the sources did not change
    - <<: *rules-changes-sources
    - <<: *rules-changes-cicd


test hardware:
  stage: test
  image: ${CI_REGISTRY}/proj/testinator/esp32:latest
  tags:
    - pn532
  dependencies:
    - build test firmware
  before_script:
    - cp cicd/platformio.ini "${PIO_PROJ_FOLDER}/platformio.ini"
    - cd "${PIO_PROJ_FOLDER}"
  script:
    # Make two attempts at uploading.
    - pio test --without-building --without-testing -vv || pio test --without-building --without-testing -vv
    - pio test --without-building --without-uploading -vv
  rules:
    # Run always, on merge request too
    - <<: *rules-merge-to-master
    # But skip by default if the sources did not change
    - <<: *rules-changes-sources
    - <<: *rules-changes-cicd


publish library:
  image: ${CI_REGISTRY}/proj/testinator/esp32:latest
  stage: deploy
  before_script:
    - python3 -m pip install --user gitpython
  script:
    - |
      python3 cicd/check_version.py ${PIO_LIB_FOLDER}/library.json && \
      pio package publish --owner ${PLATFORMIO_ORG} --non-interactive ${PIO_LIB_FOLDER}
  only:
    - tags
  except:
    - branches


pages:
  stage: deploy
  image: alpine
  needs:
    - check format
  before_script:
    - apk add --update --no-cache doxygen graphviz ttf-opensans
  script:
    - doxygen ./doxygen.conf
    - mkdir -p public
    - cp -r docs/_build/html/* public
  artifacts:
    paths:
      - public
  rules:
    - <<: *rules-master