From bdfa7f305ce77e2e22e19e4e06e1852085d53567 Mon Sep 17 00:00:00 2001
From: Matthijs Kooijman <matthijs@stdin.nl>
Date: Thu, 7 May 2020 23:17:51 +0200
Subject: [PATCH] CI: Publish HTML report of tests as an artifact

This also lets ant print a message pointing to this artifact and
explaining the files inside briefly. To make sure this is only printed
inside the github action, an extra `-D` option is passed to `ant test`
from the workflow file.

To allow `if` / `unless` on the echo element, this adds some namespace
definitions (this allows them on *any* element, not just the ones that
explicitly allow it). See https://ant.apache.org/manual/ifunless.html
---
 .github/workflows/ant.yml |  7 ++++++-
 app/build.xml             | 12 ++++++++----
 build/build.xml           |  1 +
 3 files changed, 15 insertions(+), 5 deletions(-)

diff --git a/.github/workflows/ant.yml b/.github/workflows/ant.yml
index 11b9bd1a5..0a2e0a343 100644
--- a/.github/workflows/ant.yml
+++ b/.github/workflows/ant.yml
@@ -24,6 +24,11 @@ jobs:
       run: sudo apt-get install -y xvfb
     - name: Run tests
       working-directory: ./app
-      run: xvfb-run --auto-servernum --server-args "-screen 0 1024x768x24" ant test
+      run: xvfb-run --auto-servernum --server-args "-screen 0 1024x768x24" ant test -Drunning-from-github-action=1
+    - name: Publish results
+      uses: actions/upload-artifact@v1
+      with:
+        name: html-results
+        path: app/test-bin/results/html/
     - name: Cleanup xvfb
       uses: bcomnes/cleanup-xvfb@v1
diff --git a/app/build.xml b/app/build.xml
index 8b723f660..fa3223642 100644
--- a/app/build.xml
+++ b/app/build.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<project name="Arduino PDE" default="build">
+<project name="Arduino PDE" xmlns:if="ant:if" xmlns:unless="ant:unless" default="build">
 
   <path id="class.path">
     <fileset dir="lib">
@@ -160,14 +160,18 @@
       <fileset dir="${test.reportdir}">
 	<include name="TEST-*.xml" />
       </fileset>
-      <report todir="${test.htmldir}" />
+      <!-- Create a browsable frame-based HTML -->
+      <report format="frames" todir="${test.htmldir}" />
+      <!-- Also create a single-page version, to use as CI test result -->
+      <report format="noframes" todir="${test.htmldir}" />
     </junitreport>
 
     <!-- Make these paths relative to user.dir, which is the current directory when invoking ant (so the resulting paths are relative to the environment of the user. -->
     <property name="test.htmldir.display" location="${test.htmldir}" relative="true" basedir="${user.dir}"/>
     <property name="test.reportdir.display" location="${test.reportdir}" relative="true" basedir="${user.dir}"/>
-    <echo message="Detailed test results can be found in ${test.reportdir.display}"/>
-    <echo message="A browsable HTML summary is generated in ${test.htmldir.display}/index.html"/>
+    <echo unless:set="running-from-github-action" message="Detailed test results can be found in ${test.reportdir.display}"/>
+    <echo unless:set="running-from-github-action" message="A browsable HTML summary is generated in ${test.htmldir.display}/index.html"/>
+    <echo if:set="running-from-github-action" message="Detailed test results can be downloaded as an asset from this github action. Easiest to view is the single-file version in junit-noframes.html. Alternatively, the multi-file version can be viewed from index.html and includes full stdout/stderr output of tests."/>
 
     <fail if="test.failed"/>
   </target>
diff --git a/build/build.xml b/build/build.xml
index 838ebc811..f96b1723c 100644
--- a/build/build.xml
+++ b/build/build.xml
@@ -188,6 +188,7 @@
         <!-- Forward these to subant. Use propertyset/propertyref instead of a direct property so we do not need to specify a value -->
         <propertyref name="single-test-class"/>
         <propertyref name="single-test-methods"/>
+        <propertyref name="running-from-github-actions"/>
       </propertyset>
     </subant>
   </target>