WIP

apple · Oct 24, 2024 · bfc0ba7 · bfc0ba7
1 parent 27b25e2
commit bfc0ba7
Show file tree

Hide file tree

Showing 80 changed files with 4,281 additions and 3,243 deletions.
diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml
@@ -0,0 +1,37 @@
+name: PR
+
+on:
+    pull_request:
+        types: [opened, reopened, synchronize]
+
+jobs:
+    soundness:
+        name: Soundness
+        uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+        with:
+            license_header_check_project_name: "SwiftNIO"
+    unit-tests:
+        name: Unit tests
+        uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+        with:
+            linux_5_9_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+            linux_5_10_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+            linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+            linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+            linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+    integration-tests:
+        name: Integration test
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Integration test"
+            matrix_linux_command: "apt-get update -yq && apt-get install -yq lsof dnsutils netcat-openbsd net-tools expect curl jq && ./scripts/integration_tests.sh"
+
+    cxx-interop:
+        name: Cxx interop
+        uses: apple/swift-nio/.github/workflows/cxx_interop.yml@main
+
+    swift-6-language-mode:
+        name: Swift 6 Language Mode
+        uses: apple/swift-nio/.github/workflows/swift_6_language_mode.yml@main
+        if: false  # Disabled for now.
diff --git a/.github/workflows/pull_request_label.yml b/.github/workflows/pull_request_label.yml
@@ -0,0 +1,18 @@
+name: PR label
+
+on:
+  pull_request:
+    types: [labeled, unlabeled, opened, reopened, synchronize]
+
+jobs:
+  semver-label-check:
+    name: Semantic Version label check
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Check for Semantic Version label
+        uses: apple/swift-nio/.github/actions/pull_request_semver_label_checker@main
diff --git a/.github/workflows/scheduled.yml b/.github/workflows/scheduled.yml
@@ -0,0 +1,24 @@
+name: Scheduled
+
+on:
+    schedule:
+        - cron: "0 8,20 * * *"
+
+jobs:
+    unit-tests:
+        name: Unit tests
+        uses: apple/swift-nio/.github/workflows/unit_tests.yml@main
+        with:
+            linux_5_8_enabled: false
+            linux_5_9_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+            linux_5_10_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error"
+            linux_6_0_arguments_override: "-Xswiftc -warnings-as-errors --explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+            linux_nightly_6_0_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+            linux_nightly_main_arguments_override: "--explicit-target-dependency-import-check error -Xswiftc -require-explicit-sendable"
+
+    integration-tests:
+        name: Integration test
+        uses: apple/swift-nio/.github/workflows/swift_matrix.yml@main
+        with:
+            name: "Integration test"
+            matrix_linux_command: "apt-get update -yq && apt-get install -yq lsof dnsutils netcat-openbsd net-tools expect curl jq && ./scripts/integration_tests.sh"
diff --git a/.licenseignore b/.licenseignore
@@ -0,0 +1,45 @@
+.gitignore
+**/.gitignore
+.licenseignore
+.gitattributes
+.git-blame-ignore-revs
+.mailfilter
+.mailmap
+.spi.yml
+.swift-format
+.editorconfig
+.github/*
+*.md
+*.txt
+*.yml
+*.yaml
+*.json
+Package.swift
+**/Package.swift
+Package@-*.swift
+**/Package@-*.swift
+Package.resolved
+**/Package.resolved
+Makefile
+*.modulemap
+**/*.modulemap
+**/*.docc/*
+*.xcprivacy
+**/*.xcprivacy
+*.symlink
+**/*.symlink
+Dockerfile
+**/Dockerfile
+Snippets/*
+Sources/CNIOBoringSSL/*
+dev/alloc-limits-from-test-output
+dev/boxed-existentials.d
+dev/git.commit.template
+dev/lldb-smoker
+dev/make-single-file-spm
+dev/malloc-aggregation.d
+dev/update-alloc-limits-to-last-completed-ci-build
+scripts/patch-1-inttypes.patch
+scripts/patch-2-inttypes.patch
+scripts/patch-3-more-inttypes.patch
+.unacceptablelanguageignore
diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,62 @@
+{
+  "version" : 1,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 120,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}
diff --git a/.unacceptablelanguageignore b/.unacceptablelanguageignore
@@ -0,0 +1,2 @@
+Sources/CNIOBoringSSL/*
+NOTICE.txt
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -67,6 +67,11 @@ We require that your commit messages match our template. The easiest way to do t
 
 SwiftNIO uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not. For this reason, whenever you add new tests you will want to run a script that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby generate_linux_tests.rb` at the root of the package and check the changes it made.
 
+### Run CI checks locally
+
+You can run the Github Actions workflows locally using [act](https://github.com/nektos/act). For detailed steps on how to do this please see [https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally](https://github.com/swiftlang/github-workflows?tab=readme-ov-file#running-workflows-locally).
+
+
 ## How to contribute your work
 
 Please open a pull request at https://github.com/apple/swift-nio. Make sure the CI passes, and then wait for code review.
diff --git a/IntegrationTests/plugin_junit_xml.sh b/IntegrationTests/plugin_junit_xml.sh
@@ -44,9 +44,9 @@ function junit_output_replace() {
 
 function plugin_junit_xml_test_suite_begin() {
     junit_testsuite_time=0
-    junit_output_write "<testsuite name='$1' hostname='$(hostname)' "\
-"timestamp='$(date -u +"%Y-%m-%dT%H:%M:%S")' tests='XXX-TESTS-XXX' "\
-"failures='XXX-FAILURES-XXX' time='XXX-TIME-XXX' errors='0' id='$(date +%s)'"\
+    junit_output_write "<testsuite name='$1' hostname='$(hostname)' " \
+"timestamp='$(date -u +"%Y-%m-%dT%H:%M:%S")' tests='XXX-TESTS-XXX' " \
+"failures='XXX-FAILURES-XXX' time='XXX-TIME-XXX' errors='0' id='$(date +%s)'" \
 " package='NIOIntegrationTests.$1'>"
 }
 

diff --git a/IntegrationTests/run-single-test.sh b/IntegrationTests/run-single-test.sh
@@ -20,12 +20,17 @@ set -x
 set -o pipefail
 
 test="$1"
+# shellcheck disable=SC2034 # Used by whatever we source transpile in
 tmp="$2"
+# shellcheck disable=SC2034 # Used by whatever we source transpile in
 root="$3"
+# shellcheck disable=SC2034 # Used by whatever we source transpile in
 g_show_info="$4"
 here="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
+# shellcheck source=IntegrationTests/test_functions.sh
 source "$here/test_functions.sh"
+# shellcheck source=/dev/null
 source "$test"
 wait
 )

diff --git a/IntegrationTests/run-tests.sh b/IntegrationTests/run-tests.sh
@@ -36,7 +36,9 @@ function plugins_do() {
     done
 }
 
+# shellcheck source=IntegrationTests/plugin_echo.sh
 source "$here/plugin_echo.sh"
+# shellcheck source=/dev/null
 source "$here/plugin_junit_xml.sh"
 
 plugins="echo"
@@ -88,7 +90,7 @@ function run_test() {
     if $verbose; then
         "$@" 2>&1 | tee -a "$out"
         # we need to return the return value of the first command
-        return ${PIPESTATUS[0]}
+        return "${PIPESTATUS[0]}"
     else
         "$@" >> "$out" 2>&1
     fi
@@ -113,13 +115,13 @@ for f in tests_*; do
         plugins_do test_begin "$t" "$f"
         start=$(date +%s)
         if run_test "$here/run-single-test.sh" "$here/$f/$t" "$test_tmp" "$here/.." "$show_info"; then
-            plugins_do test_ok "$(time_diff_to_now $start)"
+            plugins_do test_ok "$(time_diff_to_now "$start")"
             suite_ok=$((suite_ok+1))
             if $verbose; then
                 cat "$out"
             fi
         else
-            plugins_do test_fail "$(time_diff_to_now $start)" "$out"
+            plugins_do test_fail "$(time_diff_to_now "$start")" "$out"
             suite_fail=$((suite_fail+1))
         fi
         if ! $debug; then
@@ -131,7 +133,7 @@ for f in tests_*; do
     cnt_ok=$((cnt_ok + suite_ok))
     cnt_fail=$((cnt_fail + suite_fail))
     cd ..
-    plugins_do test_suite_end "$(time_diff_to_now $start_suite)" "$suite_ok" "$suite_fail"
+    plugins_do test_suite_end "$(time_diff_to_now "$start_suite")" "$suite_ok" "$suite_fail"
 done
 
 if ! $debug; then
@@ -142,17 +144,17 @@ fi
 
 
 # report
-if [[ $cnt_fail > 0 ]]; then
-    # kill leftovers (the whole process group)
+if [[ $cnt_fail -gt 0 ]]; then
+    # terminate leftovers (the whole process group)
     trap '' TERM
-    kill 0
+    kill 0 # ignore-unacceptable-language
 
     plugins_do summary_fail "$cnt_ok" "$cnt_fail"
 else
     plugins_do summary_ok "$cnt_ok" "$cnt_fail"
 fi
 
-if [[ $cnt_fail > 0 ]]; then
+if [[ $cnt_fail -gt 0 ]]; then
     exit 1
 else
     exit 0

diff --git a/IntegrationTests/test_functions.sh b/IntegrationTests/test_functions.sh
@@ -64,6 +64,7 @@ function assert_greater_than_or_equal() {
 g_has_previously_infoed=false
 
 function info() {
+    # shellcheck disable=SC2154 # Defined by an include our by being source transpiled in
     if $g_show_info; then
         if ! $g_has_previously_infoed; then
             echo >&3 || true # echo an extra newline so it looks better

diff --git a/IntegrationTests/tests_01_general/test_01_renegotiation.sh b/IntegrationTests/tests_01_general/test_01_renegotiation.sh
@@ -13,11 +13,14 @@
 ##
 ##===----------------------------------------------------------------------===##
 
+# shellcheck source=IntegrationTests/tests_01_allocation_counters/defines.sh
 source defines.sh
 
 swift build
 
 # Generate a self-signed certificate.
+
+# shellcheck disable=SC2154 # Provided by framework
 cat << EOF > "$tmp/openssl.cnf"
 [ req ]
 distinguished_name = subject

diff --git a/IntegrationTests/tests_01_general/test_02_execstack.sh b/IntegrationTests/tests_01_general/test_02_execstack.sh
@@ -13,6 +13,7 @@
 ##
 ##===----------------------------------------------------------------------===##
 
+# shellcheck source=IntegrationTests/tests_01_allocation_counters/defines.sh
 source defines.sh
 
 if [[ "$(uname -s)" == "Darwin" ]]; then
@@ -26,7 +27,7 @@ swift build -c release
 DEBUG_SERVER_PATH="$(swift build --show-bin-path)/NIOTLSServer"
 RELEASE_SERVER_PATH="$(swift build --show-bin-path -c release)/NIOTLSServer"
 
-results=$(execstack $DEBUG_SERVER_PATH $RELEASE_SERVER_PATH)
+results=$(execstack "$DEBUG_SERVER_PATH" "$RELEASE_SERVER_PATH")
 count=$(echo "$results" | grep -c '^X' || true)
 if [ "$count" -ne 0 ]; then
     exit 1

diff --git a/IntegrationTests/tests_02_allocation_counters/test_01_allocation_counts.sh b/IntegrationTests/tests_02_allocation_counters/test_01_allocation_counts.sh
@@ -13,6 +13,7 @@
 ##
 ##===----------------------------------------------------------------------===##
 
+# shellcheck source=IntegrationTests/tests_01_allocation_counters/defines.sh
 source defines.sh
 
 set -eu
@@ -26,6 +27,7 @@ for file in "$here/test_01_resources/"test_*.swift; do
     all_tests+=( "$test_name" )
 done
 
+# shellcheck disable=SC2154 # Provided by framework
 "$here/test_01_resources/run-nio-ssl-alloc-counter-tests.sh" -t "$tmp" > "$tmp/output"
 
 for test in "${all_tests[@]}"; do