macos_tests.yml

name: macOS tests

on:
  workflow_call:
    inputs:
      xcode_15_4_enabled:
        type: boolean
        description: "⚠️ Jobs with this version of Xcode are deprecated."
        default: false
      xcode_15_4_test_arguments_override:
        type: string
        description: "⚠️ Deprecated."
        default: ""
      xcode_16_0_enabled:
        type: boolean
        description: "Boolean to enable the Xcode version 16.0 jobs. Defaults to false."
        default: false
      xcode_16_0_build_arguments_override:
        type: string
        description: "The arguments passed to swift build in the macOS 5.10 Swift version matrix job."
        default: ""
      xcode_16_0_test_arguments_override:
        type: string
        description: "The arguments passed to swift test in the macOS 5.10 Swift version matrix job."
        default: ""
      xcode_16_0_setup_command:
        type: string
        description: "The command(s) to be executed before all other work."
        default: ""
      xcode_16_1_enabled:
        type: boolean
        description: "Boolean to enable the Xcode version 16.1 jobs. Defaults to false."
        default: false
      xcode_16_1_build_arguments_override:
        type: string
        description: "The arguments passed to swift build in the Xcode version 16.1 job."
        default: ""
      xcode_16_1_test_arguments_override:
        type: string
        description: "The arguments passed to swift test in the Xcode version 16.1 job."
        default: ""
      xcode_16_1_setup_command:
        type: string
        description: "The command(s) to be executed before all other work."
        default: ""
      xcode_16_2_enabled:
        type: boolean
        description: "Boolean to enable the Xcode version 16.2 jobs. Defaults to true."
        default: true
      xcode_16_2_build_arguments_override:
        type: string
        description: "The arguments passed to swift build in the Xcode version 16.2 job."
        default: ""
      xcode_16_2_test_arguments_override:
        type: string
        description: "The arguments passed to swift test in the Xcode version 16.2 job."
        default: ""
      xcode_16_2_setup_command:
        type: string
        description: "The command(s) to be executed before all other work."
        default: ""
      xcode_16_3_enabled:
        type: boolean
        description: "Boolean to enable the Xcode version 16.3 jobs. Defaults to true."
        default: true
      xcode_16_3_build_arguments_override:
        type: string
        description: "The arguments passed to swift build in the Xcode version 16.3 job."
        default: ""
      xcode_16_3_test_arguments_override:
        type: string
        description: "The arguments passed to swift test in the Xcode version 16.3 job."
        default: ""
      xcode_16_3_setup_command:
        type: string
        description: "The command(s) to be executed before all other work."
        default: ""
      xcode_26_beta_enabled:
        type: boolean
        description: "⚠️ Deprecated."
        default: false
      xcode_26_beta_1_build_arguments_override:
        type: string
        description: "⚠️ Deprecated."
        default: ""
      xcode_26_beta_1_test_arguments_override:
        type: string
        description: "⚠️ Deprecated."
        default: ""
      xcode_26_beta_1_setup_command:
        type: string
        description: "⚠️ Deprecated."
        default: ""
      xcode_latest_beta_enabled:
        type: boolean
        description: "Boolean to enable the Xcode beta jobs (uses latest beta if one currently exists). Defaults to true."
        default: true
      xcode_latest_beta_build_arguments_override:
        type: string
        description: "The arguments passed to swift build in the Xcode beta job."
        default: ""
      xcode_latest_beta_test_arguments_override:
        type: string
        description: "The arguments passed to swift test in the Xcode beta job."
        default: ""
      xcode_latest_beta_setup_command:
        type: string
        description: "The command(s) to be executed before all other work."
        default: ""

      build_scheme:
        type: string
        description: "The build scheme used in the Xcode builds."
      swift_test_enabled:
        type: boolean
        description: "Boolean to enable test execution with `swift test`. Defaults to true."
        default: true
      macos_xcode_build_enabled:
        type: boolean
        description: "Boolean to enable the Xcode build targeting macOS. Defaults to true."
        default: true
      macos_xcode_test_enabled:
        type: boolean
        description: "Boolean to enable the Xcode test targeting macOS. Defaults to false."
        default: false
      ios_xcode_build_enabled:
        type: boolean
        description: "Boolean to enable the Xcode build targeting iOS. Defaults to true."
        default: true
      ios_xcode_test_enabled:
        type: boolean
        description: "Boolean to enable the Xcode test targeting iOS. Defaults to false."
        default: false
      watchos_xcode_build_enabled:
        type: boolean
        description: "Boolean to enable the Xcode build targeting watchOS. Defaults to true."
        default: true
      watchos_xcode_test_enabled:
        type: boolean
        description: "Boolean to enable the Xcode test targeting watchOS. Defaults to false."
        default: false
      tvos_xcode_build_enabled:
        type: boolean
        description: "Boolean to enable the Xcode build targeting tvOS. Defaults to true."
        default: true
      tvos_xcode_test_enabled:
        type: boolean
        description: "Boolean to enable the Xcode test targeting tvOS. Defaults to false."
        default: false
      visionos_xcode_build_enabled:
        type: boolean
        description: "Boolean to enable the Xcode build targeting visionOS. Defaults to true."
        default: true
      visionos_xcode_test_enabled:
        type: boolean
        description: "Boolean to enable the Xcode test targeting visionOS. Defaults to false."
        default: false

      runner_pool:
        type: string
        description: "The runner pool which will be requested."
        default: "nightly"

jobs:
  construct-matrix:
    name: Construct Darwin matrix
    runs-on: ubuntu-latest
    outputs:
      darwin-matrix: '${{ steps.generate-matrix.outputs.darwin-matrix }}'
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - id: generate-matrix
        run: |
          cat >> "$GITHUB_OUTPUT" << EOM
          darwin-matrix=$(
            runner_pool="${MATRIX_RUNNER_POOL:="nightly"}"
            xcode_15_4_enabled="${MATRIX_MACOS_15_4_ENABLED:=true}"
            xcode_15_4_build_arguments_override="${MATRIX_MACOS_15_4_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_15_4_test_arguments_override="${MATRIX_MACOS_15_4_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_15_4_setup_command="${MATRIX_MACOS_15_4_SETUP_COMMAND:=""}"
            xcode_16_0_enabled="${MATRIX_MACOS_16_0_ENABLED:=true}"
            xcode_16_0_build_arguments_override="${MATRIX_MACOS_16_0_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_0_test_arguments_override="${MATRIX_MACOS_16_0_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_0_setup_command="${MATRIX_MACOS_16_0_SETUP_COMMAND:=""}"
            xcode_16_1_enabled="${MATRIX_MACOS_16_1_ENABLED:=true}"
            xcode_16_1_build_arguments_override="${MATRIX_MACOS_16_1_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_1_test_arguments_override="${MATRIX_MACOS_16_1_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_1_setup_command="${MATRIX_MACOS_16_1_SETUP_COMMAND:=""}"
            xcode_16_2_enabled="${MATRIX_MACOS_16_2_ENABLED:=true}"
            xcode_16_2_build_arguments_override="${MATRIX_MACOS_16_2_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_2_test_arguments_override="${MATRIX_MACOS_16_2_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_2_setup_command="${MATRIX_MACOS_16_2_SETUP_COMMAND:=""}"
            xcode_16_3_enabled="${MATRIX_MACOS_16_3_ENABLED:=true}"
            xcode_16_3_build_arguments_override="${MATRIX_MACOS_16_3_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_3_test_arguments_override="${MATRIX_MACOS_16_3_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_16_3_setup_command="${MATRIX_MACOS_16_3_SETUP_COMMAND:=""}"
            xcode_latest_beta_enabled="${MATRIX_MACOS_26_BETA_1_ENABLED:=true}" # TODO: remove once no repos use this
            xcode_latest_beta_build_arguments_override="${MATRIX_MACOS_26_BETA_1_BUILD_ARGUMENTS_OVERRIDE:=""}" # TODO: remove once no repos use this
            xcode_latest_beta_test_arguments_override="${MATRIX_MACOS_26_BETA_1_TEST_ARGUMENTS_OVERRIDE:=""}" # TODO: remove once no repos use this
            xcode_latest_beta_setup_command="${MATRIX_MACOS_26_BETA_1_SETUP_COMMAND:=""}" # TODO: remove once no repos use this
            xcode_latest_beta_enabled="${MATRIX_MACOS_LATEST_BETA_ENABLED:=true}"
            xcode_latest_beta_build_arguments_override="${MATRIX_MACOS_LATEST_BETA_BUILD_ARGUMENTS_OVERRIDE:=""}"
            xcode_latest_beta_test_arguments_override="${MATRIX_MACOS_LATEST_BETA_TEST_ARGUMENTS_OVERRIDE:=""}"
            xcode_latest_beta_setup_command="${MATRIX_MACOS_LATEST_BETA_SETUP_COMMAND:=""}"

            # Create matrix from inputs
            matrix='{"config": []}'

            if [[ "$xcode_15_4_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_15_4_setup_command"  \
                --arg build_arguments_override "$xcode_15_4_build_arguments_override"  \
                --arg test_arguments_override "$xcode_15_4_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode 15.4", "xcode_version": "15.4", "xcode_app": "Xcode_15.4.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            if [[ "$xcode_16_0_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_16_0_setup_command"  \
                --arg build_arguments_override "$xcode_16_0_build_arguments_override"  \
                --arg test_arguments_override "$xcode_16_0_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode 16.0", "xcode_version": "16.0", "xcode_app": "Xcode_16.0.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            if [[ "$xcode_16_1_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_16_1_setup_command"  \
                --arg build_arguments_override "$xcode_16_1_build_arguments_override"  \
                --arg test_arguments_override "$xcode_16_1_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode 16.1", "xcode_version": "16.1", "xcode_app": "Xcode_16.1.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            if [[ "$xcode_16_2_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_16_2_setup_command"  \
                --arg build_arguments_override "$xcode_16_2_build_arguments_override"  \
                --arg test_arguments_override "$xcode_16_2_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode 16.2", "xcode_version": "16.2", "xcode_app": "Xcode_16.2.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            if [[ "$xcode_16_3_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_16_3_setup_command"  \
                --arg build_arguments_override "$xcode_16_3_build_arguments_override"  \
                --arg test_arguments_override "$xcode_16_3_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode 16.3", "xcode_version": "16.3", "xcode_app": "Xcode_16.3.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            if [[ "$xcode_latest_beta_enabled" == "true" ]]; then
                matrix=$(echo "$matrix" | jq -c \
                --arg setup_command "$xcode_latest_beta_setup_command"  \
                --arg build_arguments_override "$xcode_latest_beta_build_arguments_override"  \
                --arg test_arguments_override "$xcode_latest_beta_test_arguments_override"  \
                --arg runner_pool "$runner_pool"  \
                '.config[.config| length] |= . + { "name": "Xcode latest beta", "xcode_version": "latest beta", "xcode_app": "Xcode-latest.app", "setup_command": $setup_command, "build_arguments_override": $build_arguments_override, "test_arguments_override": $test_arguments_override, "os": "sequoia", "arch": "ARM64", "pool": $runner_pool }')
            fi

            echo "$matrix" | jq -c
          )"
          EOM
        env:
          MATRIX_RUNNER_POOL: ${{ inputs.runner_pool }}
          MATRIX_MACOS_15_4_ENABLED: ${{ inputs.xcode_15_4_enabled }}
          MATRIX_MACOS_15_4_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_15_4_build_arguments_override }}
          MATRIX_MACOS_15_4_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_15_4_test_arguments_override }}
          MATRIX_MACOS_15_4_SETUP_COMMAND: ${{ inputs.xcode_15_4_setup_command }}
          MATRIX_MACOS_16_0_ENABLED: ${{ inputs.xcode_16_0_enabled }}
          MATRIX_MACOS_16_0_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_0_build_arguments_override }}
          MATRIX_MACOS_16_0_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_0_test_arguments_override }}
          MATRIX_MACOS_16_0_SETUP_COMMAND: ${{ inputs.xcode_16_0_setup_command }}
          MATRIX_MACOS_16_1_ENABLED: ${{ inputs.xcode_16_1_enabled }}
          MATRIX_MACOS_16_1_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_1_build_arguments_override }}
          MATRIX_MACOS_16_1_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_1_test_arguments_override }}
          MATRIX_MACOS_16_1_SETUP_COMMAND: ${{ inputs.xcode_16_1_setup_command }}
          MATRIX_MACOS_16_2_ENABLED: ${{ inputs.xcode_16_2_enabled }}
          MATRIX_MACOS_16_2_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_2_build_arguments_override }}
          MATRIX_MACOS_16_2_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_2_test_arguments_override }}
          MATRIX_MACOS_16_2_SETUP_COMMAND: ${{ inputs.xcode_16_2_setup_command }}
          MATRIX_MACOS_16_3_ENABLED: ${{ inputs.xcode_16_3_enabled }}
          MATRIX_MACOS_16_3_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_3_build_arguments_override }}
          MATRIX_MACOS_16_3_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_16_3_test_arguments_override }}
          MATRIX_MACOS_16_3_SETUP_COMMAND: ${{ inputs.xcode_16_3_setup_command }}
          MATRIX_MACOS_26_BETA_1_ENABLED: ${{ inputs.xcode_26_beta_1_enabled }}
          MATRIX_MACOS_26_BETA_1_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_26_beta_1_build_arguments_override }}
          MATRIX_MACOS_26_BETA_1_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_26_beta_1_test_arguments_override }}
          MATRIX_MACOS_26_BETA_1_SETUP_COMMAND: ${{ inputs.xcode_26_beta_1_setup_command }}
          MATRIX_MACOS_LATEST_BETA_ENABLED: ${{ inputs.xcode_latest_beta_enabled }}
          MATRIX_MACOS_LATEST_BETA_BUILD_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_latest_beta_build_arguments_override }}
          MATRIX_MACOS_LATEST_BETA_TEST_ARGUMENTS_OVERRIDE: ${{ inputs.xcode_latest_beta_test_arguments_override }}
          MATRIX_MACOS_LATEST_BETA_SETUP_COMMAND: ${{ inputs.xcode_latest_beta_setup_command }}

  darwin-job:
    name: ${{ matrix.config.name }}
    needs: construct-matrix
    runs-on: [self-hosted, macos, "${{ matrix.config.os }}", "${{ matrix.config.arch }}", "${{ matrix.config.pool }}"]
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix: ${{ fromJson(needs.construct-matrix.outputs.darwin-matrix) }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          persist-credentials: false
          submodules: true
      - name: Setup command
        if: ${{ matrix.config.setup_command != '' }}
        run: bash -c "${{ matrix.config.setup_command }}"
      - name: Swift build
        run: |
          if [ -n "${{ matrix.config.build_arguments_override }}" ]; then
            swift build ${{ matrix.config.build_arguments_override }}
          else
            swift build --build-tests
          fi
      - name: Swift test
        if: 'inputs.swift_test_enabled'
        run: |
          if [ -n "${{ matrix.config.test_arguments_override }}" ]; then
            swift test ${{ matrix.config.test_arguments_override }}
          else
            swift test
          fi
        # see `xcodebuild -list` for schemes, `simctl list` for destinations
      - name: macOS build
        if: '!cancelled() && inputs.macos_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=macos,variant=macos" build
      - name: macOS test
        if: '!cancelled() && inputs.macos_xcode_test_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=My Mac,variant=macos" test
      - name: macOS Catalyst build
        if: '!cancelled() && inputs.macos_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=macos,variant=Mac Catalyst" build
      - name: macOS Catalyst test
        if: '!cancelled() && inputs.macos_xcode_test_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=My Mac,variant=Mac Catalyst" test
      - name: iOS build
        if: '!cancelled() && inputs.ios_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=ios" build
      - name: iOS test
        if: '!cancelled() && inputs.ios_xcode_test_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=iPhone 16 Pro" test
      - name: watchOS build
        if: '!cancelled() && inputs.watchos_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=watchos" build
      - name: watchOS test
        if: '!cancelled() && inputs.watchos_xcode_test_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=Apple Watch Series 10 (46mm)" test
      - name: tvOS build
        if: '!cancelled() && inputs.tvos_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=tvos" build
      - name: tvOS test
        if: '!cancelled() && inputs.tvos_xcode_test_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=Apple TV 4K (3rd generation)" test
      - name: visionOS build  # arm only
        if: '!cancelled() && inputs.visionos_xcode_build_enabled'
        run: /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "generic/platform=visionos" build
      - name: visionOS test  # arm only
        if: '!cancelled() && inputs.visionos_xcode_test_enabled'
        run: TARGET_OS=""; if [ "$XCODE_VERSION" = "16.2" ]; then TARGET_OS=",OS=2.3"; fi && /usr/bin/xcodebuild -quiet -scheme ${BUILD_SCHEME} -destination "name=Apple Vision Pro$TARGET_OS" test
    env:
      XCODE_VERSION: ${{ matrix.config.xcode_version }}
      DEVELOPER_DIR: "/Applications/${{ matrix.config.xcode_app }}"
      BUILD_SCHEME: ${{ inputs.build_scheme }}