Add tests infrastructure

Author: vkryl

.gitignore

@@ -17,4 +17,6 @@ obj
 /captures
 /local.properties
 
+/tests/*/checks
+
 libc++_shared.so

.gitmodules

@@ -58,6 +58,11 @@
 	url = https://github.com/TGX-Android/jni-utils
 	shallow = true
 	branch = main
+[submodule "vkryl/annotation"]
+	path = vkryl/annotation
+	url = https://github.com/TGX-Android/X-Annotation
+	shallow = true
+	branch = main
 [submodule "vkryl/leveldb"]
 	path = vkryl/leveldb
 	url = https://github.com/TGX-Android/leveldb

README.md

@@ -67,6 +67,118 @@ This is the complete source code and the build instructions for the official alt
    telegram.api_hash=YOUR_TELEGRAM_API_HASH</pre>
 3. [Setup Firebase](https://firebase.google.com/docs/android/setup) and replace `google-services.json` with the one that's suitable for your `app.id`
 
+### Commands
+
+<details>
+<summary>Reference of commands for building, testing and maintenance</summary>
+
+`-Pabi` limits native libraries to given ABIs, separated by commas: `arm64`, `arm32`, `x64` or `x86`. Without it, all ABIs are built. `Latest` in task names can be replaced with another flavor, see [flavors](/tests/README.md#flavors).
+
+#### Building
+
+Set up Android SDK, NDK and `local.properties`, on Windows in MSYS2:
+```shell
+scripts/setup.sh
+```
+
+Check that submodules and Git LFS files are fetched:
+```shell
+./gradlew :app:validateGitSetup
+```
+
+Build and install debug build on connected device:
+```shell
+./gradlew :app:installLatestDebug -Pabi=arm64
+```
+
+Build `legacy` flavor for Android 4.x, which requires older NDK:
+```shell
+./gradlew :app:assembleLegacyDebug -PuseLegacyNdk=true -Pabi=arm32
+```
+
+Build libvpx and FFmpeg for all flavors and ABIs, add `-PuseLegacyNdk=true` for `legacy` flavor:
+```shell
+./gradlew :app:buildLibvpx
+./gradlew :app:buildFfmpeg
+```
+
+#### Checking
+
+Run unit tests:
+```shell
+./gradlew :app:testLatestDebugUnitTest
+```
+
+Run integration tests and UI tests on emulator:
+```shell
+./gradlew :app:emulatorLatestDebugAndroidTest -Pabi=arm64
+./gradlew :tests:ui:emulatorLatestNonMinifiedReleaseAndroidTest -Pabi=arm64
+```
+
+Run one test on device, e.g. on connected one:
+```shell
+./gradlew :tests:ui:connectedLatestNonMinifiedReleaseAndroidTest -Pabi=arm64 -Pandroid.testInstrumentationRunnerArguments.class=tgx.test.UnauthorizedLaunchTest
+```
+
+Find classes added after minSdk of each flavor in declarations and, for Android 4.x, in imports, and calls to them without version checks:
+```shell
+./gradlew checkMinSdk
+./gradlew checkMinSdk -PuseLegacyNdk=true
+./gradlew :app:lintLegacyDebug -PuseLegacyNdk=true
+```
+
+Describe results of checks before and after a change for pull request, see [tests](/tests/README.md#tests-and-checks):
+```shell
+./gradlew clearCheckResults
+# Run checks without the change
+./gradlew saveCheckResults
+# Run checks with the change
+./gradlew describeCheckResults
+```
+
+Check test tools on connected test device after changing them, see [tests](/tests/README.md#running-tests):
+```shell
+scripts/check-test-tools.sh
+```
+
+#### Performance
+
+Run benchmarks on connected device and compare results before and after a change:
+```shell
+./gradlew :tests:benchmark:connectedLatestBenchmarkReleaseAndroidTest -Pabi=arm64
+./gradlew :tests:benchmark:saveBenchmarkResults
+# Apply the change and run benchmarks again
+./gradlew :tests:benchmark:compareBenchmarkResults -Pmetric=frameDurationCpuMsP90
+```
+
+Run microbenchmarks of app code and show implementations side by side:
+```shell
+./gradlew :tests:microbenchmark:connectedLatestNonMinifiedReleaseAndroidTest -Pabi=arm64 -Pandroid.testInstrumentationRunnerArguments.class=tgx.test.TextBenchmarks
+./gradlew :tests:microbenchmark:describeBenchmarkResults
+```
+
+Optimize `Text`: save results before a change, then run microbenchmarks after it and compare, see [tests](/tests/README.md#optimizing-code):
+```shell
+./gradlew -q :tests:microbenchmark:connectedLatestNonMinifiedReleaseAndroidTest :tests:microbenchmark:saveBenchmarkResults -Pabi=arm64 -Pandroid.testInstrumentationRunnerArguments.class=tgx.test.TextSuite
+# Change Text and run them again
+./gradlew -q :tests:microbenchmark:connectedLatestNonMinifiedReleaseAndroidTest :tests:microbenchmark:compareBenchmarkResults -Pabi=arm64 -Pandroid.testInstrumentationRunnerArguments.class=tgx.test.TextSuite -Pimplementation=Text -Pcontrol=BoringOrStaticLayout
+```
+
+List devices and variants for which baseline profiles will be generated, without generating them, as tasks named `<device><Variant>AndroidTest`:
+```shell
+./gradlew :app:generateBaselineProfile -Pabi=arm64 -m | grep AndroidTest
+```
+
+Generate baseline profiles for all variants on emulator and connected device, keeping computer awake and saving log. ABIs must suit both devices: on x86_64 computers emulator is `x64`, unlike phones:
+```shell
+# macOS with Apple silicon
+caffeinate -i ./gradlew :app:generateBaselineProfile -Pabi=arm64 --continue 2>&1 | tee ~/baseline-profile.log
+# Ubuntu
+systemd-inhibit --what=idle:sleep ./gradlew :app:generateBaselineProfile -Pabi=arm64,x64 --continue 2>&1 | tee ~/baseline-profile.log
+```
+
+</details>
+
 ## Reproducing public builds
 
 In order to verify that there is no additional source code injected inside official APKs, you must use one of the following versions of **Ubuntu**:
@@ -116,6 +228,6 @@ List of third-party components used in **Telegram X** can be found [here](/docs/
 
 ## Contributions
 
-**Telegram X** welcomes contributions. Check out [pull request template](/docs/PULL_REQUEST_TEMPLATE.md) and [guide for contributors](/docs/GUIDE.md) to learn more about Telegram X internals before creating the first pull request.
+**Telegram X** welcomes contributions. Check out [pull request template](/docs/PULL_REQUEST_TEMPLATE.md), [code style](/docs/CODE_STYLE.md) and [guide for contributors](/docs/GUIDE.md) to learn more about Telegram X internals before creating the first pull request.
 
 If you are a regular user and experience a problem with Telegram X, the best place to look for solution is [Telegram X chat](https://t.me/tgandroidtests) — a community with over 4 thousand members. Please do not use this repository to ask questions: if you have general issue with Telegram, refer to [FAQ](http://telegram.org/faq) or contact [Telegram Support](https://telegram.org/faq#telegram-support).

app/build.gradle.kts

@@ -9,17 +9,18 @@ import org.gradle.kotlin.dsl.support.uppercaseFirstChar
 import tgx.gradle.*
 import tgx.gradle.source.GitInformationSource
 import tgx.gradle.task.*
+import tgx.test.configureTests
 import java.util.*
 
 plugins {
   id("java-toolchain-convention")
   id(libs.plugins.android.application.get().pluginId)
+  id(libs.plugins.androidx.baselineprofile.get().pluginId)
   id("tgx-config")
   id("tgx-module")
 }
 
 val config = tgxConfig.config.get()
-val generateBaselineProfile = tgxConfig.generateBaselineProfile.get()
 val useLegacyPackaging = tgxConfig.useLegacyPackaging.get()
 val useLegacyNdk = tgxConfig.useLegacyNdk.get()
 val globalAbiFilters = tgxConfig.abiFilters.get()
@@ -386,7 +387,6 @@ android {
     buildConfigString("NDK_VERSION", ndkVersion)
     buildConfigBool("SHARED_STL", true)
     buildConfigBool("WEBP_ENABLED", true)
-    buildConfigBool("GENERATING_BASELINE_PROFILE", generateBaselineProfile)
 
     // Library versions in BuildConfig.java
 
@@ -526,9 +526,6 @@ android {
         dimension = "SDK"
         isDefault = sdkIndex == Sdk.LATEST
 
-        if (generateBaselineProfile && !variant.isLatest) {
-          matchingFallbacks += Sdk.VARIANTS[Sdk.LATEST]!!.flavor
-        }
         Sdk.VARIANTS.forEach { (subSdkIndex, subVariant) ->
           buildConfigBool("${subVariant.flavor.uppercase()}_FLAVOR", sdkIndex == subSdkIndex)
         }
@@ -620,6 +617,14 @@ android {
 
         var extraProguardFileCount = 0
 
+        findExtraFolders(variant).forEach { folderName ->
+          val proguardFile = project.layout.projectDirectory.file("src/$folderName/proguard-rules.pro").asFile
+          if (proguardFile.exists()) {
+            proguardFile(proguardFile)
+            extraProguardFileCount++
+          }
+        }
+
         arrayOf(
           "exoplayer",
           "common",
@@ -833,6 +838,10 @@ android {
       }
 
       variant.buildConfigFields!!.apply {
+        // Build types added by baseline profile plugin, which only tests use
+        put("TEST_HOOKS_ENABLED", BuildConfigField(
+          "boolean", variant.buildType == "nonMinifiedRelease" || variant.buildType == "benchmarkRelease", null
+        ))
         put("RECAPTCHA_VERSION", BuildConfigField(
           "String", "\"$recaptchaVersion\"", null
         ))
@@ -907,19 +916,29 @@ android {
   }
 }
 
-if (generateBaselineProfile) {
-  apply(plugin = libs.plugins.androidx.baselineprofile.get().pluginId)
-
-  extensions.configure<BaselineProfileConsumerExtension> {
-    mergeIntoMain = true
-    automaticGenerationDuringBuild = false
-    saveInSrc = true
-    warnings.disabledVariants = false
+configureTests()
+
+extensions.configure<BaselineProfileConsumerExtension> {
+  mergeIntoMain = false
+  automaticGenerationDuringBuild = false
+  saveInSrc = true
+  warnings.disabledVariants = false
+  warnings.variantHasNoBaselineProfileDependency = false
+  Sdk.VARIANTS.values.filter {
+    it.usesBaselineProfile
+  }.forEach { variant ->
+    variants.create("${variant.flavor}Release").from(project(":tests:baseline-profile"))
   }
+}
 
-  afterEvaluate {
-    dependencies.add("latestReleaseBaselineProfile", project(":baseline-profile"))
-  }
+// Plugin merges and copies profiles of all release variants, which would leave empty folders in src for variants without profiles
+val variantsWithoutBaselineProfile = Sdk.VARIANTS.values.filter {
+  !it.usesBaselineProfile
+}.map { "${it.flavor.uppercaseFirstChar()}Release" }
+tasks.named { name ->
+  variantsWithoutBaselineProfile.any { name == "merge${it}BaselineProfile" || name == "copy${it}BaselineProfileIntoSrc" }
+}.configureEach {
+  enabled = false
 }
 
 afterEvaluate {
@@ -991,7 +1010,12 @@ dependencies {
     libs.androidx.exifinterface.latest
   )
   implementation(libs.androidx.biometric)
-  implementation(libs.androidx.palette)
+  flavorImplementation(
+    libs.androidx.palette.legacy,
+    libs.androidx.palette.legacy,
+    libs.androidx.palette.legacy,
+    libs.androidx.palette.latest
+  )
   implementation(libs.androidx.collection)
   implementation(libs.androidx.interpolator)
   // CameraX: https://developer.android.com/jetpack/androidx/releases/camera
@@ -1031,6 +1055,7 @@ dependencies {
   flavorImplementation(
     libs.google.play.services.maps.legacy,
     libs.google.play.services.maps.lollipop,
+    libs.google.play.services.maps.marshmallow,
     libs.google.play.services.maps.latest
   )
   flavorImplementation(
@@ -1144,6 +1169,10 @@ dependencies {
   compileOnly(libs.androidx.room.latest)
   compileOnly(libs.annotations.jsr305)
   compileOnly(libs.annotations.kotlin)
+
+  // Tests: tests/README.md
+  testImplementation(libs.bundles.unit.test)
+  androidTestImplementation(project(":tests:core"))
 }
 
 if (!config.isExperimentalBuild) {

app/src/main/java/org/thunderdog/challegram/component/attach/MediaBottomFilesController.java

@@ -926,7 +926,7 @@ private void addApplicationFolders (List<ListItem> items) {
     } catch (Throwable t) {
       Log.e(t);
     }
-    if (Config.ENABLE_BASELINE_PROFILE_HOOKS || tdlib.isDeveloper()) {
+    if (Config.ENABLE_TEST_HOOKS || tdlib.isDeveloper()) {
       InlineResultCommon snapshot = createItem(context, tdlib, KEY_SNAPSHOT, R.drawable.baseline_lock_24, Lang.getString(R.string.SessionSnapshot), Lang.getString(R.string.SessionSnapshotDesc));
       items.add(createItem(snapshot, R.id.btn_folder));
     }

app/src/main/java/org/thunderdog/challegram/config/Config.java

@@ -64,7 +64,7 @@ public class Config {
   // The only way around for the sender is to transcode video fully even when there's no need at all.
   public static final boolean TRANSCODE_ROTATED_VIDEOS_FOR_IOS_CLIENT = true;
 
-  public static final boolean ENABLE_BASELINE_PROFILE_HOOKS = BuildConfig.GENERATING_BASELINE_PROFILE;
+  public static final boolean ENABLE_TEST_HOOKS = BuildConfig.TEST_HOOKS_ENABLED;
 
   public static final boolean ENABLE_DELETE_CALL_HISTORY = BuildConfig.DEBUG;
 

app/src/main/java/org/thunderdog/challegram/navigation/ViewController.java

@@ -3488,6 +3488,9 @@ public void onFocus () {
     onFocusStateChanged();
     notifyFocusChanged(true);
     context.addKeyEventListener(this);
+    if (Config.ENABLE_TEST_HOOKS) {
+      updateScreenMarker();
+    }
   }
 
   protected final void trackUserActivity () {
@@ -3622,18 +3625,38 @@ public final void removeDestroyListener (Destroyable delegate) {
   }
 
   protected final View newStartupMarker () {
+    return newTestMarker(R.id.startup_marker);
+  }
+
+  private View newTestMarker (@IdRes int id) {
     View marker = new View(context) {
       @Override
       public boolean onTouchEvent (MotionEvent event) {
         return false;
       }
     };
-    marker.setId(R.id.startup_marker);
+    marker.setId(id);
     marker.setImportantForAccessibility(View.IMPORTANT_FOR_ACCESSIBILITY_YES);
     marker.setLayoutParams(FrameLayoutFix.newParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, Gravity.TOP | Gravity.CENTER_HORIZONTAL));
     return marker;
   }
 
+  private void updateScreenMarker () {
+    ViewGroup rootView = context.getRootView();
+    View marker = rootView.findViewById(R.id.screen_marker);
+    if (marker == null) {
+      marker = newTestMarker(R.id.screen_marker);
+      rootView.addView(marker);
+    }
+    String screenName;
+    try {
+      screenName = context.getResources().getResourceEntryName(getId());
+    } catch (Throwable t) {
+      screenName = getClass().getSimpleName();
+    }
+    marker.setContentDescription(screenName);
+  }
+
   @Override
   public final void performDestroy () {
     destroy();

app/src/main/java/org/thunderdog/challegram/ui/MainController.java

@@ -1324,7 +1324,7 @@ private void syncContacts (Runnable after) {
   }
 
   private void addStartupMarker () {
-    if (Config.ENABLE_BASELINE_PROFILE_HOOKS) {
+    if (Config.ENABLE_TEST_HOOKS) {
       tdlib.awaitConnection(() -> runOnUiThreadOptional(() -> {
         ViewGroup group = (ViewGroup) getWrapUnchecked();
         if (group.findViewById(R.id.startup_marker) == null) {
@@ -1337,7 +1337,7 @@ private void addStartupMarker () {
   private boolean notificationsRequested;
 
   private void showAnnoyingAlertsForCompliance (boolean fromAppResume) {
-    if (Config.ENABLE_BASELINE_PROFILE_HOOKS) {
+    if (Config.ENABLE_TEST_HOOKS) {
       addStartupMarker();
     }
     if (checkSyncAlert()) {

app/src/main/java/org/thunderdog/challegram/ui/PhoneController.java

@@ -1430,7 +1430,7 @@ public void onFocus () {
         if (UI.inTestMode()) {
           makeTestRequest();
         }
-        if (Config.ENABLE_BASELINE_PROFILE_HOOKS) {
+        if (Config.ENABLE_TEST_HOOKS) {
           tdlib.awaitConnection(() -> runOnUiThreadOptional(this::addStartupMarker));
         }
         break;

app/src/main/java/org/thunderdog/challegram/unsorted/Settings.java

@@ -574,7 +574,7 @@ private int getSettings () {
     }
 
     private boolean checkLogSetting (int flag) {
-      if (BuildConfig.GENERATING_BASELINE_PROFILE) {
+      if (BuildConfig.TEST_HOOKS_ENABLED) {
         if (flag == FLAG_TDLIB_OTHER_ENABLE_ANDROID_LOG) {
           return true;
         }
@@ -839,7 +839,7 @@ public File getDirectory () {
   private Settings () {
     File pmcDir = new File(AppContext.get().getFilesDir(), "pmc");
     boolean didNotExist = !pmcDir.exists();
-    if (Config.ENABLE_BASELINE_PROFILE_HOOKS && didNotExist) {
+    if (Config.ENABLE_TEST_HOOKS && didNotExist) {
       if (SessionSnapshot.restoreSnapshot()) {
         didNotExist = false;
       }