Merge upstream AnkiDroid

.github/report_emulator_test_failures.py → .github/report_test_failures.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python3
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-"""Report failures and skipped tests from Android's JUnit XML using the standard library."""
+"""Report failures and skipped tests from JUnit XML using the standard library."""
 
+import argparse
 import html
 import os
 from pathlib import Path
@@ -25,11 +26,11 @@ def read_ignored_tests(log_file):
     return ignored - failed
 
 
-def main(results_dir, log_file=None):
+def main(results_dir, log_file=None, pattern="TEST-*.xml", title="Test failures"):
     failures = []
     skipped = []
     ignored = read_ignored_tests(log_file)
-    for report in sorted(results_dir.rglob("TEST-*.xml")):
+    for report in sorted(results_dir.rglob(pattern)):
         try:
             root = ET.parse(report).getroot()
         except (ET.ParseError, OSError) as error:
@@ -68,11 +69,11 @@ def main(results_dir, log_file=None):
             print(failure, end="\n\n")
 
     if skipped:
-        title = f"Skipped tests ({len(skipped)})"
+        skipped_title = f"Skipped tests ({len(skipped)})"
         if os.environ.get("GITHUB_ACTIONS") == "true":
-            print(f"::group::{title}")
+            print(f"::group::{skipped_title}")
         else:
-            print(title, end="\n\n")
+            print(skipped_title, end="\n\n")
         for skip in skipped:
             print(skip, end="\n\n")
         if os.environ.get("GITHUB_ACTIONS") == "true":
@@ -81,11 +82,11 @@ def main(results_dir, log_file=None):
     if (failures or skipped) and os.environ.get("GITHUB_STEP_SUMMARY"):
         with open(os.environ["GITHUB_STEP_SUMMARY"], "a", encoding="utf-8") as summary:
             if failures:
-                summary.write("### Emulator test failures\n\n")
+                summary.write(f"### {title}\n\n")
                 for failure in failures:
                     summary.write(f"<pre>{html.escape(failure)}</pre>\n\n")
             if skipped:
-                summary.write(f"<details><summary>{title}</summary>\n\n")
+                summary.write(f"<details><summary>{skipped_title}</summary>\n\n")
                 for skip in skipped:
                     summary.write(f"<pre>{html.escape(skip)}</pre>\n\n")
                 summary.write("</details>\n\n")
@@ -94,4 +95,10 @@ def main(results_dir, log_file=None):
 
 
 if __name__ == "__main__":
-    sys.exit(main(Path(sys.argv[1]), Path(sys.argv[2]) if len(sys.argv) > 2 else None))
+    parser = argparse.ArgumentParser(description=__doc__)
+    parser.add_argument("results_dir", type=Path)
+    parser.add_argument("log_file", type=Path, nargs="?")
+    parser.add_argument("--pattern", default="TEST-*.xml", help="Recursive report glob relative to results_dir")
+    parser.add_argument("--title", default="Test failures", help="Failure heading in the job summary")
+    args = parser.parse_args()
+    sys.exit(main(args.results_dir, args.log_file, args.pattern, args.title))

.github/workflows/README.md

@@ -17,7 +17,7 @@ Alternately, you may run the actions on your fork of `Anki-Android`.
 | [Lint (JavaScript)](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/lint.yml)        | See script                                                           | Prettier, lint & code formatting                                                                                                                         |
 | [Build Logic](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/lint.yml)              | `./gradlew -p buildSrc test` and `tools/validate-version-code.sh`    | Version-code bump checks                                                                                                                                 |
 | [Unit Tests](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/tests_unit.yml)         | `./gradlew jacocoUnitTestReport --daemon`                            | Unit tests for the Android Project                                                                                                                       |
-| [Emulator Tests](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/tests_emulator.yml) | `TEST_RELEASE_BUILD=true ./gradlew jacocoAndroidTestReport --daemon` | Emulator tests for the Android Project.<br/>CI runs `bash .github/disable_art_metrics.sh` and `adb shell settings put global hide_error_dialogs 1` first |
+| [Emulator Tests](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/tests_emulator.yml) | `TEST_RELEASE_BUILD=true ./gradlew jacocoAndroidTestReport --daemon` | Emulator tests for the Android Project.<br/>CI runs `bash .github/disable_art_metrics.sh` and `adb shell settings put global hide_error_dialogs 1` first.<br/>Then runs `ReleaseSmokeTest` from `:baselineprofile` with `TEST_RELEASE_BUILD=false` |
 | [CodeQL](https://github.com/ankidroid/Anki-Android/blob/main/.github/workflows/codeql.yml)                 | N/A                                                                  | GitHub-only check.<br/>[Docs](https://codeql.github.com/)                                                                                                |
 
 ## Other Workflows

.github/workflows/lint.yml

@@ -9,6 +9,8 @@ on:
       - 'gh-readonly-queue/**'
       # Dependabot branches are already checked by the pull_request trigger.
       - 'dependabot/**'
+      # Crowdin translations are already checked by the pull_request trigger.
+      - 'i18n_sync'
   merge_group:
 
 permissions:

.github/workflows/publish.yml

@@ -123,13 +123,13 @@ jobs:
           gunzip *.gz
         shell: bash
 
+      - name: Clone ankidroiddocs for the changelog
+        run: git clone git@github.com:ankidroid/ankidroiddocs ../ankidroiddocs
+        shell: bash
+
       - name: Build and Release public release
         if: "${{ github.event.inputs.public != '' }}"
-        run: |
-          pushd ../
-          git clone git@github.com:ankidroid/ankidroiddocs
-          popd
-          ./tools/release.sh public
+        run: ./tools/release.sh public
         shell: bash
 
       - name: Build and Release test release

.github/workflows/screenshot_compare.yml

@@ -85,12 +85,16 @@ jobs:
           SUBDIR: ${{ github.event_name == 'pull_request' && format('screenshot-diff-pr-{0}', github.event.number) || format('screenshot-diff-{0}', github.ref_name) }}
         run: |
           # Trim 'AnkiDroid/build/outputs/roborazzi' from the artifact
-          # Only keep diagnostic content for failing cases: each <class>/diffs/ becomes <class>/
+          # Only keep the _compare images of failing cases: <class>/diffs/*_compare.png moves to <class>/
           mkdir -p "screenshot-diff/$SUBDIR"
           shopt -s nullglob
           for diffs_dir in AnkiDroid/build/outputs/roborazzi/*/diffs; do
             class_name="$(basename "$(dirname "$diffs_dir")")"
-            mv "$diffs_dir" "screenshot-diff/$SUBDIR/$class_name"
+            compares=("$diffs_dir"/*_compare.png)
+            if (( ${#compares[@]} )); then
+              mkdir -p "screenshot-diff/$SUBDIR/$class_name"
+              mv "${compares[@]}" "screenshot-diff/$SUBDIR/$class_name/"
+            fi
           done
 
       - name: Upload screenshot diffs

.github/workflows/sync_translations.yml

@@ -83,15 +83,15 @@ jobs:
           cd ./tools/localization
           yarn start extract
 
-      - name: Update translation to AnkiDroid res
+      - name: Update translations in common resources
         run: |
           cd ./tools/localization
           yarn start update
 
       - name: Check for changes and handle results
         id: tr_check
         run: |
-          git add docs/marketing/localized_description AnkiDroid/src/main/res
+          git add docs/marketing/localized_description common/android/src/main/res
           if git diff --cached --quiet; then
             echo "HAS_CHANGES=false" >> $GITHUB_OUTPUT
             echo "Translation Sync Result: No new translation found on Crowdin. No Pull Request necessary" >> $GITHUB_STEP_SUMMARY

.github/workflows/tests_emulator.yml

@@ -1,6 +1,9 @@
 name: 🛠️ Emulator Tests
 
 on:
+  schedule:
+    # Weekly emulator coverage, Monday at 03:17 UTC.
+    - cron: '17 3 * * 1'
   workflow_dispatch:
     inputs:
       iterations:
@@ -15,13 +18,15 @@ on:
       - 'gh-readonly-queue/**'
       # Dependabot branches are already checked by the pull_request trigger.
       - 'dependabot/**'
+      # Crowdin translations are already checked by the pull_request trigger.
+      - 'i18n_sync'
   merge_group:
 
 permissions:
   contents: read
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name == 'schedule' && 'scheduled' || 'ci' }}
   cancel-in-progress: true
 
 jobs:
@@ -56,22 +61,21 @@ jobs:
               console.log('iterationArray is: ' + iterationArray)
             }
 
-            // If we are running on a schedule it's our periodic passive scan for flakes
-            // Goal is to run enough iterations on all systems that we have confidence there are no flakes
-            if (context.eventName === "schedule") {
-              const iterationCount = 15
-              for (let i = 0; i < iterationCount; i++) {
-                iterationArray.push(i);
-              }
-            }
-
             // TODO Refactor to make these dynamic with a minSdk/max bracket only on schedule, not push
             let apiLevel = [36];
 
             // These are used for performance tuning what emulator to use.
             // try different architectures, targets, delays etc
             let arch = ['x86_64'];
             let target = ['google_apis', 'google_apis_ps16k'];
+            // Keep API 37 and the 16 KB emulator off the per-change CI path.
+            // Scheduled and manual runs exercise both API levels and targets.
+            if (context.eventName !== 'schedule' && context.eventName !== 'workflow_dispatch') {
+              target = ['google_apis'];
+            } else {
+              // Keep the minor version: SDK 37 packages use android-37.0.
+              apiLevel.push('37.0');
+            }
             let firstBootDelay = [600];
 
             return {
@@ -94,6 +98,14 @@ jobs:
     env:
       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       TEST_RELEASE_BUILD: true
+      # Capture startup and kernel logs before ADB is ready; -logcat conflicts with -show-kernel.
+      EMULATOR_OPTIONS: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none -verbose -show-kernel
+      # API 37 otherwise defaults to 96 MiB and panics during init with an OOM.
+      EMULATOR_RAM_SIZE: ${{ matrix.api-level == '37.0' && '2560M' || '' }}
+      # Keep the SDK package at 37.0, but ensure the AVD is recognized as API 37.
+      # API 3 fallback disables the DMA readback required by API 37's graphics mapper.
+      EMULATOR_PRE_LAUNCH_SCRIPT: >-
+        if [ '${{ matrix.api-level }}' = '37.0' ]; then sed -i 's/^target=.*/target=android-37/' "$ANDROID_AVD_HOME/test.ini" "$ANDROID_AVD_HOME/test.avd/config.ini"; fi
     strategy:
       fail-fast: false
       matrix: ${{fromJson(needs.matrix_prep.outputs.matrix)}}
@@ -138,17 +150,16 @@ jobs:
           # Comment this and the with: above out for performance testing on a branch
           cache-read-only: ${{ github.ref != 'refs/heads/main' }}
 
-        # This appears to be 'Cache Size: ~1230 MB (1290026823 B)' based on watching action logs
-        # Repo limit is 10GB; branch caches are independent; branches may read default branch cache.
-        # We don't want branches to evict main branch snapshot, so save on main, read-only all else
+        # Cache only the per-change emulator: the 16 KB snapshot costs about 2.5 GiB.
       - name: AVD cache
+        if: matrix.target == 'google_apis'
         uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
         id: avd-cache
         with:
           path: |
             ~/.android/avd/*
             ~/.android/adb*
-          key: avd-${{ matrix.api-level }}-${{ matrix.arch }}-${{matrix.target}}-v2-${{ github.event.inputs.clearCaches }}
+          key: avd-${{ matrix.api-level }}-${{ matrix.arch }}-${{matrix.target}}-v2-
           restore-keys: |
             avd-${{ matrix.api-level }}-${{ matrix.arch }}-${{matrix.target}}-v2
 
@@ -159,7 +170,7 @@ jobs:
           timeout_minutes: 15
           retry_wait_seconds: 60
           max_attempts: 3
-          command: ./gradlew packagePlayRelease packagePlayReleaseAndroidTest --daemon
+          command: ./gradlew packagePlayRelease packagePlayReleaseAndroidTest :baselineprofile:packageBenchmarkBenchmark --daemon
 
       - name: Install Android Emulator
         # Retry to work around https://github.com/ReactiveCircus/android-emulator-runner/issues/496
@@ -191,16 +202,18 @@ jobs:
             "${ANDROID_HOME:?}/system-images/android-${SDK_API_LEVEL:?}/${SDK_TARGET:?}/${SDK_ARCH:?}/.installer"
 
       - name: AVD Boot and Snapshot Creation
-        # Only generate a snapshot for saving if we are on main branch with a cache miss
+        # Warm up the uncached 16 KB emulator on every run; otherwise only on main cache misses.
         # Comment the if out to generate snapshots on branch for performance testing
-        if: "${{ github.event.inputs.clearCaches != '' || (steps.avd-cache.outputs.cache-hit != 'true' && github.ref == 'refs/heads/main') }}"
+        if: "${{ matrix.target == 'google_apis_ps16k' || (steps.avd-cache.outputs.cache-hit != 'true' && github.ref == 'refs/heads/main') }}"
         uses: reactivecircus/android-emulator-runner@a421e43855164a8197daf9d8d40fe71c6996bb0d # v2.38.0
         with:
           api-level: ${{ matrix.api-level }}
           force-avd-creation: false
           target: ${{ matrix.target }}
           arch: ${{ matrix.arch }}
-          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          emulator-options: ${{ env.EMULATOR_OPTIONS }}
+          ram-size: ${{ env.EMULATOR_RAM_SIZE }}
+          pre-emulator-launch-script: ${{ env.EMULATOR_PRE_LAUNCH_SCRIPT }}
           sdcard-path-or-size: 100M
           disable-animations: true
           # Give the emulator a little time to run and do first boot stuff before taking snapshot
@@ -212,10 +225,10 @@ jobs:
 
         # This step is separate so pure install time may be calculated as a step
       - name: Emulator Snapshot After Firstboot Warmup
-        # Only generate a snapshot for saving if we are on main branch with a cache miss
+        # Always warm up the 16 KB emulator. The default emulator only needs it on main cache misses.
         # Switch the if statements via comment if generating snapshots for performance testing
         # if: matrix.first-boot-delay != '0'
-        if: "${{ github.event.inputs.clearCaches != '' || (steps.avd-cache.outputs.cache-hit != 'true' && github.ref == 'refs/heads/main') }}"
+        if: "${{ matrix.target == 'google_apis_ps16k' || (steps.avd-cache.outputs.cache-hit != 'true' && github.ref == 'refs/heads/main') }}"
         env:
           FIRST_BOOT_DELAY: ${{ matrix.first-boot-delay }}
         uses: reactivecircus/android-emulator-runner@a421e43855164a8197daf9d8d40fe71c6996bb0d # v2.38.0
@@ -224,7 +237,9 @@ jobs:
           force-avd-creation: false
           target: ${{ matrix.target }}
           arch: ${{ matrix.arch }}
-          emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          emulator-options: ${{ env.EMULATOR_OPTIONS }}
+          ram-size: ${{ env.EMULATOR_RAM_SIZE }}
+          pre-emulator-launch-script: ${{ env.EMULATOR_PRE_LAUNCH_SCRIPT }}
           sdcard-path-or-size: 100M
           disable-animations: true
           # Restart zygote to win a config race / Give emulator time to run and do first boot stuff before taking snapshot
@@ -245,7 +260,9 @@ jobs:
           force-avd-creation: false
           target: ${{ matrix.target }}
           arch: ${{ matrix.arch }}
-          emulator-options: -no-snapshot-save -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          emulator-options: -no-snapshot-save ${{ env.EMULATOR_OPTIONS }}
+          ram-size: ${{ env.EMULATOR_RAM_SIZE }}
+          pre-emulator-launch-script: ${{ env.EMULATOR_PRE_LAUNCH_SCRIPT }}
           sdcard-path-or-size: 100M
           disable-animations: true
           # update workflows/README.md when modifying this script
@@ -257,10 +274,11 @@ jobs:
             bash .github/adb_retry.sh emu screenrecord start --time-limit 1800 video.webm
             sleep 5
             bash .github/with_emulator_log.sh adb-log.txt python3 .github/run_emulator_tests.py
+            TEST_RELEASE_BUILD=false ./gradlew :baselineprofile:connectedBenchmarkBenchmarkAndroidTest -Pandroid.testInstrumentationRunnerArguments.class=com.ichi2.anki.baselineprofile.ReleaseSmokeTest -Pandroid.testInstrumentationRunnerArguments.releaseSmokeTest=true --daemon
 
       - name: Report Emulator Test Results
         if: always() && hashFiles('AnkiDroid/build/outputs/androidTest-results/connected/**/TEST-*.xml') != ''
-        run: python3 .github/report_emulator_test_failures.py AnkiDroid/build/outputs/androidTest-results/connected adb-log.txt
+        run: python3 .github/report_test_failures.py AnkiDroid/build/outputs/androidTest-results/connected adb-log.txt --title "Emulator test failures"
 
       - name: Configure NDK tools PATH for alignment checking
         run: |

.github/workflows/tests_unit.yml

@@ -28,6 +28,8 @@ on:
       - 'gh-readonly-queue/**'
       # Dependabot branches are already checked by the pull_request trigger.
       - 'dependabot/**'
+      # Crowdin translations are already checked by the pull_request trigger.
+      - 'i18n_sync'
   merge_group:
 
 permissions:
@@ -177,6 +179,10 @@ jobs:
         if: (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') && matrix.iteration == 1 && matrix.os == 'ubuntu-latest'
         run: ./gradlew testFullDebugUnitTest -PemptyApplication --daemon
 
+      - name: Report Unit Test Results
+        if: always() && hashFiles('**/build/test-results/**/TEST-*.xml') != ''
+        run: python3 .github/report_test_failures.py . --pattern "build/test-results/**/TEST-*.xml" --title "Unit test failures"
+
       - name: Store Logcat as Artifact
         # cancelled() handles test timeouts
         # remove when test timeouts cause a failure()

.idea/dictionaries/android.xml

@@ -10,6 +10,7 @@
       <w>FILESIZE</w>
       <w>ONEPLUS</w>
       <w>Roborazzi</w>
+      <w>Supernote</w>
       <w>allempty</w>
       <w>apkgfileprovider</w>
       <w>asynctasks</w>