WWDC Notes

Write tests to fail

Show Apple's description.
Plan for failure: Design great tests to help you find and diagnose even the toughest bugs. Learn how to improve your automated tests with XCTest to find hidden issues in even the best code. We’ll explain how to prepare your tests for failure to make triaging issues easier, letting you solve interface issues and deliver fixes quickly. To get the most out of this session, you should already be familiar with writing UI tests within the XCTest framework. For more on testing tools, head over to “The suite life of testing”.
  • Your main focus while writing Tests is to fail

The test template follows this pattern

  • Set up
  • Test: actions
  • Test: assertions
  • Tear down

Set Up

  • This is where you explicitly state the required assumptions and set the right environment for your app to run in
  • You can use setUpWithError() throws that allows you to throw an error during your set up, you may need this in a case for example where your previous tests have modifier the state of your app, example:
class RecipesTests: XCTestCase {
	let app = FrutaApp()

	override func setUpWithError() throws {
    	continueAfterFailure = false
    	app.launchArguments.append("-recipes-tests")
    	app.launch()
	}
}
  • continueAfterFailure = false causes your testing process to stop immediately instead of test failing for no obvious reasons
  • launchArguments can be used to pass flags to bypass certain parts of your app, for example, here we’re bypassing the first tap .menu and jumping to the last one .recipes:
@State private var selection: Tab = CommandLine.arguments.contains("-recipes-tests") ? .recipes : .menu

Test: actions

  • Tests names should reflect what the test is doing
  • Minimize the number of actions a test is doing as much as possible
  • Use enum cases to extract typed Strings from your tests, this makes it easier to update them later, and reduces the not-so-obvious errors coming from misspelling strings
  • Factor out common code into separate functions to reduce repetitive bits and allow for more time to focus on hardening these paths to reduce errors
  • Try to model your app domain and design a test language around those models, for example, here we’re creating a FrutaApp object that can retrieve an array of SmoothieList:
public class FrutaApp : XCUIApplication {
  public func smoothieList() throws -> SmoothieList {  }
} 

public class SmoothieList : FrutaUIElement {
  public func selectRecipe(smoothie: SmoothieType) throws -> Recipe {  }
}
  • This helps in increasing the readability of your code and organizes the hierarchy of objects
  • Consider creating shared frameworks or shared Swift Packages when your test codebase becomes large, and especially when sharing code between multiple applications

Test: assertions

  • Try to make use of optional descriptions in different XCTAssert* functions as much as possible, this gives more context for failure messages when viewed from the test results bundle
XCTAssertEqual(
	count, 
	expectedCount, 
	"\(SmoothieType.berryBlue.rawValue) smoothie is expected to have \(expectedCount) ingredients: \(expectedIngredients), however, there were \(count) found."
)

Leave out too specific details such as date, timestamps and file paths from your assertion messages

  • When testing asynchronous logic, avoid using sleep(), you should otherwise use built in wait functions such as waitForExistence , this allows you to thrown a custom error and lets you view the time async operations took to finish in the tests results
  • Unwrap your optionals gracefully, force unwrapping causes crashes and halts your tests, examples of techniques that can be used to unwrap optionals:
if let favs = favorites {  }
guard let favs = favorites else { /* throw an error */ }
let favs = favorites ?? []
let favs = try XCTUnwrap(favorites, "favorites is nil, so there is nothing to count”)

Unlike crashing, failing a test gracefully on unwrap allows your teardown method to be called

  • User throw in your shared code functions this allows sharing basic testing logic between different test cases, you can also throw custom errors to give more clear error messages:
public func verify(ingredients: [String]) throws {
	...
	throw RecipeError.ingredientDoesNotExist(ingredient)
}

public enum RecipeError : Error, CustomStringConvertible {
	case ingredientDoesNotExist(String)

	public var description : String {
    	switch self {
    	case .ingredientDoesNotExist(let ingredient):
        	return "\(ingredient) does not exist in the Ingredients View.)"
    	}
	}
}

New in Xcode 12, you can see the back trace for thrown errors, which allows you to see directly from which inner/shared code an error was thrown

  • Use XCTContext.runActivity() to provide custom entries in your results bundle that helps identifying the current context, you can add XCTAttachment as well and it will show along the given context:
public func verify(ingredients: [String]) throws {
	try XCTContext.runActivity(named: "Verifying \(ingredients) exists in the Recipe screen.")
	{ verifyingRecipe in
    	for ingredient in ingredients {
        	if !element.switches[ingredient].waitForExistence(timeout: 5) {
            	let attachment = XCTAttachment(string: element.debugDescription)
            	verifyingRecipe.add(attachment)
            	 throw RecipeError.ingredientDoesNotExist(ingredient)
        	}
    	}
	}
}
  • Use XCTSkip(), XCTSkipIf() and XCTSkipUnless() when you want to skip certain test cases when it’s not a suitable time for them to run, or they’re not relevant to a certain platform
  • This is particularly useful for when a test is failing due to flawed code that is due fixing in the near future, or for when the test is written before the code itself
  • Skipping the test will still make it appear in the results bundle, reminding you that you still have to go back and fill that missing code or fix it at sometime

Tear Down

  • Use tearDownWithError() throws and take advantage of the provided error management
  • Collect additional logging that’s relevant to your tests, including some analysis of the failures
  • Remember to reset the environment from the changes that were done during the set up

Missing anything? Corrections? Contributions are welcome 😃

Related

Written by

ATahhan

Ammar AlTahhan

Ammar AlTahhan A software engineer with a good knowledge in iOS, web development as well as graphics, UI and UX design. Teaching iOS passionately. Deeply interested in CI/CD and faster deployment processes.