使用Android测试框架进行Android AsyncTask测试


97

我有一个非常简单的AsyncTask实现示例,使用Android JUnit框架对其进行测试时遇到了问题。

当我在常规应用程序中实例化并执行它时,它的工作正常。但是,当从任何Android Testing框架类(即AndroidTestCaseActivityUnitTestCaseActivityInstrumentationTestCase2等)执行该代码时,它的行为都会很奇怪:

  • 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是一个非常简单的Activity,提供用于在模式下测试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());
}

}

所有这些代码都工作正常,除了AsyncTask在Android Testing Framework中执行时不调用其通知方法这一事实。有任何想法吗?

Answers:


125

在实施一些单元测试时,我遇到了类似的问题。我必须测试一些与执行程序一起使用的服务,并且我需要使服务回调与ApplicationTestCase类中的测试方法同步。通常,测试方法本身会在访问回调之前完成,因此将不会测试通过回调发送的数据。尝试应用@UiThreadTest胸围仍然无法正常工作。

我发现以下方法有效,并且仍在使用。我只是使用CountDownLatch信号对象来实现等待通知(您可以使用synced(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()
彼得·阿杰泰

11
我正在测试一个AsynchTask。做到了这一点,好吧,似乎永远不会调用后台任务,而信号永远永远等待:(
Ixx 2012年

@Ixx,你打电话task.execute(Param...)之前await(),把countDown()onPostExecute(Result)?(见stackoverflow.com/a/5722193/253468)同样@PeterAjtai,Service.doSomething是一个异步调用一样task.execute
TWiStErRob

多么可爱又简单的解决方案。
Maciej Beimcik '18年

Service.doSomething()是您应该替换服务/异步任务调用的地方。确保调用signal.countDown()您需要实现的任何方法,否则测试会卡住。
维克多·R。奥利维拉

94

我找到了很多接近的答案,但没有一个将所有部分正确地组合在一起。因此,在JUnit测试案例中使用android.os.AsyncTask时,这是一种正确的实现。

 /**
 * 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
感谢您编写一个完整的示例...在实现此功能时,我遇到了很多小问题。
彼得·阿杰泰

仅仅一年后,您救了我。谢谢Billy Brackeen!
MaTT 2012年

8
如果要将超时计为测试失败,则可以执行以下操作:assertTrue(signal.await(...));
Jarett Millard 2013年

4
嘿,比利,我已经尝试过此实现,但是找不到runTestOnUiThread。测试用例应该扩展AndroidTestCase还是需要扩展ActivityInstrumentationTestCase2?
Doug Ray

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在不同于主应用程序UI的单独线程中运行测试。AsyncTask的文档说,任务实例和对execute()的调用必须在主UI线程上。这是因为AsyncTask依赖于主线程,Looper并且MessageQueue其内部处理程序可以正常工作。

注意:

我以前建议@UiThreadTest在测试方法上用作装饰器,以强制测试在主线程上运行,但这对于测试AsyncTask并不完全正确,因为在测试方法在主线程上运行时,不会在主线程上处理任何消息。主MessageQueue-包括AsyncTask发送的有关其进度的消息,导致测试挂起。


那救了我...尽管我不得不从另一个线程调用“ runTestOnUiThread”,否则我会得到“无法从主应用程序线程调用此方法”
Matthieu 2012年

@Matthieu您是否正在使用runTestOnUiThread()带有@UiThreadTest装饰器的测试方法?那行不通。如果没有测试方法@UiThreadTest,则默认情况下它应在自己的非主线程上运行。
亚历克斯·普雷茨拉夫

1
这个答案是纯真宝石。如果您真的想保留最初的答案,应该重新整理以强调更新,将其作为一些背景说明和常见的陷阱。
Snicolas 2013年

1
文档状态方法 Deprecated in API level 24 developer.android.com/reference/android/test/…–
Aivaras,

1
弃用,InstrumentationRegistry.getInstrumentation().runOnMainSync()改为使用!
Marco7757

5

如果您不介意在调用者线程中执行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及更高版本。


这应该上升
StefanTo

5

我为Android编写了足够的unitests,只是想分享如何做到这一点。

首先,这里是负责等待和释放侍者的助手类。没什么特别的:

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
}

接下来,创建我们要测试的Task的一些骨架:

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

-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()调用后返回的结果。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.