WIP

apple · Dec 2, 2024 · 0b0c716 · 0b0c716
1 parent bd94260
commit 0b0c716
Show file tree

Hide file tree

Showing 4 changed files with 366 additions and 1 deletion.
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -22,7 +22,7 @@ jobs:
 
   unit-tests:
     name: Unit tests
-    uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+    uses: ./.github/workflows/unit_tests.yml
     with:
       linux_5_9_arguments_override: "--explicit-target-dependency-import-check error"
       linux_5_10_arguments_override: "--explicit-target-dependency-import-check error"

diff --git a/.github/workflows/swift_test_matrix.yml b/.github/workflows/swift_test_matrix.yml
@@ -0,0 +1,100 @@
+name: Matrix
+
+on:
+  workflow_call:
+    inputs:
+      name:
+        type: string
+        description: "The name of the workflow used for the concurrency group."
+        required: true
+      matrix_path:
+        type: string
+        description: "The path of the test matrix definition."
+        default: ""
+      matrix_string:
+        type: string
+        description: "The test matrix definition."
+        default: ""
+
+# We will cancel previously triggered workflow runs
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.name }}
+  cancel-in-progress: true
+
+jobs:
+  generate-matrix:
+    name: Prepare matrices
+    runs-on: ubuntu-latest
+    outputs:
+      swift-matrix: ${{ steps.load-matrix.outputs.swift-matrix }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Mark the workspace as safe
+        # https://github.com/actions/checkout/issues/766
+        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+      - id: file_check
+        run: |
+          if [ ! -z '${{ inputs.matrix_string }}' ]; then
+            echo "matrix_string_populated=true" >> $GITHUB_ENV
+          else
+            echo "matrix_string_populated=false" >> $GITHUB_ENV
+          fi
+      - id: cat-matrix
+        if: ${{ env.matrix_string_populated == 'false' }}
+        run: |
+          jq -c '.' ${{ inputs.matrix_path }} >| __coverage_matrix.json
+      - id: write-matrix
+        if: ${{ env.matrix_string_populated  == 'true' }}
+        run: |
+          echo '${{ inputs.matrix_string }}' | jq -c '.' >| __coverage_matrix.json
+      - id: load-matrix
+        run: |
+          {
+            echo 'swift-matrix<<EOF'
+            echo "$(cat __coverage_matrix.json)"
+            echo EOF
+          }  >> "$GITHUB_OUTPUT"
+
+  execute-matrix:
+    name: ${{ matrix.swift.platform }} (${{ matrix.swift.name }})
+    needs: generate-matrix
+    runs-on: ${{ matrix.swift.runner }}
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.generate-matrix.outputs.swift-matrix) }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+          submodules: true
+      - name: Mark the workspace as safe
+        # https://github.com/actions/checkout/issues/766
+        run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
+      - name: Pull Docker image
+        run: docker pull ${{ matrix.swift.image }}
+      - name: Run matrix job
+        if: ${{ matrix.swift.platform != 'Windows' }}
+        run: |
+          if [[ -n "${{ matrix.swift.setup_command }}" ]]; then
+            setup_command_expression="${{ matrix.swift.setup_command }} &&"
+          else
+            setup_command_expression=""
+          fi
+          workspace="/$(basename ${{ github.workspace }})"
+          docker run -v ${{ github.workspace }}:"$workspace" -w "$workspace" -e setup_command_expression="$setup_command_expression" ${{ matrix.swift.image }} bash -c "swift --version && $setup_command_expression ${{ matrix.swift.command }} ${{ matrix.swift.command_arguments }}"
+      - name: Run matrix job (Windows)
+        if: ${{ matrix.swift.platform == 'Windows' }}
+        run: |
+          if (-not [string]::IsNullOrEmpty("${{ matrix.swift.setup_command }}")) {
+              $setup_command_expression = "${{ matrix.swift.setup_command }} &"
+          } else {
+              $setup_command_expression = ""
+          }
+          $workspace = "C:\" + (Split-Path ${{ github.workspace }} -Leaf)
+          docker run -v ${{ github.workspace }}:$($workspace) -w $($workspace) -e setup_command_expression=%setup_command_expression% ${{ matrix.swift.image }} cmd /s /c  "swift --version & powershell Invoke-Expression ""$($setup_command_expression) ${{ matrix.swift.command }} ${{ matrix.swift.command_arguments }}"""
+    env:
+      SWIFT_VERSION: ${{ matrix.swift.swift_version }}
diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
@@ -0,0 +1,112 @@
+name: Unit tests
+
+on:
+  workflow_call:
+    inputs:
+      linux_5_9_enabled:
+        type: boolean
+        description: "Boolean to enable the Linux 5.9 Swift version matrix job. Defaults to true."
+        default: true
+      linux_5_9_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Linux 5.9 Swift version matrix job."
+        default: ""
+      linux_5_10_enabled:
+        type: boolean
+        description: "Boolean to enable the Linux 5.10 Swift version matrix job. Defaults to true."
+        default: true
+      linux_5_10_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Linux 5.10 Swift version matrix job."
+        default: ""
+      linux_6_0_enabled:
+        type: boolean
+        description: "Boolean to enable the Linux 6.0 Swift version matrix job. Defaults to true."
+        default: true
+      linux_6_0_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Linux 6.0 Swift version matrix job."
+        default: ""
+      linux_nightly_6_0_enabled:
+        type: boolean
+        description: "Boolean to enable the Linux nightly 6.0 Swift version matrix job. Defaults to true."
+        default: true
+      linux_nightly_6_0_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Linux nightly 6.0 Swift version matrix job."
+        default: ""
+      linux_nightly_main_enabled:
+        type: boolean
+        description: "Boolean to enable the Linux nightly main Swift version matrix job. Defaults to true."
+        default: true
+      linux_nightly_main_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Linux nightly main Swift version matrix job."
+        default: ""
+
+      windows_6_0_enabled:
+        type: boolean
+        description: "Boolean to enable the Windows 6.0 Swift version matrix job. Defaults to true."
+        default: false
+      windows_6_0_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Windows 6.0 Swift version matrix job."
+        default: ""
+      windows_nightly_6_0_enabled:
+        type: boolean
+        description: "Boolean to enable the Windows nightly 6.0 Swift version matrix job. Defaults to true."
+        default: false
+      windows_nightly_6_0_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Windows nightly 6.0 Swift version matrix job."
+        default: ""
+      windows_nightly_main_enabled:
+        type: boolean
+        description: "Boolean to enable the Windows nightly main Swift version matrix job. Defaults to true."
+        default: false
+      windows_nightly_main_arguments_override:
+        type: string
+        description: "The arguments passed to swift test in the Windows nightly main Swift version matrix job."
+        default: ""
+
+jobs:
+  construct-matrix:
+    name: Construct unit test matrix
+    runs-on: ubuntu-latest
+    outputs:
+      unit-test-matrix: '${{ steps.generate-matrix.outputs.unit-test-matrix }}'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - id: generate-matrix
+        run: echo "unit-test-matrix=$(./scripts/generate_matrix.sh)" >> "$GITHUB_OUTPUT"
+        env:
+          MATRIX_LINUX_COMMAND: "swift test"
+          MATRIX_LINUX_5_9_ENABLED: ${{ inputs.linux_5_9_enabled }}
+          MATRIX_LINUX_5_9_COMMAND_ARGUMENTS: ${{ inputs.linux_5_9_arguments_override }}
+          MATRIX_LINUX_5_10_ENABLED: ${{ inputs.linux_5_10_enabled }}
+          MATRIX_LINUX_5_10_COMMAND_ARGUMENTS: ${{ inputs.linux_5_10_arguments_override }}
+          MATRIX_LINUX_6_0_ENABLED: ${{ inputs.linux_6_0_enabled }}
+          MATRIX_LINUX_6_0_COMMAND_ARGUMENTS: ${{ inputs.linux_6_0_arguments_override }}
+          MATRIX_LINUX_NIGHTLY_6_0_ENABLED: ${{ inputs.linux_nightly_6_0_enabled }}
+          MATRIX_LINUX_NIGHTLY_6_0_COMMAND_ARGUMENTS: ${{ inputs.linux_nightly_6_0_arguments_override }}
+          MATRIX_LINUX_NIGHTLY_MAIN_ENABLED: ${{ inputs.linux_nightly_main_enabled }}
+          MATRIX_LINUX_NIGHTLY_MAIN_COMMAND_ARGUMENTS: ${{ inputs.linux_nightly_main_arguments_override }}
+          MATRIX_WINDOWS_COMMAND: "swift test"
+          MATRIX_WINDOWS_6_0_ENABLED: ${{ inputs.windows_6_0_enabled }}
+          MATRIX_WINDOWS_6_0_COMMAND_ARGUMENTS: ${{ inputs.windows_6_0_arguments_override }}
+          MATRIX_WINDOWS_NIGHTLY_6_0_ENABLED: ${{ inputs.windows_nightly_6_0_enabled }}
+          MATRIX_WINDOWS_NIGHTLY_6_0_COMMAND_ARGUMENTS: ${{ inputs.windows_nightly_6_0_arguments_override }}
+          MATRIX_WINDOWS_NIGHTLY_MAIN_ENABLED: ${{ inputs.windows_nightly_main_enabled }}
+          MATRIX_WINDOWS_NIGHTLY_MAIN_COMMAND_ARGUMENTS: ${{ inputs.windows_nightly_main_arguments_override }}
+
+  unit-tests:
+    name: Unit tests
+    needs: construct-matrix
+    # TODO: use global reference
+    uses: ./.github/workflows/swift_test_matrix.yml
+    with:
+      name: "Unit tests"
+      matrix_string: '${{ needs.construct-matrix.outputs.unit-test-matrix }}'
diff --git a/scripts/generate_matrix.sh b/scripts/generate_matrix.sh
@@ -0,0 +1,153 @@
+#!/bin/bash
+##===----------------------------------------------------------------------===##
+##
+## This source file is part of the SwiftNIO open source project
+##
+## Copyright (c) 2024 Apple Inc. and the SwiftNIO project authors
+## Licensed under Apache License v2.0
+##
+## See LICENSE.txt for license information
+## See CONTRIBUTORS.txt for the list of SwiftNIO project authors
+##
+## SPDX-License-Identifier: Apache-2.0
+##
+##===----------------------------------------------------------------------===##
+
+# Parameters
+linux_command="$MATRIX_LINUX_COMMAND"  # required if any Linux pipeline is enabled
+linux_setup_command="$MATRIX_LINUX_SETUP_COMMAND"
+linux_5_9_enabled="${MATRIX_LINUX_5_9_ENABLED:=true}"
+linux_5_9_command_arguments="$MATRIX_LINUX_5_9_COMMAND_ARGUMENTS"
+linux_5_10_enabled="${MATRIX_LINUX_5_10_ENABLED:=true}"
+linux_5_10_command_arguments="$MATRIX_LINUX_5_10_COMMAND_ARGUMENTS"
+linux_6_0_enabled="${MATRIX_LINUX_6_0_ENABLED:=true}"
+linux_6_0_command_arguments="$MATRIX_LINUX_6_0_COMMAND_ARGUMENTS"
+linux_nightly_6_0_enabled="${MATRIX_LINUX_NIGHTLY_6_0_ENABLED:=true}"
+linux_nightly_6_0_command_arguments="$MATRIX_LINUX_NIGHTLY_6_0_COMMAND_ARGUMENTS"
+linux_nightly_main_enabled="${MATRIX_LINUX_NIGHTLY_MAIN_ENABLED:=true}"
+linux_nightly_main_command_arguments="$MATRIX_LINUX_NIGHTLY_MAIN_COMMAND_ARGUMENTS"
+
+windows_command="$MATRIX_WINDOWS_COMMAND"  # required if any Windows pipeline is enabled
+windows_setup_command="$MATRIX_WINDOWS_SETUP_COMMAND"
+windows_6_0_enabled="${MATRIX_WINDOWS_6_0_ENABLED:=false}"
+windows_6_0_command_arguments="$MATRIX_WINDOWS_6_0_COMMAND_ARGUMENTS"
+windows_nightly_6_0_enabled="${MATRIX_WINDOWS_NIGHTLY_6_0_ENABLED:=false}"
+windows_nightly_6_0_command_arguments="$MATRIX_WINDOWS_NIGHTLY_6_0_COMMAND_ARGUMENTS"
+windows_nightly_main_enabled="${MATRIX_WINDOWS_NIGHTLY_MAIN_ENABLED:=false}"
+windows_nightly_main_command_arguments="$MATRIX_WINDOWS_NIGHTLY_MAIN_COMMAND_ARGUMENTS"
+
+# Defaults
+linux_runner="ubuntu-latest"
+linux_5_9_container_image="swift:5.9-jammy"
+linux_5_10_container_image="swift:5.10-jammy"
+linux_6_0_container_image="swift:6.0-jammy"
+linux_nightly_6_0_container_image="swiftlang/swift:nightly-6.0-jammy"
+linux_nightly_main_container_image="swiftlang/swift:nightly-main-jammy"
+
+windows_6_0_runner="windows-2022"
+windows_6_0_container_image="swift:6.0-windowsservercore-ltsc2022"
+windows_nightly_6_0_runner="windows-2019"
+windows_nightly_6_0_container_image="swiftlang/swift:nightly-6.0-windowsservercore-1809"
+windows_nightly_main_runner="windows-2019"
+windows_nightly_main_container_image="swiftlang/swift:nightly-main-windowsservercore-1809"
+
+# Create matrix from inputs
+matrix='{"swift": []}'
+
+## Linux
+if [[ "$linux_5_9_enabled" == "true" || "$linux_5_10_enabled" == "true" || "$linux_6_0_enabled" == "true" || \
+      "$linux_nightly_6_0_enabled" == "true" || "$linux_nightly_main_enabled" == "true" ]]; then
+      if [[ -z "$linux_command" ]]; then
+        echo "No linux command defined"; exit 1
+      fi
+fi
+
+
+if [[ "$linux_5_9_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$linux_setup_command"  \
+    --arg command "$linux_command"  \
+    --arg command_arguments "$linux_5_9_command_arguments" \
+    --arg container_image "$linux_5_9_container_image" \
+    --arg runner "$linux_runner" \
+    '.swift[.swift| length] |= . + { "name": "5.9", "image": $container_image, "swift_version": "5.9", "platform": "Linux", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner}')
+fi
+
+if [[ "$linux_5_10_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$linux_setup_command"  \
+    --arg command "$linux_command"  \
+    --arg command_arguments "$linux_5_10_command_arguments" \
+    --arg container_image "$linux_5_10_container_image" \
+    --arg runner "$linux_runner" \
+    '.swift[.swift| length] |= . + { "name": "5.10", "image": $container_image, "swift_version": "5.10", "platform": "Linux", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner}')
+fi
+
+if [[ "$linux_6_0_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$linux_setup_command"  \
+    --arg command "$linux_command"  \
+    --arg command_arguments "$linux_6_0_command_arguments" \
+    --arg container_image "$linux_6_0_container_image" \
+    --arg runner "$linux_runner" \
+    '.swift[.swift| length] |= . + { "name": "6.0", "image": $container_image, "swift_version": "6.0", "platform": "Linux", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner}')
+fi
+
+if [[ "$linux_nightly_6_0_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$linux_setup_command"  \
+    --arg command "$linux_command"  \
+    --arg command_arguments "$linux_nightly_6_0_command_arguments" \
+    --arg container_image "$linux_nightly_6_0_container_image" \
+    --arg runner "$linux_runner" \
+    '.swift[.swift| length] |= . + { "name": "nightly-6.0", "image": $container_image, "swift_version": "nightly-6.0", "platform": "Linux", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner}')
+fi
+
+if [[ "$linux_nightly_main_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$linux_setup_command"  \
+    --arg command "$linux_command"  \
+    --arg command_arguments "$linux_nightly_main_command_arguments" \
+    --arg container_image "$linux_nightly_main_container_image" \
+    --arg runner "$linux_runner" \
+    '.swift[.swift| length] |= . + { "name": "nightly-main", "image": $container_image, "swift_version": "nightly-main", "platform": "Linux", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner}')
+fi
+
+## Windows
+if [[ "$windows_6_0_enabled" == "true" || "$windows_nightly_6_0_enabled" == "true" || "$windows_nightly_main_enabled" == "true" ]]; then
+      if [[ -z "$windows_command" ]]; then
+        echo "No windows command defined"; exit 1
+      fi
+fi
+
+if [[ "$windows_6_0_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$windows_setup_command"  \
+    --arg command "$windows_command"  \
+    --arg command_arguments "$windows_6_0_command_arguments" \
+    --arg container_image "$windows_6_0_container_image" \
+    --arg runner "$windows_6_0_runner" \
+    '.swift[.swift| length] |= . + { "name": "6.0", "image": $container_image, "swift_version": "6.0", "platform": "Windows", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner }')
+fi
+
+if [[ "$windows_nightly_6_0_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$windows_setup_command"  \
+    --arg command "$windows_command"  \
+    --arg command_arguments "$windows_nightly_6_0_command_arguments" \
+    --arg container_image "$windows_nightly_6_0_container_image" \
+    --arg runner "$windows_nightly_6_0_runner" \
+    '.swift[.swift| length] |= . + { "name": "nightly-6.0", "image": $container_image, "swift_version": "nightly-6.0", "platform": "Windows", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner }')
+fi
+
+if [[ "$windows_nightly_main_enabled" == "true" ]]; then
+  matrix=$(echo "$matrix" | jq -c \
+    --arg setup_command "$windows_setup_command"  \
+    --arg command "$windows_command"  \
+    --arg command_arguments "$windows_nightly_main_command_arguments" \
+    --arg container_image "$windows_nightly_main_container_image" \
+    --arg runner "$windows_nightly_main_runner" \
+    '.swift[.swift| length] |= . + { "name": "nightly-main", "image": $container_image, "swift_version": "nightly-main", "platform": "Windows", "command": $command, "command_arguments": $command_arguments, "setup_command": $setup_command, "runner": $runner }')
+fi
+
+echo "$matrix" | jq -c