Add maestro check-syntax command (#2387)

Author: Leland-Takamine

maestro

@@ -2,4 +2,10 @@
 
 set -e
 
-./gradlew :maestro-cli:installDist -q && ./maestro-cli/build/install/maestro/bin/maestro "$@"
+if [ -t 0 ]; then
+  input=""
+else
+  input=$(cat -)
+fi
+
+./gradlew :maestro-cli:installDist -q && echo "$input" | ./maestro-cli/build/install/maestro/bin/maestro "$@"

maestro-cli/src/main/java/maestro/cli/App.kt

@@ -23,6 +23,7 @@ import maestro.MaestroException
 import maestro.cli.analytics.Analytics
 import maestro.cli.command.BugReportCommand
  import maestro.cli.command.ChatCommand
+import maestro.cli.command.CheckSyntaxCommand
 import maestro.cli.command.CloudCommand
 import maestro.cli.command.DownloadSamplesCommand
 import maestro.cli.command.LoginCommand
@@ -64,6 +65,7 @@ import kotlin.system.exitProcess
         StartDeviceCommand::class,
         GenerateCompletion::class,
         ChatCommand::class,
+        CheckSyntaxCommand::class,
     ]
 )
 class App {

maestro-cli/src/main/java/maestro/cli/command/CheckSyntaxCommand.kt

@@ -0,0 +1,41 @@
+package maestro.cli.command
+
+import maestro.cli.CliError
+import maestro.orchestra.error.SyntaxError
+import maestro.orchestra.yaml.YamlCommandReader
+import picocli.CommandLine
+import java.io.File
+import java.util.concurrent.Callable
+
+@CommandLine.Command(
+    name = "check-syntax",
+    description = [
+        "Check syntax of Maestro code"
+    ],
+    hidden = true
+)
+class CheckSyntaxCommand : Callable<Int> {
+
+    @CommandLine.Parameters(
+        index = "0",
+        description = ["Check syntax of Maestro flow file or \"-\" for stdin"],
+    )
+    private lateinit var file: File
+
+    override fun call(): Int {
+        val maestroCode = if (file.path == "-") {
+            System.`in`.readBytes().toString(Charsets.UTF_8)
+        } else {
+            if (!file.exists()) throw CliError("File does not exist: ${file.absolutePath}")
+            file.readText()
+        }
+        if (maestroCode.isBlank()) throw CliError("Maestro code is empty.")
+        try {
+            YamlCommandReader.checkSyntax(maestroCode)
+            println("OK")
+        } catch (e: SyntaxError) {
+            throw CliError(e.message)
+        }
+        return 0
+    }
+}

maestro-orchestra/src/main/java/maestro/orchestra/yaml/MaestroFlowParser.kt

@@ -23,6 +23,7 @@ import com.fasterxml.jackson.core.JsonLocation
 import com.fasterxml.jackson.core.JsonParser
 import com.fasterxml.jackson.core.JsonProcessingException
 import com.fasterxml.jackson.core.JsonToken
+import com.fasterxml.jackson.core.TreeNode
 import com.fasterxml.jackson.databind.DeserializationContext
 import com.fasterxml.jackson.databind.JsonDeserializer
 import com.fasterxml.jackson.databind.ObjectMapper
@@ -40,6 +41,7 @@ import maestro.orchestra.error.MediaFileNotFound
 import maestro.orchestra.util.Env.withEnv
 import org.intellij.lang.annotations.Language
 import java.nio.file.Path
+import java.nio.file.Paths
 import kotlin.io.path.absolute
 import kotlin.io.path.isDirectory
 import kotlin.io.path.readText
@@ -486,6 +488,50 @@ object MaestroFlowParser {
         return MAPPER.writeValueAsString(commands.map { MAPPER.readTree(it) })
     }
 
+    fun checkSyntax(maestroCode: String) {
+        MAPPER.createParser(maestroCode).use { parser ->
+            val node = parser.readValueAsTree<TreeNode>()
+            if (node.isArray) {
+                checkCommandListSyntax(maestroCode)
+            } else if (node.isObject && parser.nextToken() != null) {
+                checkFlowSyntax(maestroCode)
+            } else {
+                checkCommandSyntax(maestroCode)
+            }
+        }
+    }
+
+    private fun checkCommandListSyntax(maestroCode: String) {
+        MAPPER.createParser(maestroCode).use { parser ->
+            try {
+                parseCommands(parser)
+            } catch (e: Throwable) {
+                throw wrapException(e, parser, Paths.get("/syntax-checker"), maestroCode)
+            }
+        }
+    }
+
+    private fun checkCommandSyntax(command: String) {
+        MAPPER.createParser(command).use { parser ->
+            try {
+                parser.readValueAs(YamlFluentCommand::class.java)
+            } catch (e: Throwable) {
+                throw wrapException(e, parser, Paths.get("/syntax-checker"), command)
+            }
+        }
+    }
+
+    private fun checkFlowSyntax(flow: String) {
+        MAPPER.createParser(flow).use { parser ->
+            try {
+                parseConfig(parser)
+                parseCommands(parser)
+            } catch (e: Throwable) {
+                throw wrapException(e, parser, Paths.get("/syntax-checker"), flow)
+            }
+        }
+    }
+
     private fun parseCommands(parser: JsonParser): List<YamlFluentCommand> {
         if (parser.nextToken() != JsonToken.START_ARRAY) {
             throw ParseException(

maestro-orchestra/src/main/java/maestro/orchestra/yaml/YamlCommandReader.kt

@@ -28,6 +28,7 @@ import maestro.orchestra.WorkspaceConfig
 import maestro.orchestra.error.SyntaxError
 import maestro.utils.drawTextBox
 import java.nio.file.Path
+import java.nio.file.Paths
 import kotlin.io.path.absolutePathString
 import kotlin.io.path.readText
 
@@ -70,6 +71,10 @@ object YamlCommandReader {
 
     fun formatCommands(commands: List<String>): String = MaestroFlowParser.formatCommands(commands)
 
+    fun checkSyntax(maestroCode: String) = mapParsingErrors(Paths.get("/syntax-checker/")) {
+        MaestroFlowParser.checkSyntax(maestroCode)
+    }
+
     private fun <T> mapParsingErrors(path: Path, block: () -> T): T {
         try {
             return block()

tmp.sh

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [ -t 0 ]; then
+  input=""
+else
+  input=$(cat -)
+fi
+
+echo "Hello $input"