main.yaml

name: CI

on:
  push:
    branches:
      - 'main'
  pull_request:
    branches:
      - '*'
  merge_group:
    branches:
      - 'main'

defaults:
  run:
    shell: bash

env:
  # go needs absolute directories, using the $HOME variable doesn't work here.
  GOPATH: /home/runner/work/go

  GO_VERSION: '1.22.3'
  
  LITD_ITEST_BRANCH: '0-19-staging'

jobs:
  #######################
  # sql model generation
  #######################
  sqlc-check:
    name: Sqlc check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: docker image cache
        uses: jpribyl/action-docker-layer-caching@v0.1.1
        continue-on-error: true

      - name: Generate sql models
        run: make sqlc-check

  rpc-check:
    name: RPC check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: Generate RPC stubs and check REST annotations
        run: make rpc-check

  mod-check:
    name: go mod check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: Run go mod tidy
        run: make mod-check

  test-vector-check:
    name: test vector check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: Run test vector creation check
        run: make test-vector-check

  migration-check:
    name: migration version check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Run migration check
        run: make migration-check

  ########################
  # Compilation check.
  ########################
  compile-check:
    name: Compilation check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: compile code
        run: go install -v ./...

      - name: Compile docs examples
        run: make build-docs-examples

  ########################
  # sample configuration check
  ########################
  sample-conf-check:
    name: sample configuration check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: setup go environment
        uses: ./.github/actions/setup-go

      - name: check default values in sample-tapd.conf file
        run: make sample-conf-check

  ########################
  # Docker build check.
  ########################
  docker-build-check:
    name: Docker build check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Set up QEMU
        uses: docker/setup-qemu-action@v2

      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v2

      - name: Build default image
        uses: docker/build-push-action@v4
        with:
          tags: 'default-taproot-assets'

      - name: Build dev image
        uses: docker/build-push-action@v4
        with:
          file: dev.Dockerfile
          tags: 'dev-taproot-assets'

  ########################
  # cross compilation
  ########################
  cross-compile:
    name: cross compilation
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: setup go ${{ env.GO_VERSION }}
        uses: ./.github/actions/setup-go

      - name: build release for all architectures
        run: make release

  ########################
  # Lint check.
  ########################
  lint-check:
    name: Lint check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: run lint
        run: make lint

  ########################
  # Format check.
  ########################
  format-check:
    name: Format check
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: run format
        run: make fmt

  ########################
  # run unit tests
  ########################
  unit-test:
    name: run unit tests
    runs-on: ubuntu-latest
    strategy:
      # Allow other tests in the matrix to continue if one fails.
      fail-fast: false
      matrix:
        unit_type:
          - unit-race
          - unit-cover
          - unit dbbackend=postgres
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: run ${{ matrix.unit_type }}
        run: make ${{ matrix.unit_type }}

      - name: Send coverage
        uses: shogo82148/actions-goveralls@v1
        if: matrix.unit_type == 'unit-cover'
        with:
          path-to-profile: coverage.txt
          flag-name: 'unit'
          parallel: true

  ########################
  # run integration tests
  ########################
  integration-test:
    name: run itests
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: run itest
        run: make itest

      - name: Zip log files on failure
        if: ${{ failure() }}
        run: 7z a logs-itest.zip itest/**/*.log

      - name: Upload log files on failure
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: logs-itest
          path: logs-itest.zip
          retention-days: 5

  ########################
  # run integration tests with Postgres backend
  ########################
  integration-test-postgres:
    name: run itests postgres
    runs-on: ubuntu-latest
    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: run itest
        run: make itest dbbackend=postgres

      - name: Zip log files on failure
        if: ${{ failure() }}
        run: 7z a logs-itest-postgres.zip itest/**/*.log

      - name: Upload log files on failure
        uses: actions/upload-artifact@v3
        if: ${{ failure() }}
        with:
          name: logs-itest-postgres
          path: logs-itest-postgres.zip
          retention-days: 5

  ########################
  # Run LiTd tests
  ########################
  run-lit-tests:
    name: run LiT tests
    runs-on: ubuntu-latest

    steps:
      - name: git checkout
        uses: actions/checkout@v3

      - name: Setup go environment
        uses: ./.github/actions/setup-go

      - name: Clone Lit repository
        uses: actions/checkout@v3
        with:
          repository: lightninglabs/lightning-terminal
          ref: ${{ env.LITD_ITEST_BRANCH }}
          path: lightning-terminal

      - name: Update go.mod to use the local Tap repository
        working-directory: ./lightning-terminal
        run: |
          go mod edit -replace=github.com/lightning-labs/taproot-assets=../
          go mod tidy

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

      - name: setup nodejs
        uses: ./lightning-terminal/.github/actions/setup-node
        with:
          node-version: 16.x

      - name: install LiT app dependencies
        working-directory: ./lightning-terminal/app
        run: yarn

      - name: Run LiT itests
        working-directory: ./lightning-terminal
        run: make itest icase=custom_channels

      - name: Run LiT unit tests
        working-directory: ./lightning-terminal
        run: make unit

  # Notify about the completion of all coverage collecting jobs.
  finish:
    if: ${{ always() }}
    needs: [unit-test]
    runs-on: ubuntu-latest
    steps:
      - uses: shogo82148/actions-goveralls@v1
        with:
          parallel-finished: true