Include logcat for failed Android emulator tests (#1057)

Author: dconeybe

.github/workflows/integration_tests.yml

@@ -1050,6 +1050,13 @@ jobs:
           name: mobile-simulator-test-video-artifact
           path: testapps/video-*-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.mp4
           retention-days: ${{ env.artifactRetentionDays }}
+      - name: Upload Android test logcat artifact
+        if: ${{ steps.get-device-type.outputs.device_type == 'virtual' && !cancelled() }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: mobile-simulator-test-logcat-artifact
+          path: testapps/logcat-*-android-${{ matrix.build_os }}-${{ matrix.android_device }}-${{ matrix.test_type }}.txt
+          retention-days: ${{ env.artifactRetentionDays }}
       - name: Download log artifacts
         if: ${{ needs.check_and_prepare.outputs.pr_number && failure() && !cancelled() }}
         uses: actions/download-artifact@v3

scripts/gha/test_simulator.py

@@ -677,7 +677,9 @@ def _run_android_test(testapp_dir, package_name, app_path, helper_project, retry
   logging.info("Running android helper test: %s, %s, %s", package_name, app_path, helper_project)
   _install_android_app(app_path)
   video_name = "video-%s-%s-%s.mp4" % (package_name, retry, FLAGS.logfile_name)
+  logcat_name = "logcat-%s-%s-%s.txt" % (package_name, retry, FLAGS.logfile_name)
   record_process = _record_android_tests(video_name)
+  _clear_android_logcat()
   _run_instrumented_test()
   _stop_recording(record_process)
   log = _get_android_test_log(package_name)
@@ -686,6 +688,7 @@ def _run_android_test(testapp_dir, package_name, app_path, helper_project, retry
   result = test_validation.validate_results(log, test_validation.CPP)
   if not result.complete or (FLAGS.test_type=="uitest" and result.fails>0):
     _save_recorded_android_video(video_name, testapp_dir)
+    _save_android_logcat(logcat_name, testapp_dir)
     if retry > 1:
       logging.info("Retry _run_android_test. Remaining retry: %s", retry-1)
       return _run_android_test(testapp_dir, package_name, app_path, helper_project, retry=retry-1)
@@ -734,6 +737,20 @@ def _save_recorded_android_video(video_name, summary_dir):
   subprocess.run(args=args, capture_output=True, text=True, check=False) 
 
 
+def _save_android_logcat(logcat_name, summary_dir):
+  logcat_file = os.path.join(summary_dir, logcat_name)
+  args = ["adb", "logcat", "-d"]
+  logging.info("Save logcat to %s: %s", logcat_file, " ".join(args))
+  with open(logcat_file, "wb") as f:
+    subprocess.run(args=args, stdout=f, check=False)
+
+
+def _clear_android_logcat():
+  args = ["adb", "logcat", "-c"]
+  logging.info("Clear logcat: %s", " ".join(args))
+  subprocess.run(args=args, check=False)
+
+
 def _run_instrumented_test():
   """Run the helper app.
     This helper app can run integration_test app automatically.