Pruebas Android AsyncTask con Android Test Framework

Tengo un ejemplo de implementación AsyncTask muy simple y estoy teniendo problemas para probarlo usando Android JUnit framework.

Funciona muy bien cuando lo instauro y lo ejecuto en la aplicación normal. Sin embargo, cuando se ejecuta desde cualquiera de las clases de marco de prueba de Android (es decir, AndroidTestCase , ActivityUnitTestCase , ActivityInstrumentationTestCase2 , etc.) se comporta de forma extraña:

  • Ejecuta el método doInBackground() correctamente
  • Sin embargo, no invoca ninguno de sus métodos de notificación ( onPostExecute() , onProgressUpdate() , etc.) – simplemente los ignora silenciosamente sin mostrar ningún error.

Este es un ejemplo AsyncTask muy 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 { 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"); } } 

Este es un caso de prueba. Aquí AsyncTaskDemoActivity es una actividad muy simple que proporciona UI para probar AsyncTask en modo:

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

Todo este código está funcionando bien, excepto el hecho de que AsyncTask no invoca sus métodos de notificación cuando se ejecuta dentro de Android Testing Framework. ¿Algunas ideas?

Me encontré con un problema similar al implementar algunas pruebas de unidad. Tuve que probar algún servicio que funcionaba con los ejecutores, y necesitaba sincronizar mis devoluciones de llamada de servicio con los métodos de prueba de mis clases ApplicationTestCase. Por lo general, el método de prueba finalizó antes de acceder a la callback, por lo que los datos enviados a través de las devoluciones de llamada no serían probados. Intenté aplicar el busto @UiThreadTest y aún no funcionó.

Encontré el siguiente método, que funcionó, y todavía lo uso. Simplemente uso los objetos de señal CountDownLatch para implementar wait-notify (puede usar synchronized (lock) {… lock.notify ();}, sin embargo, esto da como resultado un código feo).

 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 } 

Encontré muchas respuestas cercanas, pero ninguna de ellas reunió todas las piezas correctamente. Así que esta es una implementación correcta cuando se usa un android.os.AsyncTask en los casos de prueba de 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 myTask = new AsyncTask() { @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); } 

La forma de lidiar con esto es ejecutar cualquier código que invoca una AsyncTask en 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()); } 

De manera predeterminada, junit ejecuta pruebas en un hilo separado de la UI de la aplicación principal. La documentación de AsyncTask dice que la instancia de la tarea y la llamada a la ejecución () deben estar en el hilo de la interfaz de usuario principal; esto se debe a que AsyncTask depende de Looper y MessageQueue del subproceso principal para que su controlador interno funcione correctamente.

NOTA:

Anteriormente, recomendé usar @UiThreadTest como decorador en el método de prueba para forzar la ejecución de la prueba en el hilo principal, pero esto no es del todo correcto para probar un AsyncTask porque mientras el método de prueba se ejecuta en el hilo principal no se procesan los mensajes en el MessageQueue principal, incluidos los mensajes que envía AsyncTask sobre su progreso, haciendo que su prueba se cuelgue.

Si no le importa ejecutar AsyncTask en el hilo de la persona que llama (debería estar bien en el caso de las pruebas de Unidad), puede usar un Ejecutor en el hilo actual como se describe en https://stackoverflow.com/a/6583868/1266123.

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

Y luego ejecuta su AsyncTask en su prueba de unidad como esta

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

Esto solo funciona para HoneyComb y superior.

Escribí suficientes unitests para Android y solo quiero compartir cómo hacerlo.

Primero, aquí está la clase de ayudante responsable de esperar y liberar al mesero. Nada especial:

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

A continuación, permite crear una interfaz con un método que debería llamarse desde AsyncTask cuando se AsyncTask trabajo. Claro que también queremos probar nuestros resultados:

TestTaskItf

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

A continuación, crearemos un esqueleto de nuestra tarea que vamos a probar:

 public class SomeTask extends AsyncTask { private ArrayList data = new ArrayList(); 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 } } } 

Por fin, nuestra clase unitest:

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 list) { assertNotNull(list); // run other validations here async.doNotify(); // release "async.doWait()" (on this step the unitest is finished) } } 

Eso es todo.

Espero que ayude a alguien.

Esto se puede usar si desea probar el resultado del método doInBackground . Reemplace el método onPostExecute y realice las pruebas allí. Para esperar a que la AsyncTask complete, use CountDownLatch. El latch.await() espera hasta que la cuenta regresiva latch.await() de 1 (que se establece durante la inicialización) a 0 (que se realiza mediante el método de 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(); } 

La mayoría de esas soluciones requieren una gran cantidad de código para cada prueba o para cambiar su estructura de clase. Lo cual me parece muy difícil de usar si tiene muchas situaciones bajo prueba o muchas AsyncTasks en su proyecto.

Hay una biblioteca que facilita el proceso de prueba AsyncTask . Ejemplo:

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

Básicamente, ejecuta su AsyncTask y prueba el resultado que devuelve después de haber postComplete() la función postComplete() .