1ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton/* 2ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * Copyright (C) 2010 The Android Open Source Project 3ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * 4ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * Licensed under the Apache License, Version 2.0 (the "License"); 5ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * you may not use this file except in compliance with the License. 6ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * You may obtain a copy of the License at 7ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * 8ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * http://www.apache.org/licenses/LICENSE-2.0 9ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * 10ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * Unless required by applicable law or agreed to in writing, software 11ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * distributed under the License is distributed on an "AS IS" BASIS, 12ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * See the License for the specific language governing permissions and 14ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * limitations under the License 15ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton */ 16ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 17ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonpackage android.test; 18ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 19ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.content.Loader; 20ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.content.Loader.OnLoadCompleteListener; 21ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.os.AsyncTask; 22ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.os.Handler; 23ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.os.Looper; 24ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport android.os.Message; 25ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 26ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonimport java.util.concurrent.ArrayBlockingQueue; 27ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 28ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton/** 29ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * A convenience class for testing {@link Loader}s. This test case 30ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * provides a simple way to synchronously get the result from a Loader making 31ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * it easy to assert that the Loader returns the expected result. 32ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton */ 33ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamiltonpublic class LoaderTestCase extends AndroidTestCase { 34ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton static { 35ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // Force class loading of AsyncTask on the main thread so that it's handlers are tied to 36ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // the main thread and responses from the worker thread get delivered on the main thread. 37ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // The tests are run on another thread, allowing them to block waiting on a response from 38ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // the code running on the main thread. The main thread can't block since the AysncTask 39ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // results come in via the event loop. 40ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton new AsyncTask<Void, Void, Void>() { 41ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton @Override 42ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton protected Void doInBackground(Void... args) {return null;} 43ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton @Override 44ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton protected void onPostExecute(Void result) {} 45ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton }; 46ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 47ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 48ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton /** 49ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * Runs a Loader synchronously and returns the result of the load. The loader will 50ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * be started, stopped, and destroyed by this method so it cannot be reused. 51ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * 52ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * @param loader The loader to run synchronously 53ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton * @return The result from the loader 54ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton */ 55ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton public <T> T getLoaderResultSynchronously(final Loader<T> loader) { 56ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // The test thread blocks on this queue until the loader puts it's result in 57ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton final ArrayBlockingQueue<T> queue = new ArrayBlockingQueue<T>(1); 58ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 59ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // This callback runs on the "main" thread and unblocks the test thread 60ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // when it puts the result into the blocking queue 61ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton final OnLoadCompleteListener<T> listener = new OnLoadCompleteListener<T>() { 62ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton @Override 63ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton public void onLoadComplete(Loader<T> completedLoader, T data) { 64ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // Shut the loader down 65ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton completedLoader.unregisterListener(this); 66ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton completedLoader.stopLoading(); 67c91893511dc1b9e634648406c9ae61b15476e65dDianne Hackborn completedLoader.reset(); 68ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 69ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // Store the result, unblocking the test thread 70ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton queue.add(data); 71ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 72ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton }; 73ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 74ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // This handler runs on the "main" thread of the process since AsyncTask 75ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // is documented as needing to run on the main thread and many Loaders use 76ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // AsyncTask 77ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton final Handler mainThreadHandler = new Handler(Looper.getMainLooper()) { 78ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton @Override 79ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton public void handleMessage(Message msg) { 80ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton loader.registerListener(0, listener); 81ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton loader.startLoading(); 82ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 83ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton }; 84ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 85ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // Ask the main thread to start the loading process 86ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton mainThreadHandler.sendEmptyMessage(0); 87ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 88ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton // Block on the queue waiting for the result of the load to be inserted 89ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton T result; 90ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton while (true) { 91ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton try { 92ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton result = queue.take(); 93ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton break; 94ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } catch (InterruptedException e) { 95ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton throw new RuntimeException("waiting thread interrupted", e); 96ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 97ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 98ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton 99ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton return result; 100ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton } 101ebd19e0f48b0cb246c246274a256a9bb494b7e7aJeff Hamilton} 102