web-dev-qa-db-fra.com

Android Test AsyncTask avec Android Framework de test

J'ai un exemple d'implémentation AsyncTask très simple et j'ai du mal à le tester en utilisant Android Framework JUnit.

Cela fonctionne très bien lorsque j'instancie et l'exécute dans une application normale. Cependant, lorsqu'il est exécuté à partir de l'une des Android Test des classes de framework (ie AndroidTestCase , - ActivityUnitTestCase , ActivityInstrumentationTestCase2 etc) il se comporte étrangement:

  • Il exécute correctement la méthode doInBackground()
  • Cependant, il n'invoque aucune de ses méthodes de notification (onPostExecute(), onProgressUpdate(), etc.) - les ignore simplement en silence sans afficher d'erreurs.

Ceci est un exemple AsyncTask très simple:

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

}

Ceci est un cas de test. Ici AsyncTaskDemoActivity est une activité très simple fournissant une interface utilisateur pour tester AsyncTask en mode:

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

}

Tout ce code fonctionne très bien, sauf le fait que AsyncTask n'appelle pas ses méthodes de notification lorsqu'il est exécuté par dans Android Framework de test. Des idées?

androidjunit
94
Vladimir Kroz

J'ai rencontré un problème similaire lors de la mise en œuvre d'un test unitaire. J'ai dû tester un service qui fonctionnait avec des exécuteurs, et j'avais besoin de synchroniser mes rappels de service avec les méthodes de test de mes classes ApplicationTestCase. Habituellement, la méthode de test elle-même se terminait avant d'accéder au rappel, de sorte que les données envoyées via les rappels n'étaient pas testées. J'ai essayé d'appliquer le buste @UiThreadTest ne fonctionnait toujours pas.

J'ai trouvé la méthode suivante, qui a fonctionné, et je l'utilise toujours. J'utilise simplement les objets de signal CountDownLatch pour implémenter le wait-notify (vous pouvez utiliser synchronisé (verrou) {... lock.notify ();}, mais cela se traduit par un mécanisme de code laid).

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

J'ai trouvé beaucoup de réponses proches, mais aucune d'entre elles n'a correctement assemblé toutes les parties. Il s'agit donc d'une implémentation correcte lors de l'utilisation d'un Android.os.AsyncTask dans vos cas de tests 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);
}
92
Billy Brackeen

La façon de résoudre ce problème consiste à exécuter tout code qui appelle une AsyncTask dans 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());
}

Par défaut, junit exécute les tests dans un thread distinct de l'interface utilisateur de l'application principale. La documentation d'AsyncTask indique que l'instance de tâche et l'appel à execute () doivent être sur le thread d'interface utilisateur principal; c'est parce que AsyncTask dépend du Looper et MessageQueue du thread principal pour que son gestionnaire interne fonctionne correctement.

REMARQUE:

J'ai précédemment recommandé d'utiliser @UiThreadTest en tant que décorateur sur la méthode de test pour forcer le test à s'exécuter sur le thread principal, mais ce n'est pas tout à fait approprié pour tester une AsyncTask car pendant que votre méthode de test s'exécute sur le thread principal, aucun message n'est traité sur le MessageQueue principal - y compris les messages envoyés par AsyncTask à propos de sa progression, entraînant le blocage de votre test.

25
Alex Pretzlav

Si cela ne vous dérange pas d'exécuter AsyncTask dans le thread appelant (cela devrait être bien en cas de test unitaire), vous pouvez utiliser un exécuteur dans le thread actuel comme décrit dans https://stackoverflow.com/a/ 6583868/126612

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

Et puis vous exécutez votre AsyncTask dans votre test unitaire comme celui-ci

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

Cela ne fonctionne que pour HoneyComb et supérieur.

5
robUx4

J'ai écrit assez d'unités pour Android et je veux juste partager comment faire cela.

Tout d'abord, voici la classe d'assistance chargée d'attendre et de libérer le serveur. Rien de spécial:

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

Ensuite, permet de créer une interface avec une méthode qui devrait être appelée à partir de AsyncTask lorsque le travail est terminé. Bien sûr, nous voulons également tester nos résultats:

TestTaskItf

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

Ensuite, créons un squelette de notre tâche que nous allons tester:

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

Enfin - notre classe unitaire:

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

C'est tout.

J'espère que cela aidera quelqu'un.

5
Maxim Shoustin

Ceci peut être utilisé si vous souhaitez tester le résultat de la méthode doInBackground. Substituez la méthode onPostExecute et effectuez-y les tests. Pour attendre la fin de la tâche AsyncTask, utilisez CountDownLatch. La latch.await() attend que le compte à rebours passe de 1 (qui est défini lors de l'initialisation) à 0 (ce qui est fait par la méthode 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();
    }
4
Keerthana S