Android Unit Test

Save time & clear your unit tests on Android !

Use annotations to inject Context, Activities, Fragments and Views into your tests

Usage

@RunWith(CustomTestRunner.class)
public class MainActivityTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RContect Context context; //inject the app context
    @RActivity MainActivity activity; //generates the tested activity
    @Mock User user; //mock an user

    @Test
    public void testDisplayUser() throws Exception {
        // Given
        given(user.getName()).willReturn("florent");
        
        // When
        activity.display(user);
        
        // Then
        assertThat(activity.textView.getText()).isEqualTo("florent");
    }
}

TestRunner

Simplify Robolectric Integration

public class CustomTestRunner extends AndroidUnitTestRunner {
    public CustomTestRunner(Class<?> testClass) throws InitializationError {
        super(testClass, BuildConfig.FLAVOR, BuildConfig.BUILD_TYPE, BuildConfig.APPLICATION_ID, TestMyApplication.class);
    }
}

Activity

Set initial activity state (by default activity is created())

@RunWith(CustomTestRunner.class)
public class MyTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RActivity(state = CREATED / STARTED / RESUMED / PAUSED / STOPPED / DESTROYED)
    MainActivity activity;
    
    @Test
    public void testMyFunction(){
         androidUnitTest.activity().resume();
    }

}

Note that the injected activity is a spy !

verify(activity, times(2)).someMethod(anyInt());

Context

Retrieve Context easily

@RunWith(CustomTestRunner.class)
public class MyTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RContext Context context;
}

Note that the injected context is a spy !

verify(context, times(2)).someMethod(anyInt());

View

@RunWith(CustomTestRunner.class)
public class MyTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RView CustomView customView;
    
    @Test
    public void testDisplayUser() throws Exception {
        // Given
        given(user.getName()).willReturn("florent");
        
        // When
        mainView.display(user);
        
        // Then
        verify(customView).displayText("florent");
    }
}

Note that the injected view is a spy !

Fragment

@RunWith(CustomTestRunner.class)
public class MyTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RFragment MyFragment myFragment;
    @Mock User user;
    
    @Test
    public void testDisplayUser() throws Exception {
        // Given
        given(user.getName()).willReturn("florent");
        
        // When
        myFragment.display(user);
        
        // Then
        verify(myFragment).displayText("florent");
    }
}

@RunWith(CustomTestRunner.class)
public class MyTest {
    @Rule public AndroidUnitTest androidUnitTest = AndroidUnitTest.rule();

    @RFragment(
        attached = true / false,
        tag = "fragmentTag"
    )
    MyFragment myFragment;
        
    @Test
    public void testMyFunction() throws Exception {
        androidUnitTest.fragment().addToActivity(myFragment)
    }
}

Note that the injected fragment is a spy !

Download

testCompile 'com.github.florent37:androidunittest:(last version)'

testCompile 'junit:junit:4.12'
testCompile 'org.mockito:mockito-core:1.10.19'
testCompile 'org.robolectric:robolectric:3.0'

Credits

Author: Florent Champigny

License

Copyright 2016 florent37, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.