astral-sh-uv/.github/workflows/test.yml

on:
  workflow_call:
    inputs:
      save-rust-cache:
        required: false
        type: string
        default: "true"
      test-macos:
        required: false
        type: string
        default: "false"

permissions: {}

env:
  CARGO_INCREMENTAL: 0
  CARGO_NET_RETRY: 10
  CARGO_TERM_COLOR: always
  PYTHON_VERSION: "3.12"
  RUSTUP_MAX_RETRIES: 10

jobs:
  # We use the large GitHub actions runners
  # For Ubuntu and Windows, this requires Organization-level configuration
  # See: https://docs.github.com/en/actions/using-github-hosted-runners/about-larger-runners/about-larger-runners#about-ubuntu-and-windows-larger-runners

  cargo-test-linux:
    timeout-minutes: 10
    runs-on: depot-ubuntu-24.04-16
    name: "cargo test on linux"
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - name: "Install mold"
        run: ./scripts/install-mold.sh

      - uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
        with:
          save-if: ${{ inputs.save-rust-cache == 'true' }}

      - name: "Install Rust toolchain"
        run: rustup show

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          version: "0.11.21"

      - name: "Install required Python versions"
        run: uv python install

      - name: "Install secret service"
        run: |
          echo 'Acquire::Retries "3";' | sudo tee /etc/apt/apt.conf.d/80-retries > /dev/null
          sudo apt install -y gnome-keyring

      - name: "Start gnome-keyring"
        # run gnome-keyring with 'foobar' as password for the login keyring
        # this will create a new login keyring and unlock it
        # the login password doesn't matter, but the keyring must be unlocked for the tests to work
        run: gnome-keyring-daemon --components=secrets --daemonize --unlock <<< 'foobar'

      - name: "Create btrfs filesystem"
        run: |
          sudo apt install -y btrfs-progs
          truncate -s 1G /tmp/btrfs.img
          mkfs.btrfs /tmp/btrfs.img
          sudo mkdir /btrfs
          sudo mount -o loop /tmp/btrfs.img /btrfs
          sudo chown "$(id -u):$(id -g)" /btrfs

      - name: "Create tmpfs filesystem"
        run: |
          sudo mkdir /tmpfs
          sudo mount -t tmpfs -o size=256m tmpfs /tmpfs
          sudo chown "$(id -u):$(id -g)" /tmpfs

      - name: "Create minix filesystem (low hardlink limit)"
        run: |
          truncate -s 16M /tmp/minix.img
          mkfs.minix /tmp/minix.img
          sudo mkdir /minix
          sudo mount -o loop /tmp/minix.img /minix
          sudo chown "$(id -u):$(id -g)" /minix

      - name: "Install cargo nextest"
        uses: taiki-e/install-action@0631aa6515c7d545823c67cfae7ef4fc7f490154 # v2.81.8
        with:
          tool: cargo-nextest

      - name: "Cargo test"
        env:
          # Retry more than default to reduce flakes in CI
          UV_HTTP_RETRIES: 5
          RUST_BACKTRACE: 1
          UV_INTERNAL__TEST_COW_FS: /btrfs
          UV_INTERNAL__TEST_NOCOW_FS: /tmpfs
          UV_INTERNAL__TEST_ALT_FS: /tmpfs
          UV_INTERNAL__TEST_LOWLINKS_FS: /minix
          # Write pending snapshots to a separate directory for artifact upload
          INSTA_UPDATE: new
          INSTA_PENDING_DIR: ${{ github.workspace }}/pending-snapshots
        run: |
          cargo nextest run \
            --cargo-profile fast-build \
            --features test-python-patch,native-auth,secret-service \
            --workspace \
            --profile ci-linux

      - name: "Upload pending snapshots"
        if: ${{ failure() }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: pending-snapshots-linux
          path: pending-snapshots/
          if-no-files-found: ignore
          include-hidden-files: true
          retention-days: 14

      - name: "Upload JUnit results"
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: junit-results-linux
          path: target/nextest/ci*/junit.xml
          if-no-files-found: ignore
          retention-days: 14

  cargo-test-macos:
    timeout-minutes: 20
    # Only run macOS tests on main without opt-in
    if: ${{ inputs.test-macos == 'true' }}
    runs-on: depot-macos-15
    name: "cargo test on macos"
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
        with:
          save-if: ${{ inputs.save-rust-cache == 'true' }}

      - name: "Install Rust toolchain"
        run: rustup show

      - name: "Create HFS+ disk image (no reflink support)"
        run: |
          hdiutil create -size 256m -fs HFS+ -volname NoReflink /tmp/noreflink.dmg
          hdiutil attach /tmp/noreflink.dmg
          echo "HFS_MOUNT=/Volumes/NoReflink" >> "$GITHUB_ENV"

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          version: "0.11.21"

      - name: "Install required Python versions"
        run: uv python install

      - name: "Install cargo nextest"
        uses: taiki-e/install-action@0631aa6515c7d545823c67cfae7ef4fc7f490154 # v2.81.8
        with:
          tool: cargo-nextest

      - name: "Cargo test"
        env:
          # Retry more than default to reduce flakes in CI
          UV_HTTP_RETRIES: 5
          RUST_BACKTRACE: 1
          # macOS tmpdir is on APFS which supports reflink
          UV_INTERNAL__TEST_COW_FS: ${{ runner.temp }}
          # HFS+ RAM disk does not support copy-on-write and is on a different device
          UV_INTERNAL__TEST_NOCOW_FS: ${{ env.HFS_MOUNT }}
          UV_INTERNAL__TEST_ALT_FS: ${{ env.HFS_MOUNT }}
          # Write pending snapshots to a separate directory for artifact upload
          INSTA_UPDATE: new
          INSTA_PENDING_DIR: ${{ github.workspace }}/pending-snapshots
        run: |
          cargo nextest run \
            --cargo-profile fast-build \
            --no-default-features \
            --features test-python,test-python-managed,test-pypi,test-git,test-git-lfs,performance,test-crates-io,native-auth,apple-native \
            --workspace \
            --profile ci-macos

      - name: "Upload pending snapshots"
        if: ${{ failure() }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: pending-snapshots-macos
          path: pending-snapshots/
          if-no-files-found: ignore
          include-hidden-files: true
          retention-days: 14

      - name: "Upload JUnit results"
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: junit-results-macos
          path: target/nextest/ci*/junit.xml
          if-no-files-found: ignore
          retention-days: 14

  cargo-test-windows:
    timeout-minutes: 15
    runs-on: namespace-profile-windows-2022-x86-64-16
    name: "cargo test on windows ${{ matrix.partition }} of 3"
    strategy:
      fail-fast: false
      matrix:
        partition: [1, 2, 3]
    steps:
      - uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
        with:
          persist-credentials: false

      - name: Setup Dev Drive
        run: ${{ github.workspace }}/.github/workflows/setup-dev-drive.ps1

      # actions/checkout does not let us clone into anywhere outside ${{ github.workspace }}, so we have to copy the clone...
      - name: Copy Git Repo to Dev Drive
        run: |
          Copy-Item -Path "${{ github.workspace }}" -Destination "$Env:UV_WORKSPACE" -Recurse

      - uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
        with:
          version: "0.11.21"

      - name: "Install required Python versions"
        run: uv python install

      - uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
        with:
          workspaces: ${{ env.UV_WORKSPACE }}
          # Use the same cache entry across the partitions
          add-job-id-key: false
          save-if: ${{ inputs.save-rust-cache == 'true' }}

      - name: "Install Rust toolchain"
        working-directory: ${{ env.UV_WORKSPACE }}
        run: rustup show

      - name: "Create NTFS test directory (low hardlink limit)"
        run: New-Item -Path "C:\uv" -ItemType Directory -Force

      - name: "Create SMB test share (alternative filesystem)"
        run: |
          New-Item -Path "C:\uv-smb" -ItemType Directory -Force
          New-SmbShare -Name "uv-alt-fs" -Path "C:\uv-smb" -FullAccess "Everyone"

      - name: "Install cargo nextest"
        uses: taiki-e/install-action@0631aa6515c7d545823c67cfae7ef4fc7f490154 # v2.81.8
        with:
          tool: cargo-nextest

      - name: "Cargo test"
        working-directory: ${{ env.UV_WORKSPACE }}
        env:
          # Retry more than default to reduce flakes in CI
          UV_HTTP_RETRIES: 5
          # Avoid permission errors during concurrent tests
          # See https://github.com/astral-sh/uv/issues/6940
          UV_LINK_MODE: copy
          RUST_BACKTRACE: 1
          UV_INTERNAL__TEST_ALT_FS: "\\\\localhost\\uv-alt-fs"
          UV_INTERNAL__TEST_SMB_FS: "\\\\localhost\\uv-alt-fs"
          UV_INTERNAL__TEST_LOWLINKS_FS: "C:\\uv"
          # Write pending snapshots to a separate directory for artifact upload
          INSTA_UPDATE: new
          INSTA_PENDING_DIR: ${{ github.workspace }}/pending-snapshots
        shell: bash
        run: |
          cargo nextest run \
            --cargo-profile fast-build \
            --no-default-features \
            --features test-python,test-pypi,test-python-managed,test-windows-registry,native-auth,windows-native \
            --workspace \
            --profile ci-windows \
            --partition hash:${{ matrix.partition }}/3

      - name: "Upload pending snapshots"
        if: ${{ failure() }}
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: pending-snapshots-windows-${{ matrix.partition }}
          path: pending-snapshots/
          if-no-files-found: ignore
          include-hidden-files: true
          retention-days: 14

      - name: "Upload JUnit results"
        if: always()
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: junit-results-windows-${{ matrix.partition }}
          path: ${{ env.UV_WORKSPACE }}/target/nextest/ci*/junit.xml
          if-no-files-found: ignore
          retention-days: 14