2015年10月23日

[Android]Robolectricを使ったテスト用ファイル読み込み

主にAndroidアプリ開発をしている外山です。

Androidのユニットテスト時にテスト用のファイルを読み込む方法について調べてみました。


事前準備

ライブラリ追加

今回はRobolectric 3.0を使用する
testCompile "org.robolectric:robolectric:3.0"

Testファイル

Testを記述するためのクラスを作成
ExampleUnitTest.java
@RunWith(CustomRobolectricGradleTestRunner.class)
@Config(constants = BuildConfig.class, sdk = 21)
public class ExampleUnitTest {

	// InputStreamをStringへ変換するためのメソッド
	private static String streamToString(InputStream is) {
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        byte[] buf = new byte[2048];
        int size;
        try {
            while ((size = is.read(buf)) != -1) {
                baos.write(buf, 0, size);
            }
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (is != null) {
                try {
                    is.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

        return new String(baos.toByteArray());
    }
}

assetsディレクトリを使う方法

デフォルトではユニットテスト時にはtest/assetsディレクトリが使われないのでassetsディレクトリのパスを指定することでテスト用のファイルを使用するように変更します

CustomRobolectricGradleTestRunner.javaを作成しgetAppManifest内でassetsのパスを指定する

public class CustomRobolectricGradleTestRunner extends RobolectricGradleTestRunner {
    public CustomRobolectricGradleTestRunner(Class klass) throws InitializationError {
        super(klass);
    }

    @Override
    protected AndroidManifest getAppManifest(Config config) {
        String buildVariant = (BuildConfig.FLAVOR.isEmpty() ? "" : BuildConfig.FLAVOR + "/") 
	        + BuildConfig.BUILD_TYPE;
        return new AndroidManifest(
                Fs.fileFromPath("src/main/AndroidManifest.xml"),
                Fs.fileFromPath("build/intermediates/res/" + buildVariant),
                Fs.fileFromPath("src/test/assets")
        );
    }
}

テスト

ExampleUnitTest.javaに以下を追加して読み込みができているかをチェックすると無事テストが成功しています

@Test
public void readFileFromAssets() throws IOException {
	InputStream is = RuntimeEnvironment.application.getAssets().open("assets_hello.txt");
	String text = streamToString(is);
	assertThat(text, is(equalTo("hello assets")));
}

resourcesディレクトリを使う方法

app/src/test/resources/resources_hello.txtにファイルを作成しておきます

resourcesディレクトリ内に作成したファイルから文字列を取得する場合は以下のようにします

プログラム

ExampleUnitTest.javaに以下を追加して読み込みができているかをチェックすると無事テストが成功しています
@Test 
public void readFileFromResources() {
	InputStream is = getClass().getResourceAsStream("/resources_hello.txt");
	String text = streamToString(is);
	assertThat(text, is(equalTo("hello resources")));
}

getClass().getResourceAsStream(path)を使用することでresourcesディレクトリ内のファイルへアクセスするためのInputStreamを取得することができます


まとめ

APIサーバーからのレスポンスをモックする際などコードに文字列を埋め込むのはつらいものがあるのでファイルから読み込めるというのはとても便利なのでテスト用に長い文字列を使いたい時などは使っていきたいですね。 今回はファイルから文字列を取得しましたが画像の読み込みなどももちろんできるので用途に応じて使い分けましょう。


posted by Seesaa京都スタッフ at 20:50| Comment(0) | Android | このブログの読者になる | 更新情報をチェックする
この記事へのコメント
コメントを書く
お名前:

メールアドレス:

ホームページアドレス:

コメント: