Android 使用 Dagger 2 进行单元测试

Question

我有一个 Android 应用程序使用 Dagger 2 进行依赖注入。我还使用了最新的 gradle 构建工具，这些工具允许一种用于单元测试的构建变体和一种用于仪器测试的构建变体。我在我的应用程序中使用 java.util.Random，我想模拟它进行测试。我正在测试的 classes 不使用任何 Android 东西，所以它们只是常规 java classes.

在我的主要代码中，我在扩展 Application class 的 class 中定义了 Component，但在单元测试中我没有使用 Application。我尝试定义测试 Module 和 Component，但 Dagger 不会生成 Component。我还尝试使用我在我的应用程序中定义的 Component 并在我构建它时交换 Module，但是应用程序的 Component 没有 inject 方法用于我的测试 classes。我如何提供 Random 的模拟实现以进行测试？

下面是一些示例代码：

申请：

public class PipeGameApplication extends Application {

    private PipeGame pipeGame;

    @Singleton
    @Component(modules = PipeGameModule.class)
    public interface PipeGame {
        void inject(BoardFragment boardFragment);
        void inject(ConveyorFragment conveyorFragment);
    }

    @Override
    public void onCreate() {
        super.onCreate();
        pipeGame = DaggerPipeGameApplication_PipeGame.create();
    }

    public PipeGame component() {
        return pipeGame;
    }
}

模块：

@Module
public class PipeGameModule {

    @Provides
    @Singleton
    Random provideRandom() {
        return new Random();
    }
}

基础 class 测试：

public class BaseModelTest {

    PipeGameTest pipeGameTest;

    @Singleton
    @Component(modules = PipeGameTestModule.class)
    public interface PipeGameTest {
        void inject(BoardModelTest boardModelTest);
        void inject(ConveyorModelTest conveyorModelTest);
    }

    @Before
    public void setUp() {
        pipeGameTest = DaggerBaseModelTest_PipeGameTest.create(); // Doesn't work
    }

    public PipeGameTest component() {
        return pipeGameTest;
    }
}

或：

public class BaseModelTest {

    PipeGameApplication.PipeGame pipeGameTest;

    // This works if I make the test module extend
    // the prod module, but it can't inject my test classes
    @Before
    public void setUp() {
        pipeGameTest = DaggerPipeGameApplication_PipeGame.builder().pipeGameModule(new PipeGameModuleTest()).build();
    }

    public PipeGameApplication.PipeGame component() {
        return pipeGameTest;
    }
}

测试模块：

@Module
public class PipeGameTestModule {

    @Provides
    @Singleton
    Random provideRandom() {
        return mock(Random.class);
    }
}

Answer 1

如果没有一些解决方法，目前 Dagger 2（从 v2.0.0 开始）是不可能的。你可以阅读它 here.

有关可能解决方法的更多信息：

How do you override a module/dependency in a unit test with Dagger 2.0?
Creating test dependencies when using Dagger2

Answer 2

在我看来，您可以从不同的角度来看待这个问题。您可以轻松地对 class 进行单元测试，方法是不依赖 Dagger 构建被测 class 并将其模拟依赖项注入其中。

我的意思是，在测试设置中，您可以：

模拟被测class的依赖关系
使用模拟的依赖项手动构建 class 被测

我们不需要测试依赖项是否被正确注入，因为 Dagger 会在编译期间验证依赖关系图的正确性。因此，编译失败将报告任何此类错误。这就是为什么在设置方法中手动创建 class under test 应该是可以接受的。

在被测 class 中使用构造函数注入依赖项的代码示例：

public class BoardModelTest {

  private BoardModel boardModel;
  private Random random;

  @Before
  public void setUp() {
    random = mock(Random.class);
    boardModel = new BoardModel(random);
  }

  @Test
  ...
}

public class BoardModel {
  private Random random;

  @Inject
  public BoardModel(Random random) {
    this.random = random;
  }

  ...
}

使用被测class中的字段注入依赖项的代码示例（如果BoardModel由框架构建）：

public class BoardModelTest {

  private BoardModel boardModel;
  private Random random;

  @Before
  public void setUp() {
    random = mock(Random.class);
    boardModel = new BoardModel();
    boardModel.random = random;
  }

  @Test
  ...
}

public class BoardModel {
  @Inject
  Random random;

  public BoardModel() {}

  ...
}

Answer 3

如果您将 dagger2 与 Android 一起使用，则可以使用应用风格来提供模拟资源。

请在此处查看模拟测试中的风味演示（无匕首）： https://www.youtube.com/watch?v=vdasFFfXKOY

这个代码库有一个例子： https://github.com/googlecodelabs/android-testing

在你的/src/prod/com/yourcompany/Component.java 您提供生产组件。

在你的/src/mock/com/yourcompany/Component.java 你提供你的模拟组件。

这允许您使用或不使用模拟来创建应用程序的构建。它还允许并行开发（一个团队的后端，另一个团队的前端应用程序），您可以模拟直到 api 方法可用。

我的 gradle 命令的外观（它是一个 Makefile）：

install_mock:
    ./gradlew installMockDebug

install:
    ./gradlew installProdDebug

test_unit:
    ./gradlew testMockDebugUnitTest

test_integration_mock:
    ./gradlew connectedMockDebugAndroidTest

test_integration_prod:
    ./gradlew connectedProdDebugAndroidTest

Answer 4

您说得一针见血：

application's Component doesn't have inject methods for my test classes

因此，为了解决这个问题，我们可以制作您的应用程序的测试版本 class。然后我们可以获得您的模块的测试版本。为了在测试中全部运行，我们可以使用 Robolectric.

1) 创建应用程序的测试版本 class

public class TestPipeGameApp extends PipeGameApp {
    private PipeGameModule pipeGameModule;

    @Override protected PipeGameModule getPipeGameModule() {
        if (pipeGameModule == null) {
            return super.pipeGameModule();
        }
        return pipeGameModule;
    }

    public void setPipeGameModule(PipeGameModule pipeGameModule) {
        this.pipeGameModule = pipeGameModule;
        initComponent();
    }}

2) 您的原始应用程序 class 需要具有 initComponent() 和 pipeGameModule() 方法

public class PipeGameApp extends Application {
    protected void initComponent() {
        DaggerPipeGameComponent.builder()
            .pipeGameModule(getPipeGameModule())
            .build();
    }

    protected PipeGameModule pipeGameModule() {
        return new PipeGameModule(this);
    }}

3) 您的 PipeGameTestModule 应该使用构造函数扩展生产模块：

public class PipeGameTestModule extends PipeGameModule {
    public PipeGameTestModule(Application app) {
        super(app);
    }}

4) 现在，在您的 junit 测试的 setup() 方法中，在您的测试应用程序上设置此测试模块：

@Before
public void setup() {
    TestPipeGameApp app = (TestPipeGameApp) RuntimeEnvironment.application;
    PipeGameTestModule module = new PipeGameTestModule(app);
    app.setPipeGameModule(module);
}

现在您可以按照最初的需要自定义测试模块。

Answer 5

我实际上遇到了同样的问题，并找到了一个非常简单的解决方案。这不是我认为的最佳解决方案，但它会解决您的问题。

在您的应用模块中创建一个类似的 class：

public class ActivityTest<T extends ViewModelBase> {

    @Inject
    public T vm;
}

然后，在您的 AppComponent 中添加：

void inject(ActivityTest<LoginFragmentVM> activityTest);

然后您就可以在测试中注入它 class。

 public class HelloWorldEspressoTest extends ActivityTest<LoginFragmentVM> {

    @Rule
    public ActivityTestRule<MainActivity> mActivityRule = new ActivityTestRule(MainActivity.class);

    @Test
    public void listGoesOverTheFold() throws InterruptedException {
        App.getComponent().inject(this);
        vm.email.set("1234");
        closeSoftKeyboard();
    }
}

Android 使用 Dagger 2 进行单元测试

Android Unit Tests with Dagger 2

java

android

unit-testing

dagger-2