From 04293d3fbd1c5712ee23cc47e165b060f53622c2 Mon Sep 17 00:00:00 2001
From: ell <77150506+ellraiser@users.noreply.github.com>
Date: Fri, 6 Oct 2023 13:26:51 +0100
Subject: [PATCH] use love-test-report action

added md support to work with love-test-report, a basic action made to just dump md files into repo checks
---
 .github/workflows/main.yml     | 24 +++++++++++++-----------
 .gitignore                     |  1 +
 testing/classes/TestMethod.lua |  6 ++++--
 testing/classes/TestModule.lua | 11 +++++++++--
 testing/classes/TestSuite.lua  | 18 +++++++++++++++++-
 testing/output/readme.md       |  2 +-
 testing/todo.md                |  3 +--
 7 files changed, 46 insertions(+), 19 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 6eac9e3d8..31c982836 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -205,14 +205,16 @@ jobs:
       with:
         name: love-windows-${{ steps.vars.outputs.arch }}${{ steps.vars.outputs.compatname }}-dbg
         path: pdb/Release/*.pdb
+    - name: Build Test Exe
+      run: cmake --build build --config Release --target install
     - name: Run All Tests
-      run: love-windows-${{ steps.vars.outputs.arch }}${{ steps.vars.outputs.compatname }}.exe testing --console --runAllTests
-    - name: Test Report
-      uses: dorny/test-reporter@v1
+      run: install\love.exe testing --console --runAllTests
+    - name: Love Test Report
+      uses: ellraiser/love-test-report@main
       with:
-        name: Test Output
-        path: testing/output/*.xml
-        reporter: jest-junit
+        name: Love Testsuite Windows
+        title: windows-${{ steps.vars.outputs.arch }}${{ steps.vars.outputs.compatname }}-test-report
+        path: testing/output/lovetest_runAllTests.md
   macOS:
     runs-on: macos-latest
     steps:
@@ -243,12 +245,12 @@ jobs:
         path: love-macos.zip
     - name: Run All Tests
       run: love-macos/love.app/Contents/MacOS/love testing --runAllTests
-    - name: Test Report
-      uses: dorny/test-reporter@v1
+    - name: Love Test Report
+      uses: ellraiser/love-test-report@main
       with:
-        name: Test Output
-        path: testing/output/*.xml
-        reporter: jest-junit
+        name: Love Testsuite MacOS
+        title: macos-test-report
+        path: testing/output/lovetest_runAllTests.md
   iOS-Simulator:
     runs-on: macos-latest
     steps:
diff --git a/.gitignore b/.gitignore
index 5bc5b9401..f84038cd7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -71,3 +71,4 @@ stamp-h1
 .vscode/
 /testing/output/*.xml
 /testing/output/*.html
+/testing/output/*.md
diff --git a/testing/classes/TestMethod.lua b/testing/classes/TestMethod.lua
index 7422fb935..6f9b182f9 100644
--- a/testing/classes/TestMethod.lua
+++ b/testing/classes/TestMethod.lua
@@ -303,18 +303,20 @@ TestMethod = {
     -- get failure/skip message for output (if any)
     local failure = ''
     local output = ''
-    -- @NOTE if you don't put anything inside of the <failure></failure> then
-    -- dorny/test-reporter@v1 will fail to parse it
     if self.passed == false and self.skipped == false then
       failure = '\t\t\t<failure message="' .. self.result.key .. ' ' ..
         self.result.message .. '">' .. self.result.key .. ' ' .. self.result.message .. '</failure>\n'
         output = self.result.key .. ' ' ..  self.result.message
+      -- append failures if any to report md
+      love.test.mdfailures = love.test.mdfailures .. '> 🔴 ' .. self.method .. '  \n' ..
+        '> ' .. output .. '  \n\n'
     end
     if output == '' and self.skipped == true then
       failure = '\t\t\t<skipped message="' .. self.skipreason .. '" />\n'
       output = self.skipreason
     end
 
+
     -- append XML for the test class result
     self.testmodule.xml = self.testmodule.xml .. '\t\t<testcase classname="' ..
       self.method .. '" name="' .. self.method .. '" assertions="' .. tostring(#self.asserts) ..
diff --git a/testing/classes/TestModule.lua b/testing/classes/TestModule.lua
index 9ee6cd62e..fa71ddb74 100644
--- a/testing/classes/TestModule.lua
+++ b/testing/classes/TestModule.lua
@@ -84,6 +84,15 @@ TestModule = {
   -- @return {nil}
   printResult = function(self)
     local finaltime = UtilTimeFormat(self.time)
+    local status = '🔴'
+    if self.failed == 0 then status = '🟢' end
+    -- add md row to main output
+    love.test.mdrows = love.test.mdrows .. '| ' .. status .. 
+      ' love.' .. self.module .. 
+      ' | ' .. tostring(self.passed) .. 
+      ' | ' .. tostring(self.failed) .. 
+      ' | ' .. tostring(self.skipped) .. 
+      ' | ' .. finaltime .. 's |' .. '\n'
     -- add xml to main output
     love.test.xml = love.test.xml .. '\t<testsuite name="love.' .. self.module .. 
       '" tests="' .. tostring(self.passed) .. 
@@ -91,8 +100,6 @@ TestModule = {
       '" skipped="' .. tostring(self.skipped) ..
       '" time="' .. finaltime .. '">\n' .. self.xml .. '\t</testsuite>\n'
     -- add html to main output
-    local status = '🔴'
-    if self.failed == 0 then status = '🟢' end
     love.test.html = love.test.html .. '<h2>' .. status .. '&nbsp;love.' .. self.module .. '</h2><ul class="summary">' ..
       '<li>🟢&nbsp;' .. tostring(self.passed) .. ' Tests</li>' ..
       '<li>🔴&nbsp;' .. tostring(self.failed) .. ' Failures</li>' ..
diff --git a/testing/classes/TestSuite.lua b/testing/classes/TestSuite.lua
index 99ee6bbcc..0396d841b 100644
--- a/testing/classes/TestSuite.lua
+++ b/testing/classes/TestSuite.lua
@@ -17,6 +17,8 @@ TestSuite = {
       time = 0,
       xml = '',
       html = '',
+      mdrows = '',
+      mdfailures = '',
       fakequit = false,
       windowmode = true,
 
@@ -124,10 +126,23 @@ TestSuite = {
 
   -- @method - TestSuite:printResult()
   -- @desc - prints the result of the whole test suite as well as writes
-  --         the XML + HTML of the testsuite output
+  --         the MD, XML + HTML of the testsuite output
   -- @return {nil}
   printResult = function(self)
     local finaltime = UtilTimeFormat(self.time)
+    
+    local md = '<!-- PASSED ' .. tostring(self.totals[1]) ..
+      ' || FAILED ' .. tostring(self.totals[2]) ..
+      ' || SKIPPED ' .. tostring(self.totals[3]) ..
+      ' || TIME ' .. finaltime .. ' -->\n\n' ..
+      '**' .. tostring(self.totals[1] + self.totals[2] + self.totals[3]) .. '** tests were completed in **' ..
+      finaltime .. 's** with **' ..
+      tostring(self.totals[1]) .. '** passed, **' ..
+      tostring(self.totals[2]) .. '** failed, and **' ..
+      tostring(self.totals[3]) .. '** skipped\n\n### Report\n' ..
+      '| Module                | Passed | Failed | Skipped | Time   |\n' ..
+      '| --------------------- | ------ | ------ | ------- | ------ |\n' ..
+      self.mdrows .. '\n\n### Failures\n' .. self.mdfailures
 
     local xml = '<testsuites name="love.test" tests="' .. tostring(self.totals[1]) .. 
       '" failures="' .. tostring(self.totals[2]) .. 
@@ -147,6 +162,7 @@ TestSuite = {
     love.filesystem.mountFullPath(love.filesystem.getSource() .. "/output", "tempoutput", "readwrite")
     love.filesystem.write('tempoutput/' .. self.output .. '.xml', xml .. self.xml .. '</testsuites>')
     love.filesystem.write('tempoutput/' .. self.output .. '.html', html .. self.html .. '</div></body></html>')
+    love.filesystem.write('tempoutput/' .. self.output .. '.md', md)
 
     self.module:log('grey', '\nFINISHED - ' .. finaltime .. 's\n')
     local failedcol = '\27[31m'
diff --git a/testing/output/readme.md b/testing/output/readme.md
index 1a1059a7b..bff4c6375 100644
--- a/testing/output/readme.md
+++ b/testing/output/readme.md
@@ -1,2 +1,2 @@
 # Testing Output
-Any tests run will output an XML and HTML file here, assuming the tests are run with readwrite permissions for this repo
\ No newline at end of file
+Any tests run will output an XML, MD, and HTML file here, assuming the tests are run with readwrite permissions for this repo
\ No newline at end of file
diff --git a/testing/todo.md b/testing/todo.md
index e64f5e165..f5951c748 100644
--- a/testing/todo.md
+++ b/testing/todo.md
@@ -1,9 +1,8 @@
 `/Applications/love_12.app/Contents/MacOS/love ./testing`
 
 ## Todo
-- fix XML format
 - check test runs for windows setup
-- add runs for linux + ios
+- add runs for linux + ios?
 - finish graphics state methods
 - start graphics drawing methods
 - start object methods