Mikroporównanie i Hilt

Wiele aplikacji używa Hilt do wstrzykiwania różnych zachowań do różnych wariantów kompilacji. Może to być szczególnie przydatne podczas mikrotestów porównawczych aplikacji, ponieważ pozwala przełączyć komponent, który może zniekształcać wyniki. Na przykład ten fragment kodu pokazuje repozytorium, które pobiera i sortuje listę nazw:

Kotlin

class PeopleRepository @Inject constructor(
    @Kotlin private val dataSource: NetworkDataSource,
    @Dispatcher(DispatcherEnum.IO) private val dispatcher: CoroutineDispatcher
) {
    private val _peopleLiveData = MutableLiveData<List<Person>>()

    val peopleLiveData: LiveData<List<Person>>
        get() = _peopleLiveData

    suspend fun update() {
        withContext(dispatcher) {
            _peopleLiveData.postValue(
                dataSource.getPeople()
                    .sortedWith(compareBy({ it.lastName }, { it.firstName }))
            )
        }
    }
}}

Java

public class PeopleRepository {

    private final MutableLiveData<List<Person>> peopleLiveData = new MutableLiveData<>();

    private final NetworkDataSource dataSource;

    public LiveData<List<Person>> getPeopleLiveData() {
        return peopleLiveData;
    }

    @Inject
    public PeopleRepository(NetworkDataSource dataSource) {
        this.dataSource = dataSource;
    }

    private final Comparator<Person> comparator = Comparator.comparing(Person::getLastName)
            .thenComparing(Person::getFirstName);

    public void update() {
        Runnable task = new Runnable() {

            @Override
            public void run() {
                peopleLiveData.postValue(
                        dataSource.getPeople()
                                .stream()
                                .sorted(comparator)
                                .collect(Collectors.toList())
                );
            }
        };
        new Thread(task).start();
    }
}

Jeśli podczas testu porównawczego uwzględniasz wywołanie sieciowe, zaimplementuj fałszywe wywołanie sieciowe, aby uzyskać dokładniejszy wynik.

Uwzględnienie rzeczywistego wywołania sieciowego podczas testu porównawczego utrudnia interpretację wyników. Na wywołania sieciowe może wpływać wiele czynników zewnętrznych, a ich czas trwania może się różnić w zależności od iteracji testu porównawczego. Połączenia sieciowe mogą trwać dłużej niż sortowanie.

Implementowanie fałszywego wywołania sieciowego za pomocą Hilt

Wywołanie dataSource.getPeople(), jak pokazano w poprzednim przykładzie, zawiera wywołanie sieciowe. Jednak instancja NetworkDataSource jest wstrzykiwana przez Hilt i możesz ją zastąpić tą fałszywą implementacją na potrzeby testu porównawczego:

Kotlin

class FakeNetworkDataSource @Inject constructor(
    private val people: List<Person>
) : NetworkDataSource {
    override fun getPeople(): List<Person> = people
}

Java

public class FakeNetworkDataSource implements NetworkDataSource{

    private List<Person> people;

    @Inject
    public FakeNetworkDataSource(List<Person> people) {
        this.people = people;
    }

    @Override
    public List<Person> getPeople() {
        return people;
    }
}

To fałszywe wywołanie sieciowe jest zaprojektowane tak, aby działało jak najszybciej po wywołaniu metody getPeople(). Aby Hilt mógł wstrzyknąć tę zależność, używany jest ten dostawca:

Kotlin

@Module
@InstallIn(SingletonComponent::class)
object FakekNetworkModule {

    @Provides
    @Kotlin
    fun provideNetworkDataSource(@ApplicationContext context: Context): NetworkDataSource {
        val data = context.assets.open("fakedata.json").use { inputStream ->
            val bytes = ByteArray(inputStream.available())
            inputStream.read(bytes)

            val gson = Gson()
            val type: Type = object : TypeToken<List<Person>>() {}.type
            gson.fromJson<List<Person>>(String(bytes), type)
        }
        return FakeNetworkDataSource(data)
    }
}

Java

@Module
@InstallIn(SingletonComponent.class)
public class FakeNetworkModule {

    @Provides
    @Java
    NetworkDataSource provideNetworkDataSource(
            @ApplicationContext Context context
    ) {
        List<Person> data = new ArrayList<>();
        try (InputStream inputStream = context.getAssets().open("fakedata.json")) {
            int size = inputStream.available();
            byte[] bytes = new byte[size];
            if (inputStream.read(bytes) == size) {
                Gson gson = new Gson();
                Type type = new TypeToken<ArrayList<Person>>() {
                }.getType();
                data = gson.fromJson(new String(bytes), type);

            }
        } catch (IOException e) {
            // Do something
        }
        return new FakeNetworkDataSource(data);
    }
}

Dane są wczytywane z komponentów za pomocą wywołania wejścia/wyjścia o potencjalnie zmiennej długości. Dzieje się to jednak podczas inicjowania i nie powoduje żadnych nieprawidłowości, gdy funkcja getPeople() jest wywoływana podczas analizy porównawczej.

Niektóre aplikacje używają już fałszywych danych w kompilacjach do debugowania, aby usunąć wszelkie zależności backendu. Musisz jednak przeprowadzić testy porównawcze na kompilacji jak najbardziej zbliżonej do kompilacji do publikacji. W dalszej części tego dokumentu używamy struktury wielomodułowej i wielowariantowej, zgodnie z opisem w sekcji Pełna konfiguracja projektu.

Są 3 moduły:

• benchmarkable: zawiera kod do testu porównawczego.
• benchmark: zawiera kod testu porównawczego.
• app: zawiera pozostały kod aplikacji.

Każdy z powyższych modułów ma wariant kompilacji o nazwie benchmark oraz zwykłe warianty debug i release.

Konfigurowanie modułu testu porównawczego

Kod fałszywego wywołania sieciowego znajduje się w zbiorze źródeł debug modułu benchmarkable, a pełna implementacja sieciowa – w zbiorze źródeł release tego samego modułu. Plik zasobu zawierający dane zwracane przez fałszywą implementację znajduje się w zbiorze źródeł debug, aby uniknąć nadmiernego rozmiaru pliku APK w kompilacji release. Wariant benchmark musi być oparty na release i używać zbioru źródeł debug. Konfiguracja kompilacji dla wariantu benchmark modułu benchmarkable zawierającego fałszywą implementację wygląda tak:

Kotlin

android {
    ...
    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "proguard-rules.pro"
            )
        }
        create("benchmark") {
            initWith(getByName("release"))
        }
    }
    ...
    sourceSets {
        getByName("benchmark") {
            java.setSrcDirs(listOf("src/debug/java"))
            assets.setSrcDirs(listOf("src/debug/assets"))
        }
    }
}

Dynamiczny

android {
    ...
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'),
                'proguard-rules.pro'
            )
        }
        benchmark {
            initWith release
        }
    }
    ...
    sourceSets {
        benchmark {
            java.setSrcDirs ['src/debug/java']
            assets.setSrcDirs(listOf ['src/debug/assets']
        }
    }
}

W module benchmark dodaj niestandardowy moduł uruchamiający testy, który tworzy obiekt Application, w którym będą uruchamiane testy obsługujące Hilt:

Kotlin

class HiltBenchmarkRunner : AndroidBenchmarkRunner() {

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

Java

public class JavaHiltBenchmarkRunner extends AndroidBenchmarkRunner {

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

Dzięki temu obiekt Application, w którym są przeprowadzane testy, rozszerza klasę HiltTestApplication. Wprowadź te zmiany w konfiguracji kompilacji:

Kotlin

plugins {
    alias(libs.plugins.android.library)
    alias(libs.plugins.benchmark)
    alias(libs.plugins.jetbrains.kotlin.android)
    alias(libs.plugins.kapt)
    alias(libs.plugins.hilt)
}

android {
    namespace = "com.example.hiltmicrobenchmark.benchmark"
    compileSdk = 34

    defaultConfig {
        minSdk = 24

        testInstrumentationRunner = "com.example.hiltbenchmark.HiltBenchmarkRunner"
    }

    testBuildType = "benchmark"
    buildTypes {
        debug {
            // Since isDebuggable can't be modified by Gradle for library modules,
            // it must be done in a manifest. See src/androidTest/AndroidManifest.xml.
            isMinifyEnabled = true
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "benchmark-proguard-rules.pro"
            )
        }
        create("benchmark") {
            initWith(getByName("debug"))
        }
    }
}

dependencies {
    androidTestImplementation(libs.bundles.hilt)
    androidTestImplementation(project(":benchmarkable"))
    implementation(libs.androidx.runner)
    androidTestImplementation(libs.androidx.junit)
    androidTestImplementation(libs.junit)
    implementation(libs.androidx.benchmark)
    implementation(libs.google.dagger.hiltTesting)
    kaptAndroidTest(libs.google.dagger.hiltCompiler)
    androidTestAnnotationProcessor(libs.google.dagger.hiltCompiler)
}

Dynamiczny

plugins {
    alias libs.plugins.android.library
    alias libs.plugins.benchmark
    alias libs.plugins.jetbrains.kotlin.android
    alias libs.plugins.kapt
    alias libs.plugins.hilt
}

android {
    namespace = 'com.example.hiltmicrobenchmark.benchmark'
    compileSdk = 34

    defaultConfig {
        minSdk = 24

        testInstrumentationRunner 'com.example.hiltbenchmark.HiltBenchmarkRunner'
    }

    testBuildType "benchmark"
    buildTypes {
        debug {
            // Since isDebuggable can't be modified by Gradle for library modules,
            // it must be done in a manifest. See src/androidTest/AndroidManifest.xml.
            minifyEnabled true
            proguardFiles(
                getDefaultProguardFile('proguard-android-optimize.txt'),
                'benchmark-proguard-rules.pro'
            )
        }
        benchmark {
            initWith debug"
        }
    }
}

dependencies {
    androidTestImplementation libs.bundles.hilt
    androidTestImplementation project(':benchmarkable')
    implementation libs.androidx.runner
    androidTestImplementation libs.androidx.junit
    androidTestImplementation libs.junit
    implementation libs.androidx.benchmark
    implementation libs.google.dagger.hiltTesting
    kaptAndroidTest libs.google.dagger.hiltCompiler
    androidTestAnnotationProcessor libs.google.dagger.hiltCompiler
}

W powyższym przykładzie:

• Zastosuj niezbędne wtyczki Gradle do kompilacji.
• Określa, że do uruchamiania testów używany jest niestandardowy moduł uruchamiający testy.
• Określa, że wariant benchmark jest typem testowym dla tego modułu.
• Dodaje wariant benchmark.
• dodaje wymagane zależności,

Musisz zmienić testBuildType, aby Gradle utworzył zadanie connectedBenchmarkAndroidTest, które przeprowadza test porównawczy.

Tworzenie mikrotestu porównawczego

Test porównawczy jest przeprowadzany w ten sposób:

Kotlin

@RunWith(AndroidJUnit4::class)
@HiltAndroidTest
class PeopleRepositoryBenchmark {

    @get:Rule
    val benchmarkRule = BenchmarkRule()

    @get:Rule
    val hiltRule = HiltAndroidRule(this)

    private val latch = CountdownLatch(1)

    @Inject
    lateinit var peopleRepository: PeopleRepository

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

    @Test
    fun benchmarkSort() {
        benchmarkRule.measureRepeated {
            runBlocking {
                benchmarkRule.getStart().pauseTiming()
                withContext(Dispatchers.Main.immediate) {
                    peopleRepository.peopleLiveData.observeForever(observer)
                }
                benchmarkRule.getStart().resumeTiming()
                peopleRepository.update()
                latch.await()
                assert(peopleRepository.peopleLiveData.value?.isNotEmpty() ?: false)
           }
        }
    }

    private val observer: Observer<List<Person>> = object : Observer<List<Person>> {
        override fun onChanged(people: List<Person>?) {
            peopleRepository.peopleLiveData.removeObserver(this)
            latch.countDown()
        }
    }
}

Java

@RunWith(AndroidJUnit4.class)
@HiltAndroidTest
public class PeopleRepositoryBenchmark {
    @Rule
    public BenchmarkRule benchmarkRule = new BenchmarkRule();

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

    private CountdownLatch latch = new CountdownLatch(1);

    @Inject
    JavaPeopleRepository peopleRepository;

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

    @Test
    public void benchmarkSort() {
        BenchmarkRuleKt.measureRepeated(benchmarkRule, (Function1<BenchmarkRule.Scope, Unit>) scope -> {
            benchmarkRule.getState().pauseTiming();
            new Handler(Looper.getMainLooper()).post(() -> {
                awaitValue(peopleRepository.getPeopleLiveData());
            });
            benchmarkRule.getState().resumeTiming();
            peopleRepository.update();
            try {
                latch.await();
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            assert (!peopleRepository.getPeopleLiveData().getValue().isEmpty());
            return Unit.INSTANCE;
        });
    }

    private <T> void awaitValue(LiveData<T> liveData) {
        Observer<T> observer = new Observer<T>() {
            @Override
            public void onChanged(T t) {
                liveData.removeObserver(this);
                latch.countDown();
            }
        };
        liveData.observeForever(observer);
        return;
    }
}

W poprzednim przykładzie utworzono reguły zarówno dla testu porównawczego, jak i dla Hilt. benchmarkRule mierzy czas testu porównawczego. hiltRule wykonuje wstrzykiwanie zależności w klasie testu porównawczego. Aby przeprowadzić wstrzykiwanie przed uruchomieniem poszczególnych testów, musisz wywołać metodę inject() reguły Hilt w funkcji @Before.

Sam test porównawczy wstrzymuje pomiar czasu, gdy obserwator LiveData jest zarejestrowany. Następnie używa zatrzasku, aby poczekać na aktualizację LiveData, zanim zakończy działanie. Sortowanie jest wykonywane w czasie między wywołaniem peopleRepository.update() a otrzymaniem aktualizacji przez LiveData, więc czas trwania sortowania jest uwzględniany w czasie testu porównawczego.

Uruchamianie mikrotestu porównawczego

Uruchom test porównawczy za pomocą ./gradlew :benchmark:connectedBenchmarkAndroidTest, aby przeprowadzić go w wielu iteracjach i wyświetlić dane o czasie w Logcat:

PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...

Powyższy przykład pokazuje, że uruchomienie algorytmu sortowania na liście zawierającej 1000 elementów zajmuje od 0,6 ms do 1,4 ms. Jeśli jednak uwzględnisz wywołanie sieciowe w teście porównawczym, rozbieżność między iteracjami będzie większa niż czas potrzebny na wykonanie sortowania, dlatego konieczne jest odizolowanie sortowania od wywołania sieciowego.

Zawsze możesz refaktoryzować kod, aby ułatwić uruchamianie sortowania w izolacji, ale jeśli używasz już Hilta, możesz go użyć do wstrzykiwania fałszywych danych na potrzeby testów porównawczych.