Mikroporównanie i Hilt

Wiele aplikacji korzysta z Hilt do wprowadzania odmiennych działań do różnych wariantów kompilacji. Jest to szczególnie przydatne przy przeprowadzaniu mikrotestów porównawczych aplikacji, ponieważ pozwala wykluczyć komponent, który może zniekształcać wyniki. Na przykład ten fragment kodu zawiera repozytorium, które pobiera i sortuje listę nazw:

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

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 testach porównawczych uwzględnisz wywołanie sieciowe, zaimplementuj fałszywe wywołanie sieci, aby uzyskać dokładniejsze wyniki.

Uwzględnienie prawdziwego wywołania sieci w przypadku testów porównawczych utrudnia interpretację wyników testów porównawczych. Wywołania sieci mogą zależeć od wielu czynników zewnętrznych, a ich czas trwania może się różnić w zależności od iteracji testu porównawczego. Czas trwania wywołań sieciowych może trwać dłużej niż sortowanie.

Wdrażanie fałszywego wywołania sieciowego za pomocą Hilt

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

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

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 sieci ma działać jak najszybciej, gdy wywołujesz metodę getPeople(). Aby umożliwić wstrzyknięcie kodu przez Hilt, używany jest następujący dostawca:

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

@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 przy użyciu wywołania wejścia-wyjścia o potencjalnie zmiennej długości. Odbywa się to jednak podczas inicjowania i nie spowoduje żadnych nieprawidłowości, gdy funkcja getPeople() zostanie wywołana podczas testów porównawczych.

Niektóre aplikacje używają już fałszywych w kompilacjach do debugowania, aby usunąć wszelkie zależności backendu. Musisz jednak przeprowadzić porównanie z kompilacją jak najbliżej wersji wydania. Pozostała część tego dokumentu wykorzystuje wielomodułową strukturę z wieloma wariantami, jak opisano w sekcji Pełna konfiguracja projektu.

Dostępne są 3 moduły:

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

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

Konfigurowanie modułu analizy porównawczej

Kod fałszywego wywołania sieci 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ę jest ustawiony w źródle debug, co pozwala uniknąć zbędnych plików APK w kompilacji release. Wariant benchmark musi się opierać na release i używać zbioru źródłowego debug. Konfiguracja kompilacji wariantu benchmark modułu benchmarkable zawierającego fałszywą implementację wygląda tak:

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

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 mechanizm uruchamiania testów, który tworzy Application do przeprowadzenia testów, który obsługuje Hilt:

class HiltBenchmarkRunner : AndroidBenchmarkRunner() {

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

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ą uruchamiane testy, rozszerza klasę HiltTestApplication. Wprowadź te zmiany w konfiguracji kompilacji:

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

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:

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

Musisz zmienić testBuildType, aby mieć pewność, że Gradle tworzy zadanie connectedBenchmarkAndroidTest, które wykonuje testy porównawcze.

Tworzenie mikroanalizy

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

@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()
        }
    }
}

@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 dla testu porównawczego i Hilt. benchmarkRule wykonuje test porównawczy z uwzględnieniem czasu trwania testu. hiltRule wykonuje wstrzykiwanie zależności w klasie testu porównawczego. Zanim uruchomisz jakikolwiek test, musisz wywołać metodę inject() reguły Hilt w funkcji @Before, aby wykonać wstrzykiwanie.

Test porównawczy zatrzymuje czas na czas rejestracji obserwatora LiveData. Następnie używa zatrzasku, aby zaczekać na zaktualizowanie LiveData, zanim zakończy. Sortowanie jest przeprowadzane w czasie między wywołaniem funkcji peopleRepository.update() a otrzymaniem aktualizacji przez LiveData, więc czas trwania sortowania jest uwzględniany w czasie analizy porównawczej.

Przeprowadź mikrotest porównawczy

Przeprowadź test porównawczy z użyciem parametru ./gradlew :benchmark:connectedBenchmarkAndroidTest, aby przeprowadzić test porównawczy dla wielu iteracji i wydrukować dane o czasie w narzędziu 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, co oznacza uruchomienie algorytmu sortowania w przypadku listy 1000 elementów. Jeśli jednak uwzględnisz wywołanie sieciowe w teście porównawczym, różnica między iteracjami będzie większa niż czas potrzebny na przeprowadzenie sortowania, a tym samym konieczność odizolowania tego sortowania od wywołania sieci.

Zawsze możesz przeprowadzić refaktoryzację kodu, aby ułatwić sobie sortowanie w izolacji, ale jeśli już korzystasz z Hilt, możesz go użyć do wstrzykiwania fałszywych treści na potrzeby testów porównawczych.