「iOSアプリ:テスト自動化入門」が届いた

March 26, 2014 by yohei | Leave a comment

すごく読みたかった本がようやく届いた。

バックエンド系のシステムだと自動テストがあるのは当たり前になってきたけど、まだまだネイティブアプリでは自動テストが書かれていないというのが実情だと思ってる（私もあまり出来ていない）。テストができていないと、つまらないミスでアプリがクラッシュしてしまい、AppStoreのレビューが荒れて悲惨なことになる。。かといって、リリース前に毎回手動テストするのもそれはそれでコストなので、そこでテストの自動化でしょという話になってくる。

既存のアプリのすべてのコンポーネントに自動テストを一気に用意するのは、大変だと思うけど、テストを書きやすいところから書いていければいいと思う。UIに依存しない部分、APIにリクエストして結果を取得する部分など。現実問題、UIのテストってやるべきなのかって話もあるからね。

とりあえず目次を貼って終わりにします。

iOSアプリテスト自動化入門｜書籍情報｜秀和システム

Chapter 1 テスト自動化への取り組み
1.1 テスト自動化とは
1.1.1 テスト自動化の必要性
1.1.2 自動テストと手動テスト
1.1.3 テスト自動化のROI
1.2 テストの種類と自動化のスコープ
1.2.1 テストレベル
1.2.2 テストタイプ
Chapter 2 テストコードの書きかた
2.1 モデルのユニットテストを書く
2.1.1 XCTestの導入
2.1.2 テストクラスの新規作成
2.1.3 テストメソッドの作成
2.1.4 テストの実行
2.1.5 テストメソッドとアサーションの関係
2.1.6 テスタビリティの高い設計
2.2 既存のアプリにテストを追加する
2.2.1 不具合修正の前にテストを書く
2.2.2 タイミング依存の問題に対してテストを書く
2.2.3 テストを書くことが困難な場合
2.3 ユニットテストのテクニック
2.3.1 構造テストと仕様テスト
2.3.2 仕様化テスト
2.3.3 テストファーストとフェイルイット
2.3.4 TDD（テスト駆動開発）
2.3.5 テストダブル
2.3.6 テストコードの保守性とリファクタリング
2.4 iOSアプリのテストTips
2.4.1 テストフィクスチャをファイルでバンドルする
2.4.2 NSUserDefaultsをクリアする
2.4.3 アプリケーションデータを再現してテスト実行する
2.4.4 Core Dataを使用しているアプリのテスト
2.4.5 Core Dataをインメモリストアで使用する
2.4.6 非公開メソッドをテストする
2.4.7 例外発生をテストする
2.4.8 性能テスト（処理時間の測定）
Chapter 3 ユニットテストフレームワーク
3.1 XCTest
3.1.1 既存プロジェクトにXCTestを導入する
3.1.2 テストターゲットの依存関係
3.1.3 XCTestのアサーション
3.1.4 コマンドラインからXCTestを実行する
3.1.5 OCUnitからXCTestへのコンバート
3.2 GHUnit
3.2.1 GHUnitをプロジェクトに導入する
3.2.2 GHUnitのテスト実行
3.2.3 GHUnitのアサーション
3.2.4 非同期処理のテスト
3.2.5 UIViewの表示テスト
3.2.6 コマンドラインからGHUnitを実行する
3.3 Kiwi
3.3.1 Kiwiをプロジェクトに導入する
3.3.2 Spec（仕様）の記述方法
3.3.3 Expectations（期待値の評価）
3.3.4 テストスタブによる間接入力の操作
3.3.5 モックオブジェクトによる間接出力の検証
3.3.6 プロトコルのモックオブジェクト
3.3.7 非同期処理のテスト
Chapter 4 ユニットテストの補助ツール
4.1 OCHamcrest
4.1.1 OCHamcrestをプロジェクトに導入する
4.1.2 OCHamcrestの使いかた
4.2 OCMock
4.2.1 OCMockをプロジェクトに導入する
4.2.2 テストスタブによる間接入力の操作
4.2.3 特殊な間接入力の操作
4.2.4 モックオブジェクトによる間接出力の検証
4.2.5 プロトコルのモックオブジェクト
4.2.6 クラスメソッドの置き換え
4.2.7 Nice Mock, Partial Mock
4.3 OCMockito
4.3.1 OCMockitoをプロジェクトに導入する
4.3.2 テストスタブによる間接入力の操作
4.3.3 モックオブジェクトによる間接出力の検証
4.3.4 プロトコルのモックオブジェクト
4.3.5 OCMockitoでは実現できないこと
4.4 NLTHTTPStubServer
4.4.1 NLTHTTPStubServerをプロジェクトに導入する
4.4.2 NLTHTTPStubServerの使いかた
4.4.3 レスポンス操作のバリエーション
Chapter 5 システムテストの自動化
5.1 システムテスト自動化の予備知識
5.1.1 システムテストの位置付け
5.1.2 Drive,Judge,Report
5.1.3 システムレベルの機能テスト自動化のROI
5.2 UI Automation
5.2.1 UI Automationの使いかた
5.2.2 テストスクリプトの記述
5.2.3 コマンドラインからテストを実行する
5.2.4 Tuneup JS
5.3 Frank
5.3.1 Frankをプロジェクトに導入する
5.3.2 cucumberコマンドオプション
5.3.3 フィーチャとステップの記述
5.3.4 Symbioteインスペクトツールの利用
5.4 MonkeyTalk
5.4.1 MonkeyTalkのセットアップ
5.4.2 テスト対象アプリとの接続、キャプチャ＆リプレイ
5.4.3 MonkeyTalkのComponentとAction
5.4.4 MonkeyTalkエージェントのアプリへの組み込み
5.5 その他のテスティングフレームワーク
5.5.1 KIF(Keep It Functional)
5.5.2 Appium
5.5.3 Calabash
5.5.4 Zucchini
Chapter 6 ビルドと配布の自動化
6.1 テスト用のビルドを作る
6.1.1 Target, Configuration, Scheme
6.1.2 xcconfigファイルの利用
6.2 ビルドとテスト実行の自動化
6.2.1 xcodebuild
6.2.2 xctool
6.2.3 バージョン番号、Copyrightの更新を自動化する
6.2.4 ビルドの配布方法
6.3 TestFlightによるビルドの配布
6.3.1 TestFlightの利用登録
6.3.2 Upload API
6.3.3 テスターの登録
Chapter 7 CI （継続的インテグレーション）
7.1 OS X Server/Bots
7.1.1 OS X Serverのインストールと設定
7.1.2 Botsによるビルド実行設定
7.1.3 ビルド結果の確認
7.2 Jenkins
7.2.1 Jenkinsのインストールと設定
7.2.2 ジョブの設定
7.2.3 ビルド結果の確認
7.2.4 xctoolによるテスト実行とレポート
7.3 Travis CI
7.3.1 Travis CIの利用登録
7.3.2 .travis.yml
7.3.3 ビルド結果の確認
Chapter 8 メトリック
8.1 コードカバレッジ
8.1.1 Xcodeによるコードカバレッジの採取
8.1.2 CoverStoryによる表示
8.1.3 Jenkins Coberturaプラグインによる表示
8.1.4 Coverallsを利用する
8.2 静的解析
8.2.1 Analyzeビルドアクション
8.2.2 OCLintによる解析
8.2.3 OCLintをJenkinsで実行する

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

Chapter 1 テスト自動化への取り組み

1.1 テスト自動化とは

1.1.1 テスト自動化の必要性

1.1.2 自動テストと手動テスト

1.1.3 テスト自動化のROI

1.2 テストの種類と自動化のスコープ

1.2.1 テストレベル

1.2.2 テストタイプ

Chapter 2 テストコードの書きかた

2.1 モデルのユニットテストを書く

2.1.1 XCTestの導入

2.1.2 テストクラスの新規作成

2.1.3 テストメソッドの作成

2.1.4 テストの実行

2.1.5 テストメソッドとアサーションの関係

2.1.6 テスタビリティの高い設計

2.2 既存のアプリにテストを追加する

2.2.1 不具合修正の前にテストを書く

2.2.2 タイミング依存の問題に対してテストを書く

2.2.3 テストを書くことが困難な場合

2.3 ユニットテストのテクニック

2.3.1 構造テストと仕様テスト

2.3.2 仕様化テスト

2.3.3 テストファーストとフェイルイット

2.3.4 TDD（テスト駆動開発）

2.3.5 テストダブル

2.3.6 テストコードの保守性とリファクタリング

2.4 iOSアプリのテストTips

2.4.1 テストフィクスチャをファイルでバンドルする

2.4.2 NSUserDefaultsをクリアする

2.4.3 アプリケーションデータを再現してテスト実行する

2.4.4 Core Dataを使用しているアプリのテスト

2.4.5 Core Dataをインメモリストアで使用する

2.4.6 非公開メソッドをテストする

2.4.7 例外発生をテストする

2.4.8 性能テスト（処理時間の測定）

Chapter 3 ユニットテストフレームワーク

3.1 XCTest

3.1.1 既存プロジェクトにXCTestを導入する

3.1.2 テストターゲットの依存関係

3.1.3 XCTestのアサーション

3.1.4 コマンドラインからXCTestを実行する

3.1.5 OCUnitからXCTestへのコンバート

3.2 GHUnit

3.2.1 GHUnitをプロジェクトに導入する

3.2.2 GHUnitのテスト実行

3.2.3 GHUnitのアサーション

3.2.4 非同期処理のテスト

3.2.5 UIViewの表示テスト

3.2.6 コマンドラインからGHUnitを実行する

3.3 Kiwi

3.3.1 Kiwiをプロジェクトに導入する

3.3.2 Spec（仕様）の記述方法

3.3.3 Expectations（期待値の評価）

3.3.4 テストスタブによる間接入力の操作

3.3.5 モックオブジェクトによる間接出力の検証

3.3.6 プロトコルのモックオブジェクト

3.3.7 非同期処理のテスト

Chapter 4 ユニットテストの補助ツール

4.1 OCHamcrest

4.1.1 OCHamcrestをプロジェクトに導入する

4.1.2 OCHamcrestの使いかた

4.2 OCMock

4.2.1 OCMockをプロジェクトに導入する

4.2.2 テストスタブによる間接入力の操作

4.2.3 特殊な間接入力の操作

4.2.4 モックオブジェクトによる間接出力の検証

4.2.5 プロトコルのモックオブジェクト

4.2.6 クラスメソッドの置き換え

4.2.7 Nice Mock, Partial Mock

4.3 OCMockito

4.3.1 OCMockitoをプロジェクトに導入する

4.3.2 テストスタブによる間接入力の操作

4.3.3 モックオブジェクトによる間接出力の検証

4.3.4 プロトコルのモックオブジェクト

4.3.5 OCMockitoでは実現できないこと

4.4 NLTHTTPStubServer

4.4.1 NLTHTTPStubServerをプロジェクトに導入する

4.4.2 NLTHTTPStubServerの使いかた

4.4.3 レスポンス操作のバリエーション

Chapter 5 システムテストの自動化

5.1 システムテスト自動化の予備知識

5.1.1 システムテストの位置付け

5.1.2 Drive,Judge,Report

5.1.3 システムレベルの機能テスト自動化のROI

5.2 UI Automation

5.2.1 UI Automationの使いかた

5.2.2 テストスクリプトの記述

5.2.3 コマンドラインからテストを実行する

5.2.4 Tuneup JS

5.3 Frank

5.3.1 Frankをプロジェクトに導入する

5.3.2 cucumberコマンドオプション

5.3.3 フィーチャとステップの記述

5.3.4 Symbioteインスペクトツールの利用

5.4 MonkeyTalk

5.4.1 MonkeyTalkのセットアップ

5.4.2 テスト対象アプリとの接続、キャプチャ＆リプレイ

5.4.3 MonkeyTalkのComponentとAction

5.4.4 MonkeyTalkエージェントのアプリへの組み込み

5.5 その他のテスティングフレームワーク

5.5.1 KIF(Keep It Functional)

5.5.2 Appium

5.5.3 Calabash

5.5.4 Zucchini

Chapter 6 ビルドと配布の自動化

6.1 テスト用のビルドを作る

6.1.1 Target, Configuration, Scheme

6.1.2 xcconfigファイルの利用

6.2 ビルドとテスト実行の自動化

6.2.1 xcodebuild

6.2.2 xctool

6.2.3 バージョン番号、Copyrightの更新を自動化する

6.2.4 ビルドの配布方法

6.3 TestFlightによるビルドの配布

6.3.1 TestFlightの利用登録

6.3.2 Upload API

6.3.3 テスターの登録

Chapter 7 CI （継続的インテグレーション）

7.1 OS X Server/Bots

7.1.1 OS X Serverのインストールと設定

7.1.2 Botsによるビルド実行設定

7.1.3 ビルド結果の確認

7.2 Jenkins

7.2.1 Jenkinsのインストールと設定

7.2.2 ジョブの設定

7.2.3 ビルド結果の確認

7.2.4 xctoolによるテスト実行とレポート

7.3 Travis CI

7.3.1 Travis CIの利用登録

7.3.2 .travis.yml

7.3.3 ビルド結果の確認

Chapter 8 メトリック

8.1 コードカバレッジ

8.1.1 Xcodeによるコードカバレッジの採取

8.1.2 CoverStoryによる表示

8.1.3 Jenkins Coberturaプラグインによる表示

8.1.4 Coverallsを利用する

8.2 静的解析

8.2.1 Analyzeビルドアクション

8.2.2 OCLintによる解析

8.2.3 OCLintをJenkinsで実行する

ヘッダのカスタマイズや独自処理をしたいときの AFNetworking 2.0 の使い方

March 17, 2014 by yohei | Leave a comment

ヘッダのカスタマイズや独自処理をしたいときの AFNetworking 2.0 の使い方

普通の使い方

AFHTTPRequestOperationManager というクラスを主に利用します。 GETで通信したい場合は、以下のように GET:parameters:success:failure: メソッドを呼び出すことで、リクエストを開始することができます。 parameters: に NSDictionary 型のデータを渡せば、それをよしなにURIパラメータやBODYに付与してくれます。

サーバとの通信に成功しレスポンスが返って来た場合には、success: で指定したブロックが呼び出されます。また、ネットワークに繋がっていなかったり、指定したURLのサーバホストの名前解決がでいないなどサーバとの通信に失敗した場合は、failure: で指定したブロックが呼び出されます。ちなみに、AFHTTPRequestOperation からステータスコードやレスポンスヘッダといった情報を取り出すことができます。

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
[manager GET:@"https://hogehoge.api.com/user"
  parameters:@{ @"user_id":@"hoge" }
     success:^(AFHTTPRequestOperation *operation, id responseObject) {
         NSLog(@"res:%@", responseObject);
     }
     failure:^(AFHTTPRequestOperation *operation, NSError *error) {
         NSLog(@"error:%@", error);
     }];

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];

[manager GET:@"https://hogehoge.api.com/user"

parameters:@{ @"user_id":@"hoge" }

success:^(AFHTTPRequestOperation *operation, id responseObject) {

NSLog(@"res:%@", responseObject);

}

failure:^(AFHTTPRequestOperation *operation, NSError *error) {

NSLog(@"error:%@", error);

}];

GET 以外には、POST, DELETE, PUT 用のメソッドも用意されています。

ヘッダのカスタマイズ

さて、ここからカスタマイズ編です。リクエスト時のヘッダをカスタマイズしたい場合は、以下のように AFHTTPRequestOperationManager の requestSelializer というプロパティに対して、setValue:forHTTPHeaderField: を呼び出します。 NSMutableURLRequest にヘッダを設定する場合と似てますね。

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
[manager.requestSerializer setValue:@"SomeValue" forHTTPHeaderField:@"SomeHeaderField"]

1 2	AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager]; [manager.requestSerializer setValue:@"SomeValue" forHTTPHeaderField:@"SomeHeaderField"]

ちなみに、BASIC認証したい場合は、以下のメソッドが使えます。

- (void)setAuthorizationHeaderFieldWithUsername:(NSString *)username
                                       password:(NSString *)password;

...

[manager.requestSerializer setAuthorizationHeaderFieldWithUsername:@"username"
                                                            password:@"xxx"];

- (void)setAuthorizationHeaderFieldWithUsername:(NSString *)username

password:(NSString *)password;

...

[manager.requestSerializer setAuthorizationHeaderFieldWithUsername:@"username"

password:@"xxx"];

NSURLRequest のカスタマイズ

リクエストを開始する前にNSURLRequestにある処理を実行したいという場合があると思います。例えば、Parse を使っていてリクエストヘッダにアクセストークンを付与したい場合、以下のように行うことができます。

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];

AFHTTPRequestSerializer *selializer = [AFHTTPRequestSerializer serializer];
self.requestSerializer = selializer;

NSString *URLString = @"https://api.twitter.com/1.1/friendships/create.json";

// リクエストに使う NSURLRequest を生成
// このメソッドを使うことで、AFNetworkingのパラメータのエンコードを良しなにやってくれる処理を再利用できる
NSMutableURLRequest *request =
   [selializer requestWithMethod:@"POST"
                       URLString:URLString
                      parameters:@{ @"screen_name":@"gologo13" }
                           error:nil];
    
// 独自の処理 リクエストヘッダに Twitter API を叩くためのアクセストークンを付与する
[[PFTwitterUtils twitter] signRequest:request];

// リクエスト開始
AFHTTPRequestOperation *operation = [self HTTPRequestOperationWithRequest:request success:success failure:failure];
[self.operationQueue addOperation:operation];

AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];

AFHTTPRequestSerializer *selializer = [AFHTTPRequestSerializer serializer];

self.requestSerializer = selializer;

NSString *URLString = @"https://api.twitter.com/1.1/friendships/create.json";

// リクエストに使う NSURLRequest を生成

// このメソッドを使うことで、AFNetworkingのパラメータのエンコードを良しなにやってくれる処理を再利用できる

NSMutableURLRequest *request =

[selializer requestWithMethod:@"POST"

URLString:URLString

parameters:@{ @"screen_name":@"gologo13" }

error:nil];

// 独自の処理リクエストヘッダに Twitter API を叩くためのアクセストークンを付与する

[[PFTwitterUtils twitter] signRequest:request];

// リクエスト開始

AFHTTPRequestOperation *operation = [self HTTPRequestOperationWithRequest:request success:success failure:failure];

[self.operationQueue addOperation:operation];

最初に紹介したやり方よりは記述量が多くなってしまいますが、必ず毎回実行したい処理ならAFHTTPRequestOperationManagerのカテゴリ拡張もしくはサブクラスを作っても良いかもしれません。

Reference

http://qiita.com/asakahara/items/9cb68bef56ca70b505c6
http://qiita.com/jtemplej/items/c3c25a5301c7250305fe
- Request Serialization, Response Serialization の説明がわかりやすい