找出要测试的内容
在编写任何测试之前,了解基础知识很重要。您需要测试什么?
如果您的目标是扩展现有应用程序,则应首先为计划更改的任何组件编写测试。
通常,测试应涵盖:
- 核心功能:模型类和方法及其与控制器的交互
- 最常见的UI工作流程
- 边界条件
- Bug修复
测试最佳实践
下面描述了有效单元测试的一组简明标准。这些标准是:
- 快速:测试应该快速进行。
- 独立/隔离:测试不应相互共享状态。
- 可重复:每次运行测试时,您都应获得相同的结果。外部数据提供者或并发问题可能会导致间歇性故障。
- 自我验证:测试应完全自动化。输出应该是“通过”或“失败”,而不是依赖于程序员对日志文件的解释。
- 及时:理想情况下,应该在编写测试的生产代码之前编写测试(测试驱动开发)。
遵循上面原则将使您的测试清晰,有用,而不会成为您应用程序的障碍。
入门
有两个单独的入门项目:BullsEye和HalfTunes。
-
BullsEye基于iOS Apprentice中的示例应用程序。游戏逻辑在
BullsEyeGame
该类中,您将在本教程中进行测试。 - HalfTunes是URLSession教程示例应用程序的更新版本。用户可以在iTunes API中查询歌曲,然后下载并播放歌曲片段。
Xcode中的单元测试
该测试导航提供与测试工作的最简单的方法; 您将使用它来创建测试目标并针对您的应用运行测试。
创建单元测试目标
打开BullsEye项目,然后按Command-6打开Test导航器。
单击左下角的+按钮,然后从菜单中选择“ 新建单元测试目标 ”:
接受默认名称BullsEyeTests。当测试捆绑包出现在“测试”导航器中时,单击以在编辑器中打开捆绑包。如果捆绑软件未自动显示,请通过单击其他导航器之一进行故障排除,然后返回到“测试”导航器。
默认的模板导入测试框架,XCTest,并定义一个BullsEyeTests
子类XCTestCase
,用setUp()
,tearDown()
以及例如测试方法。
有三种运行测试的方法:
- Product▸Build▸Test或Command-U。这两个都运行所有测试类。
- 单击“测试”导航器中的箭头按钮。
- 单击装订线中的菱形按钮。
您也可以通过在“测试”导航器或装订线中单击其菱形来运行单个测试方法。
尝试不同的方式运行测试,以了解所需的时间和外观。样本测试还没有做任何事情,因此它们运行得非常快!
当所有测试成功时,菱形将变为绿色并显示选中标记。您可以单击末尾的灰色菱形testPerformanceExample()
以打开性能结果:
使用XCTAssert测试模型
首先,您将使用XCTAssert
函数来测试BullsEye模型的核心功能:BullsEyeGame
对象是否正确计算出回合的分数?
在BullsEyeTests.swift中,在import
语句下面添加以下行:
@testable import BullsEye
这使单元测试可以访问BullsEye中的内部类型和函数。
在BullsEyeTests
类的顶部,添加以下属性:
var sut:BullsEyeGame!
这将为占位符创建占位符,占位符BullsEyeGame
是被测系统(SUT)或此测试用例类与测试有关的对象。
接下来,将其内容替换为setup()
:
super.setUp()
sut = BullsEyeGame()
sut.startNewGame()
这将BullsEyeGame
在类级别创建一个对象,因此该测试类中的所有测试都可以访问SUT对象的属性和方法。
在这里,您还调用了游戏的startNewGame()
,它会初始化targetValue
。许多测试将targetValue
用来测试游戏是否正确计算了分数。
在忘记之前,请在中释放您的SUT对象tearDown()
。将其内容替换为:
sut = nil
super .tearDown()
注意:比较好的作法是在
setUp()
中创建SUT并在tearDown()
中将其释放,以确保每次测试均以初始的状态开始。
编写您的第一个测试
现在,您准备编写第一个测试!
将以下代码添加到的末尾BullsEyeTests
:
func testScoreIsComputed() {
// 1. given
let guess = sut.targetValue + 5
// 2. when
sut.check(guess: guess)
// 3. then
XCTAssertEqual(sut.scoreRound, 95, "Score computed from guess is wrong")
}
单击装订线或“测试”导航器中的菱形图标,运行测试。这将构建并运行该应用程序,菱形图标将变为绿色的选中标记!
注意:要查看XCTestAssertions的完整列表,请转到Apple的“按类别列出的断言”。
调试测试
有一个BullsEyeGame
故意内置的错误,您将练习找到它。要查看运行中的错误,您将创建一个测试,该测试在给定的部分中减去 5 ,并使其他所有内容保持不变。targetValue
添加以下测试:
func testScoreIsComputedWhenGuessLTTarget() {
// 1. given
let guess = sut.targetValue - 5
// 2. when
sut.check(guess: guess)
// 3. then
XCTAssertEqual(sut.scoreRound, 95, "Score computed from guess is wrong")
}
guess
和之间的差targetValue
仍为5,因此分数仍应为95。
在Breakpoint导航器中,添加Test Failure Breakpoint。当测试方法发生故障断言时,这将停止测试运行。
运行测试,它应该在XCTAssertEqual
测试失败的那一行停止。
检查sut
并guess
在调试控制台中:
guess
是targetValue - 5
但是scoreRound
是105,而不是95!
为了进一步研究,使用正常的调试过程:设置一个断点,并在一个BullsEyeGame.swift,里面check(guess:)
,在那里创建difference
。然后再次运行测试,并通过let difference
语句检查difference
应用程序中的值:
问题是,它difference
是负数,所以得分是100 –(-5)。为了解决这个问题,你应该使用绝对值的difference
。在中check(guess:)
,取消注释正确的行并删除不正确的行。
删除两个断点,然后再次运行测试以确认现在可以成功了。
使用XCTestExpectation测试异步操作
既然您已经了解了如何测试模型和调试测试失败,那么现在该继续测试异步代码了。
打开HalfTunes项目。它用于URLSession
查询iTunes API和下载歌曲样本。假设您想对其进行修改以使用AlamoFire进行网络操作。要查看是否有任何中断,您应该为网络操作编写测试,并在更改代码之前和之后运行它们。
URLSession
方法是异步的:它们立即返回,但是要等到以后再运行。要测试异步方法,您XCTestExpectation
可以使测试等待异步操作完成。
异步测试通常很慢,因此应将它们与更快的单元测试分开。
创建一个名为HalfTunesSlowTests的新单元测试目标。打开HalfTunesSlowTests
该类,并在现有import
语句的下面导入HalfTunes应用模块:
@testable import HalfTunes
此类中的所有测试都使用默认值URLSession
将请求发送到Apple的服务器,因此声明一个sut
对象,在中创建它,setUp()
然后在中释放它tearDown()
。
将HalfTunesSlowTests
类的内容替换为:
var sut: URLSession!
override func setUp() {
super.setUp()
sut = URLSession(configuration: .default)
}
override func tearDown() {
sut = nil
super.tearDown()
}
接下来,添加此异步测试:
// Asynchronous test: success fast, failure slow
func testValidCallToiTunesGetsHTTPStatusCode200() {
// given
let url = URL(string: "https://itunes.apple.com/search?media=music&entity=song&term=abba")
// 1
let promise = expectation(description: "Status code: 200")
// when
let dataTask = sut.dataTask(with: url!) { data, response, error in
// then
if let error = error {
XCTFail("Error: \(error.localizedDescription)")
return
} else if let statusCode = (response as? HTTPURLResponse)?.statusCode {
if statusCode == 200 {
// 2
promise.fulfill()
} else {
XCTFail("Status code: \(statusCode)")
}
}
}
dataTask.resume()
// 3
wait(for: [promise], timeout: 5)
}
此测试检查向iTunes发送有效查询是否返回200状态码。大多数代码与您在应用程序中编写的代码相同,但有以下几行:
-
Expectation(description :):返回
XCTestExpectation
存储在中的对象promise
。该description
参数描述了您期望发生的事情。 - promise.fulfill():在异步方法的完成处理程序的成功条件关闭中调用此函数,以标记已满足期望。
-
wait(for:timeout :):保持测试运行,直到满足所有期望或
timeout
间隔结束(以先发生者为准)。
运行测试。如果您已连接到互联网,则在将应用程序加载到模拟器中后,测试应该需要大约一秒钟才能成功。
您可以通过更改以下假设来改进此方法,并使测试更快失败:不要等待请求成功,而要等到异步方法的完成处理程序被调用。一旦应用程序从服务器接收到满足预期的响应(无论是正常还是错误),就会发生这种情况。然后,您的测试可以检查请求是否成功。
要查看其工作原理,请创建一个新测试。
但首先,通过撤消对所做的更改来修复以前的测试url
。
然后,将以下测试添加到您的类中:
// Asynchronous test: faster fail
func testCallToiTunesCompletes() {
// given
let url = URL(string: "https://itunes.apple.com/search?media=music&entity=song&term=abba")
// 1
let promise = expectation(description: "Completion handler invoked")
var statusCode: Int?
var responseError: Error?
// when
let dataTask = sut.dataTask(with: url!) { data, response, error in
statusCode = (response as? HTTPURLResponse)?.statusCode
responseError = error
// 2
promise.fulfill()
}
dataTask.resume()
// 3
wait(for: [promise], timeout: 5)
// then
XCTAssertNil(responseError)
XCTAssertEqual(statusCode, 200)
}
关键区别在于,只需输入完成处理程序即可满足期望,而这仅需一秒钟即可完成。如果请求失败,则then
断言失败。
运行测试。现在大约需要一秒钟才能失败。它失败是因为请求失败,而不是因为测试运行超出了timeout
。
修复url
,然后再次运行测试以确认现在可以成功进行。
伪造对象和互动
异步测试使您有信心代码可以为异步API生成正确的输入。您可能还需要测试,当代码从接收到输入时,代码是否可以正常工作URLSession
,或者它可以正确更新用户的默认数据库或iCloud容器。
大多数应用程序都与系统或库对象(您无法控制的对象)进行交互,并且与这些对象进行交互的测试可能很慢且不可重复,这违反了FIRST的两项原则。相反,您可以通过从存根获取输入或通过更新模拟对象来伪造交互。
当您的代码对系统或库对象有依赖性时,请进行伪造。您可以通过创建一个假的对象来演那个角色,做这个注射这个假入你的代码。乔恩·里德(Jon Reid)的依赖注入描述了几种方法。
来自存根的假输入
在此测试中,您将通过检查应用程序updateSearchResults(_:)
是否正确分析了会话下载的数据searchResults.count
是否正确。SUT是视图控制器,您将使用存根和一些预下载的数据来伪造会话。
转到“测试”导航器并添加一个新的“ 单元测试目标”。将其命名为HalfTunesFakeTests。打开HalfTunesFakeTests.swift并导入以下import
语句下方的HalfTunes应用模块:
@testable import HalfTunes
现在,用以下内容替换HalfTunesFakeTests
类的内容:
var sut: SearchViewController!
override func setUp() {
super.setUp()
sut = UIStoryboard(name: "Main", bundle: nil)
.instantiateInitialViewController() as? SearchViewController
}
override func tearDown() {
sut = nil
super.tearDown()
}
这将声明为SUT,SearchViewController
在中创建它并在setUp()
其中释放它tearDown()
:
注意:SUT是视图控制器,因为HalfTunes有一个很大的视图控制器问题-所有工作都在SearchViewController.swift中完成。将网络代码移动到单独的模块中将减少此问题,并使测试更加容易。
接下来,您将需要一些示例JSON数据,您的虚假会话将这些数据提供给测试。仅需执行以下几项操作,因此要限制您在iTunes中的下载结果,请附加&limit=3
到URL字符串:
https://itunes.apple.com/search?media=music&entity=song&term=abba& limit = 3
复制此URL并将其粘贴到浏览器中。这将下载一个名为1.txt,1.txt.js或类似文件。预览它以确认它是一个JSON文件,然后将其重命名为abbaData.json。
现在,返回到Xcode并转到项目导航器。将文件添加到HalfTunesFakeTests组。
HalfTunes项目包含支持文件DHURLSessionMock.swift。这定义了一个简单的协议,名为DHURLSession
,带有方法(存根)以使用a URL
或a 创建数据任务URLRequest
。它还定义了URLSessionMock
,它使用初始化程序符合此协议,该初始化程序使您URLSession
可以选择数据,响应和错误来创建模拟对象。
要设置伪造品,请转到HalfTunesFakeTests.swift并在setUp()
创建SUT的语句之后在中添加以下内容:
let testBundle = Bundle(for: type(of: self))
let path = testBundle.path(forResource: "abbaData", ofType: "json")
let data = try? Data(contentsOf: URL(fileURLWithPath: path!), options: .alwaysMapped)
let url = URL(string: "https://itunes.apple.com/search?media=music&entity=song&term=abba")
let urlResponse = HTTPURLResponse(url: url!, statusCode: 200, httpVersion: nil, headerFields: nil)
let sessionMock = URLSessionMock(data: data, response: urlResponse, error: nil)
sut.defaultSession = sessionMock
这将设置假数据和响应并创建假会话对象。最后,最后,它将伪造的会话作为的属性注入到应用程序中sut
。
现在,您可以编写测试来检查调用是否updateSearchResults(_:)
解析伪数据了。添加以下测试:
func test_UpdateSearchResults_ParsesData() {
// given
let promise = expectation(description: "Status code: 200")
// when
XCTAssertEqual(sut.searchResults.count, 0, "searchResults should be empty before the data task runs")
let url = URL(string: "https://itunes.apple.com/search?media=music&entity=song&term=abba")
let dataTask = sut.defaultSession.dataTask(with: url!) {
data, response, error in
// if HTTP request is successful, call updateSearchResults(_:) which parses the response data into Tracks
if let error = error {
print(error.localizedDescription)
} else if let httpResponse = response as? HTTPURLResponse,
httpResponse.statusCode == 200 {
self.sut.updateSearchResults(data)
}
promise.fulfill()
}
dataTask.resume()
wait(for: [promise], timeout: 5)
// then
XCTAssertEqual(sut.searchResults.count, 3, "Didn't parse 3 items from fake response")
}
您仍然必须将其编写为异步测试,因为存根假装是异步方法。
该时的说法是,searchResults
是数据任务执行前空。这应该是正确的,因为您在中创建了一个全新的SUT setUp()
。
假数据包含三个JSON Track
对象,所以然后断言是视图控制器的searchResults
阵列包含三个项目。
运行测试。它应该很快就能成功,因为没有任何真正的网络连接!
假更新到模拟对象
先前的测试使用存根提供来自假对象的输入。接下来,您将使用模拟对象来测试代码是否正确更新UserDefaults
。
重新打开BullsEye项目。该应用程序具有两种游戏风格:用户要么移动滑块以匹配目标值,要么从滑块位置猜测目标值。右下角的分段控件可切换游戏样式并将其保存在用户默认设置中。
您的下一个测试将检查应用程序是否正确保存了gameStyle
属性。
在“测试”导航器中,单击“ 新建单元测试类”,并将其命名为BullsEyeMockTests。在import
语句下面添加以下内容:
@testable import BullsEye
class MockUserDefaults: UserDefaults {
var gameStyleChanged = 0
override func set(_ value: Int, forKey defaultName: String) {
if defaultName == "gameStyle" {
gameStyleChanged += 1
}
}
}
MockUserDefaults
重写set(_:forKey:)
以增加gameStyleChanged
标志。通常,您会看到类似的测试会设置一个Bool
变量,但是增加Int
会给您带来更大的灵活性-例如,您的测试可以检查该方法仅被调用一次。
在中声明SUT和模拟对象BullsEyeMockTests
:
var sut: ViewController!
var mockUserDefaults: MockUserDefaults!
接下来,替换默认setUp()
和tearDown()
与此:
override func setUp() {
super.setUp()
sut = UIStoryboard(name: "Main", bundle: nil).instantiateInitialViewController() as? ViewController
mockUserDefaults = MockUserDefaults(suiteName: "testing")
sut.defaults = mockUserDefaults
}
override func tearDown() {
sut = nil
mockUserDefaults = nil
super.tearDown()
}
这将创建SUT和模拟对象,并将模拟对象作为SUT的属性注入。
现在,将模板中的两个默认测试方法替换为:
func testGameStyleCanBeChanged() {
// given
let segmentedControl = UISegmentedControl()
// when
XCTAssertEqual(mockUserDefaults.gameStyleChanged, 0, "gameStyleChanged should be 0 before sendActions")
segmentedControl.addTarget(sut,
action: #selector(ViewController.chooseGameStyle(_:)), for: .valueChanged)
segmentedControl.sendActions(for: .valueChanged)
// then
XCTAssertEqual(mockUserDefaults.gameStyleChanged, 1, "gameStyle user default wasn't changed")
}
在当断言是该gameStyleChanged
标志为0的测试方法改变分段控制之前。因此,如果then断言也成立,则意味着只set(_:forKey:)
被调用了一次。
运行测试;它应该成功。
Xcode中的UI测试
UI测试使您可以测试与用户界面的交互。UI测试的工作方式是通过查询查找应用程序的UI对象,综合事件,然后将事件发送到这些对象。API使您可以检查UI对象的属性和状态,以便将它们与预期状态进行比较。
在BullsEye项目的Test导航器中,添加一个新的UI Test Target。检查要测试的目标是BullsEye,然后接受默认名称BullsEyeUITests。
打开BullsEyeUITests.swift并将此属性添加到BullsEyeUITests
类的顶部:
var app:XCUIApplication!
在中setUp()
,将语句替换XCUIApplication().launch()
为以下内容:
app = XCUIApplication()
app.launch()
将名称更改testExample()
为testGameStyleSwitch()
。
在其中打开新行,testGameStyleSwitch()
然后单击编辑器窗口底部的红色“ 记录”按钮:
这会以将您的互动记录为测试命令的模式在模拟器中打开该应用。应用加载后,点击游戏样式开关的“ 滑动”部分和顶部标签。然后,单击“ Xcode记录”按钮以停止记录。
现在,您在以下三行中testGameStyleSwitch()
:
let app = XCUIApplication()
app.buttons["Slide"].tap()
app.staticTexts["Get as close as you can to: "].tap()
记录器已创建代码以测试您在应用程序中测试的相同操作。将水龙头发送到滑块和标签。您将以这些为基础来创建自己的UI测试。
如果您看到其他任何语句,只需删除它们即可。
第一行与您在中创建的属性重复setUp()
,因此请删除该行。您无需点击任何内容,因此也请.tap()
在第2行和第3行的末尾删除。现在,打开旁边的小菜单,["Slide"]
然后选择segmentedControls.buttons["Slide"]
。
您剩下的应该是以下内容:
app.segmentedControls.buttons["Slide"]
app.staticTexts["Get as close as you can to: "]
点击其他任何对象,让记录器帮助您找到可以在测试中访问的代码。现在,用以下代码替换这些行以创建给定的部分:
// given
let slideButton = app.segmentedControls.buttons["Slide"]
let typeButton = app.segmentedControls.buttons["Type"]
let slideLabel = app.staticTexts["Get as close as you can to: "]
let typeLabel = app.staticTexts["Guess where the slider is: "]
现在您已经有了分段控件中两个按钮的名称以及两个可能的顶部标签,在下面添加以下代码:
// then
if slideButton.isSelected {
XCTAssertTrue(slideLabel.exists)
XCTAssertFalse(typeLabel.exists)
typeButton.tap()
XCTAssertTrue(typeLabel.exists)
XCTAssertFalse(slideLabel.exists)
} else if typeButton.isSelected {
XCTAssertTrue(typeLabel.exists)
XCTAssertFalse(slideLabel.exists)
slideButton.tap()
XCTAssertTrue(slideLabel.exists)
XCTAssertFalse(typeLabel.exists)
}
这将检查您tap()
在分段控件中的每个按钮上是否存在正确的标签。运行测试-所有断言都应成功。
性能测试
根据Apple的文档:性能测试采用您要评估的代码块并将其运行十次,以收集运行的平均执行时间和标准差。这些单独测量值的平均值形成测试运行的值,然后可以将其与基准进行比较以评估成功或失败。
编写性能测试非常简单:您只需将要测量的代码放入的闭包中measure()
。
要查看实际效果,请重新打开HalfTunes项目,并在HalfTunesFakeTests.swift中添加以下测试:
// Performance
func test_StartDownload_Performance() {
let track = Track(name: "Waterloo", artist: "ABBA",
previewUrl: "http://a821.phobos.apple.com/us/r30/Music/d7/ba/ce/mzm.vsyjlsff.aac.p.m4a")
measure {
self.sut.startDownload(track)
}
}
运行测试,然后单击measure()
尾随闭包开头旁边的图标以查看统计信息。
单击设置基准以设置参考时间。然后,再次运行性能测试并查看结果-它可能比基准更好或更差。使用“ 编辑”按钮可以将基准重置为该新结果。
基准是按设备配置存储的,因此您可以在多个不同的设备上执行相同的测试,并且根据特定配置的处理器速度,内存等,使每个基准保持不同的基准。
每当您对应用程序进行更改而可能影响所测试方法的性能时,请再次运行性能测试以查看其与基准的比较情况。
代码覆盖率
代码覆盖率工具会告诉您测试实际上正在运行哪些应用程序代码,因此您知道该应用程序代码的哪些部分尚未(尚未)测试。
要启用代码覆盖率,请编辑方案的“ 测试”操作,然后选中“ 选项”选项卡下的“ 收集覆盖率”复选框:
运行所有测试(Command-U),然后打开报告导航器(Command-9)。选择该列表顶部项目下的Coverage:
单击显示三角形,以查看SearchViewController.swift中的函数和闭包列表:
向下滚动updateSearchResults(_:)
以查看覆盖率为87.9%。
单击此功能的箭头按钮以打开该功能的源文件。当您将鼠标悬停在右侧栏中的coverage注释上时,代码部分将突出显示绿色或红色:
覆盖注释显示测试击中每个代码段的次数;未调用的部分以红色突出显示。如您所料,for循环运行了3次,但错误路径中的任何内容均未执行。
要增加此功能的覆盖范围,可以复制abbaData.json,然后对其进行编辑,以免引起不同的错误。例如,更改"results"
到"result"
一个测试命中print("Results key not found in dictionary")
。
100%覆盖率?
您应该努力争取100%的代码覆盖率吗?Google的“ 100%单元测试覆盖率”,您会发现一系列支持和反对的论点,以及有关“ 100%覆盖率”这一定义的争论。反对它的人说最后的10-15%不值得付出努力。关于它的争论说最后的10-15%是最重要的,因为它很难测试。谷歌“很难对不良设计进行单元测试”,以找到令人信服的论点,即无法测试的代码是更深层的设计问题的迹象。