Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fabioCollini/DaggerMock
A JUnit rule to easily override Dagger 2 objects
https://github.com/fabioCollini/DaggerMock
android dagger espresso junit-rule mockito testing
Last synced: 2 months ago
JSON representation
A JUnit rule to easily override Dagger 2 objects
- Host: GitHub
- URL: https://github.com/fabioCollini/DaggerMock
- Owner: fabioCollini
- License: apache-2.0
- Created: 2015-12-27T10:40:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-02-01T09:31:05.000Z (about 2 years ago)
- Last Synced: 2024-08-10T14:05:29.764Z (6 months ago)
- Topics: android, dagger, espresso, junit-rule, mockito, testing
- Language: Java
- Homepage:
- Size: 484 KB
- Stars: 1,161
- Watchers: 33
- Forks: 96
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# DaggerMock
A JUnit rule to easily override Dagger 2 objects
[](https://travis-ci.org/fabioCollini/DaggerMock)
[](https://codecov.io/gh/fabioCollini/DaggerMock)
[](https://android-arsenal.com/details/1/2987)
[](https://jitpack.io/#fabioCollini/DaggerMock)
More info about testing using Dagger 2 and Mockito are available in this
[Medium post](https://medium.com/@fabioCollini/android-testing-using-dagger-2-mockito-and-a-custom-junit-rule-c8487ed01b56).
Overriding an object managed by Dagger 2 is not easy, you need to define a TestModule and, if you want
to inject your test object, a TestComponent.
Using a `DaggerMockRule` it's possible to override easily (in Java or Kotlin) the objects defined in a Dagger module:
###### Java
```java
public class MainServiceTest {
@Rule public DaggerMockRule rule = new DaggerMockRule<>(MyComponent.class, new MyModule())
.set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(MyComponent component) {
mainService = component.mainService();
}
});
@Mock RestService restService;
@Mock MyPrinter myPrinter;
MainService mainService;
@Test
public void testDoSomething() {
when(restService.getSomething()).thenReturn("abc");
mainService.doSomething();
verify(myPrinter).print("ABC");
}
}
```
###### Kotlin
```kotlin
class MainServiceTest {
@get:Rule val rule = DaggerMock.rule(MyModule()) {
set { mainService = it.mainService() }
}
val restService: RestService = mock()
val myPrinter: MyPrinter = mock()
lateinit var mainService: MainService
@Test
fun testDoSomething() {
whenever(restService.something).thenReturn("abc")
mainService.doSomething()
verify(myPrinter).print("ABC")
}
}
```
When `DaggerMockRule` rule is instantiated, it looks for all @Mock annotated fields in your test class
and it replaces them with Mockito mocks if there is a provider method in your module for that class.
Then it uses all the test fields to override the objects defined in the Dagger configuration.
> Note: DaggerMock invokes `MockitoAnnotations.initMocks` before the test. Hence, just adding the `DaggerMockRule`
is not enough: you additionally need to annotate any field you want to mock with `@Mock` or `@Spy` (even if you
don't have to define behavior or `verify` things on the mock).
> Note: static and null fields can't be used by DaggerMock.
In this example
[MyModule](https://github.com/fabioCollini/DaggerMock/blob/master/app/src/main/java/it/cosenonjaviste/daggermock/demo/MyModule.java)
contains two methods to provide `RestService` and `MyPrinter` objects. Behind the scenes, the
`DaggerMockRule` rule dynamically creates a new module that overrides `MyModule`, it returns the mocks
for `restService` and `myPrinter` defined in the test instead of the real objects, like this:
```java
public class TestModule extends MyModule {
@Override public MyPrinter provideMyPrinter() {
return Mockito.mock(MyPrinter.class);
}
@Override public RestService provideRestService() {
return Mockito.mock(RestService.class);
}
}
```
DaggerMock can't override Dagger objects that are defined using `Inject` annotation, since version 0.6
you get a runtime error if the test contains a field of a class that is not defined in a module.
All the modules containing objects that are going to be replaced must be provided in the `DaggerMockRule` constructor.
## Espresso support
A `DaggerMockRule` can also be used in an Espresso test:
###### Java
```java
public class MainActivityTest {
@Rule public DaggerMockRule daggerRule = new DaggerMockRule<>(MyComponent.class, new MyModule())
.set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(MyComponent component) {
App app = (App) InstrumentationRegistry.getInstrumentation().getTargetContext().getApplicationContext();
app.setComponent(component);
}
});
@Rule public ActivityTestRule activityRule = new ActivityTestRule<>(MainActivity.class, false, false);
@Mock RestService restService;
@Mock MyPrinter myPrinter;
@Test
public void testCreateActivity() {
when(restService.getSomething()).thenReturn("abc");
activityRule.launchActivity(null);
verify(myPrinter).print("ABC");
}
}
```
###### Kotlin
```kotlin
class MainActivityTest {
@get:Rule val daggerRule = DaggerMock.rule(MyModule()) {
set {
val app = InstrumentationRegistry.getInstrumentation().targetContext.applicationContext as App
app.component = it
}
}
@get:Rule var activityRule = ActivityTestRule(MainActivity::class.java, false, false)
val restService: RestService = mock()
val myPrinter: MyPrinter = mock()
@Test fun testCreateActivity() {
whenever(restService.something).thenReturn("abc")
activityRule.launchActivity(null)
verify(myPrinter).print("ABC")
}
}
```
In this example the third parameter `launchActivity` of the `ActivityTestRule` constructor is set to `false` to manually
launch the Activity. This way it's possible to define behaviour on the mocks before the creation of the Activity, and
`verify` things on your mocks in your tests.
## Robolectric support
In a similar way a `DaggerMockRule` can be used in a Robolectric test:
###### Java
```java
@RunWith(RobolectricGradleTestRunner.class)
@Config(constants = BuildConfig.class, sdk = 21)
public class MainActivityTest {
@Rule public final DaggerMockRule rule = new DaggerMockRule<>(MyComponent.class, new MyModule())
.set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(MyComponent component) {
((App) RuntimeEnvironment.application).setComponent(component);
}
});
@Mock RestService restService;
@Mock MyPrinter myPrinter;
@Test
public void testCreateActivity() {
when(restService.getSomething()).thenReturn("abc");
Robolectric.setupActivity(MainActivity.class);
verify(myPrinter).print("ABC");
}
}
```
###### Kotlin
```kotlin
@RunWith(RobolectricTestRunner::class)
@Config(constants = BuildConfig::class, sdk = intArrayOf(21))
class MainActivityTest {
@get:Rule val rule = DaggerMock.rule(MyModule()) {
set { (RuntimeEnvironment.application as App).component = it }
}
val restService: RestService = mock()
val myPrinter: MyPrinter = mock()
@Test fun testCreateActivity() {
whenever(restService.something).thenReturn("abc")
Robolectric.setupActivity(MainActivity::class.java)
verify(myPrinter).print("ABC")
}
}
```
> Note for Linux and Mac Users: working directory must be manually configured in Android Studio. More info on [Robolectric site](http://robolectric.org/getting-started/).
## InjectFromComponent annotation
In the first example we have used a ComponentSetter subclass to retrieve an object from the component:
```java
@Rule public DaggerMockRule rule = new DaggerMockRule<>(MyComponent.class, new MyModule())
.set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(MyComponent component) {
mainService = component.mainService();
}
});
MainService mainService;
```
Since DaggerMock 0.6 this code can be written in an easier way using `InjectFromComponent` annotation:
###### Java
```java
public class MainServiceTest {
@Rule public final DaggerMockRule rule = new DaggerMockRule<>(MyComponent.class, new MyModule());
@Mock RestService restService;
@Mock MyPrinter myPrinter;
@InjectFromComponent MainService mainService;
@Test
public void testDoSomething() {
when(restService.getSomething()).thenReturn("abc");
mainService.doSomething();
verify(myPrinter).print("ABC");
}
}
```
###### Kotlin
```kotlin
class MainServiceTest {
@get:Rule val rule = DaggerMock.rule(MyModule())
val restService: RestService = mock()
val myPrinter: MyPrinter = mock()
@InjectFromComponent lateinit var mainService: MainService
@Test fun testDoSomething() {
whenever(restService.something).thenReturn("abc")
mainService.doSomething()
verify(myPrinter).print("ABC")
}
}
```
Many objects managed by Dagger are only injected in other objects and are not exposed in a component.
For example if the MainService object is injected in MainActivity we can use the following annotation:
```java
@InjectFromComponent(MainActivity.class) MainService mainService;
```
A MainActivity object is created using reflection, the inject method is invoked on this object and then
the mainService field is extracted and used to populate the test field.
## Custom rules
It's easy to create a `DaggerMockRule` subclass to avoid copy and paste and simplify the test code:
```java
public class MyRule extends DaggerMockRule {
public MyRule() {
super(MyComponent.class, new MyModule());
set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(MyComponent component) {
App app = (App) InstrumentationRegistry.getInstrumentation().getTargetContext().getApplicationContext();
app.setComponent(component);
}
});
}
}
```
In Kotlin a method that creates the rule can be easily defined:
```kotlin
fun myRule() =
DaggerMock.rule(MyModule()) {
set {
val app = InstrumentationRegistry.getInstrumentation().targetContext.applicationContext as App
app.component = it
}
}
```
The final test uses the rule subclass:
```java
public class MainActivityTest {
@Rule public MyRule daggerRule = new MyRule();
@Rule public ActivityTestRule activityRule = new ActivityTestRule<>(MainActivity.class, false, false);
@Mock RestService restService;
@Mock MyPrinter myPrinter;
@Test
public void testCreateActivity() {
when(restService.getSomething()).thenReturn("abc");
activityRule.launchActivity(null);
verify(myPrinter).print("ABC");
}
}
```
## Supported Dagger features
### Subcomponents
Since version 0.6 Dagger subcomponents are supported by DaggerMock with a limitation:
subcomponent module must be passed as parameter in subcomponent creation method.
For example if the subcomponent is defined as follows:
```java
@Subcomponent(modules = MainActivityModule.class)
public interface MainActivityComponent {
void inject(MainActivity mainActivity);
}
```
The method in the main component that creates the subcomponent must be defined using a module parameter:
```java
@Singleton
@Component(modules = AppModule.class)
public interface AppComponent {
MainActivityComponent activityComponent(MainActivityModule module);
}
```
Subcomponent support doesn't work on Dagger 2.0, you need to use Dagger version 2.1+.
A complete example is available [here](https://github.com/fabioCollini/DaggerMock/tree/master/RealWorldApp).
### Abstract and static methods in module
DaggerMock doesn't support modules with static or abstract methods (annotated with `@Binds`). However if a component contains multiple modules (some abstract and other not abstract) DaggerMock can be used to replace objects defined in the not abstract modules.
### Dagger Android
Dagger Android is supported with some limitations:
- JVM tests are not supported, DaggerMock can be used only in Espresso tests
- objects defined in subcomponent/dependent component cannot be replaced, DaggerMock works only for objects defined in application component
- application must be set manually using `customizeBuilder` method:
###### Java
```java
public class EspressoDaggerMockRule extends DaggerMockRule {
public EspressoDaggerMockRule() {
super(AppComponent.class, new AppModule());
customizeBuilder(new BuilderCustomizer() {
@Override public AppComponent.Builder customize(AppComponent.Builder builder) {
return builder.application(getApp());
}
});
set(new DaggerMockRule.ComponentSetter() {
@Override public void setComponent(AppComponent component) {
component.inject(getApp());
}
});
}
private static App getApp() {
return (App) InstrumentationRegistry.getInstrumentation().getTargetContext().getApplicationContext();
}
}
```
###### Kotlin
```kotlin
fun espressoDaggerMockRule() = DaggerMock.rule(AppModule(app)) {
set { component -> component.inject(app) }
customizeBuilder { it.application(app) }
}
val app: App get() = InstrumentationRegistry.getInstrumentation().targetContext.applicationContext as App
```
A complete example is available [here](https://github.com/fabioCollini/DaggerMock/tree/master/RealWorldAppInjector).
## Kotlin support
DaggerMock can be used in both Java and Kotlin projects. Kotlin classes are final by default, you need to
_open_ them to create mocks using Mockito (and to use DaggerMock). There are three ways to solve this problem:
- define classes as `open`: the big drawback is that classes are open also in production code
- use [mock-maker](http://hadihariri.com/2016/10/04/Mocking-Kotlin-With-Mockito/) or mockito-inline dependency and [dexopener](https://github.com/tmurakami/dexopener):
a demo is available in [RealWorldAppKotlin](https://github.com/fabioCollini/DaggerMock/tree/master/RealWorldAppKotlin) module
- use [kotlin-allopen](https://kotlinlang.org/docs/reference/compiler-plugins.html#all-open-compiler-plugin):
a demo is available in [RealWorldAppKotlinAllOpen](https://github.com/fabioCollini/DaggerMock/tree/master/RealWorldAppKotlinAllOpen) module
## JitPack configuration
DaggerMock is available on [JitPack](https://jitpack.io/#fabioCollini/DaggerMock/),
add the JitPack repository in your build.gradle (in top level dir):
```gradle
repositories {
jcenter()
maven { url "https://jitpack.io" }
}
```
and the dependency in the build.gradle of the module:
```gradle
dependencies {
testImplementation 'com.github.fabioCollini.daggermock:daggermock:0.8.5'
//and/or
androidTestImplementation 'com.github.fabioCollini.daggermock:daggermock:0.8.5'
//kotlin helper methods
testImplementation 'com.github.fabioCollini.daggermock:daggermock-kotlin:0.8.5'
//and/or
androidTestImplementation 'com.github.fabioCollini.daggermock:daggermock-kotlin:0.8.5'
}
```
## License
Copyright 2016-2017 Fabio Collini
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.