Unit Testing and Travis CI

2018/4/21 @ Swift Taipei

Transcript

1. Unit Testing & Travis CI Dada Chen 2018/4/21 @ Swift Girl
2. • A christian at New Life Church • Working at KKBOX • iOS Experience: 1+ years in ObjC、Swift • iOSDC Japan 2017 Speaker (Apple Watch) • 偶爾會出沒在 CocoaHeads Taipei、Swift Taipei About Me
3. Outline
4. Outline 新⼿手村 出城打怪
5. 如何寫單元測試
6. 在這之前，想幾個問題 什什麼是單元測試？ 測試什什麼？ 為什什麼要寫單元測試？ https://speakerdeck.com/nalydadad/talking-about-tdd-part-1
7. func add(a: Int, b: Int) -> Int { return a + b } 1. 起⼿手式
8. add(a: int, b:int) input output func add(a: Int, b: Int) -> Int { return a + b } 1. 起⼿手式
9. add(a: int, b:int) input output func testOneAddTwo() { let result = add(a: one, b: two) XCTAssert(result == 3) } func add(a: Int, b: Int) -> Int { return a + b } 1. 起⼿手式
10. module input output
11. Thinking Calculator input output
12. Operands Operator Calculate Thinking Calculator input output
13. Thinking Login Manager input output
14. Thinking Username
 Password login( ) Login Result Login Manager input output
15. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } 2. XCTest Framework
16. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } 繼承 XCTest Case，class name 需以 Tests 結尾 2. XCTest Framework
17. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } 繼承 XCTest Case，class name 需以 Tests 結尾 每⼀一條 test case 開始測前要做的事 2. XCTest Framework
18. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } 繼承 XCTest Case，class name 需以 Tests 結尾 每⼀一條 test case 測完後要做的事 每⼀一條 test case 開始測前要做的事 2. XCTest Framework
19. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } func testExample() { XCTAssert(1 == 1, "wrong message") XCTAssertNil(nil, "wrong message") XCTAssertNotNil("Any", "wrong message") XCTAssertTrue(true, "wrong message") XCTAssertFalse(false, "wrong message") XCTAssertEqual(1, 1, "wrong message") XCTAssertGreaterThan(1, 0, "wrong message") XCTAssertLessThan(0, 1, "wrong message") XCTAssertThrowsError(CalculatorError.unSupportedOperator, "wrong message") XCTAssertNoThrow(CalculatorError.unSupportedOperator, "wrong message") } 繼承 XCTest Case，class name 需以 Tests 結尾 每⼀一條 test case 測完後要做的事 每⼀一條 test case 開始測前要做的事 2. XCTest Framework
20. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } func testExample() { XCTAssert(1 == 1, "wrong message") XCTAssertNil(nil, "wrong message") XCTAssertNotNil("Any", "wrong message") XCTAssertTrue(true, "wrong message") XCTAssertFalse(false, "wrong message") XCTAssertEqual(1, 1, "wrong message") XCTAssertGreaterThan(1, 0, "wrong message") XCTAssertLessThan(0, 1, "wrong message") XCTAssertThrowsError(CalculatorError.unSupportedOperator, "wrong message") XCTAssertNoThrow(CalculatorError.unSupportedOperator, "wrong message") } 繼承 XCTest Case，class name 需以 Tests 結尾 每⼀一條 test case 測完後要做的事 test case 需以 test 前綴 每⼀一條 test case 開始測前要做的事 2. XCTest Framework
21. import XCTest class NewTests: XCTestCase { override func setUp() { super.setUp() } override func tearDown() { super.tearDown() } } func testExample() { XCTAssert(1 == 1, "wrong message") XCTAssertNil(nil, "wrong message") XCTAssertNotNil("Any", "wrong message") XCTAssertTrue(true, "wrong message") XCTAssertFalse(false, "wrong message") XCTAssertEqual(1, 1, "wrong message") XCTAssertGreaterThan(1, 0, "wrong message") XCTAssertLessThan(0, 1, "wrong message") XCTAssertThrowsError(CalculatorError.unSupportedOperator, "wrong message") XCTAssertNoThrow(CalculatorError.unSupportedOperator, "wrong message") } 繼承 XCTest Case，class name 需以 Tests 結尾 每⼀一條 test case 測完後要做的事 test case 需以 test 前綴 每⼀一條 test case 開始測前要做的事 + U 2. XCTest Framework
22. DEMO
23. Arrange： Act： Assert： 3. 3A Rule
24. Arrange： 建立測試前的環境 Act： 呼叫受測⽅方法 Assert： 驗證結果 3. 3A Rule
25. func testSomeClassDoSomething() { // Arrange let target = SomeClass() // Act target.doSomething() // Assert XCTAssert(...) }
26. 回傳值 狀狀態 互動 4. 驗證⽅方法
27. func testOneAddTwo() { // Arrange let calculator = Calculator() // Act let result = calculator.add(1, 2) // Assert XCTAssert(result == 3) } 4. 驗證⽅方法: (1) 回傳值 Let’s test “add(_: Int, _: Int )”
28. class UsersFeedCard: UIView { var starIcon = UIImageView(image: UIImage(named: “star")!) private let isCelebrity: Bool init(isCelebrity: Bool) { self.isCelebrity = isCelebrity } func configureUI() { starIcon.isHidden = !self.isCelebrity } /* … */ } 4. 驗證⽅方法: (2) 狀狀態 - 1 Let’s test “configureUI( )”
29. class UsersFeedCardTests: XCTestCase { func testCelebrityFeedCardShowsStar() { // Arrange let celebrityFeedCard = UsersFeedCard(isCelebrity: true) // Act celebrityFeedCard.configureUI() // Assert XCTAssertFalse(celebrityFeedCard.starIcon.isHidden) } } 4. 驗證⽅方法: (2) 狀狀態 - 1
30. class UserListTableViewController: UITableViewController { let userInfos: Array<UserInfo>! init(with userInfos: Array<UserInfo>) { self.userInfos = userInfos super.init(style: .plain) } override func numberOfSections(in tableView: UITableView) -> Int { return 1 } override func tableView(_ tableView: UITableView, 
 numberOfRowsInSection section: Int) -> Int { return userInfos.count } /* ... */ } 4. 驗證⽅方法: (2) 狀狀態 - 2
31. class UserListTableViewControllerTests: XCTestCase { func testNumberOfRows() { // Arrange let userInfos = [UserInfo(name: “John”), UserInfo(name: “Mary”), UserInfo(name: “Joshua”)] let userListTableViewController = UserListTableViewController(with: userInfos) // Act userListTableViewController.tableView.reloadData() // Assert XCTAssert(userListTableViewController.tableView.numberOfRows(inSection: 0) == 3) } } 4. 驗證⽅方法: (2) 狀狀態 - 2
33. 恭喜！你已脫離新⼿手村
34. 恭喜！你已脫離新⼿手村 • Input, Module, Output • XCTest Framework • 3A Rule • Verifying Rule
36. What is the real world?
37. 回頭看看你要測試的專案
39. Modules
40. 元件跟元件之間 資料（訊號）的流動 互動
41. 來來談談 “驗證互動”

42. 來來談談 “驗證互動” 當被測試的物件與外部物件有相依性

43. 來來談談 “驗證互動” 當被測試的物件與外部物件有互動
 如何讓互動能被測試
44. Views API Navigation Controller Player AppDelgate Images NSUser Defualt Data Model Example Too Much
 Dependencies View
 Controller
45. Target Module 相依性造成測試的困難
46. Target Module 3rd Party
 Module Some Modules System Singleton 相依性造成測試的困難
47. Target Module 3rd Party
 Module Some Modules System Singleton 相依性造成測試的困難 相依的物件不在測試的範圍， 難以控制
48. • 避免過多的相依性 • 讓這些相依的動作及狀狀態 可以被測試 Access 讓互動能被測試
49. • 避免過多的相依性 • 讓這些相依的動作及狀狀態 可以被測試 Access 讓互動能被測試 架構問題
50. • 避免過多的相依性 • 讓這些相依的動作及狀狀態 可以被測試 Access 讓互動能被測試 架構問題 測試⼿手法
51. Target Module
52. Target Module test test test test test test 1. 回傳值 2. 狀狀態
53. Target Module test test test test test test
54. Signal Outer
 Module Target Module Signal Outer
 Module test test test test test test
55. Signal Outer
 Module Target Module test test test test test test Signal Outer
 Module test ？ ？ ？
56. Stub Mock 模擬 ⾏行行為 假資料 測試⼿手法
57. Stub Mock 模擬 ⾏行行為 假資料 測試⼿手法
58. Target Module Outer
 Module test test test test test test
59. Target Module 有時候想要驗證的， 是由外部物件 觸發⾏行行為 後， Target 的狀狀態 Outer
 Module test test test test test test
60. Target Module Signal 有時候想要驗證的， 是由外部物件 觸發⾏行行為 後， Target 的狀狀態 Outer
 Module test test test test test test test
61. Target Module Stub
 Module Stub Method test test test test test test 控制 訊號
62. Target Module Stub
 Module Stub Method test test test test test test 模擬外部⾏行行為 控制 訊號 造假
63. 當被測試的物件被外部物件呼叫
 我們想要指定傳入的資訊 Then, Stub > 塞入假資料、假⾏行行為
64. Stub Mock 模擬 ⾏行行為 假資料 測試⼿手法
65. Outer
 Module 怎麼確定，訊號有正確傳給外部物件？ Target Module test test test test test
66. Outer
 Module Signal (method) 怎麼確定，訊號有正確傳給外部物件？ Target Module test test test test test
67. Outer
 Module Target Module Signal (method) 怎麼確定，訊號有正確傳給外部物件？ 被封裝過的物件， 有些狀狀態是隱藏起來來的 OMG test test test test test
68. Mock
 Module Target Module 怎麼確定，訊號有正確傳給外部物件？ 模仿外部物件的實作， 產⽣生新的驗證開⼝口。 test test test test test
69. Signal (method) Mock
 Module Target Module 怎麼確定，訊號有正確傳給外部物件？ 模仿外部物件的實作， 產⽣生新的驗證開⼝口。 test test test test test test
70. 當被測試的物件與外部相依的物件
 因為封裝的關係
 無法知道相依物件的狀狀態 Then, Mock > 開後⾨門
71. Stub , Mock 技巧 Inheritance Confirm Protocol
72. Stub Example class StubTimeMachineAPI: TimeMachineAPI { var videoUrl = "https://www.youtube.com/watch?v=SQ8aRKG9660" func getVideoFor(year: Int) -> String { return videoUrl } } Inheritance
73. Mock Example class ActionHandler: DataSourceDelegate { func dataSource(dataSource: DataSource, partialUpdateAt section: Index) { /*…*/ } } class MockActionHandler: MenuActionHandler { var partialUpdateWasCalled = false override func dataSource(dataSource: DataSource, partialUpdateAt section: Index) { partialUpdateWasCalled = true } } Inheritance
74. Confirm Protocol class ActionHandler: DataSourceDelegate { func dataSource(dataSource: DataSource, partialUpdateAt section: Index) { /*…*/ } } class MockActionHandler: DataSourceDelegate { var partialUpdateWasCalled = false func dataSource(dataSource: DataSource, partialUpdateAt section: Index) { partialUpdateWasCalled = true } } Mock Example
75. DEMO
76. Refactor to Testable
77. Dependency Injection
78. We have a view controller. class UserListViewController: UIViewController { var apiHandler: APIHandler? init() { super.init(nibName: nil, bundle: nil) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } }
79. class UserListViewController: UIViewController { var apiHandler: APIHandler? init() { super.init(nibName: nil, bundle: nil) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } } Dependency Find the dependencies.
80. Dependency Injection • Constructor • Property • Argument What • Stub • Mock Where • Dummy
81. Injection - Constructor class UserListViewController: UIViewController { private let apiHandler: APIHandler init(apiHandler: APIHandler) { self.apiHandler = apiHandler super.init(nibName: nil, bundle: nil) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } } let userListViewController = UserListViewController(apiHandler: StubAPIHandler())
82. class UserListViewController: UIViewController { var apiHandler: APIHandler? init() { super.init(nibName: nil, bundle: nil) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } } let userListViewController = UserListViewController() userListViewController.apiHandler = StubAPIHandler() Injection - Properties
83. class UserListViewController: UIViewController { init() { super.init(nibName: nil, bundle: nil) } required init?(coder aDecoder: NSCoder) { fatalError("init(coder:) has not been implemented") } func fetchData(with apiHandler: APIHandler) { /* … */ } } let userListViewController = UserListViewController() userListViewController.fetchData(with: StubAPIHandler()) Injection - Arguments
84. Mock, Stub 技巧 Dependency Injection 當你無法控制相依的對象時 突破封裝的藩籬 卻⼜又不影響架構
85. Mock, Stub 技巧 Dependency Injection 當你無法控制相依的對象時 突破封裝的藩籬 卻⼜又不影響架構
86. 突破封裝的藩籬 Stub Mock
87. Mock, Stub 技巧 Dependency Injection 當你無法控制相依的對象時 突破封裝的藩籬 卻⼜又不影響架構
88. 卻⼜又不影響架構 class UserTableViewController { let session: URLSession! init(session: URLSession = URLSession.shared) { /* ... */ } /* ... */ } let userTableViewController = UserTableViewController(session: MockURLSession)
89. 但不要過度使⽤用 Mock, Stub Target Module
90. Target Module 但不要過度使⽤用 Mock, Stub One test, One Mock or Stub
91. 測試框架 OCMock ⽀支援 Objective-C only 如何 Mock、Stub
92. Stub id mock = OCMClassMock([SomeClass class]); OCMStub([mock someMethod]).andReturn(myValue); /* run code under test */ OCMVerify([mock someMethod]); OCMock
93. Mock id mock = OCMClassMock([SomeClass class]); /* run code under test */ OCMVerify([mock someMethod]); OCMock
94. Asynchronous Test Call APIs, Read File, View animations… etc
95. func testAsyncTask() { let promise = expectation(description: "Asnyc test complete") let fakeAsyncTaskManager = AsyncTaskManager() fakeAsyncTaskManager.doSomething { result, error in if let error = error { XCTFail("Error: \(error.localizedDescription)") } else { if result == .success { promise.fulfill() } else { XCTFail("Job fail, result code: \(result.rawValue)") } } } waitForExpectations(timeout: 5, handler: nil) } Asynchronous Callback
96. func testAsyncTask() { let promise = expectation(description: "Asnyc test complete") let fakeAsyncTaskManager = AsyncTaskManager() fakeAsyncTaskManager.doSomething { result, error in if let error = error { XCTFail("Error: \(error.localizedDescription)") } else { if result == .success { promise.fulfill() } else { XCTFail("Job fail, result code: \(result.rawValue)") } } } waitForExpectations(timeout: 5, handler: nil) } Asynchronous Callback 1. expectation 2. wait for fulfill
97. func testAsyncTask() { let promise = expectation(description: "Asnyc test complete") let fakeAsyncTaskManager = AsyncTaskManager() fakeAsyncTaskManager.doSomething { result, error in if let error = error { XCTFail("Error: \(error.localizedDescription)") } else { if result == .success { promise.fulfill() } else { XCTFail("Job fail, result code: \(result.rawValue)") } } } waitForExpectations(timeout: 5, handler: nil) } Asynchronous Callback 3. fulfill
98. DEMO
99. Dummy Data Don’t want wait for backend. Prepare your own data.
100. Dummy Data Json Serialization Codable (Swift 4)
101. public typealias Codable = Decodable & Encodable Codable Protocol struct User: Codable { let name: String let userID: String let phoneNumber: Int private enum CodingKeys: String, CodingKey { case name = "name" case userID = "id" case phoneNumber } }
102. Encode Decode open func encode<T>(_ value: T) throws -> Data where T : Encodable let user = User(name: "dada", userID: "12345", phoneNumber: 0955777888) let encoder = JSONEncoder() let data = try? encoder.encode(user) let decoder = JSONDecoder() let parsedUser = try? decoder.decode(User.self, from: data) open func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
103. DEMO
104. Write good tests • ⼀一次只測試⼀一個動作 • 測試之間彼此獨立 • 測試能不斷重複的被測試 • 儘量量不要有判斷邏輯在測試裡 • 不濫濫⽤用 Stub, Mock
105. Unit Test - Wrap Up • Input, Module, Output • XCTest Framework • 3A Rule • Verifying Rule Part 1 • Stub, Mock • Dependency Injection • OCMock • Dummy Data • Asynchronous Test Part 2
106. Write your unit tests.
107. Let’s build an app to show playlists list. KKBOX Open API https://developer.kkbox.com/#/
108. Capability query music libraries, playlists, charts, search … etc KKBOX Open API https://developer.kkbox.com/#/ Restful API SDKs support Python, Javascript, Android, Objective-C, Swift, .NET Framework, GO
109. Get Access https://developer.kkbox.com/#/ Create ID Get Access Token Call APIs
110. KKBOX Open API References Get Started: 
 https://docs-en.kkbox.codes/docs/getting-started References: https://docs-en.kkbox.codes/v1.1/reference Swift SDK https://github.com/KKBOX/OpenAPI-Swift
111. KKBOX Open API Swift SDK https://github.com/KKBOX/OpenAPI-Swift var API = KKBOXOpenAPI(clientID: clientID, secret: clientSecret) func doAPICallWithAccessToken(callback: @escaping (Error?) -> ()) { if let _ = self.API.accessToken { callback(nil) return } _ = try? self.API.fetchAccessTokenByClientCredential { result in switch result { case .error(let error): callback(error) case .success(_): break } } }
112. Unit Test Demo https://github.com/nalydadad/ DemoKKBOXOpenAPISwift
113. Kube Playlists https://itunes.apple.com/us/app/kube-playlists/id1369069997?ls=1&mt=8
114. 導入 Travis CI
115. Continuous Integration 持續整合 準備⼀一個環境
 ⾃自動化的 建置、測試、分析 程式碼
117. 沒有 CI 的單元測試沒辦法落落實
118. Intro. Travis Integrate with GitHub 使⽤用 .yml 管理理建置流程 ⽀支援 10 種以上的語⾔言
119. Set Up Sign Up Select Repo Create Configuration File: .travis.yml push
120. Sign In with Your GitHub Account
121. 新增 .travis.yml 建置成功 Create .travis.yaml
122. language: swift osx_image: xcode9.2 script: - xcodebuild clean test -project TryTDD.xcodeproj -scheme TryTDDTests -destination 'platform=iOS Simulator,name=iPhone 8,OS=11.2’ -configuration Debug | xcpretty Create .travis.yaml
123. language: swift osx_image: xcode9.2 script: - xcodebuild clean test -project TryTDD.xcodeproj -scheme TryTDDTests -destination 'platform=iOS Simulator,name=iPhone 8,OS=11.2’ -configuration Debug | xcpretty Create .travis.yaml
124. xcodebuild build / test clean -project / -workspace -scheme -destination -configuration DEBUG / RELEASE
125. 新增 .travis.yml 建置成功 Success
126. Anything else…
127. Code Coverage - codecov.io after_success: - bash <(curl -s https://codecov.io/bash)
128. Dashboard
129. Badges !!
130. branches: only: - master - some feature branch Branch
131. before_install: - gem install cocoa pods - pod install CocoaPods
132. Deploy Travis 9
     Fastlane
133. Q & A