Bugfix/ls24004538/nested call error stack

rpgJavaInterpreter-core/src/main/kotlin/com/smeup/rpgparser/interpreter/ProgramInterpreter.kt

@@ -1,8 +1,15 @@
 package com.smeup.rpgparser.interpreter
 
+import com.smeup.rpgparser.execution.MainExecutionContext
+
 class ProgramInterpreter(val systemInterface: SystemInterface) {
 
     fun execute(rpgProgram: RpgProgram, initialValues: LinkedHashMap<String, Value>) {
-        rpgProgram.execute(systemInterface = systemInterface, params = initialValues)
+        MainExecutionContext.getProgramStack().push(rpgProgram)
+        try {
+            rpgProgram.execute(systemInterface = systemInterface, params = initialValues)
+        } finally {
+            MainExecutionContext.getProgramStack().pop()
+        }
     }
 }

rpgJavaInterpreter-core/src/main/kotlin/com/smeup/rpgparser/interpreter/program.kt

@@ -128,8 +128,20 @@ class RpgProgram(val cu: CompilationUnit, val name: String = "<UNNAMED RPG PROGR
             }
             if (!initialized) {
                 initialized = true
-                val caller = if (MainExecutionContext.getProgramStack().isNotEmpty()) {
-                    MainExecutionContext.getProgramStack().peek()
+
+                /**
+                 * As the RPG program stack is managed outside of this method, it is up to the caller of this method
+                 * to ensure it is in the correct state, that is:
+                 * - `lastIndex` is this RpgProgram
+                 * - `lastIndex - 1` is the RpgProgram that calls this RpgProgram
+                 *
+                 * Note: If these two rules are not followed at this point, do not expect RpgPrograms to behave correctly.
+                 * that means something is wrong with `MainExecutionContext.getProgramStack()` push and pop logic.
+                 */
+                val programStack = MainExecutionContext.getProgramStack()
+                val caller = if (programStack.size > 1) {
+                    val parentProgramIndex = programStack.lastIndex - 1
+                    programStack[parentProgramIndex]
                 } else {
                     null
                 }
@@ -149,7 +161,6 @@ class RpgProgram(val cu: CompilationUnit, val name: String = "<UNNAMED RPG PROGR
 
                 activationGroup = ActivationGroup(activationGroupType, activationGroupType.assignedName(caller))
             }
-            MainExecutionContext.getProgramStack().push(this)
             MainExecutionContext.getConfiguration().jarikoCallback.onEnterPgm(name, interpreter.getGlobalSymbolTable())
             // set reinitialization to false because symboltable cleaning currently is handled directly
             // in internal interpreter before exit
@@ -160,7 +171,6 @@ class RpgProgram(val cu: CompilationUnit, val name: String = "<UNNAMED RPG PROGR
             changedInitialValues = params().map { interpreter[it.name] }
             // here clear symbol table if needed
             interpreter.doSomethingAfterExecution()
-            MainExecutionContext.getProgramStack().pop()
         }.nanoseconds
         if (MainExecutionContext.isLoggingEnabled) {
             logHandlers.renderLog(LazyLogEntry.produceStatement(logSource, "INTERPRETATION", "END"))

rpgJavaInterpreter-core/src/main/kotlin/com/smeup/rpgparser/parsing/ast/statements.kt

@@ -29,10 +29,7 @@ import com.smeup.rpgparser.parsing.parsetreetoast.acceptBody
 import com.smeup.rpgparser.parsing.parsetreetoast.error
 import com.smeup.rpgparser.parsing.parsetreetoast.isInt
 import com.smeup.rpgparser.parsing.parsetreetoast.toAst
-import com.smeup.rpgparser.utils.ComparisonOperator
-import com.smeup.rpgparser.utils.divideAtIndex
-import com.smeup.rpgparser.utils.resizeTo
-import com.smeup.rpgparser.utils.substringOfLength
+import com.smeup.rpgparser.utils.*
 import com.strumenta.kolasu.model.*
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
@@ -739,6 +736,9 @@ data class CallStmt(
         }
 
         program ?: throw callIssueException
+        if (program is RpgProgram) {
+            MainExecutionContext.getProgramStack().push(program)
+        }
 
         // Ignore exceeding params
         val targetProgramParams = program.params()
@@ -787,11 +787,14 @@ data class CallStmt(
                 }
             } catch (e: Exception) { // TODO Catch a more specific exception?
                 if (errorIndicator == null) {
+                    if (program is RpgProgram) {
+                        MainExecutionContext.getProgramStack().pop()
+                    }
                     throw e
                 }
+
                 interpreter.getIndicators()[errorIndicator] = BooleanValue.TRUE
                 MainExecutionContext.getConfiguration().jarikoCallback.onCallPgmError.invoke(popRuntimeErrorEvent())
-                MainExecutionContext.getProgramStack().pop()
                 null
             }
         paramValuesAtTheEnd?.forEachIndexed { index, value ->
@@ -803,6 +806,9 @@ data class CallStmt(
                 currentParam.result?.let { interpreter.assign(it, value) }
             }
         }
+
+        if (program is RpgProgram)
+            MainExecutionContext.getProgramStack().pop()
     }
 
     override fun getStatementLogRenderer(source: LogSourceProvider, action: String): LazyLogEntry {

rpgJavaInterpreter-core/src/test/kotlin/com/smeup/rpgparser/smeup/MULANGT10BaseCodopTest.kt

@@ -397,6 +397,16 @@ open class MULANGT10BaseCodopTest : MULANGTTest() {
         assertEquals(expected, "smeup/MUDRNRAPU00268".outputOf(configuration = smeupConfig))
     }
 
+    /**
+     * State of context after a CALL stack failed setting an error indicator
+     * @see #LS24004538
+     */
+    @Test
+    fun executeMUDRNRAPU00269() {
+        val expected = listOf("ok")
+        assertEquals(expected, "smeup/MUDRNRAPU00269".outputOf(configuration = smeupConfig))
+    }
+
     /**
      * Comparing number and `*ZEROS` by using `IFxx`.
      * @see #LS24004528

rpgJavaInterpreter-core/src/test/resources/smeup/ERRORPGM2.rpgle

@@ -0,0 +1,2 @@
+      *  This program has the sole purpose of calling a program that throws a runtime exception
+     C                   CALL        'ERRORPGM'

rpgJavaInterpreter-core/src/test/resources/smeup/MUDRNRAPU00268.rpgle

@@ -22,7 +22,7 @@
      D £TESTDS         DS
      D  £TESTPA                      10
 
-      * Call of a program that throws an error and setting the error indicator
+      * Call of a program that throws an error and sets the error indicator
      C                   CALL        'ERRORPGM'                         35
 
       * If call failed but the error indicator was set

rpgJavaInterpreter-core/src/test/resources/smeup/MUDRNRAPU00269.rpgle

@@ -0,0 +1,38 @@
+     V* ==============================================================
+     V* 30/10/2024 APU002 Creation
+     V* ==============================================================
+    O * PROGRAM GOAL
+    O * Call a program with an error indicator that calls another program
+    O * that throws an error and ensure the execution context is appropriate
+     V* ==============================================================
+    O * JARIKO ANOMALY
+    O * Before the fix, the error was about the caller not resolving
+    O * symbols in the correct compilation unit
+    O *
+    O * Note: see MUDRNRAPU00268.rpgle for a deeper explanation
+    O * on how the error was reproduced
+     V* ==============================================================
+
+      * Test declarations
+     D £TESTDS         DS
+     D  £TESTPA                      10
+
+      * Call of a program that throws an error and sets the error indicator
+     C                   CALL        'ERRORPGM2'                        35
+
+      * If call failed but the error indicator was set
+      * Execution should continue and the context should reference the correct program
+     C                   IF        P_Test(£TESTPA:'EmiMsg(':'')='Y'
+     C     'ok'          DSPLY
+     C                   ENDIF
+
+      * Test procedure
+     PP_Test           B
+     D P_Test          Pi         30000    VARYING
+     D  $A                           15    CONST
+     D  $B                            1N   OPTIONS(*NOPASS)
+     D  $C                            1    OPTIONS(*NOPASS)
+     C                   RETURN    'Y'
+     P                 E
+
+     C                   SETON                                        LR