154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project/* 254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Copyright (C) 2008 The Android Open Source Project 354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * you may not use this file except in compliance with the License. 654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * You may obtain a copy of the License at 754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 1054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 1154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 1254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * See the License for the specific language governing permissions and 1454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * limitations under the License. 1554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 1654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 1754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Projectpackage android.test; 1854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 1954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Projectimport android.app.Application; 2054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Projectimport android.app.Instrumentation; 2154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Projectimport android.content.Context; 2254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 2354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project/** 2454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * This test case provides a framework in which you can test Application classes in 2554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * a controlled environment. It provides basic support for the lifecycle of a 2654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Application, and hooks by which you can inject various dependencies and control 2754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * the environment in which your Application is tested. 2854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 2954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * <p><b>Lifecycle Support.</b> 3054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Every Application is designed to be accessed within a specific sequence of 3154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * method calls (see {@link android.app.Application} for more details). 3254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * In order to support the lifecycle of a Application, this test case will make the 3354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * following calls at the following times. 3454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 3554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * <ul><li>The test case will not call onCreate() until your test calls 3654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * {@link #createApplication()}. This gives you a chance 3754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * to set up or adjust any additional framework or test logic before 3854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * onCreate().</li> 3954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * <li>After your test completes, the test case {@link #tearDown} method is 4054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * automatically called, and it will stop & destroy your application by calling its 4154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * onDestroy() method.</li> 4254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * </ul> 4354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 4454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * <p><b>Dependency Injection.</b> 4554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Every Application has one inherent dependency, the {@link android.content.Context Context} in 4654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * which it runs. 4754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * This framework allows you to inject a modified, mock, or isolated replacement for this 4854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * dependencies, and thus perform a true unit test. 4954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 5054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * <p>If simply run your tests as-is, your Application will be injected with a fully-functional 5154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Context. 5254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * You can create and inject alternative types of Contexts by calling 5354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * {@link AndroidTestCase#setContext(Context) setContext()}. You must do this <i>before</i> calling 54ae5d46fddf39e784427a9c344a782001dd6f195cSimon Schoar * {@link #createApplication()}. The test framework provides a 5554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * number of alternatives for Context, including {@link android.test.mock.MockContext MockContext}, 5654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * {@link android.test.RenamingDelegatingContext RenamingDelegatingContext}, and 5754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * {@link android.content.ContextWrapper ContextWrapper}. 5854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 5954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Projectpublic abstract class ApplicationTestCase<T extends Application> extends AndroidTestCase { 6054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 6154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project Class<T> mApplicationClass; 6254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 6354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project private Context mSystemContext; 6454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 6554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project public ApplicationTestCase(Class<T> applicationClass) { 6654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplicationClass = applicationClass; 6754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 6854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 6954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project private T mApplication; 7054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project private boolean mAttached = false; 7154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project private boolean mCreated = false; 7254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 7354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 7454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * @return Returns the actual Application under test. 7554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 7654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project public T getApplication() { 7754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project return mApplication; 7854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 7954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 8054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 8154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * This will do the work to instantiate the Application under test. After this, your test 8254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * code must also start and stop the Application. 8354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 8454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project @Override 8554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project protected void setUp() throws Exception { 8654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project super.setUp(); 8754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 8854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project // get the real context, before the individual tests have a chance to muck with it 8954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mSystemContext = getContext(); 9054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 9154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 9254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 9354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Load and attach the application under test. 9454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 9554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project private void setupApplication() { 9654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplication = null; 9754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project try { 9854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplication = (T) Instrumentation.newApplication(mApplicationClass, getContext()); 9954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } catch (Exception e) { 10054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project assertNotNull(mApplication); 10154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 10254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mAttached = true; 10354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 10454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 10554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 10654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Start the Application under test, in the same way as if it was started by the system. 10754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * If you use this method to start the Application, it will automatically 10854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * be stopped by {@link #tearDown}. If you wish to inject a specialized Context for your 10954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * test, by calling {@link AndroidTestCase#setContext(Context) setContext()}, 11054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * you must do so before calling this method. 11154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 11254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project final protected void createApplication() { 11354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project assertFalse(mCreated); 11454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 11554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project if (!mAttached) { 11654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project setupApplication(); 11754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 11854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project assertNotNull(mApplication); 11954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 12054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplication.onCreate(); 12154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mCreated = true; 12254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 12354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 12454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 12554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * This will make the necessary calls to terminate the Application under test (it will 12654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * call onTerminate(). Ordinarily this will be called automatically (by {@link #tearDown}, but 12754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * you can call it directly from your test in order to check for proper shutdown behaviors. 12854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 12954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project final protected void terminateApplication() { 13054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project if (mCreated) { 13154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplication.onTerminate(); 13254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 13354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 13454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 13554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 13654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Shuts down the Application under test. Also makes sure all resources are cleaned up and 13754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * garbage collected before moving on to the next 13854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * test. Subclasses that override this method should make sure they call super.tearDown() 13954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * at the end of the overriding method. 14054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 14154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * @throws Exception 14254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 14354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project @Override 14454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project protected void tearDown() throws Exception { 14554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project terminateApplication(); 14654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project mApplication = null; 14754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 14854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project // Scrub out members - protects against memory leaks in the case where someone 14954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project // creates a non-static inner class (thus referencing the test case) and gives it to 15054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project // someone else to hold onto 15154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project scrubClass(ApplicationTestCase.class); 15254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 15354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project super.tearDown(); 15454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 15554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 15654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 15754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Return a real (not mocked or instrumented) system Context that can be used when generating 15854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * Mock or other Context objects for your Application under test. 15954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 16054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * @return Returns a reference to a normal Context. 16154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 16254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project public Context getSystemContext() { 16354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project return mSystemContext; 16454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 16554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project 16654b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project /** 16754b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * This test simply confirms that the Application class can be instantiated properly. 16854b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * 16954b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project * @throws Exception 17054b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project */ 17154b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project final public void testApplicationTestCaseSetUpProperly() throws Exception { 17254b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project setupApplication(); 17354b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project assertNotNull("Application class could not be instantiated successfully", mApplication); 17454b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project } 17554b6cfa9a9e5b861a9930af873580d6dc20f773The Android Open Source Project} 176