Component.BuildTest.yml

name: Build Component

on:
  workflow_call:
    inputs:
      project-name:
        required: true
        type: string
      run-tests:
        required: false
        default: true
        type: boolean
      code-cov-name:
        required: true
        type: string
      code-cov-prefix:
        default: 'unittests'
        required: false
        type: string
      os-list:
        default: '[ "windows-latest", "ubuntu-24.04" ]'
        required: false
        type: string
      tfm-list:
        default: '[ "net462", "net8.0", "net9.0", "net10.0" ]'
        required: false
        type: string
      test-case-filter:
        required: false
        type: string
      test-require-elevated:
        default: false
        required: false
        type: boolean
      pack:
        default: true
        required: false
        type: boolean

permissions:
  contents: read

jobs:
  build-test:

    strategy:
      fail-fast: false # ensures the entire test matrix is run, even if one permutation fails
      matrix:
        os: ${{ fromJSON(inputs.os-list) }}
        version: ${{ fromJSON(inputs.tfm-list) }}
        exclude:
        - os: ubuntu-24.04
          version: net462
        - os: macos-latest
          version: net462

    runs-on: ${{ matrix.os }}
    timeout-minutes: 45

    steps:
    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      with:
        # Note: By default GitHub only fetches 1 commit. MinVer needs to find
        # the version tag which is typically NOT on the first commit so we
        # retrieve them all.
        fetch-depth: 0

    - name: Resolve project
      id: resolve-project
      shell: pwsh
      env:
        PROJECT_NAME: ${{ inputs.project-name }}
      run: |
        Import-Module .\build\scripts\build.psm1

        # Note: inputs.project-name is either a .proj file or
        # Component[component_name]. The ResolveProject call here parses
        # inputs.project-name into variables we need for build.

        $title = '' # Used for friendly names in action UI
        $project = '' # Actual project passed to dotnet
        $component = '' # Used to tell Component.proj what to build

        ResolveProject `
          -projectNameOrComponentData ${env:PROJECT_NAME} `
          -title ([ref]$title) `
          -project ([ref]$project) `
          -component ([ref]$component)

        echo "title=$title" >> $env:GITHUB_OUTPUT
        echo "project=$project" >> $env:GITHUB_OUTPUT

        $artifactName = $component
        if ([string]::IsNullOrEmpty($artifactName)) {
          $artifactName = $title
          if ($artifactName.EndsWith(".proj")) {
            $artifactName = $artifactName.Substring(0, $artifactName.Length - 5)
          }
        }

        echo "name=$artifactName" >> $env:GITHUB_OUTPUT

        # Note: BUILD_COMPONENT envvar tells Component.proj what to build. Only
        # used if $project ends up Component.proj.
        echo "BUILD_COMPONENT=$component" >> $env:GITHUB_ENV

    - name: Setup previous .NET runtimes
      uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5.2.0
      with:
        dotnet-version: |
          8.0.x

    - name: Setup .NET
      uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5.2.0

    - name: dotnet restore ${{ steps.resolve-project.outputs.title }}
      run: dotnet restore ${env:PROJECT_PATH} -p:EnablePackageValidation=true
      shell: pwsh
      env:
        PROJECT_PATH: ${{ steps.resolve-project.outputs.project }}

    - name: dotnet build ${{ steps.resolve-project.outputs.title }}
      run: dotnet build ${env:PROJECT_PATH} --configuration Release --no-restore
      shell: pwsh
      env:
        PROJECT_PATH: ${{ steps.resolve-project.outputs.project }}

    - name: dotnet test ${{ steps.resolve-project.outputs.title }}
      if: inputs.run-tests
      shell: pwsh
      env:
        PROJECT_PATH: ${{ steps.resolve-project.outputs.project }}
        TARGET_FRAMEWORK: ${{ matrix.version }}
        TEST_FILTER: ${{ inputs.test-case-filter }}
      run: >
        ${{ inputs.test-require-elevated && matrix.os != 'windows-latest' && 'sudo -E' || '' }}
        dotnet test ${env:PROJECT_PATH}
        --collect:"Code Coverage"
        --results-directory:TestResults
        --framework ${env:TARGET_FRAMEWORK}
        --configuration Release
        --no-restore
        --no-build
        --logger:"console;verbosity=detailed"
        --logger:"GitHubActions;report-warnings=false"
        --logger:"junit;LogFilePath=TestResults/junit.xml"
        --filter "${env:TEST_FILTER}"
        -- RunConfiguration.DisableAppDomain=true
        ${{ inputs.test-require-elevated && matrix.os != 'windows-latest' && '&& sudo chmod a+rw ./TestResults' || '' }}

    - name: dotnet pack ${{ steps.resolve-project.outputs.title }}
      if: matrix.os == 'windows-latest' && inputs.pack
      run: dotnet pack ${env:PROJECT_PATH} --configuration Release --no-restore --no-build -p:EnablePackageValidation=true
      shell: pwsh
      env:
        PROJECT_PATH: ${{ steps.resolve-project.outputs.project }}

    - name: Install coverage tool
      if: inputs.run-tests
      run: dotnet tool install -g dotnet-coverage

    - name: Merging test results
      if: inputs.run-tests && hashFiles('./TestResults/**/*.coverage') != ''
      run: dotnet-coverage merge -f cobertura -o ./TestResults/Cobertura.xml ./TestResults/**/*.coverage

    - name: Upload code coverage ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }}
      if: inputs.run-tests && hashFiles('./TestResults/Cobertura.xml') != ''
      uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0
      continue-on-error: true # Note: Don't fail for upload failures
      env:
        OS: ${{ matrix.os }}
        TFM: ${{ matrix.version }}
        FILTER: ${{ inputs.test-case-filter }}
        token: ${{ secrets.CODECOV_TOKEN }}
      with:
        files: TestResults/Cobertura.xml
        env_vars: OS,TFM,FILTER
        flags: ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }}
        name: Code Coverage for ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }} on [${{ matrix.os }}.${{ matrix.version }}]
        codecov_yml_path: .github/codecov.yml

    - name: Upload test results  ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }}
      if: ${{ !cancelled() && inputs.run-tests && hashFiles('./**/TestResults/junit.xml') != '' }}
      uses: codecov/codecov-action@57e3a136b779b570ffcdbf80b3bdc90e7fab3de2 # v6.0.0
      with:
        env_vars: OS,TFM,FILTER
        flags: ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }}
        name: Test results for ${{ inputs.code-cov-prefix }}-${{ inputs.code-cov-name }} on [${{ matrix.os }}.${{ matrix.version }}]
        report_type: test_results
        token: ${{ secrets.CODECOV_TOKEN }}

    - name: Publish ${{ steps.resolve-project.outputs.name }} NuGet packages to Artifacts
      uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
      # Only publish packages from the first job, which should be net462 for Windows in most cases, which is preferred for .NET Framework support
      if: matrix.os == 'windows-latest' && inputs.pack && strategy.job-index == 0
      with:
        name: ${{ steps.resolve-project.outputs.name }}-packages
        path: ./artifacts/package/release
        if-no-files-found: error