consul/.github/workflows/reusable-unit-split.yml

name: reusable-unit-split

on:
  workflow_call:
    inputs:
      directory:
        required: true
        type: string
      runs-on:
        description: An expression indicating which kind of runners to use.
        required: true
        type: string
      go-arch:
        required: false
        type: string
        default: ""
      uploaded-binary-name:
        required: false
        type: string
        default: "consul-bin" 
      args:
        required: false
        type: string
        default: ""
      runner-count: 
        required: false
        type: number
        default: 1
      go-test-flags:
        required: false
        type: string
        default: ""
      repository-name:
        required: true
        type: string
      go-tags:
        required: false
        type: string
        default: ""
      go-version:
        required: true
        type: string
    secrets:
      elevated-github-token:
        required: true
      consul-license:
        required: true
      datadog-api-key:
        required: true
env:
  TEST_RESULTS: /tmp/test-results
  GOTESTSUM_VERSION: "1.11.0"
  GOARCH: ${{inputs.go-arch}}
  TOTAL_RUNNERS: ${{inputs.runner-count}}
  CONSUL_LICENSE: ${{secrets.consul-license}}
  GOTAGS: ${{ inputs.go-tags}}
  GOPRIVATE: github.com/hashicorp # Required for enterprise deps
  DATADOG_API_KEY: ${{secrets.datadog-api-key}}
  
jobs:
  set-test-package-matrix:
    runs-on: ubuntu-latest
    outputs:
      package-matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
      - uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
        with:
          go-version: ${{ inputs.go-version }}
      - id: set-matrix
        run: ./.github/scripts/set_test_package_matrix.sh ${{env.TOTAL_RUNNERS}}

  go-test:
    runs-on: ${{ fromJSON(inputs.runs-on) }}
    name: "go-test"
    needs:
      - set-test-package-matrix
    strategy:
      fail-fast: false
      matrix:
        package: ${{ fromJson(needs.set-test-package-matrix.outputs.package-matrix) }}
    steps:   
      - name: ulimit
        run: |
          echo "Soft limits"
          ulimit -Sa
          echo "Hard limits"
          ulimit -Ha             
      # upload-artifact requires a unique ID per run. These steps will be repeated with the matrix run, and other unit tests
      # will also overlap with the names here. We use a random string rather than trying to do trickery 
      # with the package matrix.
      - id: generate-matrix-id
        run: |
          MATRIX_RUN_ID=$(head /dev/urandom | tr -dc A-Z | head -c8)
          echo "The matrix run ID is $MATRIX_RUN_ID"
          echo "matrix-run-id=$MATRIX_RUN_ID" >> "$GITHUB_OUTPUT"          
      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
      # NOTE: This step is specifically needed for ENT. It allows us to access the required private HashiCorp repos.
      - name: Setup Git
        if: ${{ endsWith(inputs.repository-name, '-enterprise') }}
        run: git config --global url."https://${{ secrets.elevated-github-token }}:@github.com".insteadOf "https://github.com"
      - uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
        with:
          go-version: ${{ inputs.go-version }}
      - run: mkdir -p ${{env.TEST_RESULTS}}
      - name: go mod download
        working-directory: ${{inputs.directory}}
        run: go mod download
      - name: Download consul
        uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
        with:
          name: ${{inputs.uploaded-binary-name}}
          path: ${{inputs.directory}} 
      - name: Display downloaded file
        run: ls -ld consul 
        working-directory: ${{inputs.directory}}
      - run: echo "$GITHUB_WORKSPACE/${{inputs.directory}}" >> $GITHUB_PATH
      - name: Make sure consul is executable
        run: chmod +x $GITHUB_WORKSPACE/${{inputs.directory}}/consul
      - run: go env
      - name: Run tests 
        working-directory: ${{inputs.directory}}
        run: |
          # separate the list
          PACKAGE_NAMES="${{ join(matrix.package, ' ') }}"
          # PACKAGE_NAMES="${{ matrix.package }}"

          # some tests expect this umask, and arm images have a different default
          umask 0022

          go run gotest.tools/gotestsum@v${{env.GOTESTSUM_VERSION}} \
          --format=github-actions \
          --format-hide-empty-pkg \
          --jsonfile /tmp/jsonfile/go-test.log \
          --rerun-fails \
          --rerun-fails-report=/tmp/gotestsum-rerun-fails \
          --packages="$PACKAGE_NAMES" \
          --junitfile ${{env.TEST_RESULTS}}/gotestsum-report.xml -- \
          -tags="${{env.GOTAGS}}" \
          ${{inputs.go-test-flags}} \
          -cover -coverprofile=coverage.txt \
          -timeout=30m          

      # NOTE: ENT specific step as we store secrets in Vault.
      - name: Authenticate to Vault
        if: ${{ !cancelled() && endsWith(github.repository, '-enterprise') }}
        id: vault-auth
        run: vault-auth

      # NOTE: ENT specific step as we store secrets in Vault.
      - name: Fetch Secrets
        if: ${{ !cancelled() && endsWith(github.repository, '-enterprise') }}
        id: secrets
        uses: hashicorp/vault-action@v3
        with:
          url: ${{ steps.vault-auth.outputs.addr }}
          caCertificate: ${{ steps.vault-auth.outputs.ca_certificate }}
          token: ${{ steps.vault-auth.outputs.token }}
          secrets: |
              kv/data/github/${{ github.repository }}/datadog apikey | DATADOG_API_KEY;              

      - name: prepare datadog-ci
        if: ${{ !cancelled() && !endsWith(github.repository, '-enterprise') }}
        run: |
          curl -L --fail "https://github.com/DataDog/datadog-ci/releases/latest/download/datadog-ci_linux-x64" --output "/usr/local/bin/datadog-ci"
          chmod +x /usr/local/bin/datadog-ci          

      - name: upload coverage
        # do not run on forks
        if: ${{ !cancelled() && env.DATADOG_API_KEY}}
        env:
          DD_ENV: ci
        run: datadog-ci junit upload --service "$GITHUB_REPOSITORY" ${{env.TEST_RESULTS}}/gotestsum-report.xml

      - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
        if: ${{ !cancelled() }}
        with:
          name: ${{ steps.generate-matrix-id.outputs.matrix-run-id }}-test-results
          path: ${{env.TEST_RESULTS}}
      - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
        if: ${{ !cancelled() }}
        with:
          name: ${{ steps.generate-matrix-id.outputs.matrix-run-id }}-jsonfile
          path: /tmp/jsonfile
      - name: "Re-run fails report"
        if: ${{ !cancelled() }}
        run: |
          .github/scripts/rerun_fails_report.sh /tmp/gotestsum-rerun-fails