kuksa_databroker_build.yml

# /********************************************************************************
# * Copyright (c) 2022 Contributors to the Eclipse Foundation
# *
# * See the NOTICE file(s) distributed with this work for additional
# * information regarding copyright ownership.
# *
# * This program and the accompanying materials are made available under the
# * terms of the Apache License 2.0 which is available at
# * http://www.apache.org/licenses/LICENSE-2.0
# *
# * SPDX-License-Identifier: Apache-2.0
# ********************************************************************************/

name: Build kuksa-databroker

on:
  push:
    branches: [ main]
  pull_request:
  workflow_call:
  workflow_dispatch:

concurrency:
      group: ${{ github.ref }}-${{ github.workflow }}
      cancel-in-progress: true

# Needed as default_workflow_permissions is "read"
permissions:
  packages: write

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    env:
      CARGO_TERM_COLOR: always
    steps:
      - uses: actions/checkout@v4
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: databroker-lint-${{ hashFiles('**/Cargo.lock') }}
      - name: Show toolchain information
        working-directory: ${{github.workspace}}
        run: |
          rustup toolchain list
          cargo --version
      - name: cargo fmt
        working-directory: ${{github.workspace}}
        run: cargo fmt -- --check
      - name: cargo clippy
        working-directory: ${{github.workspace}}
        run: cargo clippy --all-targets -- -W warnings -D warnings
      - name: cargo clippy (feature viss)
        working-directory: ${{github.workspace}}
        run: cargo clippy --features viss --all-targets -- -W warnings -D warnings

  test:
    name: Unit tests
    runs-on: ubuntu-latest
    env:
      CARGO_TERM_COLOR: always
    steps:
      - uses: actions/checkout@v4
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: databroker-coverage-${{ hashFiles('**/Cargo.lock') }}
      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov
      - name: Generate code coverage
        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
      - name: Upload coverage to Codecov
        # To use v4 a token must be specifed by "token: ${{ secrets.CODECOV_TOKEN }}""
        # Uploaded result available at https://app.codecov.io/gh/eclipse-kuksa/kuksa-databroker
        uses: codecov/codecov-action@v3
        with:
          files: lcov.info

  build:
    name: Build
    runs-on: ubuntu-latest
    env:
      CARGO_TERM_COLOR: always
    strategy:
      matrix:
        platform:
          - name: amd64
            target: x86_64-unknown-linux-musl
          - name: arm64
            target: aarch64-unknown-linux-musl
          - name: riscv64
            target: riscv64gc-unknown-linux-gnu
    steps:
    - uses: actions/checkout@v4
    - uses: actions/cache@v4
      with:
        path: |
          ~/.cargo/bin/
          ~/.cargo/registry/index/
          ~/.cargo/registry/cache/
          ~/.cargo/git/db/
          target/
        key: databroker-release-${{ matrix.platform.name }}-${{ hashFiles('**/Cargo.lock') }}
    - name: Install build prerequisites
      working-directory: ${{github.workspace}}/
      run: |
        which cross || cargo install cross
    - name: Build
      working-directory: ${{github.workspace}}/
      run: |
        cross build --target ${{ matrix.platform.target }} --bin databroker --release
        mkdir -p "dist/${{ matrix.platform.name }}"
        cp "target/${{ matrix.platform.target }}/release/databroker" "dist/${{ matrix.platform.name }}"
    - name: Package dist files
      shell: bash
      working-directory: ${{github.workspace}}
      run: |
        tar -cf databroker-${{ matrix.platform.name }}.tar.gz dist

    - name: Upload artifacts
      uses: actions/upload-artifact@v4
      with:
        name: databroker-${{ matrix.platform.name }}.tar.gz
        path: databroker-${{ matrix.platform.name }}.tar.gz
        if-no-files-found: error

  check_ghcr_push:
    name: Check access rights
    uses: eclipse-kuksa/kuksa-actions/.github/workflows/check_ghcr_push.yml@2
    secrets: inherit

  create-container:
    name: Create multiarch container
    runs-on: ubuntu-latest

    needs: [build, bom, check_ghcr_push]

    steps:
    - uses: actions/checkout@v4
    - name: Retrieve artifacts
      uses: actions/download-artifact@v4
      with:
        path: artifacts
        merge-multiple: true

    - name: Unpack binaries
      env:
        AMD64_DIR: ${{ github.workspace }}/target/x86_64-unknown-linux-musl/release
        ARM64_DIR: ${{ github.workspace }}/target/aarch64-unknown-linux-musl/release
        RISCV64_DIR: ${{ github.workspace }}/target/riscv64gc-unknown-linux-gnu/release
      run: |
        tar xf artifacts/databroker-amd64.tar.gz
        mkdir -p "$AMD64_DIR"
        mv dist/amd64/databroker "$AMD64_DIR"
        tar xf artifacts/databroker-arm64.tar.gz
        mkdir -p "$ARM64_DIR"
        mv dist/arm64/databroker "$ARM64_DIR"
        tar xf artifacts/databroker-riscv64.tar.gz
        mkdir -p "$RISCV64_DIR"
        mv dist/riscv64/databroker "$RISCV64_DIR"
        tar xf artifacts/thirdparty.tar.gz
    - name: Set container metadata
      id: meta
      uses: docker/metadata-action@v5
      with:
        # list of Docker images to use as base name for tags
        images: |
          ghcr.io/eclipse-kuksa/kuksa-databroker
        # generate Docker tags based on the following events/attributes
        tags: |
          type=ref,event=branch
          type=ref,event=pr
          type=semver,pattern={{version}}
          type=semver,pattern={{major}}.{{minor}}
          type=semver,pattern={{major}}

    - name: Setup Docker Buildx
      id: buildx
      uses: docker/setup-buildx-action@v3

    - name: Log in to the Container registry
      if: needs.check_ghcr_push.outputs.push == 'true'
      uses: docker/login-action@v3
      with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}

    - name: Build kuksa-databroker container and push to ghcr.io (and ttl.sh)
      id: ghcr-build
      if: needs.check_ghcr_push.outputs.push == 'true'
      uses: docker/build-push-action@v5
      with:
        platforms: |
          linux/amd64
          linux/arm64
          linux/riscv64
        file: ./Dockerfile
        context: .
        push: true
        tags: |
          ${{ steps.meta.outputs.tags }}
          ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}
        labels: ${{ steps.meta.outputs.labels }}
        # Provenance to solve that an unknown/unkown image is shown on ghcr.io
        # Same problem as described in https://github.com/orgs/community/discussions/45969
        provenance: false

    - name: Build ephemeral kuksa-databroker container and push to ttl.sh
      if: needs.check_ghcr_push.outputs.push == 'false'
      id: tmp-build
      uses: docker/build-push-action@v5
      with:
        platforms: |
          linux/amd64
          linux/arm64
          linux/riscv64
        file: ./Dockerfile
        context: .
        push: true
        tags: "ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}"
        labels: ${{ steps.meta.outputs.labels }}
        # Provenance to solve that an unknown/unkown image is shown on ghcr.io
        # Same problem as described in https://github.com/orgs/community/discussions/45969
        provenance: false

    - name: Posting message
      uses: eclipse-kuksa/kuksa-actions/post-container-location@2
      with:
        image: ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}

  integration-test:
    name: Run integration test
    runs-on: ubuntu-latest
    needs: [create-container]

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

      - uses: actions/checkout@v4

      - name: Run integration test on AMD64 container
        env:
          DATABROKER_IMAGE: ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}
          CONTAINER_PLATFORM: linux/amd64
        run: |
          ${{github.workspace}}/integration_test/run.sh

      - name: Run integration test on ARM64 container
        env:
          DATABROKER_IMAGE: ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}
          CONTAINER_PLATFORM: linux/arm64
        run: |
          ${{github.workspace}}/integration_test/run.sh

      - name: Run integration test on RISCV64 container
        env:
          DATABROKER_IMAGE: ttl.sh/eclipse-kuksa/kuksa-databroker-${{github.sha}}
          CONTAINER_PLATFORM: linux/riscv64
        run: |
          ${{github.workspace}}/integration_test/run.sh

  bom:
    name: Check Bill of Material
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: databroker-bom-${{ hashFiles('**/Cargo.lock') }}

      - name: Install prerequisites
        working-directory: ${{github.workspace}}/createbom
        run: |
         which cargo-license || cargo install cargo-license
      - name: License check and Dash output generation
        working-directory: ${{github.workspace}}/createbom
        run: |
         python3 createbom.py --dash ${{github.workspace}}/dash-databroker-deps ../databroker
      - name: Dash license check
        uses: eclipse-kuksa/kuksa-actions/check-dash@2
        with:
          dashinput: ${{github.workspace}}/dash-databroker-deps
      - name: Generate Bill of Materials
        working-directory: ${{github.workspace}}/createbom
        run: |
          rm -r ../databroker/thirdparty
          python3 createbom.py ../databroker
          cd ..
          tar cf thirdparty.tar.gz databroker/thirdparty
      - name: Upload Bill of Materials
        uses: actions/upload-artifact@v4
        with:
          name: Third party licenses
          path: thirdparty.tar.gz
          if-no-files-found: error