[5.9] Backport macOS CI related changes (#6539)

* Re-enable disabled tests

* Re-enable disabled tests

This re-enables a bunch of disabled tests, the hope is that they should now work that we have a newer superior Xcode installed on CI. If that happens to not be the case, we have `SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS` to disable these tests specifically for the macOS CI if needed. This change introduces the variable where expected to be needed, but doesn't set it.

* Removed back deployment rpaths
* Removed more Darwin rpaths into the toolchain

A macOS that contains the dyld issue worked around by swiftlang/swift#37978 has been deployed by Swift CI, so we can't do this anymore on Darwin.

* Do not include Swift runtime libs in `DYLD_LIBRARY_PATH` on Darwin

(cherry picked from commit 16fb1d2)

* Skip SDK dependent tests in macOS bootstrap

This is manifesting itself as `cannot find 'XCTAssertEqual' in scope` on Swift CI again, but instead of disabling these tests wholesale like we did before, we want to take a more targetted approach.

(cherry picked from commit bc35b9c)

* Put `CommandsTests` behind `SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS`

Looks like these tests are suffering from some of the same problems as `FunctionalTests` which makes sense since they're conceptually very similar.

(cherry picked from commit 2cb0f2f)

Author: neonichu

Examples/package-info/Sources/package-info/example.swift

@@ -1,8 +1,4 @@
-#if swift(>=5.7)
-@preconcurrency import Basics
-#else
 import Basics
-#endif
 import TSCBasic
 import Workspace
 

Package.swift

@@ -579,47 +579,10 @@ let package = Package(
             name: "BuildTests",
             dependencies: ["Build", "SPMTestSupport"]
         ),
-        .testTarget(
-            name: "CommandsTests",
-            dependencies: [
-                "swift-build",
-                "swift-package",
-                "swift-test",
-                "swift-run",
-                "Basics",
-                "Build",
-                "Commands",
-                "PackageModel",
-                "PackageRegistryTool",
-                "SourceControl",
-                "SPMTestSupport",
-                "Workspace",
-            ]
-        ),
         .testTarget(
             name: "WorkspaceTests",
             dependencies: ["Workspace", "SPMTestSupport"]
         ),
-        // rdar://101868275 "error: cannot find 'XCTAssertEqual' in scope" can affect almost any functional test, so we flat out disable them all until we know what is going on
-        /*.testTarget(
-            name: "FunctionalTests",
-            dependencies: [
-                "swift-build",
-                "swift-package",
-                "swift-test",
-                "PackageModel",
-                "SPMTestSupport"
-            ]
-        ),*/
-        .testTarget(
-            name: "FunctionalPerformanceTests",
-            dependencies: [
-                "swift-build",
-                "swift-package",
-                "swift-test",
-                "SPMTestSupport"
-            ]
-        ),
         .testTarget(
             name: "PackageDescriptionTests",
             dependencies: ["PackageDescription"]
@@ -703,6 +666,56 @@ let package = Package(
     swiftLanguageVersions: [.v5]
 )
 
+// Workaround SPM's attempt to link in executables which does not work on all
+// platforms.
+#if !os(Windows)
+package.targets.append(contentsOf: [
+    .testTarget(
+        name: "FunctionalPerformanceTests",
+        dependencies: [
+            "swift-build",
+            "swift-package",
+            "swift-test",
+            "SPMTestSupport"
+        ]
+    ),
+])
+
+// rdar://101868275 "error: cannot find 'XCTAssertEqual' in scope" can affect almost any functional test, so we flat out disable them all until we know what is going on
+if ProcessInfo.processInfo.environment["SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS"] == nil {
+    package.targets.append(contentsOf: [
+        .testTarget(
+            name: "FunctionalTests",
+            dependencies: [
+                "swift-build",
+                "swift-package",
+                "swift-test",
+                "PackageModel",
+                "SPMTestSupport"
+            ]
+        ),
+
+        .testTarget(
+            name: "CommandsTests",
+            dependencies: [
+                "swift-build",
+                "swift-package",
+                "swift-test",
+                "swift-run",
+                "Basics",
+                "Build",
+                "Commands",
+                "PackageModel",
+                "PackageRegistryTool",
+                "SourceControl",
+                "SPMTestSupport",
+                "Workspace",
+            ]
+        ),
+    ])
+}
+#endif
+
 // Add package dependency on llbuild when not bootstrapping.
 //
 // When bootstrapping SwiftPM, we can't use llbuild as a package dependency it

Sources/Build/BuildPlan.swift

@@ -775,10 +775,6 @@ public class BuildPlan: SPMBuildCore.BuildPlan {
                     case.unknown:
                         throw InternalError("unknown binary target '\(target.name)' type")
                     }
-                case .macro:
-                    if product.type == .macro {
-                        staticTargets.append(target)
-                    }
                 case .plugin:
                     continue
                 }

Tests/FunctionalTests/DependencyResolutionTests.swift

@@ -78,6 +78,8 @@ class DependencyResolutionTests: XCTestCase {
     }
 
     func testMirrors() throws {
+        try XCTSkipIf(true, "test is broken and needs investigation rdar://107970938")
+
         try fixture(name: "DependencyResolution/External/Mirror") { fixturePath in
             let prefix = try resolveSymlinks(fixturePath)
             let appPath = prefix.appending("App")

Tests/FunctionalTests/PluginTests.swift

@@ -463,6 +463,7 @@ class PluginTests: XCTestCase {
                         accessibleTools: [:],
                         writableDirectories: [pluginDir.appending("output")],
                         readOnlyDirectories: [package.path],
+                        allowNetworkConnections: [],
                         pkgConfigDirectories: [],
                         fileSystem: localFileSystem,
                         observabilityScope: observability.topScope,
@@ -729,6 +730,7 @@ class PluginTests: XCTestCase {
                 accessibleTools: [:],
                 writableDirectories: [pluginDir.appending("output")],
                 readOnlyDirectories: [package.path],
+                allowNetworkConnections: [],
                 pkgConfigDirectories: [],
                 fileSystem: localFileSystem,
                 observabilityScope: observability.topScope,
@@ -1022,7 +1024,7 @@ class PluginTests: XCTestCase {
             let (stdout, _) = try executeSwiftBuild(
                 fixturePath.appending(component: "MySourceGenPlugin"),
                 configuration: .Debug,
-                extraArgs: ["--product", "MyLocalTool", "-Xbuild-tools-swiftc", "-DUSE_CREATING"]
+                extraArgs: ["--product", "MyLocalTool", "-Xbuild-tools-swiftc", "-DUSE_CREATE"]
             )
             XCTAssert(stdout.contains("Linking MySourceGenBuildTool"), "stdout:\n\(stdout)")
             XCTAssert(stdout.contains("Creating foo.swift from foo.dat"), "stdout:\n\(stdout)")

Tests/FunctionalTests/ResourcesTests.swift

@@ -10,10 +10,13 @@
 //
 //===----------------------------------------------------------------------===//
 
+import Basics
 import XCTest
 import SPMTestSupport
 
-import TSCBasic
+import struct TSCBasic.AbsolutePath
+import var TSCBasic.localFileSystem
+import func TSCBasic.withTemporaryDirectory
 
 class ResourcesTests: XCTestCase {
     func testSimpleResources() throws {
@@ -103,6 +106,7 @@ class ResourcesTests: XCTestCase {
     func testFoundationlessClient() throws {
         try fixture(name: "Resources/FoundationlessClient") { fixturePath in
             #if os(Linux) && swift(>=5.8)
+            try XCTSkipIf(!SwiftVersion.current.isDevelopment, "test needs tools-version 999.0")
             let pkgPath = fixturePath.appending(components: "AppPkg")
             guard let failure = XCTAssertBuildFails(pkgPath) else {
                 XCTFail("missing expected command execution error")

Tests/WorkspaceTests/InitTests.swift

@@ -248,8 +248,6 @@ class InitTests: XCTestCase {
     }
 
     func testNonC99NameExecutablePackage() throws {
-        throw XCTSkip("This test fails to find XCTAssertEqual; rdar://101868275")
-
         try withTemporaryDirectory(removeTreeOnDeinit: true) { tempDirPath in
             XCTAssertDirectoryExists(tempDirPath)
 
@@ -266,11 +264,7 @@ class InitTests: XCTestCase {
             )
             try initPackage.writePackageStructure()
 
-            #if os(macOS)
-              XCTAssertSwiftTest(packageRoot)
-            #else
-              XCTAssertBuilds(packageRoot)
-            #endif
+            XCTAssertBuilds(packageRoot)
         }
     }
 

Tests/WorkspaceTests/WorkspaceTests.swift

@@ -4948,8 +4948,6 @@ final class WorkspaceTests: XCTestCase {
 
     // This verifies that the simplest possible loading APIs are available for package clients.
     func testSimpleAPI() throws {
-        throw XCTSkip("This test fails to find XCTAssertEqual; rdar://101868275")
-
         try testWithTemporaryDirectory { path in
             // Create a temporary package as a test case.
             let packagePath = path.appending("MyPkg")
@@ -4963,7 +4961,10 @@ final class WorkspaceTests: XCTestCase {
 
             // Load the workspace.
             let observability = ObservabilitySystem.makeForTesting()
-            let workspace = try Workspace(forRootPackage: packagePath)
+            let workspace = try Workspace(
+                forRootPackage: packagePath,
+                customHostToolchain: UserToolchain.default
+            )
 
             // From here the API should be simple and straightforward:
             let manifest = try tsc_await {

Utilities/bootstrap

@@ -367,9 +367,14 @@ def test(args):
     """Builds SwiftPM, then tests itself."""
     build(args)
 
+    if '-macosx' in args.build_target:
+        extra_env = ["SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS=YES"]
+    else:
+        extra_env = []
+
     note("Testing")
     parse_test_args(args)
-    cmd = [
+    cmd = extra_env + [
         "SWIFT_EXEC=" + args.swiftc_path,
         "SWIFT_DRIVER_SWIFT_EXEC=" + args.swiftc_path,
         os.path.join(args.bin_dir, "swift-test")
@@ -583,14 +588,7 @@ def add_rpath_for_cmake_build(args, rpath):
 
 def get_swift_backdeploy_library_paths(args):
     if platform.system() == 'Darwin':
-        # Need to include backwards compatibility libraries for Concurrency
-        if args.release:
-            # For release builds, we need a relative path that finds the compatibility libs in the current toolchain.
-            backdeploy_path = '@executable_path/../lib/swift-5.5/macosx'
-        else:
-            # FIXME: Would be nice if we could get this from `swiftc -print-target-info`
-            backdeploy_path = args.target_info["paths"]["runtimeLibraryPaths"][0] + '/../../swift-5.5/macosx'
-        return ['/usr/lib/swift', backdeploy_path]
+        return ['/usr/lib/swift']
     else:
         return []
 
@@ -750,7 +748,7 @@ def get_swiftpm_env_cmd(args):
         env_cmd.append("SWIFTCI_INSTALL_RPATH_OS=%s" % args.platform_path.group(2))
 
     if args.bootstrap:
-        libs_joined = ":".join([
+        libs = [
             os.path.join(args.bootstrap_dir,                       "lib"),
             os.path.join(args.build_dirs["tsc"],                   "lib"),
             os.path.join(args.build_dirs["llbuild"],               "lib"),
@@ -762,11 +760,12 @@ def get_swiftpm_env_cmd(args):
             os.path.join(args.build_dirs["swift-collections"],     "lib"),
             os.path.join(args.build_dirs["swift-asn1"],            "lib"),
             os.path.join(args.build_dirs["swift-certificates"],    "lib"),
-        ] + args.target_info["paths"]["runtimeLibraryPaths"])
+        ]
 
         if platform.system() == 'Darwin':
-            env_cmd.append("DYLD_LIBRARY_PATH=%s" % libs_joined)
+            env_cmd.append("DYLD_LIBRARY_PATH=%s" % ":".join(libs))
         else:
+            libs_joined = ":".join(libs + args.target_info["paths"]["runtimeLibraryPaths"])
             env_cmd.append("LD_LIBRARY_PATH=%s" % libs_joined)
 
     return env_cmd
@@ -799,26 +798,6 @@ def get_swiftpm_flags(args):
             "-Xlinker", "@executable_path/../lib/swift/pm/llbuild",
         ])
 
-    # Add a relative rpath to find Swift libraries in toolchains.
-    # On non-Darwin platforms, a relative rpath is necessary because Swift
-    # libraries are not part of the OS.
-    # On Darwin platforms, a relative rpath is necessary for experimental
-    # toolchains that include libraries not part of the OS (e.g. PythonKit or
-    # TensorFlow).
-    if '-macosx' in args.build_target:
-        # rpaths for compatibility libraries
-        for lib_path in get_swift_backdeploy_library_paths(args):
-            build_flags.extend(["-Xlinker", "-rpath", "-Xlinker", lib_path])
-
-        build_flags.extend(
-           [
-               "-Xlinker",
-               "-rpath",
-               "-Xlinker",
-               "@executable_path/../" + args.platform_path.group(1),
-           ]
-        )
-
     if '-openbsd' in args.build_target:
         build_flags.extend(["-Xlinker", "-z", "-Xlinker", "origin"])
         build_flags.extend(["-Xcc", "-I/usr/local/include"])