Hilt test kılavuzu (Görünümler)

Kavramlar ve Jetpack Compose uygulaması

Hilt gibi bağımlılık ekleme çerçevelerini kullanmanın avantajlarından biri, kodunuzu test etmeyi kolaylaştırmasıdır.

Birim testleri

Oluşturucu yerleştirme kullanan bir sınıfı test ederken bu sınıfı örneklendirmek için Hilt kullanmanız gerekmediğinden birim testleri için Hilt gerekli değildir. Bunun yerine, yapıcıda ek açıklama yokmuş gibi sahte veya taklit bağımlılıkları ileterek sınıf yapıcısını doğrudan çağırabilirsiniz:

Kotlin

@ActivityScoped
class AnalyticsAdapter @Inject constructor(
  private val service: AnalyticsService
) { ... }

class AnalyticsAdapterTest {

  @Test
  fun `Happy path`() {
    // You don't need Hilt to create an instance of AnalyticsAdapter.
    // You can pass a fake or mock AnalyticsService.
    val adapter = AnalyticsAdapter(fakeAnalyticsService)
    assertEquals(...)
  }
}

Java

@ActivityScope
public class AnalyticsAdapter {

  private final AnalyticsService analyticsService;

  @Inject
  AnalyticsAdapter(AnalyticsService analyticsService) {
    this.analyticsService = analyticsService;
  }
}

public final class AnalyticsAdapterTest {

  @Test
  public void happyPath() {
    // You don't need Hilt to create an instance of AnalyticsAdapter.
    // You can pass a fake or mock AnalyticsService.
    AnalyticsAdapter adapter = new AnalyticsAdapter(fakeAnalyticsService);
    assertEquals(...);
  }
}

Uçtan uca testler

Entegrasyon testleri için Hilt, bağımlılıkları üretim kodunuzda olduğu gibi ekler. Hilt ile test yapmak bakım gerektirmez çünkü Hilt her test için otomatik olarak yeni bir bileşen grubu oluşturur.

Test bağımlılıkları ekleme

Testlerinizde Hilt'i kullanmak için projenize hilt-android-testing bağımlılığını ekleyin:

Modern

dependencies {
    // For Robolectric tests.
    testImplementation 'com.google.dagger:hilt-android-testing:2.57.1'
    // ...with Kotlin.
    kaptTest 'com.google.dagger:hilt-android-compiler:2.57.1'
    // ...with Java.
    testAnnotationProcessor 'com.google.dagger:hilt-android-compiler:2.57.1'

    // For instrumented tests.
    androidTestImplementation 'com.google.dagger:hilt-android-testing:2.57.1'
    // ...with Kotlin.
    kaptAndroidTest 'com.google.dagger:hilt-android-compiler:2.57.1'
    // ...with Java.
    androidTestAnnotationProcessor 'com.google.dagger:hilt-android-compiler:2.57.1'
}

Kotlin

dependencies {
    // For Robolectric tests.
    testImplementation("com.google.dagger:hilt-android-testing:2.57.1")
    // ...with Kotlin.
    kaptTest("com.google.dagger:hilt-android-compiler:2.57.1")
    // ...with Java.
    testAnnotationProcessor("com.google.dagger:hilt-android-compiler:2.57.1")

    // For instrumented tests.
    androidTestImplementation("com.google.dagger:hilt-android-testing:2.57.1")
    // ...with Kotlin.
    kaptAndroidTest("com.google.dagger:hilt-android-compiler:2.57.1")
    // ...with Java.
    androidTestAnnotationProcessor("com.google.dagger:hilt-android-compiler:2.57.1")
}

Kullanıcı arayüzü testi kurulumu

Hilt kullanan tüm kullanıcı arayüzü testlerine @HiltAndroidTest ek açıklamasını eklemeniz gerekir. Bu ek açıklama, her test için Hilt bileşenlerini oluşturmaktan sorumludur.

Ayrıca, test sınıfına HiltAndroidRule eklemeniz gerekir. Bileşenlerin durumunu yönetir ve testinizde ekleme yapmak için kullanılır:

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule
  public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  // UI tests here.
}

Ardından, testinizin Hilt'in sizin için otomatik olarak oluşturduğu Application sınıfını bilmesi gerekir.

Test uygulaması

Hilt'i kullanan araçlı testleri, Hilt'i destekleyen bir Application nesnesinde yürütmeniz gerekir. Kitaplık, testlerde kullanılmak üzere HiltTestApplication sağlar. Testleriniz için farklı bir temel uygulama gerekiyorsa Testler için özel uygulama bölümüne bakın.

Test uygulamanızı enstrümantasyon testlerinizde veya Robolectric testlerinizde çalışacak şekilde ayarlamanız gerekir. Aşağıdaki talimatlar Hilt'e özel değildir. Testlerde çalıştırılacak özel bir uygulamanın nasıl belirtileceğine dair genel yönergelerdir.

Enstrümantasyon testlerinde test uygulamasını ayarlama

Hilt test uygulamasını enstrümantasyon testlerinde kullanmak için yeni bir test çalıştırıcı yapılandırmanız gerekir. Bu sayede Hilt, projenizdeki tüm enstrümantasyon testlerinde çalışır. Aşağıdaki adımları uygulayın:

  1. androidTest klasöründe AndroidJUnitRunner sınıfını genişleten özel bir sınıf oluşturun.
  2. newApplication işlevini geçersiz kılın ve oluşturulan Hilt test uygulamasının adını iletin.

Kotlin

// A custom runner to set up the instrumented application class for tests.
class CustomTestRunner : AndroidJUnitRunner() {

    override fun newApplication(cl: ClassLoader?, name: String?, context: Context?): Application {
        return super.newApplication(cl, HiltTestApplication::class.java.name, context)
    }
}

Java

// A custom runner to set up the instrumented application class for tests.
public final class CustomTestRunner extends AndroidJUnitRunner {

  @Override
  public Application newApplication(ClassLoader cl, String className, Context context)
      throws ClassNotFoundException, IllegalAccessException, InstantiationException {
    return super.newApplication(cl, HiltTestApplication.class.getName(), context);
  }
}

Ardından, bu test çalıştırıcıyı Gradle dosyanızda Araçlı birim testi kılavuzunda açıklandığı şekilde yapılandırın. Tam sınıf yolunu kullandığınızdan emin olun:

Modern

android {
    defaultConfig {
        // Replace com.example.android.dagger with your class path.
        testInstrumentationRunner "com.example.android.dagger.CustomTestRunner"
    }
}

Kotlin

android {
    defaultConfig {
        // Replace com.example.android.dagger with your class path.
        testInstrumentationRunner = "com.example.android.dagger.CustomTestRunner"
    }
}
Robolectric testlerinde test uygulamasını ayarlama

Kullanıcı arayüzü katmanınızı test etmek için Robolectric kullanıyorsanız robolectric.properties dosyasında hangi uygulamanın kullanılacağını belirtebilirsiniz:

application = dagger.hilt.android.testing.HiltTestApplication

Alternatif olarak, Robolectric'in @Config ek açıklamasını kullanarak uygulamayı her testte ayrı ayrı yapılandırabilirsiniz:

Kotlin

@HiltAndroidTest
@Config(application = HiltTestApplication::class)
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  // Robolectric tests here.
}

Java

@HiltAndroidTest
@Config(application = HiltTestApplication.class)
class SettingsActivityTest {

  @Rule public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  // Robolectric tests here.
}

4.2'den eski bir Android Gradle eklentisi sürümü kullanıyorsanız modülünüzün build.gradle dosyasında aşağıdaki yapılandırmayı uygulayarak yerel birim testlerinde @AndroidEntryPoint sınıflarının dönüştürülmesini etkinleştirin:

Modern

hilt {
    enableTransformForLocalTests = true
}

Kotlin

hilt {
    enableTransformForLocalTests = true
}

enableTransformForLocalTests hakkında daha fazla bilgiyi Hilt belgelerinde bulabilirsiniz.

Test özellikleri

Hilt, testlerinizde kullanılmaya hazır olduğunda test sürecini özelleştirmek için çeşitli özelliklerden yararlanabilirsiniz.

Testlerde türleri ekleme

Türleri bir teste yerleştirmek için alan yerleştirme amacıyla @Inject kullanın. Hilt'e @Inject alanlarını doldurmasını söylemek için hiltRule.inject() yöntemini çağırın.

Aşağıdaki enstrümantasyon testi örneğine bakın:

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var hiltRule = HiltAndroidRule(this)

  @Inject
  lateinit var analyticsAdapter: AnalyticsAdapter

  @Before
  fun init() {
    hiltRule.inject()
  }

  @Test
  fun `happy path`() {
    // Can already use analyticsAdapter here.
  }
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  @Inject AnalyticsAdapter analyticsAdapter;

  @Before
  public void init() {
    hiltRule.inject();
  }

  @Test
  public void happyPath() {
    // Can already use analyticsAdapter here.
  }
}

Bağlamayı değiştirme

Bir bağımlılığın sahte veya taklit örneğini yerleştirmeniz gerekiyorsa Hilt kitaplığına, canlı sürüm kodunda kullandığı bağlamayı kullanmamasını ve bunun yerine farklı bir bağlama kullanmasını söylemeniz gerekir. Bir bağlamayı değiştirmek için bağlamayı içeren modülü, testte kullanmak istediğiniz bağlamaları içeren bir test modülüyle değiştirmeniz gerekir.

Örneğin, üretim kodunuzun AnalyticsService için aşağıdaki gibi bir bağlama bildirdiğini varsayalım:

Kotlin

@Module
@InstallIn(SingletonComponent::class)
abstract class AnalyticsModule {

  @Singleton
  @Binds
  abstract fun bindAnalyticsService(
    analyticsServiceImpl: AnalyticsServiceImpl
  ): AnalyticsService
}

Java

@Module
@InstallIn(SingletonComponent.class)
public abstract class AnalyticsModule {

  @Singleton
  @Binds
  public abstract AnalyticsService bindAnalyticsService(
    AnalyticsServiceImpl analyticsServiceImpl
  );
}

Testlerde AnalyticsService bağlamasını değiştirmek için test veya androidTest klasöründe sahte bağımlılık içeren yeni bir Hilt modülü oluşturun ve bu modülü @TestInstallIn ile ek açıklama ekleyin. Bunun yerine, o klasördeki tüm testlere sahte bağımlılık eklenir.

Kotlin

@Module
@TestInstallIn(
    components = [SingletonComponent::class],
    replaces = [AnalyticsModule::class]
)
abstract class FakeAnalyticsModule {

  @Singleton
  @Binds
  abstract fun bindAnalyticsService(
    fakeAnalyticsService: FakeAnalyticsService
  ): AnalyticsService
}

Java

@Module
@TestInstallIn(
    components = SingletonComponent.class,
    replaces = AnalyticsModule.class
)
public abstract class FakeAnalyticsModule {

  @Singleton
  @Binds
  public abstract AnalyticsService bindAnalyticsService(
    FakeAnalyticsService fakeAnalyticsService
  );
}

Tek bir testte bağlamayı değiştirme

Bir bağlamayı tüm testler yerine tek bir testte değiştirmek için @UninstallModules ek açıklamasını kullanarak bir Hilt modülünü testten kaldırın ve testin içinde yeni bir test modülü oluşturun.

Önceki sürümdeki AnalyticsService örneğini kullanarak test sınıfında @UninstallModules ek açıklamasını kullanarak Hilt'e üretim modülünü yoksaymasını söyleyin:

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest { ... }

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
public final class SettingsActivityTest { ... }

Ardından, bağlamayı değiştirmeniz gerekir. Test sınıfı içinde, test bağlamayı tanımlayan yeni bir modül oluşturun:

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest {

  @Module
  @InstallIn(SingletonComponent::class)
  abstract class TestModule {

    @Singleton
    @Binds
    abstract fun bindAnalyticsService(
      fakeAnalyticsService: FakeAnalyticsService
    ): AnalyticsService
  }

  ...
}

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
public final class SettingsActivityTest {

  @Module
  @InstallIn(SingletonComponent.class)
  public abstract class TestModule {

    @Singleton
    @Binds
    public abstract AnalyticsService bindAnalyticsService(
      FakeAnalyticsService fakeAnalyticsService
    );
  }
  ...
}

Bu işlem yalnızca tek bir test sınıfının bağlamasını değiştirir. Tüm test sınıfları için bağlamayı değiştirmek istiyorsanız yukarıdaki bölümde yer alan @TestInstallIn ek açıklamasını kullanın. Alternatif olarak, test bağlamayı Robolectric testleri için test modülüne veya enstrümantasyon testleri için androidTest modülüne yerleştirebilirsiniz. Mümkün olduğunda @TestInstallIn kullanmanız önerilir.

Yeni değerler bağlanıyor

Testinizdeki alanları Hilt bağımlılık grafiğine kolayca bağlamak için @BindValue ek açıklamasını kullanın. Bir alanı @BindValue ile ek açıklama eklediğinizde, bu alan, bildirilen alan türü altında, o alan için mevcut olan tüm niteleyicilerle birlikte bağlanır.

AnalyticsService örneğinde, @BindValue kullanarak AnalyticsService öğesini sahte bir öğeyle değiştirebilirsiniz:

Kotlin

@UninstallModules(AnalyticsModule::class)
@HiltAndroidTest
class SettingsActivityTest {

  @BindValue @JvmField
  val analyticsService: AnalyticsService = FakeAnalyticsService()

  ...
}

Java

@UninstallModules(AnalyticsModule.class)
@HiltAndroidTest
class SettingsActivityTest {

  @BindValue AnalyticsService analyticsService = FakeAnalyticsService();

  ...
}

Bu sayede, testinizde bir bağlamayı değiştirme ve bağlamaya referans verme işlemlerini aynı anda yapabilirsiniz.

@BindValue, niteleyiciler ve diğer test ek açıklamalarıyla çalışır. Örneğin, Mockito gibi test kitaplıkları kullanıyorsanız bunu Robolectric testinde şu şekilde kullanabilirsiniz:

Kotlin

...
class SettingsActivityTest {
  ...

  @BindValue @ExampleQualifier @Mock
  lateinit var qualifiedVariable: ExampleCustomType

  // Robolectric tests here
}

Java

...
class SettingsActivityTest {
  ...
  @BindValue @ExampleQualifier @Mock ExampleCustomType qualifiedVariable;

  // Robolectric tests here
}

Çoklu bağlama eklemeniz gerekiyorsa @BindValue yerine @BindValueIntoSet ve @BindValueIntoMap ek açıklamalarını kullanabilirsiniz. @BindValueIntoMap, alanı bir harita anahtarı ek açıklamasıyla da açıklama eklemenizi gerektirir.

Özel durumlar

Hilt, standart dışı kullanım alanlarını destekleyen özellikler de sunar.

Testler için özel uygulama

Test uygulamanızın başka bir uygulamayı genişletmesi gerektiği için HiltTestApplication öğesini kullanamıyorsanız yeni bir sınıfı veya arayüzü @CustomTestApplication ile ek açıklama ekleyerek oluşturulan Hilt uygulamasının genişletmesini istediğiniz temel sınıfın değerini iletin.

@CustomTestApplication, parametre olarak ilettiğiniz uygulamayı genişleten ve Hilt ile test edilmeye hazır bir Application sınıfı oluşturur.

Kotlin

@CustomTestApplication(BaseApplication::class)
interface HiltTestApplication

Java

@CustomTestApplication(BaseApplication.class)
interface HiltTestApplication { }

Örnekte Hilt, BaseApplication sınıfını genişleten HiltTestApplication_Application adlı bir Application oluşturur. Genel olarak, oluşturulan uygulamanın adı, ek açıklamalı sınıfın adının sonuna _Application eklenmiş halidir. Oluşturulan Hilt test uygulamasını, Test uygulaması bölümünde açıklandığı gibi enstrümantasyon testlerinizde veya Robolectric testlerinizde çalışacak şekilde ayarlamanız gerekir.

Enstrümantasyon testinizde birden fazla TestRule nesnesi

Testinizde başka TestRule nesneleri varsa tüm kuralların birlikte çalışmasını sağlamanın birden fazla yolu vardır.

Kuralları aşağıdaki gibi bir araya getirebilirsiniz:

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule
  var rule = RuleChain.outerRule(HiltAndroidRule(this)).
        around(SettingsActivityTestRule(...))

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule public RuleChain rule = RuleChain.outerRule(new HiltAndroidRule(this))
        .around(new SettingsActivityTestRule(...));

  // UI tests here.
}

Alternatif olarak, HiltAndroidRule önce yürütüldüğü sürece her iki kuralı da aynı düzeyde kullanabilirsiniz. @Rule ek açıklamasındaki order özelliğini kullanarak yürütme sırasını belirtin. Bu özellik yalnızca JUnit 4.13 veya sonraki sürümlerde çalışır:

Kotlin

@HiltAndroidTest
class SettingsActivityTest {

  @get:Rule(order = 0)
  var hiltRule = HiltAndroidRule(this)

  @get:Rule(order = 1)
  var settingsActivityTestRule = SettingsActivityTestRule(...)

  // UI tests here.
}

Java

@HiltAndroidTest
public final class SettingsActivityTest {

  @Rule(order = 0)
  public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

  @Rule(order = 1)
  public SettingsActivityTestRule settingsActivityTestRule = new SettingsActivityTestRule(...);

  // UI tests here.
}

launchFragmentInContainer

androidx.fragment:fragment-testing kitaplığındaki launchFragmentInContainer, @AndroidEntryPoint ile ek açıklama eklenmemiş bir etkinliğe dayandığından Hilt ile kullanılamaz.

Bunun yerine architecture-samples GitHub deposundaki launchFragmentInHiltContainer kodunu kullanın.