dotnetCi.yml

name: .NET CI

on:
  push:
    branches: [ "master" ]
  pull_request:
    branches: [ "master" ]

jobs:

  # Summary:
  #
  # * Installs and configures the environment
  # * Builds the solution with SonarScanner analysis
  #   * In Debug configuration
  # * Runs all .NET and JS tests
  #   * In Debug configuration (.NET tests)
  #   * Producing code coverage reports, consumed by SonarScanner
  #   * WebDriver-based tests use a locally-running Chrome browser ONLY
  # * Packages test results as build artifacts
  # * Builds & packs the solution in Release configuration
  # * Uploads the Release config packages as build artifacts

  build_test_and_pack:
    name: Build, test & package
    runs-on: ubuntu-24.04
    timeout-minutes: 30

    env:
      RunNumber: ${{ github.run_number }}.${{ github.run_attempt }}
      VersionSuffix: ci.${{ github.run_number }}
      SonarCloudProject: csf-dev_CSF.Screenplay
      SonarCloudUsername: craigfowler-github
      SonarCloudUrl: https://sonarcloud.io
      Configuration: Debug
      Tfm: net8.0
      DotnetVersion: 8.0.x
      SonarCloudSecretKey: ${{ secrets.SONARCLOUDKEY }}
      BranchName: ${{ github.event_name == 'pull_request' && github.base_ref || github.ref_name }}
      BranchParam: ${{ github.event_name == 'pull_request' && 'sonar.pullrequest.branch' || 'sonar.branch.name' }}
      PullRequestParam: ${{ github.event_name == 'pull_request' && format('/d:sonar.pullrequest.key={0}', github.event.number) || '' }}
      DISPLAY: :99
      # Change selected factory to VerboseChrome to debug Chrome-related issues
      WebDriverFactory__SelectedConfiguration: CiHeadlessChrome
    
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          lfs: true

      # Install build dependencies

      - name: Add .NET global tools location to PATH
        run: echo "$HOME/.dotnet/tools" >> "$GITHUB_PATH"
      - name: Install .NET
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: ${{ env.DotnetVersion }}
      - name: Install SonarScanner
        run: dotnet tool install --global dotnet-sonarscanner
      - name: Install Coverlet console
        run: dotnet tool install --global coverlet.console
      - name: Install DocFX
        run: dotnet tool install --global docfx
      - name: Install Node.js for building JSON-to-HTML report converter
        uses: actions/setup-node@v6.2.0
      - name: Install Java JDK for SonarScanner
        uses: actions/setup-java@v5.1.0
        with:
          java-version: 21
          distribution: 'zulu'
      # See https://chromium.googlesource.com/chromium/src/+/main/docs/security/apparmor-userns-restrictions.md
      - name: Disable AppArmor restrictions so Chrome may run
        run: echo 0 | sudo tee /proc/sys/kernel/apparmor_restrict_unprivileged_userns
      - name: Start an Xvfb display so Chrome may run
        run: Xvfb -ac $DISPLAY -screen 0 1280x1024x16 &        

      # Environment setup pre-build

      - name: Setup Selenium Manager config
        run: |
          mkdir ~/.cache/selenium
          cp Tools/se-config.toml ~/.cache/selenium
      - name: Restore .NET packages
        run: dotnet restore
      - name: Restore Node modules
        run: |
          cd CSF.Screenplay.JsonToHtmlReport.Template/src
          npm ci
          cd ../..

      # Build and test the solution

      - name: Start SonarScanner
        run: >
          dotnet sonarscanner begin
          /k:${{ env.SonarCloudProject }}
          /v:GitHub_build_${{ env.RunNumber }}
          /o:${{ env.SonarCloudUsername }}
          /d:sonar.host.url=${{ env.SonarCloudUrl }}
          /d:sonar.token=${{ env.SonarCloudSecretKey }}
          /d:${{ env.BranchParam }}=${{ env.BranchName }} ${{ env.PullRequestParam }}
          /d:sonar.javascript.lcov.reportPaths=$PWD/CSF.Screenplay.JsonToHtmlReport.Template/src/TestResults/lcov.info
          /s:$PWD/.sonarqube-analysisproperties.xml
      - name: Build the solution
        run: dotnet build -c ${{ env.Configuration }} --no-incremental
      - name: Run .NET tests with coverage
        id: dotnet_tests
        shell: bash {0}
        run: |
          for proj in Tests/*.Tests
          do
            projNameArray=(${proj//// })
            projName=${projNameArray[1]}
            assemblyPath=$proj/bin/$Configuration/$Tfm/$projName.dll
            coverlet "$assemblyPath" --target "dotnet" --targetargs "test $proj -c $Configuration --no-build --logger:nunit --test-adapter-path:." -f=opencover -o="TestResults/$projName.opencover.xml"
            exitCode=$?
            if [ $exitCode -ne 0 ]
            then
              echo "One or more tests have failed; this build should eventually fail"
              echo "failures=true" >> "$GITHUB_OUTPUT"
            fi
          done
      - name: Run JavaScript tests with coverage
        id: js_tests
        shell: bash {0}
        run: |
          cd CSF.Screenplay.JsonToHtmlReport.Template/src
          npm test
          exitCode=$?
          if [ $exitCode -ne 0 ]
          then
            echo "One or more tests have failed; this build should eventually fail"
            echo "failures=true" >> "$GITHUB_OUTPUT"
          fi
          cd ../..

      # Post-test tasks (artifacts, overall status)

      - name: Stop SonarScanner
        run:
          dotnet sonarscanner end /d:sonar.token=${{ env.SonarCloudSecretKey }}
      - name: Gracefully stop Xvfb
        run: killall Xvfb
        continue-on-error: true
      - name: Upload .NET test results artifacts
        uses: actions/upload-artifact@v4
        with:
          name: NUnit test results
          path: Tests/*.Tests/**/TestResults.xml
      # This step won't produce any artifacts if the verbose factory isn't
      # selected via appsettings.json in CSF.Screenplay.Selenium.Tests, but that's OK
      - name: Upload verbose webdriver log artifacts
        uses: actions/upload-artifact@v4
        with:
          name: Verbose webdriver logs
          path: '**/chrome-verbose-log.txt'
      - name: Upload JS test results artifacts
        uses: actions/upload-artifact@v4
        with:
          name: Jest test results
          path: CSF.Screenplay.JsonToHtmlReport.Template/src/TestResults/**/*
      - name: Upload Screenplay JSON report artifact
        uses: actions/upload-artifact@v4
        with:
          name: Screenplay JSON reports
          path: Tests/**/ScreenplayReport.json
      - name: Convert Screenplay reports to HTML
        continue-on-error: true
        run: |
          for report in $(find Tests/ -type f -name "ScreenplayReport.json")
          do
            reportDir=$(dirname "$report")
            outputFile="$reportDir/ScreenplayReport.html"
            dotnet run --no-build --framework $Tfm -c ${{ env.Configuration }} --project CSF.Screenplay.JsonToHtmlReport --ReportPath "$report" --OutputPath "$outputFile"
          done
      - name: Upload Screenplay HTML report artifact
        uses: actions/upload-artifact@v4
        with:
          name: Screenplay HTML reports
          path: Tests/**/ScreenplayReport.html
      - name: Fail the build if any test failures
        if: steps.dotnet_tests.outputs.failures == 'true' || steps.js_tests.outputs.failures == 'true'
        run: |
          echo "Failing the build due to test failures"
          exit 1

      # Build the apps in release mode and publish artifacts

      - name: Clean the solution ahead of building in release config
        run: dotnet clean
      - name: Build, in release configuration
        run: dotnet pack -p:VersionSuffix=$VersionSuffix -o packages
      - name: Upload build result artifacts
        uses: actions/upload-artifact@v4
        with:
          name: Build results (NuGet)
          path: packages/*.nupkg
      - name: Build docs website
        run: dotnet build -c Docs
      - name: Upload docs website artifact
        uses: actions/upload-artifact@v4
        with:
          name: Docs website
          path: docs/**/*