Тестирование Android AsyncTask с помощью Android Test Framework

97

У меня есть очень простой пример реализации AsyncTask, и у меня возникли проблемы с его тестированием с использованием платформы Android JUnit.

Он отлично работает, когда я создаю и выполняю его в обычном приложении. Однако, когда он выполняется из любого из классов платформы Android Testing (например, 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 в режиме:

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

}

Весь этот код работает нормально, за исключением того факта, что AsyncTask не вызывает методы уведомления при выполнении в Android Testing Framework. Любые идеи?

android  junit 
— Владимир Кроз
источник

Ответы:

125

Я столкнулся с подобной проблемой при реализации некоторого модульного теста. Мне пришлось протестировать службу, которая работала с Executors, и мне нужно было синхронизировать обратные вызовы службы с тестовыми методами из моих классов ApplicationTestCase. Обычно сам тестовый метод завершается до того, как будет получен доступ к обратному вызову, поэтому данные, отправленные через обратные вызовы, не будут проверяться. Попытка применить бюст @UiThreadTest все еще не сработала.

Я нашел следующий метод, который сработал, и я до сих пор им пользуюсь. Я просто использую сигнальные объекты CountDownLatch для реализации механизма ожидания-уведомления (вы можете использовать synchronized (lock) {... lock.notify ();}, однако это приводит к некрасивому коду).

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
}
— банди
источник
1
Что есть Service.doSomething()?
— Peter Ajtai
11
Я тестирую AsynchTask. Сделал это, и, ну, фоновая задача, кажется, никогда не будет вызвана, и будет ждать вечно :(
— Ixx
@Ixx, вы назвали , task.execute(Param...)прежде чем await()и положить countDown()в onPostExecute(Result)? (см. stackoverflow.com/a/5722193/253468 ) Также @PeterAjtai Service.doSomething- это асинхронный вызов, например task.execute.
— TWiStErRob
какое прекрасное и простое решение.
— Maciej Beimcik
Service.doSomething()здесь вы должны заменить вызов задачи service / async. Обязательно вызовите signal.countDown()любой метод, который вам нужно реализовать, иначе ваш тест застрянет.
— Victor R. Oliveira
94

Я нашел много близких ответов, но ни один из них не соединил все части правильно. Итак, это одна из правильных реализаций при использовании android.os.AsyncTask в ваших тестовых примерах 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);
}
— Билли Брэкен
источник
1
спасибо, что написал полный пример ... У меня было много мелких проблем с реализацией этого.
— Peter Ajtai
Чуть больше года спустя вы спасли меня. Спасибо, Билли Брэкин!
— MaTT
8
Если вы хотите, чтобы тайм-аут засчитывался как провал теста, вы можете:assertTrue(signal.await(...));
— Джаретт Миллард,
4
Привет, Билли, я пробовал эту реализацию, но runTestOnUiThread не найден. Должен ли тестовый пример расширять AndroidTestCase или нужно расширять ActivityInstrumentationTestCase2?
— Дуг Рэй,
3
@DougRay У меня была такая же проблема - если вы расширите InstrumentationTestCase, будет найден runTestOnUiThread.
— Luminaire
25

Способ справиться с этим - запустить любой код, который вызывает 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 запускает тесты в отдельном потоке, чем основной пользовательский интерфейс приложения. В документации AsyncTask говорится, что экземпляр задачи и вызов execute () должны находиться в основном потоке пользовательского интерфейса; это потому, что AsyncTask зависит от основного потока Looperи MessageQueueего внутреннего обработчика для правильной работы.

НОТА:

Ранее я рекомендовал использовать @UiThreadTestв качестве декоратора для метода тестирования, чтобы заставить тест запускаться в основном потоке, но это не совсем подходит для тестирования AsyncTask, потому что пока ваш метод тестирования выполняется в основном потоке, сообщения не обрабатываются в main MessageQueue - включая сообщения, которые AsyncTask отправляет о своем ходе, что приводит к зависанию вашего теста.

— Алекс Претцлав
источник
Это спасло меня ... хотя мне пришлось вызвать runTestOnUiThread из еще одного потока, иначе я бы получил «Этот метод не может быть вызван из основного потока приложения»
— Matthieu
@Matthieu Вы использовали runTestOnUiThread()тестовый метод с @UiThreadTestдекоратором? Это не сработает. Если тестовый метод не имеет @UiThreadTest, по умолчанию он должен работать в собственном неосновном потоке.
— Alex Pretzlav 05
1
Этот ответ - настоящая жемчужина. Его следует переработать, чтобы акцентировать внимание на обновлении, если вы действительно хотите сохранить первоначальный ответ, представьте его как некоторое пояснение и обычную ловушку.
— Snicolas
1
В документации Deprecated in API level 24
— Айварас
1
Не рекомендуется, используйте InstrumentationRegistry.getInstrumentation().runOnMainSync()вместо этого!
— Marco7757,
5

Если вы не возражаете против выполнения AsyncTask в потоке вызывающего абонента (должно быть нормально в случае модульного тестирования), вы можете использовать Executor в текущем потоке, как описано в 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 и выше.

— robUx4
источник
это должно
— возрасти
5

Я написал достаточно юнитов для 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завершении работы. Конечно, мы также хотим проверить наши результаты:

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

Вот и все.

Надеюсь, это кому-то поможет.

— Максим Шустин
источник
4

Это можно использовать, если вы хотите проверить результат doInBackgroundметода. Переопределите onPostExecuteметод и проведите там тесты. Чтобы дождаться завершения AsyncTask, используйте CountDownLatch. В latch.await()жду , пока обратный отсчет времени проходит от 1 (который устанавливается во время инициализации) до 0 (что делается с помощью 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();
    }
— Keerthana S
источник
-1

Большинство этих решений требует написания большого количества кода для каждого теста или для изменения структуры вашего класса. Что мне очень сложно использовать, если у вас много тестируемых ситуаций или много AsyncTasks в вашем проекте.

Есть библиотека, которая облегчает процесс тестирования 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().

— Леонардо Соарес и Сильва
источник
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.