DarwinComptibilityTests: Add Xcode Project

- Add shims and minor test fixes.

- Disable XDG tests as the xdgTestHelper does not currently work.

- Add handling for some tests requiring macOS 10.13 that run on 10.12
  when run against the sclf version of Foundation.
  This requires some of the tests to be duplicated and wrapped inside
  of a DARWIN_COMPATIBILITY_TEST conditional compile.

Author: spevans

DarwinCompatibilityTests.xcodeproj/project.pbxproj

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

DarwinCompatibilityTests/Info.plist

@@ -0,0 +1,87 @@
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See http://swift.org/LICENSE.txt for license information
+// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+
+// These shims are used solely by the DarwinCompatibilityTests Xcode project to
+// allow the TestFoundation tests to compile and run against Darwin's native
+// Foundation.
+// It contains wrappers for methods (some experimental) added in
+// swift-corelibs-foundation which do not exist in Foundation, and other small
+// differences.
+
+import Foundation
+
+
+public typealias unichar = UInt16
+
+extension unichar : ExpressibleByUnicodeScalarLiteral {
+    public typealias UnicodeScalarLiteralType = UnicodeScalar
+
+    public init(unicodeScalarLiteral scalar: UnicodeScalar) {
+        self.init(scalar.value)
+    }
+}
+
+extension NSURL {
+    func checkResourceIsReachable() throws -> Bool {
+        var error: NSError?
+        if checkResourceIsReachableAndReturnError(&error) {
+            return true
+        } else {
+            if let e = error {
+                throw e
+            }
+        }
+        return false
+    }
+}
+
+extension Thread {
+    class var mainThread: Thread {
+        return Thread.main
+    }
+}
+
+extension Scanner {
+    public func scanString(_ searchString: String) -> String? {
+        var result: NSString? = nil
+        if scanString(string, into: &result), let str = result {
+            return str as String
+        }
+        return nil
+    }
+}
+
+extension JSONSerialization {
+    class func writeJSONObject(_ obj: Any, toStream stream: OutputStream, options opt: WritingOptions) throws -> Int {
+        var error: NSError?
+        let ret = writeJSONObject(obj, to: stream, options: opt, error: &error)
+        guard ret != 0 else {
+            throw error!
+        }
+        return ret
+    }
+}
+
+extension NSIndexSet {
+    func _bridgeToSwift() -> NSIndexSet {
+        return self
+    }
+}
+
+extension CharacterSet {
+    func _bridgeToSwift() -> CharacterSet {
+        return self
+    }
+}
+
+extension NSCharacterSet {
+    func _bridgeToSwift() -> CharacterSet {
+        return self as CharacterSet
+    }
+}

DarwinShims.swift

@@ -18,7 +18,16 @@
 
 
 internal func testBundle() -> Bundle {
+#if DARWIN_COMPATIBILITY_TESTS
+    for bundle in Bundle.allBundles {
+        if let bundleId = bundle.bundleIdentifier, bundleId == "org.swift.DarwinCompatibilityTests", bundle.resourcePath != nil {
+            return bundle
+        }
+    }
+    fatalError("Cant find test bundle")
+#else
     return Bundle.main
+#endif
 }
 
 class TestBundle : XCTestCase {
@@ -88,14 +97,24 @@ class TestBundle : XCTestCase {
         let bundle = testBundle()
 
         // bundleIdentifier
+#if DARWIN_COMPATIBILITY_TESTS
+        XCTAssertEqual("org.swift.DarwinCompatibilityTests", bundle.bundleIdentifier)
+#else
         XCTAssertEqual("org.swift.TestFoundation", bundle.bundleIdentifier)
-        
+#endif
+
         // infoDictionary
         let info = bundle.infoDictionary
         XCTAssertNotNil(info)
-        XCTAssert("org.swift.TestFoundation" == info!["CFBundleIdentifier"] as! String)
+
+#if DARWIN_COMPATIBILITY_TESTS
+        XCTAssert("DarwinCompatibilityTests" == info!["CFBundleName"] as! String)
+        XCTAssert("org.swift.DarwinCompatibilityTests" == info!["CFBundleIdentifier"] as! String)
+#else
         XCTAssert("TestFoundation" == info!["CFBundleName"] as! String)
-        
+        XCTAssert("org.swift.TestFoundation" == info!["CFBundleIdentifier"] as! String)
+#endif
+
         // localizedInfoDictionary
         XCTAssertNil(bundle.localizedInfoDictionary) // FIXME: Add a localized Info.plist for testing
     }
@@ -204,6 +223,4 @@ class TestBundle : XCTestCase {
         XCTAssertThrowsError(try bundle!.preflight())
         _cleanupPlayground(playground)
     }
-
-
 }

TestFoundation/TestBundle.swift

@@ -244,7 +244,7 @@ class TestHTTPCookieStorage: XCTestCase {
     }
 
     func test_cookieInXDGSpecPath() {
-#if !os(Android)
+#if !os(Android) && !DARWIN_COMPATIBILITY_TESTS
         //Test without setting the environment variable
         let testCookie = HTTPCookie(properties: [
            .name: "TestCookie0",

TestFoundation/TestHTTPCookieStorage.swift

@@ -105,19 +105,27 @@ class TestJSONEncoder : XCTestCase {
     }
 
     func test_encodingOutputFormattingSortedKeys() {
+        let expectedJSON = "{\"email\":\"[email protected]\",\"name\":\"Johnny Appleseed\"}".data(using: .utf8)!
+        let person = Person.testValue
+#if os(OSX) || DARWIN_COMPATIBILITY_TESTS
         if #available(OSX 10.13, iOS 11.0, watchOS 4.0, tvOS 11.0, *) {
-            let expectedJSON = "{\"email\":\"[email protected]\",\"name\":\"Johnny Appleseed\"}".data(using: .utf8)!
-            let person = Person.testValue
             _testRoundTrip(of: person, expectedJSON: expectedJSON, outputFormatting: [.sortedKeys])
         }
+#else
+        _testRoundTrip(of: person, expectedJSON: expectedJSON, outputFormatting: [.sortedKeys])
+#endif
     }
 
     func test_encodingOutputFormattingPrettyPrintedSortedKeys() {
+        let expectedJSON = "{\n  \"email\" : \"[email protected]\",\n  \"name\" : \"Johnny Appleseed\"\n}".data(using: .utf8)!
+        let person = Person.testValue
+#if os(OSX) || DARWIN_COMPATIBILITY_TESTS
         if #available(OSX 10.13, iOS 11.0, watchOS 4.0, tvOS 11.0, *) {
-            let expectedJSON = "{\n  \"email\" : \"[email protected]\",\n  \"name\" : \"Johnny Appleseed\"\n}".data(using: .utf8)!
-            let person = Person.testValue
             _testRoundTrip(of: person, expectedJSON: expectedJSON, outputFormatting: [.prettyPrinted, .sortedKeys])
         }
+#else
+        _testRoundTrip(of: person, expectedJSON: expectedJSON, outputFormatting: [.prettyPrinted, .sortedKeys])
+#endif
     }
 
     // MARK: - Date Strategy Tests
@@ -151,19 +159,18 @@ class TestJSONEncoder : XCTestCase {
     }
 
     func test_encodingDateISO8601() {
-        if #available(OSX 10.12, iOS 10.0, watchOS 3.0, tvOS 10.0, *) {
-            let formatter = ISO8601DateFormatter()
-            formatter.formatOptions = .withInternetDateTime
-
-            let timestamp = Date(timeIntervalSince1970: 1000)
-            let expectedJSON = "[\"\(formatter.string(from: timestamp))\"]".data(using: .utf8)!
-
-            // We can't encode a top-level Date, so it'll be wrapped in an array.
-            _testRoundTrip(of: TopLevelArrayWrapper(timestamp),
-                           expectedJSON: expectedJSON,
-                           dateEncodingStrategy: .iso8601,
-                           dateDecodingStrategy: .iso8601)
-        }
+        let formatter = ISO8601DateFormatter()
+        formatter.formatOptions = .withInternetDateTime
+
+        let timestamp = Date(timeIntervalSince1970: 1000)
+        let expectedJSON = "[\"\(formatter.string(from: timestamp))\"]".data(using: .utf8)!
+
+        // We can't encode a top-level Date, so it'll be wrapped in an array.
+        _testRoundTrip(of: TopLevelArrayWrapper(timestamp),
+                       expectedJSON: expectedJSON,
+                       dateEncodingStrategy: .iso8601,
+                       dateDecodingStrategy: .iso8601)
+
     }
 
     func test_encodingDateFormatted() {

TestFoundation/TestJSONEncoder.swift

@@ -1415,6 +1415,7 @@ extension TestJSONSerialization {
     }
 
     func test_jsonObjectToOutputStreamInsufficientBuffer() {
+#if !DARWIN_COMPATIBILITY_TESTS  // Hangs
         let dict = ["a":["b":1]]
         let buffer = Array<UInt8>(repeating: 0, count: 10)
         let outputStream = OutputStream(toBuffer: UnsafeMutablePointer(mutating: buffer), capacity: buffer.count)
@@ -1428,6 +1429,7 @@ extension TestJSONSerialization {
         } catch {
             XCTFail("Error occurred while writing to stream")
         }
+#endif
     }
 
     func test_booleanJSONObject() {
@@ -1469,18 +1471,23 @@ extension TestJSONSerialization {
             XCTFail("Failed during serialization")
         }
     } 
-    
-    func test_serializeSortedKeys() {
-        var dict: [String: Any]
-
-        dict = ["z": 1, "y": 1, "x": 1, "w": 1, "v": 1, "u": 1, "t": 1, "s": 1, "r": 1, "q": 1, ]
-        XCTAssertEqual(try trySerialize(dict, options: .sortedKeys), "{\"q\":1,\"r\":1,\"s\":1,\"t\":1,\"u\":1,\"v\":1,\"w\":1,\"x\":1,\"y\":1,\"z\":1}")
-
-        dict = ["aaaa": 1, "aaa": 1, "aa": 1, "a": 1]
-        XCTAssertEqual(try trySerialize(dict, options: .sortedKeys), "{\"a\":1,\"aa\":1,\"aaa\":1,\"aaaa\":1}")
 
-        dict = ["c": ["c":1,"b":1,"a":1],"b":["c":1,"b":1,"a":1],"a":["c":1,"b":1,"a":1]]
-        XCTAssertEqual(try trySerialize(dict, options: .sortedKeys), "{\"a\":{\"a\":1,\"b\":1,\"c\":1},\"b\":{\"a\":1,\"b\":1,\"c\":1},\"c\":{\"a\":1,\"b\":1,\"c\":1}}")
+    func test_serializeSortedKeys() {
+        let dict1 = ["z": 1, "y": 1, "x": 1, "w": 1, "v": 1, "u": 1, "t": 1, "s": 1, "r": 1, "q": 1, ]
+        let dict2 = ["aaaa": 1, "aaa": 1, "aa": 1, "a": 1]
+        let dict3 = ["c": ["c":1,"b":1,"a":1],"b":["c":1,"b":1,"a":1],"a":["c":1,"b":1,"a":1]]
+
+#if DARWIN_COMPATIBILITY_TESTS
+        if #available(OSX 10.13, *) {
+            XCTAssertEqual(try trySerialize(dict1, options: .sortedKeys), "{\"q\":1,\"r\":1,\"s\":1,\"t\":1,\"u\":1,\"v\":1,\"w\":1,\"x\":1,\"y\":1,\"z\":1}")
+            XCTAssertEqual(try trySerialize(dict2, options: .sortedKeys), "{\"a\":1,\"aa\":1,\"aaa\":1,\"aaaa\":1}")
+            XCTAssertEqual(try trySerialize(dict3, options: .sortedKeys), "{\"a\":{\"a\":1,\"b\":1,\"c\":1},\"b\":{\"a\":1,\"b\":1,\"c\":1},\"c\":{\"a\":1,\"b\":1,\"c\":1}}")
+        }
+#else
+        XCTAssertEqual(try trySerialize(dict1, options: .sortedKeys), "{\"q\":1,\"r\":1,\"s\":1,\"t\":1,\"u\":1,\"v\":1,\"w\":1,\"x\":1,\"y\":1,\"z\":1}")
+        XCTAssertEqual(try trySerialize(dict2, options: .sortedKeys), "{\"a\":1,\"aa\":1,\"aaa\":1,\"aaaa\":1}")
+        XCTAssertEqual(try trySerialize(dict3, options: .sortedKeys), "{\"a\":{\"a\":1,\"b\":1,\"c\":1},\"b\":{\"a\":1,\"b\":1,\"c\":1},\"c\":{\"a\":1,\"b\":1,\"c\":1}}")
+#endif
     }
 
     func test_serializePrettyPrinted() {

TestFoundation/TestJSONSerialization.swift

@@ -559,8 +559,21 @@ class TestNSArray : XCTestCase {
             try FileManager.default.createDirectory(atPath: tempDir, withIntermediateDirectories: false, attributes: nil)
             let testFile = tempDir + "/readWriteURL.txt"
             let url = URL(fileURLWithPath: testFile)
+            let data2: NSArray
+#if DARWIN_COMPATIBILITY_TESTS
+            if #available(OSX 10.13, *) {
+                try data.write(to: url)
+                data2 = try NSArray(contentsOf: url, error: ())
+            } else {
+                guard data.write(toFile: testFile, atomically: true) else {
+                    throw NSError(domain: NSCocoaErrorDomain, code: CocoaError.fileWriteUnknown.rawValue)
+                }
+                data2 = NSArray(contentsOfFile: testFile)!
+            }
+#else
             try data.write(to: url)
-            let data2 = try NSArray(contentsOf: url, error: ())
+            data2 = try NSArray(contentsOf: url, error: ())
+#endif
             XCTAssertEqual(data, data2)
             removeTestFile(testFile)
         } catch let e {

TestFoundation/TestNSArray.swift

@@ -285,18 +285,21 @@ class TestNSKeyedArchiver : XCTestCase {
 
                 let s1 = String(cString: charPtr)
                 let s2 = String(cString: expectedCharPtr!)
-                
+
+#if !DARWIN_COMPATIBILITY_TESTS
                 // On Darwin decoded strings would belong to the autorelease pool, but as we don't have
                 // one in SwiftFoundation let's explicitly deallocate it here.
                 expectedCharPtr!.deallocate()
-                
+#endif
                 return s1 == s2
         })
     }
 
     func test_archive_user_class() {
+#if !DARWIN_COMPATIBILITY_TESTS  // Causes SIGABRT
         let userClass = UserClass(1234)
         test_archive(userClass)
+#endif
     }
 
     func test_archive_ns_user_class() {

TestFoundation/TestNSKeyedArchiver.swift

@@ -15,6 +15,7 @@ import SwiftFoundation
 import SwiftXCTest
 #endif
 
+#if !DARWIN_COMPATIBILITY_TESTS
 class TestProgressFraction : XCTestCase {
     static var allTests: [(String, (TestProgressFraction) -> () throws -> Void)] {
         return [
@@ -159,4 +160,5 @@ class TestProgressFraction : XCTestCase {
         XCTAssertFalse(r.overflowed)
     }
 }
+#endif