ci-workflow.yml

name: CI

on:
  workflow_dispatch:
  push:
    branches:
    - master
    - develop
  pull_request:
    branches:
    - master
    - develop

jobs:
  job_build:
    name: Compilation for X, S+, Stax and Flex

    strategy:
      matrix:
        include:
          - model: nanox
            SDK: "$NANOX_SDK"
          - model: nanosp
            SDK: "$NANOSP_SDK"
          - model: stax
            SDK: "$STAX_SDK"
          - model: flex
            SDK: "$FLEX_SDK"

    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:latest

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Build
        run: |
          make DEBUG=0 COIN=bitcoin BOLOS_SDK=${{ matrix.SDK }} && mv bin/ bitcoin-bin/
          make clean
          make DEBUG=0 COIN=bitcoin_testnet BOLOS_SDK=${{ matrix.SDK }} && mv bin/ bitcoin-testnet-bin/
      - name: Upload Bitcoin app binary
        uses: actions/upload-artifact@v4
        with:
          name: bitcoin-app-${{ matrix.model }}
          path: bitcoin-bin

      - name: Upload Bitcoin Testnet app binary
        uses: actions/upload-artifact@v4
        with:
          name: bitcoin-testnet-app-${{ matrix.model }}
          path: bitcoin-testnet-bin

  job_build_app_perftest:
    name: Compile the UX-less version of the app on Nano S+ for performance tests

    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:latest

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Build
        run: |
          make DEBUG=0 COIN=bitcoin_testnet BOLOS_SDK="$NANOSP_SDK" AUTOAPPROVE_FOR_PERF_TESTS=1

      - name: Upload Bitcoin Testnet app binary
        uses: actions/upload-artifact@v4
        with:
          name: bitcoin-testnet-perftest-app-nanosp
          path: bin

  job_unit_test:
    name: Unit test
    needs: job_build
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:latest

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Build unit tests
        run: |
          cd unit-tests/
          cmake -Bbuild -H. && make -C build && make -C build test
      - name: Generate code coverage
        run: |
          cd unit-tests/
          lcov --directory . -b "$(realpath build/)" --capture --initial -o coverage.base && \
          lcov --rc lcov_branch_coverage=1 --directory . -b "$(realpath build/)" --capture -o coverage.capture && \
          lcov --directory . -b "$(realpath build/)" --add-tracefile coverage.base --add-tracefile coverage.capture -o coverage.info && \
          lcov --directory . -b "$(realpath build/)" --remove coverage.info '*/unit-tests/*' -o coverage.info && \
          genhtml coverage.info -o coverage
      - uses: actions/upload-artifact@v4
        with:
          name: code-coverage
          path: unit-tests/coverage

      - name: Upload to codecov.io
        uses: codecov/codecov-action@v3
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: ./unit-tests/coverage.info
          flags: unittests
          name: codecov-app-bitcoin
          fail_ci_if_error: true
          verbose: true
      
      - name: HTML documentation
        run: doxygen .doxygen/Doxyfile

      - uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: doc/html

  job_test_mainnet:
    name: Tests on mainnet
    strategy:
      matrix:
        include:
          - model: nanox
          - model: nanosp
          - model: stax
          - model: flex

    needs: job_build
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/speculos:latest
      ports:
        - 1234:1234
        - 9999:9999
        - 40000:40000
        - 41000:41000
        - 42000:42000
        - 43000:43000
      options: --entrypoint /bin/bash

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Download Bitcoin app binary
        uses: actions/download-artifact@v4
        with:
          name: bitcoin-app-${{matrix.model}}
          path: bin

      - name: Install build dependencies
        run: apt update && apt install -y build-essential          

      - name: Run tests
        run: |
          pip install -r requirements.txt
          cd tests_mainnet
          PYTHONPATH=$PYTHONPATH:/speculos pytest --headless --model=${{ matrix.model }} --timeout=300

  job_test_python_lib_legacyapp:
    name: Tests with the Python library and legacy Bitcoin app
    needs: job_build
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/speculos:latest
      ports:
        - 1234:1234
        - 9999:9999
        - 40000:40000
        - 41000:41000
        - 42000:42000
        - 43000:43000
      options: --entrypoint /bin/bash

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Install build dependencies
        run: apt update && apt install -y build-essential

      - name: Run tests
        run: |
          pip install -r requirements.txt
          cd bitcoin_client/tests
          PYTHONPATH=$PYTHONPATH:/speculos pytest --headless --timeout=300 --model=nanos

  job_perftests:
    name: Performance report

    needs: job_build_app_perftest
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/speculos:latest
      ports:
        - 1234:1234
        - 9999:9999
        - 40000:40000
        - 41000:41000
        - 42000:42000
        - 43000:43000
      options: --entrypoint /bin/bash

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Download Bitcoin app binary for perftests
        uses: actions/download-artifact@v4
        with:
          name: bitcoin-testnet-perftest-app-nanosp
          path: bin

      - name: Install build dependencies
        run: apt update && apt install -y build-essential

      - name: Run tests
        run: |
          pip install -r requirements.txt
          cd tests_perf
          PYTHONPATH=$PYTHONPATH:/speculos pytest --headless --model=nanosp --benchmark-json=benchmarks.json
      - name: Upload benchmarks summary
        uses: actions/upload-artifact@v4
        with:
          name: benchmarks-log
          path: tests_perf/benchmarks.json

  job_test_js_lib:
    name: Tests with the JS library
    needs: job_build
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/speculos:latest
      ports:
        - 1234:1234
        - 9999:9999
        - 40000:40000
        - 41000:41000
        - 42000:42000
        - 43000:43000
      options: --entrypoint /bin/bash

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Install node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install yarn
        run: |
          npm install -g yarn

      - name: Download Bitcoin Testnet app binary
        uses: actions/download-artifact@v4
        with:
          name: bitcoin-testnet-app-nanosp
          path: bin

      - name: Run tests
        run: |
          cd bitcoin_client_js
          yarn install
          LOG_SPECULOS=1 LOG_APDUS=1 SPECULOS="/speculos/speculos.py" yarn test


  job_test_rust_client:
    name: Tests for rust client library
    needs: job_build
    runs-on: ubuntu-latest

    container:
      image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:latest

    steps:
      - name: Clone
        uses: actions/checkout@v4

      - name: Run tests
        run: |
          cd bitcoin_client_rs/
          cargo test --no-default-features --features="async"