Unit Testing Helper

Provides an extended XCTestCase (XCExtenedTestCase) that gives access to helper methods for printing and accessing the filesystem relative to the project. This last part comes in handy whey testing on different platforms as files that need to be read from the filesystem can be located relative from the project or test folders instead of using absolute paths.

NOTE: As of Xcode 12.5 you must enable 'Enable Testing Search Paths' for the UnitTestingHelper target. This is only for Xcode 12.5+ as building directly with Swift CLI still works with no additional changes

XCExtenedTestCase:

Properties:

• isXcodeTesting: Indicator if running withing Xcode
• projectURL: URL to the current project
• testsURL: URL to the projects Tests folder
• testTargetURL: URL to the target test folder
• testTargetName: Returns the name of the current Test Target
• canPrint: Indicator if new print method should output. This is overridable
• canVerbosePrint: Indicator if new verbosePrint method should output. This is overridable
• canDebugPrint: Indicator if new debugPrint method should output. This is overridable

Methods:

• print: Prints text when canPrint returns true
• verbosePrint: Prints text when canVerbosePrint returns true
• debugPrint: Prints text when canDebugPrint returns true
• withPrint: Ignores canPrint when calling print method within block so that it always prints
• withoutPrint: Ignores canPrint when calling print method within block so that it never prints
• withVerbosePrint: Ignores canVerbosePrint when calling verbosePrint method within block so that it always prints
• withoutVerbosePrint: Ignores canVerbosePrint when calling verbosePrint method within block so that it never prints
• withDebugPrint: Ignores canDebugPrint when calling debugPrint method within block so that it always prints
• withoutDebugPrint: Ignores canDebugPrint when calling debugPrint method within block so that it never prints
• withAnyPrint: Ignores any can..Print indicators when calling any print method within block so that they always print
• withAnyPrint: Ignores any can..Print indicators when calling any print method within block so that they never print

XCTAsserts

• XCTAsserts: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsEqual: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsNotEqual: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsTrue: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsFalse: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsGreaterThan: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsGreaterThanEqual: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsLessThan: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsLessThanEqual: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsNil: Similar to the origion but will return a bool indictor if the test was successful
• XCTAssertsNotNil: Similar to the origion but will return results from the expression
• XCTAssertsNoThrow: Returns the result of the code block or nil if an error was thrown or a bool if the block results was Void
• XCTAssertsThrow: Returns the error that was thrown or nil if no error was thrown
• XCTAssertsContains: Tests if a collection contains a condition or element
• XCTAssertsNotContains: Tests if a collection does not contain a condition or element

Requirements

• Xcode 9+ (If working within Xcode)
• Swift 4.0+

Usage

import UnitTestingHelper

class TargetTests: XCExtenedTestCase {
    override class func setUp() {
        super.setUp()
        initTestingFile() //This must be called otherwise path properties will not work
    }

    func test() {
        let workingFile = self.testTargetURL.appendPathComponent("testfile.ext")
        do {
            let workingData = try Data(contentsOf: workingFile)
            // Process file here
            ...
        } catch {
            ...
        }
    }
    ...

    func process() throws -> Object {
        ...
    }
    func process2() throws -> Object {
        ...
    }

    func testAsserts() {
        /*
            // Old way
            do {
                let obj = try process()
                let obj2 = try process2()

                XCTAssertTrue(obj1, obj2)
                if obj1 == obj2 {
                     // Only do extra test here of both obj1 and obj2 equals
                }
            } catch {
                // From here we can't easily tell where the error was thrown from
            }
        */

        // New way
        guard let obj = XCTAssertsNoThrow(try process()) else {
            // if object couldn't be created we stop everythig else
            return
        }
        guard let obj2 = XCTAssertsNoThrow(try process2()) else {
            // if object2 couldn't be created we stop everythig else
            return
        }

        if XCTAssertsEqual(obj1, obj2) {
            // Only do extra test here of both obj1 and obj2 equals
        }
        ...
    }
}

Author

• Tyler Anger - Initial work - TheAngryDarling

License

Copyright 2020 Tyler Anger

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

HERE or http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.