added summary action

Author: casianaoprut

src/model/Action.ts

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

src/parser/instrument-parser.ts

@@ -16,7 +16,7 @@ import {
     missionCommandVarProvider,
     missionEnvVarProvider,
 } from '../context/mission-variable-providers'
-import {isDefaultAction} from '../runner/action-utils'
+import {isDefaultAction, summaryActionKey} from '../runner/action-utils'
 import {missionContext} from '../context/MissionContext'
 import {
     INSTRUMENT_DIR_NAME,
@@ -103,12 +103,24 @@ function parseCommands(commandsObject: any, instrumentKey: string, actionKey: st
 }
 
 function parseDefaultAction(defaultActionObject: any, instrumentKey: string, actionKey: string): DefaultAction {
-    return {
+    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)
+            : undefined,
+    }
+
+    if (actionKey === summaryActionKey && action.summaryFile) {
+        const instrumentName = missionContext.getVariable(INSTRUMENT_NAME)!
+        missionContext.addVariable(`${instrumentName}Summary`, path.resolve(
+            missionContext.getVariable(INSTRUMENT_PATH)!, action.summaryFile
+        ))
     }
+
+    return action
 }
 
 function parseWith(withObject: any): WithAction {

src/runner/action-runner.ts

@@ -1,15 +1,16 @@
 import {Archiver} from 'archiver'
-import {cleanActionKey, packageActionKey, verifyActionKey} from './action-utils'
+import {cleanActionKey, packageActionKey, summaryActionKey, verifyActionKey} from './action-utils'
 import {Action, DefaultAction, instanceOfDefaultAction} from '../model/Action'
 import {runCommand} from './command-runner'
 import {runCleanAction} from './default-actions/clean-action-runner'
 import {runPackageAction} from './default-actions/package-action-runner'
 import {runVerifyAction} from './default-actions/verify-action-runner'
+import {runSummaryAction} from './default-actions/summary-action-runner'
 
 
 export async function runAction(action: Action, archive: Archiver | null, instrumentPath: string, instrumentName: string): Promise<void> {
     if (instanceOfDefaultAction(action))
-        await runDefaultAction(<DefaultAction>action, archive, instrumentName)
+        await runDefaultAction(<DefaultAction>action, archive, instrumentPath, instrumentName)
     else
         await runCustomAction(action, instrumentPath, instrumentName)
 }
@@ -20,7 +21,7 @@ async function runCustomAction(action: Action, instrumentPath: string, instrumen
     }
 }
 
-async function runDefaultAction(action: DefaultAction, archive: Archiver | null, instrumentName: string) {
+async function runDefaultAction(action: DefaultAction, archive: Archiver | null, instrumentPath: string, instrumentName: string) {
     switch (action.name) {
         case cleanActionKey: {
             await runCleanAction(action)
@@ -34,5 +35,9 @@ async function runDefaultAction(action: DefaultAction, archive: Archiver | null,
             await runVerifyAction(action, instrumentName)
             break
         }
+        case summaryActionKey: {
+            await runSummaryAction(action, instrumentPath, instrumentName)
+            break
+        }
     }
 }

src/runner/action-utils.ts

@@ -7,8 +7,9 @@ export const packageActionKey = 'pack'
 export const startActionKey = 'start'
 export const verifyActionKey = 'verify'
 export const unpackActionKey = 'unpack'
+export const summaryActionKey = 'summary'
 
-const defaultActionKeys: string[] = [cleanActionKey, packageActionKey, verifyActionKey, unpackActionKey]
+const defaultActionKeys: string[] = [cleanActionKey, packageActionKey, verifyActionKey, unpackActionKey, summaryActionKey]
 
 export function isDefaultAction(actionKey: string): boolean {
     for (let i = 0; i < defaultActionKeys.length; i++)

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

@@ -0,0 +1,36 @@
+import fs from 'fs'
+import path from 'node:path'
+import {DefaultAction} from '../../model/Action'
+import {runCommand} from '../command-runner'
+
+export async function runSummaryAction(
+    action: DefaultAction,
+    instrumentPath: string,
+    instrumentName: string
+): Promise<string | null> {
+    const summaryFilePath = action.summaryFile
+        ? path.resolve(instrumentPath, action.summaryFile)
+        : null
+
+    // If summaryFile is declared and already exists, skip commands
+    if (summaryFilePath && fs.existsSync(summaryFilePath)) {
+        return summaryFilePath
+    }
+
+    // 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}`)
+    }
+
+    return null
+}

src/runner/mission-runner.ts

@@ -1,9 +1,10 @@
 import {Instrument} from '../model/Instrument'
 import {missionContext} from '../context/MissionContext'
 import {loadAndParseData} from '../parser/data-parser'
-import {cleanActionKey, packageActionKey, unpackActionKey, verifyActionKey} from './action-utils'
+import {cleanActionKey, packageActionKey, summaryActionKey, unpackActionKey, verifyActionKey} from './action-utils'
 import {DefaultAction} from '../model/Action'
 import {runCleanAction} from './default-actions/clean-action-runner'
+import {runSummaryAction} from './default-actions/summary-action-runner'
 import archiver, {Archiver} from 'archiver'
 import fs from 'fs-extra'
 import {getLogFilePath, getLogsStream, getTimeInSeconds} from '../report/logs-collector-utils'
@@ -18,7 +19,6 @@ import {RESULTS_ZIP_DIR, TARGET} from '../context/context-variable-provider'
 import AdmZip from 'adm-zip'
 import {runUnpackAction} from './default-actions/unpack-action-runner'
 import {runPackageAction} from './default-actions/package-action-runner'
-import {buildAndOpenLegacySummary, openMissionSummary} from './mission-summary-runner'
 import yaml from 'js-yaml'
 
 export async function cleanMission(missionFilePath?: string): Promise<void> {
@@ -101,12 +101,19 @@ function extractInitialMissionName(unpackedResultsPath: string): string {
     return ''
 }
 
-export function openSummary(zipPath: string, legacySummary: boolean): void {
-    if (legacySummary) {
-        buildAndOpenLegacySummary(zipPath)
-        return
+export async function summaryMission(missionFilePath?: string): Promise<void> {
+    const missionPath = findMissionFile(missionFilePath)
+    if (missionPath) {
+        loadAndParseData(missionPath)
+        console.log(`Running summary actions for mission ${missionContext.name}...`)
+        for (const instrument of missionContext.instruments) {
+            const summaryAction = instrument.actions.get(summaryActionKey) as DefaultAction | undefined
+            if (summaryAction) {
+                await runSummaryAction(summaryAction, instrument.instrumentPath, instrument.name)
+            }
+        }
+        console.log(`Summary actions for mission ${missionContext.name} completed.`)
     }
-    openMissionSummary(zipPath)
 }
 
 export function findMissionFile(missionFilePath?: string): string | null {

src/voyager.ts

@@ -2,9 +2,9 @@
 import {
     cleanMission,
     findAndRunMission,
-    openSummary,
     packMission,
     runMission,
+    summaryMission,
     unpackMission,
     verifyMission,
 } from './runner/mission-runner'
@@ -56,11 +56,10 @@ program
 
 program
     .command('summary')
-    .description('Opens the mission summary from the archive')
-    .requiredOption('-z, --zipPath <zipPath>')
-    .option('-l, --legacy', 'Use legacy summary')
-    .action((options: { zipPath: string, legacy?: boolean }) => {
-        openSummary(options.zipPath, !!options.legacy)
+    .description('Run summary actions for mission instruments')
+    .option('-m, --missionPath <missionPath>')
+    .action((options: { missionPath?: string }) => {
+        summaryMission(options.missionPath).then()
     })
 
 program.version("0.0.1")