Android Test Frameworkを使用したAndroid AsyncTaskテスト

非常に単純なAsyncTask実装の例があり、Android JUnitフレームワークを使用してそれをテストする際に問題があります。

通常のアプリケーションでインスタンス化して実行すると、問題なく動作します。ただし、Androidテストフレームワーククラス（AndroidTestCase、ActivityUnitTestCase、ActivityInstrumentationTestCase2など）から実行されると、奇妙な動作をします。

• 実行する doInBackground()メソッドを正しく
• しかし、それはその通知方法（のいずれかの呼び出していないonPostExecute()、onProgressUpdate()など） -ただ静かにすべてのエラーを表示せずにそれらを無視します。

これは非常に単純なAsyncTaskの例です。

package kroz.andcookbook.threads.asynctask;

import android.os.AsyncTask;
import android.util.Log;
import android.widget.ProgressBar;
import android.widget.Toast;

public class AsyncTaskDemo extends AsyncTask<Integer, Integer, String> {

AsyncTaskDemoActivity _parentActivity;
int _counter;
int _maxCount;

public AsyncTaskDemo(AsyncTaskDemoActivity asyncTaskDemoActivity) {
    _parentActivity = asyncTaskDemoActivity;
}

@Override
protected void onPreExecute() {
    super.onPreExecute();
    _parentActivity._progressBar.setVisibility(ProgressBar.VISIBLE);
    _parentActivity._progressBar.invalidate();
}

@Override
protected String doInBackground(Integer... params) {
    _maxCount = params[0];
    for (_counter = 0; _counter <= _maxCount; _counter++) {
        try {
            Thread.sleep(1000);
            publishProgress(_counter);
        } catch (InterruptedException e) {
            // Ignore           
        }
    }
}

@Override
protected void onProgressUpdate(Integer... values) {
    super.onProgressUpdate(values);
    int progress = values[0];
    String progressStr = "Counting " + progress + " out of " + _maxCount;
    _parentActivity._textView.setText(progressStr);
    _parentActivity._textView.invalidate();
}

@Override
protected void onPostExecute(String result) {
    super.onPostExecute(result);
    _parentActivity._progressBar.setVisibility(ProgressBar.INVISIBLE);
    _parentActivity._progressBar.invalidate();
}

@Override
protected void onCancelled() {
    super.onCancelled();
    _parentActivity._textView.setText("Request to cancel AsyncTask");
}

}

これはテストケースです。ここでAsyncTaskDemoActivityは、モードでAsyncTaskをテストするためのUIを提供する非常に単純なアクティビティです。

package kroz.andcookbook.test.threads.asynctask;
import java.util.concurrent.ExecutionException;
import kroz.andcookbook.R;
import kroz.andcookbook.threads.asynctask.AsyncTaskDemo;
import kroz.andcookbook.threads.asynctask.AsyncTaskDemoActivity;
import android.content.Intent;
import android.test.ActivityUnitTestCase;
import android.widget.Button;

public class AsyncTaskDemoTest2 extends ActivityUnitTestCase<AsyncTaskDemoActivity> {
AsyncTaskDemo _atask;
private Intent _startIntent;

public AsyncTaskDemoTest2() {
    super(AsyncTaskDemoActivity.class);
}

protected void setUp() throws Exception {
    super.setUp();
    _startIntent = new Intent(Intent.ACTION_MAIN);
}

protected void tearDown() throws Exception {
    super.tearDown();
}

public final void testExecute() {
    startActivity(_startIntent, null, null);
    Button btnStart = (Button) getActivity().findViewById(R.id.Button01);
    btnStart.performClick();
    assertNotNull(getActivity());
}

}

このすべてのコードは、Androidテストフレームワーク内で実行されたときにAsyncTaskが通知メソッドを呼び出さないことを除いて、問題なく機能しています。何か案は？

いくつかの単体テストを実装しているときに、同様の問題に遭遇しました。エグゼキューターで動作するいくつかのサービスをテストする必要があり、サービスコールバックをApplicationTestCaseクラスのテストメソッドと同期させる必要がありました。通常、テストメソッド自体はコールバックがアクセスされる前に終了するため、コールバックを介して送信されるデータはテストされません。@UiThreadTestバストを適用しようとしても機能しませんでした。

私は次の方法を見つけました、それはうまくいきました、そして私はまだそれを使います。単純にCountDownLatch信号オブジェクトを使用して、待機通知（同期（ロック）{...ロック。通知（）;}を使用できますが、これによりコードが醜くなります）メカニズムを実装します。

public void testSomething(){
final CountDownLatch signal = new CountDownLatch(1);
Service.doSomething(new Callback() {

  @Override
  public void onResponse(){
    // test response data
    // assertEquals(..
    // assertTrue(..
    // etc
    signal.countDown();// notify the count down latch
  }

});
signal.await();// wait for callback
}

私は多くの近い答えを見つけましたが、それらのどれもすべての部分を正しく組み立てませんでした。したがって、これはJUnitテストケースでandroid.os.AsyncTaskを使用する場合の1つの正しい実装です。

 /**
 * This demonstrates how to test AsyncTasks in android JUnit. Below I used 
 * an in line implementation of a asyncTask, but in real life you would want
 * to replace that with some task in your application.
 * @throws Throwable 
 */
public void testSomeAsynTask () throws Throwable {
    // create  a signal to let us know when our task is done.
    final CountDownLatch signal = new CountDownLatch(1);

    /* Just create an in line implementation of an asynctask. Note this 
     * would normally not be done, and is just here for completeness.
     * You would just use the task you want to unit test in your project. 
     */
    final AsyncTask<String, Void, String> myTask = new AsyncTask<String, Void, String>() {

        @Override
        protected String doInBackground(String... arg0) {
            //Do something meaningful.
            return "something happened!";
        }

        @Override
        protected void onPostExecute(String result) {
            super.onPostExecute(result);

            /* This is the key, normally you would use some type of listener
             * to notify your activity that the async call was finished.
             * 
             * In your test method you would subscribe to that and signal
             * from there instead.
             */
            signal.countDown();
        }
    };

    // Execute the async task on the UI thread! THIS IS KEY!
    runTestOnUiThread(new Runnable() {

        @Override
        public void run() {
            myTask.execute("Do something");                
        }
    });       

    /* The testing thread will wait here until the UI thread releases it
     * above with the countDown() or 30 seconds passes and it times out.
     */        
    signal.await(30, TimeUnit.SECONDS);

    // The task is done, and now you can assert some things!
    assertTrue("Happiness", true);
}

これに対処する方法は、AsyncTaskを呼び出すコードを実行することですrunTestOnUiThread()。

public final void testExecute() {
    startActivity(_startIntent, null, null);
    runTestOnUiThread(new Runnable() {
        public void run() {
            Button btnStart = (Button) getActivity().findViewById(R.id.Button01);
            btnStart.performClick();
        }
    });
    assertNotNull(getActivity());
    // To wait for the AsyncTask to complete, you can safely call get() from the test thread
    getActivity()._myAsyncTask.get();
    assertTrue(asyncTaskRanCorrectly());
}

デフォルトでは、junitはメインアプリケーションUIとは別のスレッドでテストを実行します。AsyncTaskのドキュメントによると、タスクインスタンスとexecute（）の呼び出しはメインUIスレッド上にある必要があります。これは、AsyncTaskがメインスレッドLooperとMessageQueueその内部ハンドラが正しく動作するために。

注意：

以前@UiThreadTestはテストメソッドのデコレータとして使用してメインスレッドでテストを強制的に実行することをお勧めしましたが、テストメソッドがメインスレッドで実行されている間はメッセージが処理されないため、これはAsyncTaskのテストにはあまり適していません。メインのMessageQueue — AsyncTaskが進行状況について送信するメッセージを含み、テストをハングさせます。

呼び出し側スレッドでAsyncTaskを実行しても構わない場合（単体テストの場合は問題ないはずです）、https： //stackoverflow.com/a/6583868/1266123で説明されているように、現在のスレッドでエグゼキュータを使用できます。

public class CurrentThreadExecutor implements Executor {
    public void execute(Runnable r) {
        r.run();
    }
}

そして、あなたはこのようにユニットテストでAsyncTaskを実行します

myAsyncTask.executeOnExecutor(new CurrentThreadExecutor(), testParam);

これはHoneyComb以降でのみ機能します。

私はAndroid向けに十分な統合を書いており、その方法を共有したいだけです。

まず、待機と解放を担当するヘルパークラスを次に示します。特にない：

SyncronizeTalker

public class SyncronizeTalker {
    public void doWait(long l){
        synchronized(this){
            try {
                this.wait(l);
            } catch(InterruptedException e) {
            }
        }
    }



    public void doNotify() {
        synchronized(this) {
            this.notify();
        }
    }


    public void doWait() {
        synchronized(this){
            try {
                this.wait();
            } catch(InterruptedException e) {
            }
        }
    }
}

次に、AsyncTask作業が終了したときに呼び出されるメソッドを1つ持つインターフェースを作成します。もちろん、結果もテストしたいと思います。

TestTaskItf

public interface TestTaskItf {
    public void onDone(ArrayList<Integer> list); // dummy data
}

次に、テストするタスクのスケルトンを作成します。

public class SomeTask extends AsyncTask<Void, Void, SomeItem> {

   private ArrayList<Integer> data = new ArrayList<Integer>(); 
   private WmTestTaskItf mInter = null;// for tests only

   public WmBuildGroupsTask(Context context, WmTestTaskItf inter) {
        super();
        this.mContext = context;
        this.mInter = inter;        
    }

        @Override
    protected SomeItem doInBackground(Void... params) { /* .... job ... */}

        @Override
    protected void onPostExecute(SomeItem item) {
           // ....

       if(this.mInter != null){ // aka test mode
        this.mInter.onDone(data); // tell to unitest that we finished
        }
    }
}

ついに-私たちの団結クラス：

TestBuildGroupTask

public class TestBuildGroupTask extends AndroidTestCase  implements WmTestTaskItf{


    private SyncronizeTalker async = null;

    public void setUP() throws Exception{
        super.setUp();
    }

    public void tearDown() throws Exception{
        super.tearDown();
    }

    public void test____Run(){

         mContext = getContext();
         assertNotNull(mContext);

        async = new SyncronizeTalker();

        WmTestTaskItf me = this;
        SomeTask task = new SomeTask(mContext, me);
        task.execute();

        async.doWait(); // <--- wait till "async.doNotify()" is called
    }

    @Override
    public void onDone(ArrayList<Integer> list) {
        assertNotNull(list);        

        // run other validations here

       async.doNotify(); // release "async.doWait()" (on this step the unitest is finished)
    }
}

それで全部です。

それが誰かに役立つことを願っています。

これは、doInBackgroundメソッドの結果をテストする場合に使用できます。onPostExecuteメソッドをオーバーライドして、そこでテストを実行します。AsyncTaskが完了するのを待つには、CountDownLatchを使用します。latch.await()カウントダウンまで待機する（によって行われている0（初期化時に設定されている）1から実行countdown()方法）。

@RunWith(AndroidJUnit4.class)
public class EndpointsAsyncTaskTest {

    Context context;

    @Test
    public void testVerifyJoke() throws InterruptedException {
        assertTrue(true);
        final CountDownLatch latch = new CountDownLatch(1);
        context = InstrumentationRegistry.getContext();
        EndpointsAsyncTask testTask = new EndpointsAsyncTask() {
            @Override
            protected void onPostExecute(String result) {
                assertNotNull(result);
                if (result != null){
                    assertTrue(result.length() > 0);
                    latch.countDown();
                }
            }
        };
        testTask.execute(context);
        latch.await();
    }

これらのソリューションのほとんどは、テストごとに、またはクラス構造を変更するために、多くのコードを記述する必要があります。プロジェクトで多くのテスト中の状況や多くのAsyncTaskがある場合、これを使用するのは非常に難しいと思います。

テストのプロセスを容易にするライブラリがありますAsyncTask。例：

@Test
  public void makeGETRequest(){
        ...
        myAsyncTaskInstance.execute(...);
        AsyncTaskTest.build(myAsyncTaskInstance).
                    run(new AsyncTest() {
                        @Override
                        public void test(Object result) {
                            Assert.assertEquals(200, (Integer)result);
                        }
                    });         
  }       
}

基本的に、AsyncTaskを実行し、postComplete()が呼び出された後に返される結果をテストします。