ci.yml

# Copyright IBM Corp. All Rights Reserved.
#
# SPDX-License-Identifier: Apache-2.0
#
---
name: CI
on:
  push:
    branches: ["**"]
  pull_request:
    branches: ["**"]

permissions:
  contents: read

env:
  DB_DEPLOYMENT: local
  DB_TYPE: postgres
  FABRIC_LOGGING_SPEC: info:grpc=error

jobs:
  gate:
    name: CI Gate
    runs-on: ubuntu-latest
    if: |
      github.event_name == 'pull_request' ||
      github.repository != 'hyperledger/fabric-x-committer' ||
      startsWith(github.ref, 'refs/heads/main') ||
      startsWith(github.ref, 'refs/heads/release')
    steps:
      - run: echo "CI gate passed"

  lint:
    name: Lint and Build
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh

      # Applying go.mod tidy rules and downloading dependencies in a different
      # step to reduce output clutter.
      - run: go mod tidy
      - name: Lint
        run: |
          # Re generate auto-generated code.
          PATH="$HOME/bin:$PATH" make proto
          # Check if original code changed due to formatting.
          git diff --exit-code
          # Fetch main to only show new lint issues.
          git fetch -u origin main:main
          make lint

      - name: Build
        run: make build

  unit-test:
    name: Unit Test (non DB)
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: go mod tidy
      - run: make test-no-db
      - run: scripts/test-coverage-filter-files.sh
      - name: Send coverage
        uses: shogo82148/actions-goveralls@v1
        with:
          path-to-profile: coverage.profile
          flag-name: unit-test
          parallel: true
        continue-on-error: true

  db-test:
    name: Requires and Core DB Tests (postgres)
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: scripts/get-and-start-postgres.sh
      - run: go mod tidy
      - run: make test-all-db
      - run: scripts/test-coverage-filter-files.sh
      - name: Send coverage
        uses: shogo82148/actions-goveralls@v1
        with:
          path-to-profile: coverage.profile
          flag-name: db-test
          parallel: true
        continue-on-error: true

  core-db-test:
    name: Core DB Tests (yugabyte)
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: scripts/get-and-start-yuga.sh
      - run: go mod tidy
      - run: make test-core-db

  integration-test:
    name: Integration Tests (yugabyte)
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: scripts/get-and-start-yuga.sh
      - run: go mod tidy
      - run: make test-integration

  db-resiliency-test:
    name: Integration DB Resiliency (container)
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: go mod tidy
      - run: make test-integration-db-resiliency

  container-test:
    name: Build and test container images
    needs: [gate]
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version-file: go.mod
      - run: scripts/install-dev-dependencies.sh
      - run: go mod tidy
      - run: make build-image-test-node build-image-release
      - run: make test-container

  coveralls:
    name: Indicate completion to coveralls.io
    needs:
      - unit-test
      - db-test
    runs-on: ubuntu-latest
    steps:
      - uses: coverallsapp/github-action@v2
        with:
          parallel-finished: true
        continue-on-error: true

  analyze:
    name: Analyze (${{ matrix.language }})
    needs: [gate]
    # Runner size impacts CodeQL analysis time. To learn more, please see:
    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
    #   - https://gh.io/supported-runners-and-hardware-resources
    #   - https://gh.io/using-larger-runners (GitHub.com only)
    # Consider using larger runners or machines with greater resources for possible analysis time improvements.
    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
    permissions:
      # required for all workflows
      security-events: write

      # required to fetch internal or private CodeQL packs
      packages: read

      # only required for workflows in private repositories
      actions: read
      contents: read

    strategy:
      fail-fast: false
      matrix:
        include:
          - language: actions
            build-mode: none
          - language: go
            build-mode: autobuild
        # CodeQL supports the following values keywords for 'language':
        # 'actions', 'c-cpp', 'csharp', 'go', 'java-kotlin',
        # 'javascript-typescript', 'python', 'ruby', 'rust', 'swift'
        # Use `c-cpp` to analyze code written in C, C++ or both
        # Use 'java-kotlin' to analyze code written in Java, Kotlin or both
        # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both
        # To learn more about changing the languages that are analyzed
        # or customizing the build mode for your analysis, see
        # https://docs.github.com/en/code-security/code-scanning/
        #   creating-an-advanced-setup-for-code-scanning/
        #   customizing-your-advanced-setup-for-code-scanning
        # If you are analyzing a compiled language, you can modify
        # the 'build-mode' for that language to customize how
        # your codebase is analyzed, see
        # https://docs.github.com/en/code-security/code-scanning/
        #   creating-an-advanced-setup-for-code-scanning/
        #   codeql-code-scanning-for-compiled-languages
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      # Add any setup steps before running the `github/codeql-action/init` action.
      # This includes steps like installing compilers or runtimes (`actions/setup-node`
      # or others). This is typically only required for manual builds.
      # - name: Setup runtime (example)
      #   uses: actions/setup-example@v1

      # Initializes the CodeQL tools for scanning.
      - name: Initialize CodeQL
        uses: github/codeql-action/init@v4
        with:
          languages: ${{ matrix.language }}
          build-mode: ${{ matrix.build-mode }}
          # If you wish to specify custom queries, you can do so here or in a config file.
          # By default, queries listed here will override any specified in a config file.
          # Prefix the list here with "+" to use these queries and those in the config file.

          # For more details on CodeQL's query packs, refer to:
          # https://docs.github.com/en/code-security/code-scanning/
          #   automatically-scanning-your-code-for-vulnerabilities-and-errors/
          #   configuring-code-scanning#using-queries-in-ql-packs
          # queries: security-extended,security-and-quality

      # If the analyze step fails for one of the languages you are analyzing with
      # "We were unable to automatically build your code", modify the matrix above
      # to set the build mode to "manual" for that language. Then modify this step
      # to build your code.
      # ℹ️ Command-line programs to run using the OS shell.
      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
      - name: Run manual build steps
        if: matrix.build-mode == 'manual'
        shell: bash
        run: |
          echo 'If you are using a "manual" build mode for one or more of the' \
            'languages you are analyzing, replace this with the commands to build' \
            'your code, for example:'
          echo '  make bootstrap'
          echo '  make release'
          exit 1

      - name: Perform CodeQL Analysis
        uses: github/codeql-action/analyze@v4
        with:
          category: "/language:${{matrix.language}}"