modified summary action to receive a md and a html file

Author: casianaoprut

src/model/Action.ts

@@ -8,7 +8,8 @@ export interface Action {
 export interface DefaultAction extends Action {
     with?: WithAction;
     produces?: Map<string, string>
-    summaryFile?: string;
+    summaryMdFile?: string;
+    summaryHtmlFile?: string;
 }
 
 export interface WithAction {

src/parser/instrument-parser.ts

@@ -38,6 +38,8 @@ export function parseInstrument(instrumentsDirPath: string, instrumentDir: strin
     initVariableProvider()
     const instrumentPath = path.resolve(instrumentsDirPath, instrumentDir)
     missionContext.addVariable(INSTRUMENT_NAME, file.name)
+    missionContext.addVariable(`${file.name}SummaryMd`, 'null')
+    missionContext.addVariable(`${file.name}SummaryHtml`, 'null')
     missionContext.addVariable(INSTRUMENT_DIR_NAME, instrumentDir)
     missionContext.addVariable(INSTRUMENT_PATH, instrumentPath)
     missionContext.addVariable(INSTRUMENT_RESULTS, path.resolve(<string>missionContext.getVariable(RESULTS_UNPACK_DIR), file.name))
@@ -103,21 +105,34 @@ function parseCommands(commandsObject: any, instrumentKey: string, actionKey: st
 }
 
 function parseDefaultAction(defaultActionObject: any, instrumentKey: string, actionKey: string): DefaultAction {
+    if (defaultActionObject.summaryFile !== undefined)
+        throw new Error(`Invalid field 'summaryFile' in action '${actionKey}' of instrument '${instrumentKey}'. Use 'summaryMdFile' and 'summaryHtmlFile'.`)
+
     const action: DefaultAction = {
         name: actionKey,
         commandsContext: parseCommands(defaultActionObject.commands, instrumentKey, actionKey),
         with: parseWith(defaultActionObject.with),
         produces: parseProduces(defaultActionObject.produces),
-        summaryFile: defaultActionObject.summaryFile
-            ? replaceMissionContextVariables(defaultActionObject.summaryFile)
+        summaryMdFile: defaultActionObject.summaryMdFile
+            ? replaceMissionContextVariables(defaultActionObject.summaryMdFile)
+            : undefined,
+        summaryHtmlFile: defaultActionObject.summaryHtmlFile
+            ? replaceMissionContextVariables(defaultActionObject.summaryHtmlFile)
             : undefined,
     }
 
-    if (actionKey === summaryActionKey && action.summaryFile) {
+    if (actionKey === summaryActionKey) {
         const instrumentName = missionContext.getVariable(INSTRUMENT_NAME)!
-        missionContext.addVariable(`${instrumentName}Summary`, path.resolve(
-            missionContext.getVariable(INSTRUMENT_PATH)!, action.summaryFile
-        ))
+
+        if (action.summaryMdFile)
+            missionContext.addVariable(`${instrumentName}SummaryMd`, path.resolve(
+                missionContext.getVariable(INSTRUMENT_PATH)!, action.summaryMdFile
+            ))
+
+        if (action.summaryHtmlFile)
+            missionContext.addVariable(`${instrumentName}SummaryHtml`, path.resolve(
+                missionContext.getVariable(INSTRUMENT_PATH)!, action.summaryHtmlFile
+            ))
     }
 
     return action
@@ -198,4 +213,4 @@ function initVariableProvider(): void {
     actionEnvVarProvider = new VariableProvider()
     variableHandler.addParametersProvider(missionCommandVarProvider, missionActionVarProvider, commandVarProvider, actionVarProvider)
     variableHandler.addEnvironmentVariablesProviders(missionCommandEnvVarProvider, missionActionEnvVarProvider, missionEnvVarProvider, commandEnvVarProvider, actionEnvVarProvider)
-}
+}

src/runner/default-actions/summary-action-runner.ts

@@ -2,35 +2,61 @@ import fs from 'fs'
 import path from 'node:path'
 import {DefaultAction} from '../../model/Action'
 import {runCommand} from '../command-runner'
+import {missionContext} from '../../context/MissionContext'
+
+interface SummaryActionResult {
+    summaryMdFilePath: string | null
+    summaryHtmlFilePath: string | null
+}
 
 export async function runSummaryAction(
     action: DefaultAction,
     instrumentPath: string,
     instrumentName: string
-): Promise<string | null> {
-    const summaryFilePath = action.summaryFile
-        ? path.resolve(instrumentPath, action.summaryFile)
+): Promise<SummaryActionResult> {
+    const summaryMdFilePath = action.summaryMdFile
+        ? path.resolve(instrumentPath, action.summaryMdFile)
+        : null
+    const summaryHtmlFilePath = action.summaryHtmlFile
+        ? path.resolve(instrumentPath, action.summaryHtmlFile)
         : null
+    const expectedSummaryFiles = [summaryMdFilePath, summaryHtmlFilePath].filter((filePath): filePath is string => filePath !== null)
 
-    // If summaryFile is declared and already exists, skip commands
-    if (summaryFilePath && fs.existsSync(summaryFilePath)) {
-        return summaryFilePath
+    if (expectedSummaryFiles.length > 0 && expectedSummaryFiles.every(filePath => fs.existsSync(filePath))) {
+        updateSummaryVariables(instrumentName, summaryMdFilePath, summaryHtmlFilePath)
+        return {
+            summaryMdFilePath,
+            summaryHtmlFilePath,
+        }
     }
 
-    // Run generation commands if defined
     if (action.commandsContext && action.commandsContext.length > 0) {
         for (const commandContext of action.commandsContext) {
             await runCommand(commandContext, commandContext.dir ?? instrumentPath, instrumentName)
         }
     }
 
-    // Return the summary file path if it was declared and now exists
-    if (summaryFilePath) {
-        if (fs.existsSync(summaryFilePath)) {
-            return summaryFilePath
-        }
-        console.warn(`Instrument ${instrumentName}: summary file not found at ${summaryFilePath}`)
+    if (summaryMdFilePath && !fs.existsSync(summaryMdFilePath))
+        console.warn(`Instrument ${instrumentName}: summary markdown file not found at ${summaryMdFilePath}`)
+
+    if (summaryHtmlFilePath && !fs.existsSync(summaryHtmlFilePath))
+        console.warn(`Instrument ${instrumentName}: summary HTML file not found at ${summaryHtmlFilePath}`)
+
+    updateSummaryVariables(instrumentName, summaryMdFilePath, summaryHtmlFilePath)
+
+    return {
+        summaryMdFilePath: summaryMdFilePath && fs.existsSync(summaryMdFilePath) ? summaryMdFilePath : null,
+        summaryHtmlFilePath: summaryHtmlFilePath && fs.existsSync(summaryHtmlFilePath) ? summaryHtmlFilePath : null,
     }
+}
 
-    return null
+function updateSummaryVariables(instrumentName: string, summaryMdFilePath: string | null, summaryHtmlFilePath: string | null): void {
+    missionContext.addVariable(
+        `${instrumentName}SummaryMd`,
+        summaryMdFilePath && fs.existsSync(summaryMdFilePath) ? summaryMdFilePath : 'null'
+    )
+    missionContext.addVariable(
+        `${instrumentName}SummaryHtml`,
+        summaryHtmlFilePath && fs.existsSync(summaryHtmlFilePath) ? summaryHtmlFilePath : 'null'
+    )
 }