sonar-step-dotnet-analyze.yml

name: Sonar analyze with artifacts

on:
  workflow_call:
    inputs:
      RUN_ON:
        required: false
        type: string
        default: "zupit-agents"
      RUNNERS_CONTAINER_GROUP:
        required: false
        type: string
        default: "Container"
      WORKING_DIRECTORY:
        required: true
        type: string
      SONAR_PROJECT_KEY:
        required: true
        type: string
      SONAR_IMAGE:
        required: false
        type: string
        default: "sonarsource/sonar-scanner-cli:10.0.2.1398_5.0.1"
      SONAR_EXCLUSIONS:
        required: false
        type: string
        default: ""
      COVERAGE_EXCLUSIONS:
        required: false
        type: string
        default: ""
      DOTNET_VERSION:
        required: false
        type: string
        default: "7"
      SONAR_IMAGE_ENV_VARIABLES:
        required: false
        type: string
        default: "{}"
      COVERAGE_FILES:
        required: false
        type: string
        default: ""
      CHECK_QUALITY_GATE:
        required: false
        type: boolean
        default: false
      REPORTS_PATH:
        required: false
        type: string
        default: "**/*.trx"
      CHECK_WORKDIR_CHANGES:
        required: true
        type: boolean
        default: false
      CHECK_CUSTOM_DIR:
        required: false
        type: string
        default: ""
      CHECK_CHANGES_BY_JOBS:
        required: false
        type: string
        default: "all"

env:
  CHECK_DIR: ${{ inputs.WORKING_DIRECTORY }}

jobs:
  workdir-has-changes:
    runs-on: ubuntu-latest
    outputs:
      changes-detected: ${{ steps.filter.outputs.changes-detected }}
    steps:
      - name: Set CHECK_DIR to custom directory if provided
        if: ${{ inputs.CHECK_CUSTOM_DIR != '' }}
        run: echo "CHECK_DIR=${{ inputs.CHECK_CUSTOM_DIR }}" >> $GITHUB_ENV
      - name: Set default CHECK_DIR
        if: ${{ inputs.CHECK_CUSTOM_DIR == '' }}
        run: echo "CHECK_DIR=${{ inputs.WORKING_DIRECTORY }}" >> $GITHUB_ENV

      - uses: actions/checkout@v4
      - uses: dorny/paths-filter@v3
        id: filter
        with:
          filters: |
            changes-detected:
              - "${{ env.CHECK_DIR }}/**"

  sonar-analyze:
    needs: workdir-has-changes
    if: ${{ !inputs.CHECK_WORKDIR_CHANGES || (needs.workdir-has-changes.outputs.changes-detected == 'true' && (inputs.CHECK_CHANGES_BY_JOBS == 'all' || contains(fromJson(inputs.CHECK_CHANGES_BY_JOBS), github.job))) }}
    runs-on:
      labels: ${{ inputs.RUN_ON }}
      group: ${{ inputs.RUNNERS_CONTAINER_GROUP }}
    container:
      image: ${{ inputs.SONAR_IMAGE }}
      env: ${{ fromJson(inputs.SONAR_IMAGE_ENV_VARIABLES) }}
      options: --user root
    defaults:
      run:
        working-directory: ${{ inputs.WORKING_DIRECTORY }}
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Install .NET
        uses: zupit-it/pipeline-templates/.github/actions/dotnet/install@v1.25.0
        with:
          WORKING_DIRECTORY: ${{ inputs.WORKING_DIRECTORY }}
          DOTNET_VERSION: ${{ inputs.DOTNET_VERSION }}
          ALPINE_OS: true

      - name: Install SonarSource for .NET
        run: |
          dotnet tool update --tool-path /tmp/dotnet-tools dotnet-sonarscanner
          ln -s /tmp/dotnet-tools/dotnet-sonarscanner /usr/bin/dotnet-sonarscanner

      - name: Begin .NET SonarScanner
        shell: "bash"
        run: |
          params=()
          [[ -n "${{ inputs.SONAR_EXCLUSIONS }}" ]] && params+=(/d:sonar.exclusions="${{ inputs.SONAR_EXCLUSIONS }}")
          [[ -n "${{ inputs.COVERAGE_EXCLUSIONS }}" ]] && params+=(/d:sonar.coverage.exclusions="${{ inputs.COVERAGE_EXCLUSIONS }}")
          [[ -n "${{ inputs.COVERAGE_FILES }}" ]] && params+=(/d:sonar.cs.opencover.reportsPaths="${{ inputs.COVERAGE_FILES }}")
          [[ -z "${{ inputs.COVERAGE_FILES }}" ]] && params+=(/d:sonar.cs.opencover.reportsPaths=**/coverage.opencover.xml)

          dotnet-sonarscanner begin \
            /k:"${{ inputs.SONAR_PROJECT_KEY }}" \
            /d:sonar.token="${{ secrets.SONAR_TOKEN }}" \
            /d:sonar.host.url="${{ secrets.SONAR_HOST_URL }}" \
            /d:sonar.cs.vstest.reportsPaths=${{inputs.REPORTS_PATH}} \
            /d:sonar.qualitygate.wait=${{ inputs.CHECK_QUALITY_GATE }} \
            "${params[@]}"

      - name: Build
        uses: zupit-it/pipeline-templates/.github/actions/dotnet/build@v1.25.0
        with:
          WORKING_DIRECTORY: ${{ inputs.WORKING_DIRECTORY }}
          BUILD_CONFIG: "Debug"

      - name: Run tests
        uses: zupit-it/pipeline-templates/.github/actions/dotnet/test@v1.25.0
        with:
          WORKING_DIRECTORY: ${{ inputs.WORKING_DIRECTORY }}
          EXCLUDE_FILES: ${{ inputs.COVERAGE_EXCLUSIONS }}

      - name: End .NET SonarScanner
        run: dotnet-sonarscanner end /d:sonar.token="${{ secrets.SONAR_TOKEN }}"

  jobs-succeded:
    needs: sonar-analyze
    runs-on: ubuntu-latest
    if: ${{ always()}}
    steps:
      - name: "Jobs: sonar-analyze didn't fail."
        run: if [ "${{ needs.sonar-analyze.result }}" == "failure" ]; then exit 1; fi