clean up

neu-se · Feb 13, 2025 · b9936a3 · b9936a3
1 parent 0b0991e
commit b9936a3
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 41 deletions.
diff --git a/dist/grader/types.d.ts b/dist/grader/types.d.ts
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/grader/Grader.ts b/src/grader/Grader.ts
@@ -132,8 +132,8 @@ class Grader {
         return [
           {
             name: unit.name,
-            output: `Faults detected: ${mutantsDetected} / ${maxMutantsToDetect}`,
-            output_format: 'text',
+            output: `**Faults detected: ${mutantsDetected} / ${maxMutantsToDetect}**`,
+            output_format: 'markdown',
             score: breakPoint ? breakPoint.pointsToAward : 0,
             max_score: unit.breakPoints[0].pointsToAward
           }
@@ -152,11 +152,12 @@ class Grader {
       const passingTests = relevantTestResults.filter(
         (result) => result.status === 'pass'
       ).length
+
       return [
         {
           name: unit.name,
-          output: `Tests passed: ${passingTests} / ${expectedTests}\n${relevantTestResults.map((result) => `${result.name}: ${result.status}${result.output ? `\n${result.output}` : ''}`).join('\n')}`,
-          output_format: 'text',
+          output: `**Tests passed: ${passingTests} / ${expectedTests}**\n${relevantTestResults.map((result) => `  * ${result.name}: ${result.status}${result.output ? '\n```\n' + result.output + '\n```' : ''}`).join('\n')}`,
+          output_format: 'markdown',
           score: passingTests == expectedTests ? unit.points : 0,
           max_score: unit.points
         }
@@ -267,10 +268,10 @@ class Grader {
         this.logger.log('visible', 'Here are your failing test results:')
         for (const result of studentTestResults) {
           if (result.status === 'fail') {
-            mutantFailureAdvice += `\n${result.name}: ${result.status}\n${result.output}\n--------------------------------\n`
+            mutantFailureAdvice += `\n❌ ${result.name}: **${result.status}**`
+            mutantFailureAdvice += '```\n' + result.output + '\n```'
             this.logger.log('visible', `${result.name}: ${result.status}`)
             this.logger.log('visible', result.output)
-            this.logger.log('visible', '--------------------------------')
           }
         }
       } else {

diff --git a/src/grader/builder/GradleBuilder.ts b/src/grader/builder/GradleBuilder.ts
@@ -29,8 +29,8 @@ export default class GradleBuilder extends Builder {
       .map((file: CheckstyleReport) => {
         return file.files
           .map((f: CheckstyleFile) => {
-            return `${f.name}: ${f.errors.length} errors:
-                    ${f.errors.map((e) => `\t${e.line}: ${e.message}`).join('\n')}`
+            return ` * ${f.name}: ${f.errors.length} errors:
+                    ${f.errors.map((e) => `\t${e.line}: ` + '`' + e.message + '`').join('\n')}`
           })
           .join('\n')
       })
@@ -43,7 +43,7 @@ export default class GradleBuilder extends Builder {
     return {
       status: totalErrors > 0 ? 'fail' : 'pass',
       output: `Total errors: ${totalErrors}\n${formattedOutput}`,
-      output_format: 'text'
+      output_format: 'markdown'
     }
   }
   async test(): Promise<TestResult[]> {

diff --git a/src/grader/types.ts b/src/grader/types.ts
@@ -59,7 +59,7 @@ export function isMutationTestUnit(unit: GradedUnit): unit is MutationTestUnit {
 export function isRegularTestUnit(unit: GradedUnit): unit is RegularTestUnit {
   return 'tests' in unit && 'testCount' in unit
 }
-export type OutputFormat = 'text' // TODO also support: | 'ansi' | 'html' | 'markdown';
+export type OutputFormat = 'text' | 'ansi' | 'markdown'
 export type OutputVisibility =
   | 'hidden' // Never shown to students
   | 'visible' // Always shown to students

diff --git a/src/main.ts b/src/main.ts
@@ -103,28 +103,32 @@ export async function run(): Promise<void> {
         `**Status**: ${results.lint.status === 'pass' ? '✅' : '❌'}`
       )
       core.summary.addDetails('Lint Output', results.lint.output)
-      core.summary.addHeading('Test Results', 2)
       if (results.tests.length > 0) {
+        core.summary.addHeading('Test Results', 2)
+        core.summary.addHeading('Summary', 3)
         const rows: SummaryTableRow[] = []
         rows.push([
           { data: 'Status', header: true },
-          { data: 'Part', header: true },
           { data: 'Name', header: true },
           { data: 'Score', header: true }
         ])
+        let lastPart = undefined
         for (const test of results.tests) {
           const icon = test.score === test.max_score ? '✅' : '❌'
-          rows.push([
-            icon,
-            test.part || '',
-            test.name,
-            `${test.score}/${test.max_score}`
-          ])
-          if (test.output) {
-            core.summary.addDetails(test.name, test.output)
+          if (test.part !== lastPart && test.part) {
+            lastPart = test.part
+            rows.push([{ data: test.part, colspan: '3' }])
           }
+          rows.push([icon, test.name, `${test.score}/${test.max_score}`])
         }
         core.summary.addTable(rows)
+        core.summary.addHeading('Test Details', 3)
+        for (const test of results.tests) {
+          if (test.output) {
+            const icon = test.score === test.max_score ? '✅' : '❌'
+            core.summary.addDetails(icon + test.name, test.output)
+          }
+        }
       }
       await core.summary.write()