Mikroporównanie i Hilt

Wiele aplikacji używa Hilt, aby wprowadzać różne zachowania do różnych wariantów kompilacji. Jest to szczególnie przydatne w przypadku mikrotestów porównawczych aplikacji, ponieważ umożliwia wyłączenie komponentu, 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 w analizie porównawczej uwzględnisz wywołanie sieciowe, zaimplementuj fałszywe wywołanie sieciowe, aby uzyskać dokładniejszy wynik.

Uwzględnienie w analizie porównawczej rzeczywistego wywołania sieciowego utrudnia interpretację wyników testów porównawczych. Na wywołania sieciowe może wpływać wiele czynników zewnętrznych, a czas ich trwania może być różny w zależności od testu porównawczego. Czas trwania wywołań sieciowych może potrwać dłużej niż sortowanie.

Wdrażanie fałszywego wywołania sieciowego przy użyciu Hilt

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

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 ma na celu jak najszybsze wywołanie metody getPeople(). Aby można było wstrzyknąć to przez Hilt, 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 zasobów za pomocą wywołania wejścia/wyjścia o zmiennej długości. Robi się to jednak podczas inicjowania i nie spowoduje żadnych problemów, gdy wywołanie getPeople() zostanie wykonane podczas analizy porównawczej.

Niektóre aplikacje wykorzystują już fałszywe kompilacje do debugowania, aby usuwać zależności backendu. Musisz jednak przeprowadzić testy porównawcze w przypadku kompilacji, która jest jak najbardziej zbliżona do kompilacji. Pozostała część tego dokumentu ma strukturę złożoną z wielu modułów i wielu wariantów, zgodnie z opisem w sekcji Pełna konfiguracja projektu.

Znajdują się tam 3 moduły:

• benchmarkable: zawiera kod do analizy porównawczej.
• benchmark: zawiera kod referencyjny.
• app: zawiera pozostały kod aplikacji.

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

Konfigurowanie modułu analizy porównawczej

Kod fałszywego wywołania sieciowego znajduje się w zbiorze źródłowym debug modułu benchmarkable, a pełna implementacja sieci znajduje się w zbiorze źródłowym release tego samego modułu. Plik zasobu zawierający dane zwrócone przez fałszywą implementację znajduje się w źródle debug tak, aby uniknąć zdublowania plików APK w kompilacji release. Wariant benchmark musi być oparty na release i używać zestawu źródeł debug. Konfiguracja kompilacji dla wariantu benchmark modułu benchmarkable zawierającego fałszywą implementację jest taka:

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"))
        }
    }
}

Odlotowy

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 proces uruchamiający testy, który tworzy Application do przeprowadzania testów z obsługą 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 przeprowadzane są 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)
}

Odlotowy

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
}

Poprzedni przykład wykonuje te czynności:

• Stosuje do kompilacji niezbędne wtyczki Gradle.
• Określa, że do uruchamiania testów używany jest niestandardowy mechanizm uruchamiania testów.
• Określa, że typem testu tego modułu jest wariant benchmark.
• Dodaje wariant benchmark.
• Dodaje wymagane zależności.

Musisz zmienić testBuildType, aby Gradle utworzyła zadanie connectedBenchmarkAndroidTest, które przeprowadza analizę porównawczą.

Tworzenie mikroporównania

Test porównawczy jest implementowany 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;
    }
}

Poprzedni przykład tworzy reguły zarówno dla testu porównawczego, jak i Hilt. benchmarkRule wykonuje czas przeprowadzenia testu porównawczego. hiltRule wykonuje wstrzykiwanie zależności w klasie testu porównawczego. Aby wykonać wstrzyknięcie przed uruchomieniem pojedynczych testów, musisz wywołać metodę inject() reguły Hilt w funkcji @Before.

Sama analiza porównawcza wstrzymuje czas na czas rejestrowania obserwatora LiveData. Następnie używa zatrzasku i czeka na zakończenie aktualizacji LiveData. Ponieważ sortowanie jest wykonywane w czasie między wywołaniem funkcji peopleRepository.update() a momentem otrzymania aktualizacji przez LiveData, czas trwania sortowania jest uwzględniany w czasie analizy porównawczej.

Przeprowadź test porównawczy

Przeprowadź test porównawczy za pomocą narzędzia ./gradlew :benchmark:connectedBenchmarkAndroidTest, aby przeprowadzić analizę porównawczą z wieloma iteracjami i wydrukować dane o czasie w Logcat:

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

Poprzedni przykład pokazuje wynik testu porównawczego z zakresu od 0,6 ms do 1,4 ms, aby uruchomić algorytm sortowania na liście 1000 elementów. Jeśli jednak uwzględnisz wywołanie sieciowe w analizie porównawczej, wariancja między iteracjami będzie większa niż czas potrzebny na przeprowadzenie sortowania, stąd konieczność odizolowania sortowania od wywołania sieciowego.

Aby ułatwić sobie sortowanie w izolacji, zawsze możesz refaktoryzować kod. Jeśli jednak korzystasz już z Hilt, możesz użyć go do wstrzyknięcia fałszywych danych do testów porównawczych.