test.yml

name: Reusable Test Workflow

on:
    workflow_call:
        inputs:
            profile:
                required: true
                type: string
                description: "Test profile. See profiles.json for available profiles."
            package-version:
                required: false
                type: string
                description: >-
                    NuGet package version to test against (e.g. "1.0.0").
                    When set, project references are replaced with this package version.
                    When absent, tests run against source (default for CI and FMT).
                    Required when package-artifact-name is set.
            package-artifact-name:
                required: false
                type: string
                description: >-
                    Name of a workflow artifact containing the .nupkg file.
                    Used for CD dry-run testing when the package has not been published to nuget.org.
                    When set, the artifact is downloaded and registered as a local NuGet source.
                    Requires package-version to also be set.

env:
    CARGO_TERM_COLOR: always
    GLIDE_VERSION: ${{ inputs.package-version || 'unknown' }}

jobs:
    load-matrix:
        runs-on: ubuntu-latest
        outputs:
            host-matrix: ${{ steps.load.outputs.host-matrix }}
            container-host-matrix: ${{ steps.load.outputs.container-host-matrix }}
            server-matrix: ${{ steps.load.outputs.server-matrix }}
            dotnet-matrix: ${{ steps.load.outputs.dotnet-matrix }}
        steps:
            - name: Validate inputs
              shell: bash
              env:
                  PACKAGE_ARTIFACT_NAME: ${{ inputs.package-artifact-name }}
                  PACKAGE_VERSION: ${{ inputs.package-version }}
              run: |
                  if [[ -n "$PACKAGE_ARTIFACT_NAME" && -z "$PACKAGE_VERSION" ]]; then
                      echo "ERROR: package-artifact-name requires package-version to also be set"
                      exit 1
                  fi

            - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  sparse-checkout: .github/json_matrices

            - name: Load and filter matrices
              id: load
              working-directory: .github/json_matrices
              env:
                  PROFILE: ${{ inputs.profile }}
              run: python3 load_matrices.py "$PROFILE"

    test-with-runners:
        name: net${{ matrix.dotnet }}, ${{ matrix.server.type }} ${{ matrix.server.version }}, ${{ matrix.host.target }}
        needs: load-matrix
        timeout-minutes: 100
        strategy:
            fail-fast: false
            matrix:
                dotnet: ${{ fromJson(needs.load-matrix.outputs.dotnet-matrix) }}
                server: ${{ fromJson(needs.load-matrix.outputs.server-matrix) }}
                host: ${{ fromJson(needs.load-matrix.outputs.host-matrix) }}
        runs-on: ${{ matrix.host.runner }}
        env:
            VALKEY_GLIDE_DNS_TESTS_ENABLED: "1"

        steps:
            - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  submodules: true

            - name: Determine whether to run with coverage
              shell: bash
              run: |
                  SERVER_TYPE=$(jq -r '.server_type' dev/coverage/coverage-baseline.json)
                  SERVER_VERSION=$(jq -r '.server_version' dev/coverage/coverage-baseline.json)

                  RUN_COVERAGE=false
                  if [[ "${{ matrix.dotnet }}" == "8.0" \
                     && "${{ matrix.server.type }}" == "$SERVER_TYPE" \
                     && "${{ matrix.server.version }}" == "$SERVER_VERSION" \
                     && "${{ matrix.host.runner }}" == "ubuntu-24.04" ]]; then
                      RUN_COVERAGE=true
                  fi

                  echo "RUN_COVERAGE=$RUN_COVERAGE" >> "$GITHUB_ENV"

            - name: Output matrix parameters
              env:
                  MATRIX_JSON: ${{ toJson(matrix) }}
                  PROFILE: ${{ inputs.profile }}
                  PACKAGE_VERSION: ${{ inputs.package-version || 'source' }}
              run: |
                  echo "Job running with the following matrix configuration:"
                  echo "$MATRIX_JSON"
                  echo "Profile: $PROFILE"
                  echo "Package version: $PACKAGE_VERSION"

            - name: Set up dotnet ${{ matrix.dotnet }}
              uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5.2.0
              with:
                  # .NET 10 SDK to build project
                  # matrix.dotnet SDK for test execution
                  dotnet-version: |
                      10
                      ${{ matrix.dotnet }}
              env:
                  DOTNET_INSTALL_DIR: ~/.dotnet

            - name: Download package artifact
              if: ${{ inputs.package-artifact-name != '' }}
              uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
              with:
                  name: ${{ inputs.package-artifact-name }}
                  path: nuget.local

            - name: Set up local NuGet source
              if: ${{ inputs.package-artifact-name != '' }}
              shell: bash
              run: |
                  ls -l "$GITHUB_WORKSPACE/nuget.local"
                  dotnet nuget add source "$GITHUB_WORKSPACE/nuget.local"
                  dotnet nuget config paths

            - name: Patch project references to NuGet package
              if: ${{ inputs.package-version != '' }}
              shell: bash
              env:
                  PACKAGE_VERSION: ${{ inputs.package-version }}
              run: |
                  dotnet remove tests/Valkey.Glide.TestUtils reference sources/Valkey.Glide/Valkey.Glide.csproj
                  dotnet remove tests/Valkey.Glide.IntegrationTests reference sources/Valkey.Glide/Valkey.Glide.csproj
                  dotnet add tests/Valkey.Glide.TestUtils package Valkey.Glide --version "$PACKAGE_VERSION"
                  dotnet add tests/Valkey.Glide.IntegrationTests package Valkey.Glide --version "$PACKAGE_VERSION"
                  git diff

            - name: Install shared software dependencies
              uses: ./.github/actions/install-shared-dependencies
              with:
                  os: ${{ matrix.host.os }}
                  target: ${{ matrix.host.target }}
                  server-version: ${{ matrix.server.version }}

            - uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
              if: ${{ inputs.package-version == '' }}
              with:
                  path: rust/target
                  key: rust-${{ matrix.host.target }}

            - name: Install Task
              uses: go-task/setup-task@3be4020d41929789a01026e0e427a4321ce0ad44 # v2.0.0

            - name: Unit tests - dotnet ${{ matrix.dotnet }}
              run: >-
                  task test:unit
                  configuration=Debug
                  verbosity=detailed
                  ${{ env.RUN_COVERAGE == 'true' && 'coverage=true' || '' }}

            - name: Configure DNS for integration tests
              if: ${{ matrix.host.target != 'aarch64-pc-windows-msvc' }}
              shell: bash
              run: |
                  ENTRIES="127.0.0.1 valkey.glide.test.tls.com
                  127.0.0.1 valkey.glide.test.no_tls.com
                  ::1 valkey.glide.test.tls.com
                  ::1 valkey.glide.test.no_tls.com"
                  if [[ "${{ runner.os }}" == "Windows" ]]; then
                      echo "$ENTRIES" >> /c/Windows/System32/drivers/etc/hosts
                  else
                      echo "$ENTRIES" | sudo tee -a /etc/hosts
                  fi

            - name: Integration tests - dotnet ${{ matrix.dotnet }}
              if: ${{ matrix.host.target != 'aarch64-pc-windows-msvc' }}
              env:
                  AWS_ACCESS_KEY_ID: test_secret_key
                  AWS_SECRET_ACCESS_KEY: test_access_key
                  AWS_SESSION_TOKEN: test_session_token
              run: >-
                  task test:integration
                  configuration=Debug
                  verbosity=detailed
                  ${{ env.RUN_COVERAGE == 'true' && 'coverage=true' || '' }}

            - name: Generate coverage reports and check baseline
              if: ${{ env.RUN_COVERAGE == 'true' }}
              shell: bash
              run: |
                  task coverage:install
                  task coverage:report
                  task coverage:check

    test-with-containers:
        name: net${{ matrix.dotnet }}, ${{ matrix.server.type }} ${{ matrix.server.version }}, ${{ matrix.host.image }}
        needs: load-matrix
        if: ${{ needs.load-matrix.outputs.container-host-matrix != '[]' }}
        timeout-minutes: 100
        strategy:
            fail-fast: false
            matrix:
                dotnet: ${{ fromJson(needs.load-matrix.outputs.dotnet-matrix) }}
                server: ${{ fromJson(needs.load-matrix.outputs.server-matrix) }}
                host: ${{ fromJson(needs.load-matrix.outputs.container-host-matrix) }}
        runs-on: ${{ matrix.host.runner }}
        container:
            image: ${{ matrix.host.image }}
        env:
            VALKEY_GLIDE_DNS_TESTS_ENABLED: "1"

        steps:
            - name: Install container prerequisites
              run: |
                  yum update -y
                  yum install -y git tar findutils libicu

            - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  submodules: true

            - name: Output matrix parameters
              env:
                  MATRIX_JSON: ${{ toJson(matrix) }}
                  PROFILE: ${{ inputs.profile }}
                  PACKAGE_VERSION: ${{ inputs.package-version || 'source' }}
              run: |
                  echo "Job running with the following matrix configuration:"
                  echo "$MATRIX_JSON"
                  echo "Profile: $PROFILE"
                  echo "Package version: $PACKAGE_VERSION"

            - name: Set up dotnet ${{ matrix.dotnet }}
              uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5.2.0
              with:
                  # .NET 10 SDK to build project
                  # matrix.dotnet SDK for test execution
                  dotnet-version: |
                      10
                      ${{ matrix.dotnet }}

            - name: Install shared software dependencies
              uses: ./.github/actions/install-shared-dependencies
              with:
                  os: ${{ matrix.host.os }}
                  target: ${{ matrix.host.target }}
                  server-version: ${{ matrix.server.version }}

            - name: Configure DNS for tests
              shell: bash
              run: |
                  ENTRIES="127.0.0.1 valkey.glide.test.tls.com
                  127.0.0.1 valkey.glide.test.no_tls.com
                  ::1 valkey.glide.test.tls.com
                  ::1 valkey.glide.test.no_tls.com"
                  echo "$ENTRIES" | tee -a /etc/hosts

            - uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
              with:
                  path: rust/target
                  key: rust-${{ matrix.host.image }}

            - name: Install Task
              uses: go-task/setup-task@3be4020d41929789a01026e0e427a4321ce0ad44 # v2.0.0

            - name: Test dotnet ${{ matrix.dotnet }}
              run: task test verbosity=detailed

    # See: https://github.com/valkey-io/valkey-glide-csharp/issues/390
    test-modules:
        name: Module tests (Docker, net${{ matrix.dotnet }})
        needs: load-matrix
        runs-on: ubuntu-24.04
        timeout-minutes: 30
        strategy:
            fail-fast: false
            matrix:
                dotnet: ${{ fromJson(needs.load-matrix.outputs.dotnet-matrix) }}
        steps:
            - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
              with:
                  submodules: true

            - name: Set up dotnet ${{ matrix.dotnet }}
              uses: actions/setup-dotnet@c2fa09f4bde5ebb9d1777cf28262a3eb3db3ced7 # v5.2.0
              with:
                  # .NET 10 SDK to build project
                  # matrix.dotnet SDK for test execution
                  dotnet-version: |
                      10
                      ${{ matrix.dotnet }}
              env:
                  DOTNET_INSTALL_DIR: ~/.dotnet

            - name: Install shared software dependencies
              uses: ./.github/actions/install-shared-dependencies
              with:
                  os: ubuntu
                  target: x86_64-unknown-linux-gnu
                  server-version: "9.0"

            - uses: actions/cache@27d5ce7f107fe9357f9df03efb73ab90386fccae # v5.0.5
              with:
                  path: rust/target
                  key: rust-x86_64-unknown-linux-gnu

            - name: Install Task
              uses: go-task/setup-task@3be4020d41929789a01026e0e427a4321ce0ad44 # v2.0.0

            - name: Run module tests against Docker servers
              run: >-
                  task test:integration
                  filter=ServerModules
                  verbosity=detailed