Additional small fixes for the build report. (#1343)

* Fix reports.

* Fix ditto mark in text output.

* Fix whitespace.

* Increase one more timeout, to be safe.

Author: jonsimantov

.github/workflows/build-report.yml

@@ -52,9 +52,6 @@ jobs:
       run: |
         echo -n > comment.md
         cat >> comment.md <<EOF
-
-        ***
-
         EOF
         cat report_short.md >> comment.md
         cat >> comment.md <<EOF
@@ -70,14 +67,17 @@ jobs:
         cat report.txt >> comment.md
         cat >> comment.md <<EOF
         </pre></details>
+
+        ***
+       
         EOF
     - name: Show comment string
       run: |
         cat comment.md
     - name: Update GitHub issue (with retry)
       uses: nick-invision/retry@v2
       with:
-        timeout_minutes: 1
+        timeout_minutes: 5
         max_attempts: 3
         shell: bash
         command: python3 scripts/gha/update_issue_comment.py --token ${{ github.token }} --issue_title '[C++] Nightly Integration Testing Report' --start_tag build-dashboard-comment-start --end_tag build-dashboard-comment-end < comment.md

scripts/gha/it_workflow.py

@@ -82,8 +82,8 @@
 _COMMENT_HIDDEN_DIVIDER = f'\r\n<hidden value="{_COMMENT_IDENTIFIER}"></hidden>\r\n'
 
 _COMMENT_IDENTIFIER_DASHBOARD = "build-dashboard-comment"
-_COMMENT_DASHBOARD_START = f'\r\n<hidden value="{_COMMENT_IDENTIFIER_DASHBOARD}"-start></hidden>\r\n'
-_COMMENT_DASHBOARD_END = f'\r\n<hidden value="{_COMMENT_IDENTIFIER_DASHBOARD}"-end></hidden>\r\n'
+_COMMENT_DASHBOARD_START = f'\r\n<hidden value="{_COMMENT_IDENTIFIER_DASHBOARD}-start"></hidden>\r\n'
+_COMMENT_DASHBOARD_END = f'\r\n<hidden value="{_COMMENT_IDENTIFIER_DASHBOARD}-end"></hidden>\r\n'
 
 _LOG_ARTIFACT_NAME = "log-artifact"
 _LOG_OUTPUT_DIR = "test_results"
@@ -235,12 +235,17 @@ def test_report(token, actor, commit, run_id, build_against, build_apis):
   previous_comment = github.get_issue_body(token, issue_number)
   [previous_prefix, previous_comment_repo, previous_comment_sdk,
    previous_comment_tip] = previous_comment.split(_COMMENT_HIDDEN_DIVIDER)
+  logging.info("Previous prefix: %s", previous_prefix)
   # If there is a build dashboard, preserve it.
   if (_COMMENT_DASHBOARD_START in previous_prefix and
       _COMMENT_DASHBOARD_END in previous_prefix):
+    logging.info("Found dashboard comment, preserving.")
     [_, previous_dashboard_plus_the_rest] = previous_prefix.split(_COMMENT_DASHBOARD_START)
     [previous_dashboard, _] = previous_dashboard_plus_the_rest.split(_COMMENT_DASHBOARD_END)
     prefix = prefix + _COMMENT_DASHBOARD_START + previous_dashboard + _COMMENT_DASHBOARD_END
+    logging.info("New prefix: %s", prefix)
+  else:
+    logging.info("No dashboard comment '%s' or '%s'", _COMMENT_DASHBOARD_START, _COMMENT_DASHBOARD_END)
 
   success_or_only_flakiness, log_summary = _get_summary_table(token, run_id)
   if success_or_only_flakiness and not log_summary:

scripts/gha/report_build_status.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # Installing prerequisites:
-# 
+#
 # sudo python3 -m pip install python-dateutil progress attrs
 
 """A utility to report on daily build status.
@@ -166,14 +166,14 @@ def format_errors(all_errors, severity, event):
   individual_errors = 0
   for product, platform_dict in errors.items():
     platforms = list(platform_dict.keys())
-      
+
     if product == 'missing_log':
       product_name = 'missing logs'
     elif product == 'gma':
       product_name = product.upper()
     else:
       product_name = product.replace('_', ' ').title()
-    
+
     if 'iOS' in platforms:
       all_simulator = True
       for descriptors in platform_dict['iOS']:
@@ -182,7 +182,7 @@ def format_errors(all_errors, severity, event):
       if all_simulator:
         platform_dict = rename_key(platform_dict, 'iOS', 'iOS simulator')
         platforms = list(platform_dict.keys())
-      
+
     if 'Android' in platforms:
       all_emulator = True
       for descriptors in platform_dict['Android']:
@@ -202,7 +202,7 @@ def format_errors(all_errors, severity, event):
 
   event_text = event.lower()
   severity_text = 'flake' if severity == 'FLAKINESS' else severity.lower()
-  
+
   if total_errors == 0:
     return None
 
@@ -345,7 +345,7 @@ def main(argv):
           all_days.add(day)
         # elif firestore_test_time in str(run['date']):
         #   firestore_tests[day] = run
-    
+
       workflow_id = _WORKFLOW_PACKAGING
       all_runs = github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'schedule', _LIMIT)
       bar.next()
@@ -362,7 +362,7 @@ def main(argv):
         all_days.add(day)
         packaging_runs[day] = run
         packaging_run_ids.add(str(run['id']))
-    
+
       workflow_id = _WORKFLOW_TESTS
       all_runs = github.list_workflow_runs(FLAGS.token, workflow_id, _BRANCH, 'workflow_dispatch', _LIMIT)
       bar.next()
@@ -376,22 +376,22 @@ def main(argv):
         if run['day'] < start_date or run['day'] > end_date: continue
         if run['triggering_actor']['login'] != _TRIGGER_USER: continue
         package_tests_all.append(run)
-  
+
     # For each workflow_trigger run of the tests, determine which packaging run it goes with.
     package_tests = {}
-  
+
     logging.info("Source tests: %s %s", list(source_tests.keys()),  [source_tests[r]['id'] for r in source_tests.keys()])
     logging.info("Packaging runs: %s %s", list(packaging_runs.keys()), [packaging_runs[r]['id'] for r in packaging_runs.keys()])
-  
+
     with progress.bar.Bar('Downloading triggered workflow logs...', max=len(package_tests_all)) as bar:
       for run in package_tests_all:
         day = str(run['date'].date())
         if day in package_tests and int(package_tests[day]['id']) < int(run['id']):
           bar.next()
           continue
-    
+
         packaging_run = 0
-  
+
         logs_url = run['logs_url']
         headers = {'Accept': 'application/vnd.github.v3+json', 'Authorization': 'Bearer %s' % FLAGS.token}
         with requests.get(logs_url, headers=headers, stream=True) as response:
@@ -407,9 +407,9 @@ def main(argv):
         if str(packaging_run) in packaging_run_ids:
           package_tests[day] = run
         bar.next()
-  
+
     logging.info("Package tests: %s %s", list(package_tests.keys()), [package_tests[r]['id'] for r in package_tests.keys()])
-  
+
     with progress.bar.Bar('Downloading test summaries...', max=len(source_tests)+len(package_tests)) as bar:
       for tests in source_tests, package_tests:
         for day in tests:
@@ -519,7 +519,7 @@ def main(argv):
     if FLAGS.output_markdown and notes:
         notes = "<details><summary>&nbsp;</summary>" + notes + "</details>"
     if notes == prev_notes and not FLAGS.output_markdown:
-      if len(notes) > 0: notes = '\'\"\"'
+      if len(notes) > 0: notes = "'''"  # Creates a "ditto" mark.
     else:
       prev_notes = notes