Swift テストコード

Question

Swiftでの質問です

下記のコードのテストを行いたいですが
テストを行ったことがないので苦労してます

ResponseData のクラスにString の型を記載して、APIのテスト用JSONを作ってそれが本当にちゃんと作れているかどうかをテストすればいいと考えたのですが
どんなコードになるかいまいちピンこないです

お答えいただけたら嬉しいです！

コード

import UIKit
import Alamofire
import Keys


/// レスポンスデータ
struct ResponseData: Codable {
    var request_id = ""
    var output_type = ""
    var converted = ""
}


class ViewController: UIViewController {
    
    @IBOutlet weak var inputCharacter: UITextField!
    @IBOutlet weak var rubyCharacter: UILabel!
    @IBOutlet weak var outputCharacter: UILabel!
    @IBOutlet weak var outputView: UIView!
    
    override func viewDidLoad() {
        super.viewDidLoad()
        // 出力先の枠線の設定
        outputView.layer.borderWidth = 1.0
        outputView.layer.borderColor = UIColor.red.cgColor
        
        // 枠に対して文字の大きさを自動調節
        inputCharacter.adjustsFontSizeToFitWidth = true
        rubyCharacter.adjustsFontSizeToFitWidth = true
        outputCharacter.adjustsFontSizeToFitWidth = true
    }
    
    
    /// ルビ変換ボタン押下時、ルビを画面に表示するメソッド
    ///
    /// - Parameter sender: UIButton
    @IBAction func convertRuby(_ sender: UIButton) {
        guard let inputText = inputCharacter.text else {
            return
        }
        
        
        if inputText != "" {
            // レスポンスを画面に返す
            HttpRequest(sentence: inputText, completion: {(responseData: ResponseData) -> Void in
                self.outputCharacter.text = inputText
                self.rubyCharacter.text = responseData.converted
            })
        }
    }
    
    
    /// ひらがな化APIにリクエスト送信する
    ///
    /// - Parameters:
    ///   - sentence: 入力された文字
    ///   - completion: リクエスト送信完了
    func HttpRequest(sentence: String, completion: @escaping (ResponseData)->Void) {
        // リクエスト情報
        let url = "https://labs.goo.ne.jp/api/hiragana"
        let headers: HTTPHeaders = [
            "Contenttype": "application/json"
        ]
        let appKey : RubyConversionAppKeys = RubyConversionAppKeys()
        let parameters:[String: Any] = [
            "app_id":"b9596802da072f39033d9bb35a9338e5e9dcbec54c03e9061d6df38d00449967",
            "sentence": sentence,
            "output_type": "hiragana"
        ]
        
        // リクエスト送信
        Alamofire.request(url, method: .post, parameters: parameters, encoding: JSONEncoding.default, headers: headers).responseJSON { response in
            guard let jsonData = response.data else {
                print("response err")
                return
            }
            let responseData = try! JSONDecoder().decode(ResponseData.self, from: jsonData)
            completion(responseData)
            print(responseData)
        }
    }
    
    
    // 画面タップ時、キーボードを閉じる
    /// - Parameter sender: Any
    @IBAction func downKeyboard(_ sender: Any) {
        inputCharacter.endEditing(true)
    }
}

Comments

[nakasho_dev]

タグにテスト駆動開発とありますがテスト駆動開発がしたいのでしょうか、それともUnitTestが書きたいのでしょうか。また、「いまいちピンこない」というのではなく、まずはご自身がどのように調べてどこまでわかってどこが分からないかを伝えたほうが具体的なアドバイスをしてもらえるかもしれません。

[imasyou718]

UnitTestが書きたいです！

Answer 1

提示されたプロダクトコードで最もテストしたい価値は、HttpRequest関数であると判断し、その関数で「Alamofireを使い通信し、返却されたJSONデータをクラスに変更して取得できること」のテストコードを書いてみました。

Alamofireは使ったことがないのですが非常にテストしづらいModuleだと感じました。
テストするためには「Method Swizzling」という技術を使い通信をテスト用データに差し替える必要があります。

• Alamofire, URLSessionの通信処理をMethod Swizzlingでスタブに置き換える

上記のURLを参考にテストプロジェクト側に以下を作成しました。
参考サイトと違うのは最後の方のresponseの中身を今回のプロジェクト用のJSONデータに変更しています。

import Foundation

public class MockURLProtocol: URLProtocol {

    // 引数のURLRequestを処理できる場合はtrue
    override open class func canInit(with request:URLRequest) -> Bool {
        return true
    }

    // URLRequestの修正が必要でなければそのまま返す。
    override open class func canonicalRequest(for request: URLRequest) -> URLRequest {
        return request
    }

    // 通信開始時に呼ばれるメソッド、ここに通信のモックを実装します。
    override open func startLoading() {
        let delay: Double = 1.0 // 通信に1秒かかるモック
        DispatchQueue.global().asyncAfter(deadline: .now() + delay) {
            self.client?.urlProtocol(self, didLoad: self.response!) // 結果を返す
            self.client?.urlProtocolDidFinishLoading(self)     // 通信が終了したことを伝える

            // エラー時のハンドリングもこちらで可能です。
            // self.client?.urlProtocol(self, didFailWithError: error)
        }
    }

    // 通信停止時に呼ばれるメソッド
    override open func stopLoading() {
    }

    private var response: Data? {
        // URLなどでパターンマッチングすることで結果を切り替えることも出来る
        // self.request.url
        let json = "{\"converted\":\"てすとくどうかいはつ\",\"output_type\":\"hiragana\",\"request_id\":\"request-id\"}"
        return json.data(using: .utf8)
    }
}

そして「Method Swizzling」を実現するためのコードを実装します。
こちらは参考サイトと同じです。

import Foundation

public extension URLSessionConfiguration {

    // .defaultをモック用と入れ替えるメソッド
    public class func setupMockDefaultSessionConfiguration() {
        let defaultSessionConfiguration = class_getClassMethod(URLSessionConfiguration.self, #selector(getter: URLSessionConfiguration.default))!
        let swizzledDefaultSessionConfiguration = class_getClassMethod(URLSessionConfiguration.self, #selector(getter: URLSessionConfiguration.mock))!
        method_exchangeImplementations(defaultSessionConfiguration, swizzledDefaultSessionConfiguration)
    }

    // .defaultと入れ替えるプロパティ変数
    @objc private dynamic class var mock: URLSessionConfiguration {
        let configuration = self.mock
        configuration.protocolClasses?.insert(MockURLProtocol.self, at: 0)
        URLProtocol.registerClass(MockURLProtocol.self)
        return configuration
    }
}

これでAlamofireでrequestした際に実際のサーバにはアクセスせずに、MockURLProtocolで実行した内容がResponseとして返却される準備ができました。

そこで以下のTestを作成します。

@testable import プロジェクト名
import XCTest

class AdaptiveCardSwiftSampleTests: XCTestCase {
    private var subject: ViewController!

    override func setUp() {
        subject = ViewController()
        // スタブに置き換え
        URLSessionConfiguration.setupMockDefaultSessionConfiguration()
    }

    func testExample() {
        //非同期の待ち時間用
        let expectation = XCTestExpectation(description: "Hoge")
        
        subject.HttpRequest(sentence: "テスト駆動開発") { (result) in
        //期待する返却値(MockURLProtocolで指定しているJSONデータ)
            XCTAssertEqual(result.request_id, "request-id")
            XCTAssertEqual(result.output_type, "hiragana")
            XCTAssertEqual(result.converted, "てすとくどうかいはつ")
            expectation.fulfill()
        }
        wait(for: [expectation], timeout: 3)
    }

}

今回はサーバに通信し返却されたJSONファイルをクラスに変換するというテストを行いました。
しかし、他にもテストしないといけないことがたくさんあります。
例えば以下のようなものがあります。

• ルビ変換ボタン押下時にサーバへリクエストを投げているか
• 正しくサーバにパラメータを渡しているか
• サーバとの通信が失敗した場合
• サーバから返ってきたJSONデータが想定と異なる場合
• サーバから返ってきたデータを正しく表示できているか

ちゃんと何を確認したいか目的を持ってテストを書きましょう。
これらをテストするために色々なテストデータなどを用意する必要があります。
テスト毎にMockURLProtocolのようなクラスを作るのは大変です。
テストしたいデータだけ書き換えてスタブが作れるようにした方が楽です。
参考サイトでは[Mockingjay]（https://github.com/kylef/Mockingjay）を紹介しているので、それを使うという選択肢もあります。

そして、テストがやりやすい設計にすることも大事です。
今回は簡易的に作りました。しかしテストのしやすい設計のためには、プロダクトにあったアーキテクチャを採用したり、DI（依存性の注入）やRepositoryパターンなどを実践すると良いと考えます。
iOSの設計・テストについては以下が参考になります。

• iOSアプリ設計パターン入門
• iOSアプリ開発自動テストの教科書
• iOSテスト全書

Comments

[imasyou718]

nakasho_dev様とても丁寧なご回答ありがとうございます。
すいません初学者なのでとても変な質問だと思いますが
3番目の方のコードはテストに書き込むことはわかるのですが
上二つはどこにコードを記載すればよろしいでしょうか？
現状自分が質問させてもらっているViewController.Swiftとテストを記載している
RubyAppTest.Swiftというファイルのみとなっております。

[imasyou718]

どちらに記載すればよろしいですか？

[nakasho_dev]

RubyAppTest.Swiftのファイル内に並べて記載しても構いません。その際はimport文が重複しないように気をつけてください。また、本来であればテストプロジェクト側に別ファイルで保存したほうが良いです。

[imasyou718]

エラーばかりが出てどう記述すればいいかわからないですすいません。

Answer 2

ユニットテストはテストが正しく行われればそれでOKなのでそんなに難しく考えないでください。
こんなのでいいです。

// Equatableにする
struct User: Equatable {
    let name: String
    let age: Int
}

func testDecodeJSON() {
    
    // APIから取得したものをそのまま張り付ける
    let jsonStr = #"""
{
    "name": "Name",
    "age": 20
}
"""#
    
    // 上のJSONから生成されることが期待されるUserのインスタンス
    let expected = User(name: "Name", age: 20)
    
    do {
        let decoded = try JSONDecoder().decode(User.self, from: jsonStr.data(using: .utf8)!)
        XCTAssertEqual(expected, decoded)
    }
    catch {
        XCTFail("Can not decode JSON")
    }
}

// 注意！！！　エラーや例外がHttpRequest(sentence:completion:)メソッドに吸収されているため正しいテストは不可能
// また、テストのたびにサーバーにアクセスする必要がある。
func testSendAPI() {
    
    let vc = ViewController()
    
    let exp = expectation(description: "Hoge")
    
    vc.HttpRequest(sentence: "Word") { _ in
        exp.fulfill()
    }
    
    wait(for: [exp], timeout: 10.0)
}

---

通信部分をテストするにはDI(Dependency Injection)やモック(mock)、スタブ(stub)などテストを容易に行えるようなコードを書く必要性が出てきます。

Comments

[imasyou718]

func testSendAPI() {

let vc = ViewController()

let expectation = expectation(description: "Hoge")

vc.HttpRequest(sentence: "Word") { _ in
expectation.fulfill()
}

wait(for: [expectation], timeout: 10.0)
}
こちらのテストをすると
let expectation = expectation(description: "Hoge")
ここの部分がVariable used within its own initial value
とエラーが出るのですが何が悪いんですかね？

[MasakiHori]

識別子がだめですね。書き直します。　#書き直しました。 (expectationをexpにした）

[MasakiHori]

teratailバグってますね。　どうしよう....

[MasakiHori]

治りました

[imasyou718]

func testSendAPI() {

let vc = ViewController()

let exo = expectation(description: "Hoge")

vc.HttpRequest(sentence: "Word") { _ in
exo.fulfill()
}

wait(for: [exo], timeout: 10.0)
}

少し書き直しましたができました！
これはHttpRequestの通信の処理のテストという認識であってますか？

[MasakiHori]

completionが呼ばれたら成功でそれ以外は失敗するテストです。それ以上でも以下でもありません。

[nakasho_dev]

DI、モック、Stubについて触れているので、UnitTestの書き方については知っているのかと思いますが、テスト初心者に対してこれをUnitTestというのは非常に不親切ではないでしょうか。
Testの度にサーバにアクセスする必要があるのであればIntegrationTestになってしまうのではないでしょうか。
対向のサーバの状況や通信の不具合など様々な要因でテストが失敗することがあり、とてもUnitをTestしているとは思えません。

[MasakiHori]

コメントにテストが不完全であること、正しいテストを作成するには様々な知識やコードの変更が必要なことを明記していますが、それでは問題があるということでしょうか？
問題があると思われるのでしたら、質問者さんのために正しい回答を行ってもらえませんでしょうか？

[nakasho_dev]

問題あります。そもそも何が不完全であるかも説明していません。
提示されたテストで良いのか、と思われたらテストについて知りたい質問者の方が不幸になります。
1つ目のテストはJSONDecoderのテストとなってしまっておりプロダクトコードのテストとなりえません。用意したデータクラスがJSONと型があっているかのテストにはなるかもしれませんが、私が提示したテストでカバーされますし、テストとしての価値がほとんどありません。
2つ目のテストはリクエスト投げてエラーにならないことだけをテストしているとのことですが、レスポンスのステータスコードやボディの中身を検証したりするテストを書いたときにこのテストは無意味になりますし、そもそもそれを検証する価値があるか疑問です。
テストで何を検証すべきかについて説明せず、ただXCTestCaseをエラーが出ないように書くだけの説明ではテストを知りたい質問者に対して不親切だと考えます。
確かにHTTP通信を含むテストを書くのは面倒です。それでも質問者に間違った知識を与えて良いとは思えません。