Testowanie Android AsyncTask za pomocą Android Test Framework

Mam bardzo prosty przykład implementacji AsyncTask i mam problem z testowaniem go przy użyciu frameworka Android JUnit.

Działa dobrze, gdy tworzę instancję i wykonuję ją w normalnej aplikacji. Jednak gdy jest wykonywany z dowolnej klasy platformy Android Testing (tj. AndroidTestCase , ActivityUnitTestCase , ActivityInstrumentationTestCase2 itp.) Zachowuje się dziwnie:

• Wykonuje doInBackground()poprawnie metodę
• Jednak to nie wywołuje żadnego z jej metody powiadomień ( onPostExecute(), onProgressUpdate()itp) - po prostu po cichu ignoruje je bez wykazywania jakichkolwiek błędów.

To jest bardzo prosty przykład 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");
}

}

To jest przypadek testowy. Tutaj AsyncTaskDemoActivity to bardzo proste działanie zapewniające interfejs użytkownika do testowania AsyncTask w trybie:

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());
}

}

Cały ten kod działa dobrze, z wyjątkiem faktu, że AsyncTask nie wywołuje swoich metod powiadamiania, gdy jest wykonywany w ramach Android Testing Framework. Jakieś pomysły?

Podobny problem napotkałem podczas wykonywania testów jednostkowych. Musiałem przetestować usługę, która działała z elementami wykonawczymi, i musiałem zsynchronizować wywołania zwrotne usługi z metodami testowymi z moich klas ApplicationTestCase. Zwykle sama metoda testowa kończyła się przed uzyskaniem dostępu do wywołania zwrotnego, więc dane wysyłane przez wywołania zwrotne nie byłyby testowane. Próbowałem zastosować biust @UiThreadTest nadal nie działał.

Znalazłem następującą metodę, która zadziałała i nadal jej używam. Po prostu używam obiektów sygnałowych CountDownLatch do zaimplementowania mechanizmu wait-notification (możesz użyć synchronized (lock) {... lock.notify ();}, jednak skutkuje to brzydkim kodem).

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
}

Znalazłem wiele bliskich odpowiedzi, ale żadna z nich nie ułożyła poprawnie wszystkich części razem. Jest to więc jedna poprawna implementacja podczas korzystania z android.os.AsyncTask w przypadkach testów JUnit.

 /**
 * 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);
}

Aby sobie z tym poradzić, należy uruchomić dowolny kod, który wywołuje AsyncTask w 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());
}

Domyślnie junit uruchamia testy w osobnym wątku niż główny interfejs aplikacji. Dokumentacja AsyncTask mówi, że instancja zadania i wywołanie funkcji execute () muszą znajdować się w głównym wątku interfejsu użytkownika; Dzieje się tak, ponieważ AsyncTask zależy od głównego wątku Looperi MessageQueuejego wewnętrznej obsługi, aby działała poprawnie.

UWAGA:

Wcześniej zalecałem używanie @UiThreadTestjako dekoratora w metodzie testowej, aby wymusić uruchomienie testu w głównym wątku, ale nie jest to całkiem dobre w przypadku testowania AsyncTask, ponieważ podczas gdy Twoja metoda testowa działa w głównym wątku, żadne komunikaty nie są przetwarzane w main MessageQueue - w tym wiadomości, które AsyncTask wysyła o swoim postępie, powodując zawieszenie testu.

Jeśli nie masz nic przeciwko wykonaniu AsyncTask w wątku wywołującego (powinno być w porządku w przypadku testów jednostkowych), możesz użyć Executora w bieżącym wątku, jak opisano w https://stackoverflow.com/a/6583868/1266123

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

Następnie uruchamiasz AsyncTask w teście jednostkowym w ten sposób

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

To działa tylko dla HoneyComb i nowszych.

Napisałem wystarczająco dużo testów jednostkowych dla Androida i po prostu chcę się podzielić, jak to zrobić.

Po pierwsze, tutaj jest klasa pomocnicza odpowiedzialna za czekanie i zwalnianie kelnera. Nic specjalnego:

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) {
            }
        }
    }
}

Następnie stwórzmy interfejs z jedną metodą, która powinna być wywołana po AsyncTaskzakończeniu pracy. Oczywiście, chcemy również przetestować nasze wyniki:

TestTaskItf

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

Następnie stwórzmy szkielet naszego zadania, który będziemy testować:

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
        }
    }
}

Nareszcie - nasza najwyższa klasa:

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)
    }
}

To wszystko.

Mam nadzieję, że komuś to pomoże.

Można tego użyć, jeśli chcesz przetestować wynik doInBackgroundmetody. Zmień onPostExecutemetodę i wykonaj tam testy. Aby poczekać na zakończenie AsyncTask, użyj CountDownLatch. Gdy latch.await()czeka aż działa odliczanie od 1 (który jest ustawiany podczas inicjalizacji) 0 (która jest wykonywana przez countdown()metody).

@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();
    }

Większość z tych rozwiązań wymaga napisania dużej ilości kodu dla każdego testu lub zmiany struktury klasy. Które uważam za bardzo trudne w użyciu, jeśli masz wiele testowanych sytuacji lub wiele AsyncTasks w swoim projekcie.

Istnieje biblioteka, która ułatwia proces testowania AsyncTask. Przykład:

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

Zasadniczo uruchamia AsyncTask i testuje wynik, który zwraca po postComplete()wywołaniu.