Skip to content

Add Unit Testing Infrastructure #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Add Unit Testing Infrastructure #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
14e5a22
Add an initial unit tests target for XCTest
briancroom Mar 1, 2016
08d5948
Update the Linux build script to include running the unit tests
briancroom Mar 1, 2016
d5ba2b4
Update README documentation about the project's test suites
briancroom Mar 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ To run the tests on Linux, use the `--test` option:
./build_script.py --swiftc="/swift/usr/bin/swiftc" --test
```

To run the tests on OS X, build and run the `SwiftXCTestFunctionalTests` target in the Xcode project. You may also run them via the command line:
To run the tests on OS X, build and run the `SwiftXCTestUnitTests` and `SwiftXCTestFunctionalTests` targets in the Xcode project. You may also run the functional tests via the command line:

```
xcodebuild -project XCTest.xcodeproj -scheme SwiftXCTestFunctionalTests
```

You may add tests for XCTest by including them in the `Tests/Functional/` directory. For an example, see `Tests/Functional/SingleFailingTestCase`.
You may add functional tests for XCTest by including them in the `Tests/Functional/` directory. For an example, see `Tests/Functional/SingleFailingTestCase`. Unit tests should be placed in the `Tests/Unit/` directory, and then referenced in `Tests/Unit/main.swift`.

### Additional Considerations for Swift on Linux

Expand Down
28 changes: 28 additions & 0 deletions Tests/Unit/Resources/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?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>en</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>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>NSHumanReadableCopyright</key>
<string>Copyright (c) 2016 Apple Inc. and the Swift project authors</string>
<key>NSPrincipalClass</key>
<string></string>
</dict>
</plist>
52 changes: 52 additions & 0 deletions Tests/Unit/TestAssertions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2016 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
//

class TestAssertions: XCTestCase {
var allTests: [(String, () throws -> Void)] {
return [
("test_passingAssertionDoesNotCallFailureHandler", test_passingAssertionDoesNotCallFailureHandler),
("test_failedAssertionCallsFailureHandlerWithCorrectFailure", test_failedAssertionCallsFailureHandlerWithCorrectFailure),
]
}

func test_passingAssertionDoesNotCallFailureHandler() {
let failures = captureFailures {
XCTAssert(true)
}

XCTAssertTrue(failures.isEmpty)
}

func test_failedAssertionCallsFailureHandlerWithCorrectFailure() {
let failures = captureFailures {
XCTAssert(false, "This should fail")
}

XCTAssertEqual(failures.count, 1)

let failure = failures.first
XCTAssertEqual(failure?.message, "This should fail")
XCTAssertEqual(failure?.failureDescription, "XCTAssertTrue failed")
XCTAssertTrue(failure?.expected ?? false)

let baseFileName = failure?.file.stringValue.characters.split("/").map(String.init).last
XCTAssertEqual(baseFileName, "TestAssertions.swift")
}

private func captureFailures(closure: () -> Void) -> [XCTFailure] {
var failures = [XCTFailure]()

let oldHandler = XCTFailureHandler
XCTFailureHandler = { failures.append($0) }
closure()
XCTFailureHandler = oldHandler

return failures
}
}
12 changes: 12 additions & 0 deletions Tests/Unit/main.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2016 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
//

XCTMain([
TestAssertions(),
])
115 changes: 114 additions & 1 deletion XCTest.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,13 @@
objects = {

/* Begin PBXBuildFile section */
AE1569EF1C85CB8200A97839 /* main.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE1569EE1C85CB8200A97839 /* main.swift */; };
AE1569F11C85CCF600A97839 /* TestAssertions.swift in Sources */ = {isa = PBXBuildFile; fileRef = AE1569F01C85CCF600A97839 /* TestAssertions.swift */; };
AE1569F21C863C9E00A97839 /* XCTAssert.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F6691C3AEB6A00520CF9 /* XCTAssert.swift */; };
AE1569F31C863C9E00A97839 /* XCTestCase.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66A1C3AEB6A00520CF9 /* XCTestCase.swift */; };
AE1569F41C863C9E00A97839 /* XCTestCaseProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66B1C3AEB6A00520CF9 /* XCTestCaseProvider.swift */; };
AE1569F51C863C9E00A97839 /* XCTestMain.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66C1C3AEB6A00520CF9 /* XCTestMain.swift */; };
AE1569F61C863C9E00A97839 /* XCTimeUtilities.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66D1C3AEB6A00520CF9 /* XCTimeUtilities.swift */; };
C265F66F1C3AEB6A00520CF9 /* XCTAssert.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F6691C3AEB6A00520CF9 /* XCTAssert.swift */; };
C265F6701C3AEB6A00520CF9 /* XCTestCase.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66A1C3AEB6A00520CF9 /* XCTestCase.swift */; };
C265F6711C3AEB6A00520CF9 /* XCTestCaseProvider.swift in Sources */ = {isa = PBXBuildFile; fileRef = C265F66B1C3AEB6A00520CF9 /* XCTestCaseProvider.swift */; };
Expand All @@ -15,6 +22,13 @@
/* End PBXBuildFile section */

/* Begin PBXContainerItemProxy section */
AE1569EC1C85CB6500A97839 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 5B5D86D21BBC74AD00234F36 /* Project object */;
proxyType = 1;
remoteGlobalIDString = 5B5D86DA1BBC74AD00234F36;
remoteInfo = SwiftXCTest;
};
DAA333B91C267AF3000CC115 /* PBXContainerItemProxy */ = {
isa = PBXContainerItemProxy;
containerPortal = 5B5D86D21BBC74AD00234F36 /* Project object */;
Expand All @@ -28,6 +42,10 @@
342A33611C470D91001AA02A /* main.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = main.swift; sourceTree = "<group>"; };
5B5D86DB1BBC74AD00234F36 /* SwiftXCTest.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = SwiftXCTest.framework; sourceTree = BUILT_PRODUCTS_DIR; };
9F320B0D1C4714EC00AB3456 /* main.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = main.swift; sourceTree = "<group>"; };
AE1569DB1C85C9E100A97839 /* SwiftXCTestUnitTests.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = SwiftXCTestUnitTests.app; sourceTree = BUILT_PRODUCTS_DIR; };
AE1569EA1C85CB0100A97839 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
AE1569EE1C85CB8200A97839 /* main.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = main.swift; sourceTree = "<group>"; };
AE1569F01C85CCF600A97839 /* TestAssertions.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestAssertions.swift; sourceTree = "<group>"; };
B1384A411C1B3E8700EDF031 /* CONTRIBUTING.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
B1384A421C1B3E8700EDF031 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
B1384A431C1B3E8700EDF031 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
Expand Down Expand Up @@ -87,6 +105,7 @@
isa = PBXGroup;
children = (
5B5D86DB1BBC74AD00234F36 /* SwiftXCTest.framework */,
AE1569DB1C85C9E100A97839 /* SwiftXCTestUnitTests.app */,
);
name = Products;
sourceTree = "<group>";
Expand All @@ -99,6 +118,24 @@
path = ErrorHandling;
sourceTree = "<group>";
};
AE1569E81C85CA3A00A97839 /* Unit */ = {
isa = PBXGroup;
children = (
AE1569EE1C85CB8200A97839 /* main.swift */,
AE1569F01C85CCF600A97839 /* TestAssertions.swift */,
AE1569E91C85CAE700A97839 /* Resources */,
);
path = Unit;
sourceTree = "<group>";
};
AE1569E91C85CAE700A97839 /* Resources */ = {
isa = PBXGroup;
children = (
AE1569EA1C85CB0100A97839 /* Info.plist */,
);
path = Resources;
sourceTree = "<group>";
};
B1384A401C1B3E6A00EDF031 /* Documentation */ = {
isa = PBXGroup;
children = (
Expand Down Expand Up @@ -133,6 +170,7 @@
isa = PBXGroup;
children = (
DA78F7E81C4039410082E15B /* Functional */,
AE1569E81C85CA3A00A97839 /* Unit */,
);
path = Tests;
sourceTree = "<group>";
Expand Down Expand Up @@ -263,19 +301,38 @@
productReference = 5B5D86DB1BBC74AD00234F36 /* SwiftXCTest.framework */;
productType = "com.apple.product-type.framework";
};
AE1569DA1C85C9E100A97839 /* SwiftXCTestUnitTests */ = {
isa = PBXNativeTarget;
buildConfigurationList = AE1569E71C85C9E100A97839 /* Build configuration list for PBXNativeTarget "SwiftXCTestUnitTests" */;
buildPhases = (
AE1569D71C85C9E100A97839 /* Sources */,
);
buildRules = (
);
dependencies = (
AE1569ED1C85CB6500A97839 /* PBXTargetDependency */,
);
name = SwiftXCTestUnitTests;
productName = SwiftXCTestUnitTests;
productReference = AE1569DB1C85C9E100A97839 /* SwiftXCTestUnitTests.app */;
productType = "com.apple.product-type.application";
};
/* End PBXNativeTarget section */

/* Begin PBXProject section */
5B5D86D21BBC74AD00234F36 /* Project object */ = {
isa = PBXProject;
attributes = {
LastSwiftUpdateCheck = 0710;
LastSwiftUpdateCheck = 0730;
LastUpgradeCheck = 0710;
ORGANIZATIONNAME = Apple;
TargetAttributes = {
5B5D86DA1BBC74AD00234F36 = {
CreatedOnToolsVersion = 7.1;
};
AE1569DA1C85C9E100A97839 = {
CreatedOnToolsVersion = 7.3;
};
DAA333B51C267AD6000CC115 = {
CreatedOnToolsVersion = 7.2;
};
Expand All @@ -296,6 +353,7 @@
targets = (
5B5D86DA1BBC74AD00234F36 /* SwiftXCTest */,
DAA333B51C267AD6000CC115 /* SwiftXCTestFunctionalTests */,
AE1569DA1C85C9E100A97839 /* SwiftXCTestUnitTests */,
);
};
/* End PBXProject section */
Expand Down Expand Up @@ -323,9 +381,28 @@
);
runOnlyForDeploymentPostprocessing = 0;
};
AE1569D71C85C9E100A97839 /* Sources */ = {
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
AE1569F11C85CCF600A97839 /* TestAssertions.swift in Sources */,
AE1569F51C863C9E00A97839 /* XCTestMain.swift in Sources */,
AE1569F61C863C9E00A97839 /* XCTimeUtilities.swift in Sources */,
AE1569F41C863C9E00A97839 /* XCTestCaseProvider.swift in Sources */,
AE1569F21C863C9E00A97839 /* XCTAssert.swift in Sources */,
AE1569F31C863C9E00A97839 /* XCTestCase.swift in Sources */,
AE1569EF1C85CB8200A97839 /* main.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
/* End PBXSourcesBuildPhase section */

/* Begin PBXTargetDependency section */
AE1569ED1C85CB6500A97839 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 5B5D86DA1BBC74AD00234F36 /* SwiftXCTest */;
targetProxy = AE1569EC1C85CB6500A97839 /* PBXContainerItemProxy */;
};
DAA333BA1C267AF3000CC115 /* PBXTargetDependency */ = {
isa = PBXTargetDependency;
target = 5B5D86DA1BBC74AD00234F36 /* SwiftXCTest */;
Expand Down Expand Up @@ -457,6 +534,33 @@
};
name = Release;
};
AE1569E51C85C9E100A97839 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
CLANG_ENABLE_MODULES = YES;
CODE_SIGN_IDENTITY = "-";
COMBINE_HIDPI_IMAGES = YES;
INFOPLIST_FILE = Tests/Unit/Resources/Info.plist;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = org.swift.SwiftXCTestUnitTests;
PRODUCT_NAME = "$(TARGET_NAME)";
SWIFT_OPTIMIZATION_LEVEL = "-Onone";
};
name = Debug;
};
AE1569E61C85C9E100A97839 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
CLANG_ENABLE_MODULES = YES;
CODE_SIGN_IDENTITY = "-";
COMBINE_HIDPI_IMAGES = YES;
INFOPLIST_FILE = Tests/Unit/Resources/Info.plist;
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks";
PRODUCT_BUNDLE_IDENTIFIER = org.swift.SwiftXCTestUnitTests;
PRODUCT_NAME = "$(TARGET_NAME)";
};
name = Release;
};
DAA333B61C267AD6000CC115 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
Expand Down Expand Up @@ -503,6 +607,15 @@
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
AE1569E71C85C9E100A97839 /* Build configuration list for PBXNativeTarget "SwiftXCTestUnitTests" */ = {
isa = XCConfigurationList;
buildConfigurations = (
AE1569E51C85C9E100A97839 /* Debug */,
AE1569E61C85C9E100A97839 /* Release */,
);
defaultConfigurationIsVisible = 0;
defaultConfigurationName = Release;
};
DAA333B81C267AD6000CC115 /* Build configuration list for PBXLegacyTarget "SwiftXCTestFunctionalTests" */ = {
isa = XCConfigurationList;
buildConfigurations = (
Expand Down
Loading