Adding success exit codes parameter into exec boxes.

krulis-martin · krulis-martin · commit 4a7e444f3151 · 2024-07-22T11:57:29.000+02:00
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Box.php b/app/helpers/ExerciseConfig/Pipeline/Box/Box.php
@@ -151,7 +151,8 @@ public function validateMetadata()
                 // same, but if types are not the same and default port is undefined
                 // there can be any type in the output port
                 throw new ExerciseConfigException(
-                    "Default output port '{$defaultOutPort->getName()}' missing or malformed in box '{$this->getName()}'"
+                    "Default output port '{$defaultOutPort->getName()}' missing or malformed in box '"
+                    . $this->getName() . "'"
                 );
             }
         }
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/ElfExecutionBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/ElfExecutionBox.php
@@ -29,18 +29,17 @@ public static function init()
     {
         if (!self::$initialized) {
             self::$initialized = true;
-            self::$defaultInputPorts = array(
-                new Port((new PortMeta())->setName(self::$ARGS_PORT_KEY)->setType(VariableTypes::$STRING_ARRAY_TYPE)),
-                new Port((new PortMeta())->setName(self::$STDIN_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$INPUT_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$BINARY_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE))
-            );
-            self::$defaultOutputPorts = array(
-                new Port((new PortMeta())->setName(self::$STDOUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port((new PortMeta())->setName(self::$OUTPUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE))
-            );
+            self::$defaultInputPorts = Box::constructPorts([
+                self::$BINARY_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$ARGS_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$STDIN_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$INPUT_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$SUCCESS_EXIT_CODES_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+            ]);
+            self::$defaultOutputPorts = Box::constructPorts([
+                self::$STDOUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$OUTPUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+            ]);
         }
     }
 
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/HaskellExecutionBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/HaskellExecutionBox.php
@@ -34,24 +34,19 @@ public static function init()
     {
         if (!self::$initialized) {
             self::$initialized = true;
-            self::$defaultInputPorts = array(
-                new Port((new PortMeta())->setName(self::$BINARY_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$SOURCE_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$STDIN_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$INPUT_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$ENTRY_POINT_KEY)->setType(VariableTypes::$STRING_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$EXTRA_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-            );
-            self::$defaultOutputPorts = array(
-                new Port((new PortMeta())->setName(self::$STDOUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port((new PortMeta())->setName(self::$OUTPUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE))
-            );
+            self::$defaultInputPorts =  Box::constructPorts([
+                self::$BINARY_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$SOURCE_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$STDIN_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$INPUT_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$ENTRY_POINT_KEY => VariableTypes::$STRING_TYPE,
+                self::$EXTRA_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$SUCCESS_EXIT_CODES_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+            ]);
+            self::$defaultOutputPorts =  Box::constructPorts([
+                self::$STDOUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$OUTPUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+            ]);
         }
     }
 
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/JvmRunBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/JvmRunBox.php
@@ -43,6 +43,7 @@ public static function init()
                 self::$JAR_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
                 self::$RUNNER_EXEC_PORT_KEY => VariableTypes::$STRING_TYPE,
                 self::$CLASSPATH_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$SUCCESS_EXIT_CODES_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
             ]);
             self::$defaultOutputPorts = Box::constructPorts([
                 self::$STDOUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/ScriptExecutionBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/ScriptExecutionBox.php
@@ -33,28 +33,21 @@ public static function init()
     {
         if (!self::$initialized) {
             self::$initialized = true;
-            self::$defaultInputPorts = array(
-                new Port(
-                    (new PortMeta())->setName(self::$SOURCE_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$ARGS_PORT_KEY)->setType(VariableTypes::$STRING_ARRAY_TYPE)),
-                new Port((new PortMeta())->setName(self::$STDIN_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$INPUT_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$ENTRY_POINT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$EXTRA_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$RUNTIME_PATH_PORT_KEY)->setType(VariableTypes::$STRING_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$RUNTIME_ARGS_PORT_KEY)->setType(VariableTypes::$STRING_ARRAY_TYPE)
-                ),
-            );
-            self::$defaultOutputPorts = array(
-                new Port((new PortMeta())->setName(self::$STDOUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port((new PortMeta())->setName(self::$OUTPUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE))
-            );
+            self::$defaultInputPorts = Box::constructPorts([
+                self::$SOURCE_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$ARGS_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$STDIN_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$INPUT_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$ENTRY_POINT_KEY => VariableTypes::$FILE_TYPE,
+                self::$EXTRA_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$RUNTIME_PATH_PORT_KEY => VariableTypes::$STRING_TYPE,
+                self::$RUNTIME_ARGS_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$SUCCESS_EXIT_CODES_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+            ]);
+            self::$defaultOutputPorts = Box::constructPorts([
+                self::$STDOUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$OUTPUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE
+            ]);
         }
     }
 
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/WrappedExecutionBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/WrappedExecutionBox.php
@@ -34,22 +34,19 @@ public static function init()
     {
         if (!self::$initialized) {
             self::$initialized = true;
-            self::$defaultInputPorts = array(
-                new Port((new PortMeta())->setName(self::$ARGS_PORT_KEY)->setType(VariableTypes::$STRING_ARRAY_TYPE)),
-                new Port((new PortMeta())->setName(self::$STDIN_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$INPUT_FILES_PORT_KEY)->setType(VariableTypes::$FILE_ARRAY_TYPE)
-                ),
-                new Port((new PortMeta())->setName(self::$BINARY_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port((new PortMeta())->setName(self::$RUNTIME_PATH_PORT_KEY)->setType(VariableTypes::$STRING_TYPE)),
-                new Port(
-                    (new PortMeta())->setName(self::$RUNTIME_ARGS_PORT_KEY)->setType(VariableTypes::$STRING_ARRAY_TYPE)
-                ),
-            );
-            self::$defaultOutputPorts = array(
-                new Port((new PortMeta())->setName(self::$STDOUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE)),
-                new Port((new PortMeta())->setName(self::$OUTPUT_FILE_PORT_KEY)->setType(VariableTypes::$FILE_TYPE))
-            );
+            self::$defaultInputPorts = Box::constructPorts([
+                self::$ARGS_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$STDIN_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$INPUT_FILES_PORT_KEY => VariableTypes::$FILE_ARRAY_TYPE,
+                self::$BINARY_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$RUNTIME_PATH_PORT_KEY => VariableTypes::$STRING_TYPE,
+                self::$RUNTIME_ARGS_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+                self::$SUCCESS_EXIT_CODES_PORT_KEY => VariableTypes::$STRING_ARRAY_TYPE,
+            ]);
+            self::$defaultOutputPorts = Box::constructPorts([
+                self::$STDOUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+                self::$OUTPUT_FILE_PORT_KEY => VariableTypes::$FILE_TYPE,
+            ]);
         }
     }
 
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/CompilationBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/CompilationBox.php
@@ -26,7 +26,8 @@ abstract class CompilationBox extends Box
     public static $EXTRA_FILES_PORT_KEY = "extra-files";
     public static $RUNNER_FILE_PORT_KEY = "runner";
     public static $COMPILER_EXEC_PATH_PORT_KEY = "compiler-exec-path";
-    public static $EXISTS_FAILED_MSG = "Compilation process was completed correctly but no executable file was yielded. Unable to proceed with testing.";
+    public static $EXISTS_FAILED_MSG =
+        "Compilation process completed correctly but no executable file was yielded. Unable to proceed with testing.";
 
 
     /**
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/DataInBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/DataInBox.php
@@ -19,7 +19,6 @@
  */
 abstract class DataInBox extends Box
 {
-
     /**
      * If data for this box is remote, fill this with the right variable reference.
      * @var ?Variable
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/ExecutionBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/ExecutionBox.php
@@ -30,6 +30,7 @@ abstract class ExecutionBox extends Box
     public static $ENTRY_POINT_KEY = "entry-point";
     public static $EXTRA_FILES_PORT_KEY = "extra-files";
     public static $BINARY_FILE_PORT_KEY = "binary-file";
+    public static $SUCCESS_EXIT_CODES_PORT_KEY = "success-exit-codes";
 
 
     /**
@@ -86,6 +87,18 @@ protected function compileBaseTask(CompilationParams $params): Task
 
         $task->setSandboxConfig($sandbox);
 
+        if ($this->hasInputPortValue(self::$SUCCESS_EXIT_CODES_PORT_KEY)) {
+            $codes = $this->getInputPortValue(self::$SUCCESS_EXIT_CODES_PORT_KEY)->getValue();
+            foreach ($codes as &$code) {
+                $code = trim($code);
+                if (preg_match('/^(?<from>[0-9]+)\s*-+\s*(?<to>[0-9]+)$/', $code, $matches)) {
+                    // convert string range representation ('from-to') into tuple of ints [from, to]
+                    $code = [ (int)$matches['from'], (int)$matches['to'] ];
+                }
+            }
+            $task->setSuccessExitCodes($codes);
+        }
+
         return $task;
     }
 }
diff --git a/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/FetchBox.php b/app/helpers/ExerciseConfig/Pipeline/Box/Boxes/base/FetchBox.php
@@ -19,7 +19,6 @@
  */
 abstract class FetchBox extends Box
 {
-
     /**
      * DataInBox constructor.
      * @param BoxMeta $meta
diff --git a/app/helpers/JobConfig/Loader.php b/app/helpers/JobConfig/Loader.php
@@ -71,23 +71,26 @@ public function loadBoundDirectoryConfig($data, $taskId = ""): BoundDirectoryCon
 
         if (!isset($data[BoundDirectoryConfig::SRC_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "': bound directory does not contain required field '" . BoundDirectoryConfig::SRC_KEY . "'"
+                "Task '" . $taskId . "': bound directory does not contain required field '"
+                . BoundDirectoryConfig::SRC_KEY . "'"
             );
         }
         $boundDir->setSource($data[BoundDirectoryConfig::SRC_KEY]);
         unset($data[BoundDirectoryConfig::SRC_KEY]);
 
         if (!isset($data[BoundDirectoryConfig::DST_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "': bound directory does not contain required field '" . BoundDirectoryConfig::DST_KEY . "'"
+                "Task '" . $taskId . "': bound directory does not contain required field '"
+                . BoundDirectoryConfig::DST_KEY . "'"
             );
         }
         $boundDir->setDestination($data[BoundDirectoryConfig::DST_KEY]);
         unset($data[BoundDirectoryConfig::DST_KEY]);
 
         if (!isset($data[BoundDirectoryConfig::MODE_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "': bound directory does not contain required field '" . BoundDirectoryConfig::MODE_KEY . "'"
+                "Task '" . $taskId . "': bound directory does not contain required field '"
+                . BoundDirectoryConfig::MODE_KEY . "'"
             );
         }
         $boundDir->setMode($data[BoundDirectoryConfig::MODE_KEY]);
@@ -115,7 +118,8 @@ public function loadLimits($data, $taskId = ""): Limits
 
         if (!isset($data[Limits::HW_GROUP_ID_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "': sandbox limits section does not contain required field '" . Limits::HW_GROUP_ID_KEY . "'"
+                "Task '" . $taskId . "': sandbox limits section does not contain required field '"
+                . Limits::HW_GROUP_ID_KEY . "'"
             );
         }
         $limits->setId($data[Limits::HW_GROUP_ID_KEY]);
@@ -194,7 +198,8 @@ public function loadSandboxConfig($data, $taskId = ""): SandboxConfig
 
         if (!isset($data[SandboxConfig::NAME_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "': sandbox section does not contain required field '" . SandboxConfig::NAME_KEY . "'"
+                "Task '" . $taskId . "': sandbox section does not contain required field '"
+                . SandboxConfig::NAME_KEY . "'"
             );
         }
         $sandboxConfig->setName($data[SandboxConfig::NAME_KEY]);
@@ -292,7 +297,8 @@ public function loadTask($data): Task
 
         if (!isset($data[Task::CMD_KEY][Task::CMD_BIN_KEY])) {
             throw new JobConfigLoadingException(
-                "Task '" . $taskId . "' does not contain required field '" . Task::CMD_KEY . "." . Task::CMD_BIN_KEY . "'"
+                "Task '" . $taskId . "' does not contain required field '"
+                . Task::CMD_KEY . "." . Task::CMD_BIN_KEY . "'"
             );
         }
         $task->setCommandBinary($data[Task::CMD_KEY][Task::CMD_BIN_KEY]);
@@ -324,6 +330,14 @@ public function loadTask($data): Task
             unset($data[Task::CMD_KEY][Task::CMD_ARGS_KEY]);
         }
 
+        if (
+            isset($data[Task::CMD_KEY][Task::CMD_SUCCESS_EXIT_CODES_KEY])
+            && is_array($data[Task::CMD_KEY][Task::CMD_SUCCESS_EXIT_CODES_KEY])
+        ) {
+            $task->setSuccessExitCodes($data[Task::CMD_KEY][Task::CMD_SUCCESS_EXIT_CODES_KEY]);
+            unset($data[Task::CMD_KEY][Task::CMD_SUCCESS_EXIT_CODES_KEY]);
+        }
+
         if (isset($data[Task::TYPE_KEY])) {
             $task->setType($data[Task::TYPE_KEY]);
             unset($data[Task::TYPE_KEY]);
diff --git a/app/helpers/JobConfig/Tasks/Task.php b/app/helpers/JobConfig/Tasks/Task.php
diff --git a/fixtures/demo/15-pipelines.neon b/fixtures/demo/15-pipelines.neon
diff --git a/tests/ExerciseConfig/Compilation/BaseCompiler.phpt b/tests/ExerciseConfig/Compilation/BaseCompiler.phpt
diff --git a/tests/ExerciseConfig/Compilation/PipelinesMerger.phpt b/tests/ExerciseConfig/Compilation/PipelinesMerger.phpt
diff --git a/tests/ExerciseConfig/Helper.phpt b/tests/ExerciseConfig/Helper.phpt

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,8 @@ public function validateMetadata()`
`151`	`151`	`// same, but if types are not the same and default port is undefined`
`152`	`152`	`// there can be any type in the output port`
`153`	`153`	`throw new ExerciseConfigException(`
`154`		`- "Default output port '{$defaultOutPort->getName()}' missing or malformed in box '{$this->getName()}'"`
	`154`	`+ "Default output port '{$defaultOutPort->getName()}' missing or malformed in box '"`
	`155`	`+ . $this->getName() . "'"`
`155`	`156`	`);`
`156`	`157`	`}`
`157`	`158`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,6 @@`
`19`	`19`	`*/`
`20`	`20`	`abstract class DataInBox extends Box`
`21`	`21`	`{`
`22`		`-`
`23`	`22`	`/**`
`24`	`23`	`* If data for this box is remote, fill this with the right variable reference.`
`25`	`24`	`* @var ?Variable`