Fix xcresult log output in Travis (#5645)

* Remove code folding and raw log output

Code folds were interacting poorly with Travis and causing output to be
lost. This was causing xcresult log output to be lost.

Travis terminates jobs that exceed its maximum log output length, so
showing raw log output could cause failing jobs to be killed for
unrelated reasons.

* Fix xcresult_logs when run against non-Run configurations

The leading part of the name can be "Run" or "Test" or others.

* Add support for Xcode 10 xcreult bundles

Author: wilhuff

scripts/build.sh

@@ -114,6 +114,7 @@ function RunXcodebuild() {
 
   result=0
   xcodebuild "$@" | tee xcodebuild.log | "${xcpretty_cmd[@]}" || result=$?
+
   if [[ $result == 65 ]]; then
     ExportLogs "$@"
 
@@ -123,12 +124,9 @@ function RunXcodebuild() {
     result=0
     xcodebuild "$@" | tee xcodebuild.log | "${xcpretty_cmd[@]}" || result=$?
   fi
-  if [[ $result != 0 ]]; then
 
-    echo "xcodebuild exited with $result; raw log follows" 1>&2
-    OpenFold Raw log
-    cat xcodebuild.log
-    CloseFold
+  if [[ $result != 0 ]]; then
+    echo "xcodebuild exited with $result" 1>&2
 
     ExportLogs "$@"
     return $result
@@ -137,50 +135,7 @@ function RunXcodebuild() {
 
 # Exports any logs output captured in the xcresult
 function ExportLogs() {
-  OpenFold XCResult
-
-  exporter="${scripts_dir}/xcresult_logs.py"
-  python "$exporter" "$@"
-
-  CloseFold
-}
-
-current_group=none
-current_fold=0
-
-# Prints a command for CI environments to group log output in the logs
-# presentation UI.
-function OpenFold() {
-  description="$*"
-  current_group="$(echo "$description" | tr '[A-Z] ' '[a-z]_')"
-
-  if [[ -n "${GITHUB_ACTIONS:-}" ]]; then
-    echo "::group::description"
-
-  elif [[ -n "${TRAVIS:-}" ]]; then
-    # Travis wants groups to be numbered.
-    current_group="${current_group}.${current_fold}"
-    let current_fold++
-
-    # Show description in yellow.
-    echo "travis_fold:start:${current_group}\033[33;1m${description}\033[0m"
-
-  else
-    echo "===== $description Start ====="
-  fi
-}
-
-# Closes the current fold opened by `OpenFold`.
-function CloseFold() {
-  if [[ -n "${GITHUB_ACTIONS:-}" ]]; then
-    echo "::endgroup::"
-
-  elif [[ -n "${TRAVIS:-}" ]]; then
-    echo "travis_fold:end:${current_group}"
-
-  else
-    echo "===== $description End ====="
-  fi
+  python "${scripts_dir}/xcresult_logs.py" "$@"
 }
 
 if [[ "$xcode_major" -lt 11 ]]; then

scripts/xcresult_logs.py

@@ -26,6 +26,8 @@
 import json
 import logging
 import os
+import re
+import shutil
 import subprocess
 import sys
 
@@ -52,9 +54,17 @@ def main():
     scheme = flags['-scheme']
     xcresult_path = find_xcresult_path(project, scheme)
 
-  log_id = find_log_id(xcresult_path)
-  log = export_log(xcresult_path, log_id)
-  sys.stdout.write(log)
+  version = find_xcode_major_version()
+  if version <= 10:
+    files = find_legacy_log_files(xcresult_path)
+    cat_files(files, sys.stdout)
+
+  else:
+    # Xcode 11 and up ship xcresult tool which standardizes the xcresult format
+    # but also makes it harder to deal with.
+    log_id = find_log_id(xcresult_path)
+    log = export_log(xcresult_path, log_id)
+    sys.stdout.write(log)
 
 
 # Most flags on the xcodebuild command-line are uninteresting, so only pull
@@ -114,7 +124,7 @@ def find_xcresult_path(project, scheme):
   """
   project_path = find_project_path(project)
   bundle_dir = os.path.join(project_path, 'Logs/Test')
-  prefix = 'Run-' + scheme + '-'
+  prefix = re.compile('([^-]*)-' + re.escape(scheme) + '-')
 
   _logger.debug('Logging for xcresult bundles in %s', bundle_dir)
   xcresult = find_newest_matching_prefix(bundle_dir, prefix)
@@ -136,7 +146,7 @@ def find_project_path(project):
     The path containing the newest project output.
   """
   path = os.path.expanduser('~/Library/Developer/Xcode/DerivedData')
-  prefix = project + '-'
+  prefix = re.compile(re.escape(project) + '-')
 
   # DerivedData has directories like Firestore-csljdukzqbozahdjizcvrfiufrkb. Use
   # the most recent one if there are more than one such directory matching the
@@ -155,7 +165,7 @@ def find_newest_matching_prefix(path, prefix):
 
   Args:
     path: A directory to list
-    prefix: The starting part of any filename to consider
+    prefix: A regular expression that matches the filenames to consider
 
   Returns:
     The path to the newest entry in the directory whose basename starts with
@@ -164,7 +174,7 @@ def find_newest_matching_prefix(path, prefix):
   entries = os.listdir(path)
   result = None
   for entry in entries:
-    if entry.startswith(prefix):
+    if prefix.match(entry):
       fq_entry = os.path.join(path, entry)
       if result is None:
         result = fq_entry
@@ -177,6 +187,34 @@ def find_newest_matching_prefix(path, prefix):
   return result
 
 
+def find_legacy_log_files(xcresult_path):
+  """Finds the log files produced by Xcode 10 and below."""
+
+  result = []
+
+  for root, dirs, files in os.walk(xcresult_path, topdown=True):
+    for file in files:
+      if file.endswith('.txt'):
+        file = os.path.join(root, file)
+        result.append(file)
+
+  # Sort the files by creation time.
+  result.sort(key=lambda f: os.stat(f).st_ctime)
+  return result
+
+
+def cat_files(files, output):
+  """Reads the contents of all the files and copies them to the output.
+
+  Args:
+    files: A list of filenames
+    output: A file-like object in which all the data should be copied.
+  """
+  for file in files:
+    with open(file, 'r') as fd:
+      shutil.copyfileobj(fd, output)
+
+
 def find_log_id(xcresult_path):
   """Finds the id of the last action's logs.
 
@@ -229,6 +267,18 @@ def collect_log_output(activity_log, result):
         collect_log_output(subsection, result)
 
 
+def find_xcode_major_version():
+  """Determines the major version number of Xcode."""
+  cmd = ['xcodebuild', '-version']
+  command_trace.log(cmd)
+
+  result = str(subprocess.check_output(cmd))
+  version = result.split('\n', 1)[0]
+  version = re.sub(r'Xcode ', '', version)
+  version = re.sub(r'\..*', '', version)
+  return int(version)
+
+
 def xcresulttool(*args):
   """Runs xcresulttool and returns its output as a string."""
   cmd = ['xcrun', 'xcresulttool']