skia2/tools/skqp
Hal Canary 6a11fb0a09 SkQP: branching tools updated.
1.  get_gold_export_url.py becomes get_gold_results.py

2.  README_GENERATING_MODELS.md updated with changed and more
    complete instructions.

No-Try: true
Change-Id: I7fb84ad99e3049717ea9a572f8558ed2f73d412c
Reviewed-on: https://skia-review.googlesource.com/c/184600
Reviewed-by: Hal Canary <halcanary@google.com>
Commit-Queue: Hal Canary <halcanary@google.com>
2019-01-17 15:29:50 +00:00
..
src SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
bad_gms.txt SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
branch_skqp_dev.sh SkQP: branch script 2018-12-04 20:53:57 +00:00
clean_app.sh Test SKQP on Firebase Testlab and Upload 2018-03-07 20:44:50 +00:00
cut_release SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
docker_build_universal_apk.sh SkQP: experimental docker script cleanup, try 2 2018-12-19 03:25:42 +00:00
download_model SkQP: download_model complains when files.checksum is missing 2018-02-06 19:48:55 +00:00
generate_gn_args Consolidate stroke-rect ops and use GrFillRectOp instead of GrNonAA/AARectOp 2018-12-11 16:33:35 +00:00
get_gold_results.py SkQP: branching tools updated. 2019-01-17 15:29:50 +00:00
gn_to_bp.py SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
jitter_gms.cpp SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
make_apk_list.py SkQP: tools/skqp/get_gold_export_url.py 2018-12-03 22:33:39 +00:00
make_apk.sh SkQP: Stop requiring users to use posix shell 2018-01-24 21:11:19 +00:00
make_gmkb.go SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
make_rendertests_list.py SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
make_universal_apk tools/skqp/make_universal_apk -> python 2018-11-01 16:48:59 +00:00
make_universal_apk.py SkQP: clean up make_universal_apk.py 2019-01-14 15:22:49 +00:00
README_ALGORITHM.md SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00
README_GENERATING_MODELS.md SkQP: branching tools updated. 2019-01-17 15:29:50 +00:00
README.md SkQP: document requirement to run git-sync-deps 2018-12-07 16:51:42 +00:00
run_skqp_exe SkQP: run_skqp_exe script 2018-01-25 16:30:22 +00:00
setup_resources SkQP: remove skia_embed_resources option 2018-01-30 19:24:15 +00:00
test_apk.sh bin/sysopen: script moved to bin 2018-12-06 14:21:33 +00:00
upload_apk SkQP: tools/skqp/get_gold_export_url.py 2018-12-03 22:33:39 +00:00
upload_model SkQP: refatctor C++ bits. 2018-11-30 18:38:00 +00:00

SkQP

SkQP (Skia Quality Program) is a component of the Android CTS (Compatablity Test Suite) that tests an Android device's GPU and OpenGLES & Vulkan drivers using Skia's existing unit & rendering tests.

See https://skia.org/dev/testing/skqp for pre-build APKs.

How to build and run the SkQP tests

  1. Get the dependencies:

    • You will need Java JDK 8, git, and python.

    • Install Chromium's depot_tools. Add it to your PATH.

      git clone 'https://chromium.googlesource.com/chromium/tools/depot_tools.git'
      export PATH="${PWD}/depot_tools:${PATH}"
      
    • Install the Android NDK.

      ( cd ~; unzip ~/Downloads/android-ndk-*.zip )
      ANDROID_NDK=$(ls -d ~/android-ndk-*)   # Or wherever you installed the Android NDK.
      
    • Install the Android SDK. Set the ANDROID_HOME environment variable.

      mkdir ~/android-sdk
      ( cd ~/android-sdk; unzip ~/Downloads/sdk-tools-*.zip )
      yes | ~/android-sdk/tools/bin/sdkmanager --licenses
      export ANDROID_HOME=~/android-sdk  # Or wherever you installed the Android SDK.
      

      Put adb in your PATH.

      export PATH="${PATH}:${ANDROID_HOME}/platform-tools"
      
  2. Get the right version of Skia:

    git clone https://skia.googlesource.com/skia.git
    cd skia
    git checkout origin/skqp/dev  # or whatever release tag you need
    
  3. Build the APK:

    tools/git-sync-deps
    tools/skqp/make_universal_apk
    
  4. Build, install, and run.

    adb install -r out/skqp/skqp-universal-debug.apk
    adb logcat -c
    adb shell am instrument -w org.skia.skqp
    
  5. Monitor the output with:

    adb logcat TestRunner org.skia.skqp skia "*:S"
    

    Note the test's output path on the device. It will look something like this:

    01-23 15:22:12.688 27158 27173 I org.skia.skqp:
    output written to "/storage/emulated/0/Android/data/org.skia.skqp/files/output"
    
  6. Retrieve and view the report with:

    OUTPUT_LOCATION="/storage/emulated/0/Android/data/org.skia.skqp/files/output"
    adb pull $OUTPUT_LOCATION /tmp/
    bin/sysopen /tmp/output/skqp_report/report.html
    

Running a single test

To run a single test, for example gles_aarectmodes:

adb shell am instrument -e class 'org.skia.skqp.SkQPRunner#gles_aarectmodes' -w org.skia.skqp

Unit tests can be run with the unitTest_ prefix:

adb shell am instrument -e class 'org.skia.skqp.SkQPRunner#unitTest_GrSurface -w org.skia.skqp

Run as a non-APK executable

  1. Follow steps 1-3 as above.

  2. Build the SkQP program, load files on the device, and run skqp:

    gn gen out/skqp-arm
    ninja -C out/skqp-arm skqp
    python tools/skqp/run_skqp_exe out/skqp-arm