【iOS】今すぐ始める自動テスト（XCTest, XCUITest）

iOSアプリのテストを始めたい、やったほうが良いのはわかる、 **けど…**
という方のための、
公式フレームワーク**XCTest**と**XCUITest**で自動テストを始めるまでの記事です。

# セットアップ
※ 既に「アプリ名+Tests/UITests」のグループやTARGETSがある場合は不要
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/d6deaad1-bf4d-b56c-91b5-d0cc4dcbf1ea.png)

プロジェクト作成時に「include Unit/UI Tests」にチェック
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/c289266a-3109-d3a7-99b5-882eb1b81e9d.png)

もしくはプロジェクト作成後、File→New→Target→
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/2cfa13ce-279f-7e0e-a8bd-fce46906d3d3.png)
Unit/UI Testing Bundleを追加して
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/08503617-b223-c0b1-a702-9643ddafcb0e.png)

TARGETが増えていれば完了。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/9e65f7b5-12c2-bcd0-1a05-c1b41c052cad.png)


# XCTest
## テストクラスの作成
まず、Testsグループ内にUnitTestクラスを作成。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/f94d09bc-dbef-a0f1-89bf-c7e5d541d389.png)
↓選択
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/dbe3b144-377e-353f-9aea-6ea59f22e16f.png)
すると以下のような雛形が出来る。

```swift
import XCTest
class QiitaTest: XCTestCase {
    override func setUp() {
        // Put setup code here. This method is called before the invocation of each test method in the class.
    }
    override func tearDown() {
        // Put teardown code here. This method is called after the invocation of each test method in the class.
    }
    func testExample() {
        // This is an example of a functional test case.
        // Use XCTAssert and related functions to verify your tests produce the correct results.
    }
    func testPerformanceExample() {
        // This is an example of a performance test case.
        self.measure {
            // Put the code you want to measure the time of here.
        }
    }
}
```

[1] **setUp** 
テスト開始時に動く。共通の準備等に使う。
[2]  **testExample**
名前が`test`から始まる関数がテスト扱いとなって実行される。
[3] **tearDown**
テスト終了時に動く。共通の確認等に使う。

例：test1(), test2()を書いた場合
setUp() > test1() > tearDown() > setUp() > test2() > tearDown()
の順で動く。

## Membershipの登録
他のファイルのクラスの呼び出しにはMembershipの登録が必要。
例えばLangというクラスを呼ぶ場合、アプリ内の該当ファイルを選択し…
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/e546ac3f-5b81-a935-9f68-afea2165c061.png)
Testsにチェックを入れる。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/0a77aa0d-658b-afe4-f067-89d7c87a5cee.png)
この操作は複数ファイルを選択して同時に適用できる。グループ単位はできませんでした。


## テストの実行
アプリ内のコードを実行し、[XCTAssert〜](https://developer.apple.com/documentation/xctest/equality_and_inequality_assertions)系メソッドでチェックする。
※以下のコード例ではアプリ特有のクラスが出てきますが、要は関数の呼び出し結果が期待値と一致するかをチェックする単体テストです。

```swift
import XCTest
class ProductIdCoderServiceTests: XCTestCase {
    override func setUp() {}
    override func tearDown() {}
    func testEncodeLesson() {
        let lesson = Lesson(lang: Lang(rawValue: "ja")!, courseId: 3, lessonId: 6)
        let coderService = ProductIdCoderService()
        let productId = coderService.encodeLesson(lesson)
        XCTAssertEqual(productId, "ja.course.3.lesson.6")
    }
    func testDecodeLesson() {
        let productId = "ja.course.3.lesson.4"
        let coderService = ProductIdCoderService()
        let lesson: Lesson = coderService.decodeLesson(productId)!
        XCTAssertEqual(lesson.lang.rawValue, "ja")
        XCTAssertEqual(lesson.courseId, 3)
        XCTAssertEqual(lesson.lessonId, 4)
    }
}
```

テスト別に開始ボタンを押すか、Cmd+U等でテストを実行。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/c001ccfa-cb4c-1971-676b-dc67b907322d.png)
通るとこのように表示される。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/8a7c6dac-1659-9623-a5e0-cd50a2828d9d.png)
# XCUITest
アプリを起動し、外から操作するイメージで行われるテスト。
実際のアプリに近い画面操作をテストできるが、画面に出てこない内部情報を扱うのは難しい。
## テストクラスの作成
まず、UITestsグループ内にUITestクラスを作成。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/fc80b56f-bdc3-f202-4cbd-50d80c11068e.png)
↓選択
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/ccba66ac-6739-d364-3d66-5b528888656d.png)
すると以下のような雛形ができる。

```swift
import XCTest
class QiitaUITest: XCTestCase {
    override func setUp() {
        // Put setup code here. This method is called before the invocation of each test method in the class.
        // In UI tests it is usually best to stop immediately when a failure occurs.
        continueAfterFailure = false
        // UI tests must launch the application that they test. Doing this in setup will make sure it happens for each test method.
        XCUIApplication().launch()
        // In UI tests it’s important to set the initial state - such as interface orientation - required for your tests before they run. The setUp method is a good place to do this.
    }
    override func tearDown() {
        // Put teardown code here. This method is called after the invocation of each test method in the class.
    }
    func testExample() {
        // Use recording to get started writing UI tests.
        // Use XCTAssert and related functions to verify your tests produce the correct results.
    }
}
```

XCTestに比べ **continueAfterFailure** と **XCUIApplication()** が追加されている。
**continueAfterFailure = false**
どこかで失敗した時にそこでテストを打ち切るという設定。UIテストは多大な時間をかけて流れを追うものなので、そうするのがオススメというもの。
**XCUIApplication().launch()**
アプリを起動するという操作。

## Membershipの登録
XCTestと同じなので割愛。

## ライブラリ探索を追加
UITests => Build Settings => Runpath Search Pathsに`$(FRAMEWORK_SEARCH_PATHS)`を追加
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/272677/4685ef59-adb5-b58c-d994-0757d837ebc4.png)
この方法がスタンダードかは不明だが、
>バンドル“appUITests”は、壊れているか必要なリソースがないため読み込めませんでした。 バンドルを再インストールしてください。

とエラーが出る場合に有効。

## テストの実行
テストの実行方法自体はXCTestと同じだが、[XCUIApplication](https://developer.apple.com/documentation/xctest/xcuiapplication)や[XCUIElement](https://developer.apple.com/documentation/xctest/xcuielement)を使ってコードからアプリを操作する必要がある。
操作法の一部を紹介します。

```swift
class PurchaseLessonUITests: XCTestCase {
    var app: XCUIApplication!
    override func setUp() {
        continueAfterFailure = false
        app = XCUIApplication()
    }
    override func tearDown() {}
    func testPurchase() {
        app.launch()
        addUIInterruptionMonitor(withDescription: "アラート検知") { (alert) -> Bool in
            alert.buttons["OK"].tap()
            return true
        }
        app.buttons["purchaseButton"].tap()
        XCTAssert(XCUIApplication().alerts["お買い上げありがとうございます"].exists)
    }
}
```

### 割り込みへの予約
発生タイミングが定かでないものに対してアクションを予約しておける。
アラートを検知した時に即OKボタンを押す例。

```swift
        addUIInterruptionMonitor(withDescription: "アラート検知") { (alert) -> Bool in
            alert.buttons["OK"].tap()
            return true
        }
```

### 要素を探す
accessibilityIdentifierをアプリケーション内で設定しておくと、

```swift
    @IBOutlet weak var purchaseButton: UIButton! {
        didSet {
            purchaseButton.accessibilityIdentifier = "purchaseButton"
        }
    }
```

テストでこのように探し出してタップなどができる。

```swift
        app.buttons["purchaseButton"].tap()
```

UIによるが、単にタイトル等で探せる場合もある。

```swift
        // `exists`を呼び出して`XCTAssert`に放り込めば存在をチェックできる
        XCTAssert(XCUIApplication().alerts["お買い上げありがとうございます"].exists)
```
XCTestとXCUITestの基本は以上です。

# 応用：XCUITestで軽めにモックを挟む
テストにおいて、状況設定に応じたコードを走らせたい場合があると思います。
XCUITestはアプリを外から操作するイメージで行われるため、内部の状態把握やコントロールが少し難しいです。
**XCUIApplication**の`launchArguments`と`launchEnvironment`を使ってアプリケーション内のコードを切り替える例を紹介します。

## Argumentsを使ってテスト用モックを挟む
https://developer.apple.com/documentation/xctest/xcuiapplication/1500477-launcharguments

まず、launchArgumentsにテストである旨を追加。

```swift
import XCTest

class UITests: XCTestCase {
    var app: XCUIApplication!
    override func setUp() {
        continueAfterFailure = false
        app = XCUIApplication()
        app.launchArguments.append("UI_TEST") // ←　これ
    }
    override func tearDown() {}
    func testHoge() {
        app.launch()
        // Hogeをテストするコード
    }
}
```

アプリケーション側にテスト用のクラスを追加で用意し、

```swift:HogeService.swift
protocol HogeService {
    // ..略
}
class DefaultHogeService { // 本来使用するクラス
    // ..略
}
class TestHogeService { // テスト用クラスを追加
    // ..略
}
```
例えばインスタンス生成時に必要に応じて選択するように変更する。

```swift
func hogeService() -> HogeService {
    if ProcessInfo.processInfo.arguments.contains("UI_TEST") { // テストかを判定
        return TestHogeService()
    } else {
        return DefaultHogeService()
    }
}
```
ここはアプリ本体への追記になってしまうが、致し方ない。
これでテスト時は`TestHogeService()`が使われるようになった。

## Environmentsを使って分岐を制御する
https://developer.apple.com/documentation/xctest/xcuiapplication/1500427-launchenvironment

次は、HogeServiceが成功・失敗した後それぞれのケースもテストしたい。
launchEnvironmentに命令を書くことにする。

```swift
import XCTest

class UITests: XCTestCase {
    var app: XCUIApplication!
    override func setUp() {
        continueAfterFailure = false
        app = XCUIApplication()
        app.launchArguments.append("UI_TEST")
    }
    override func tearDown() {}
    func testHogeSuccess() {
        app.launchEnvironment["HOGE_SERVICE"] = "success" // HogeServiceの挙動を成功と指定
        app.launch()
        // Hogeが成功した後の挙動が正しいかをテストするコード
    }
    func testHogeFailure() {
        app.launchEnvironment["HOGE_SERVICE"] = "failure" // HogeServiceの挙動を失敗と指定
        app.launch()
        // Hogeが失敗した後の挙動が正しいかをテストするコード
    }
}
```

TestHogeServiceで読み取り、分岐させる。

```swift
protocol HogeService {
    func fuga()
}
class DefaultHogeService {
    // ..略
}
class TestHogeService: HogeService {
    func fuga() {
        if ProcessInfo.processInfo.environment["HOGE_SERVICE"] == "success" {
            // 成功時にやること
        } else if ProcessInfo.processInfo.environment["HOGE_SERVICE"] == "failure" {
            // 失敗時にやること
        } else {
            fatalError()
        }
    }
}
```

以上です。お役に立てば幸いです。