[#48] feat: improve message for input/output mismatch

Author: krzema12

src/main/kotlin/it/krzeminski/githubactionstyping/ManifestsToReport.kt

@@ -5,6 +5,7 @@ import it.krzeminski.githubactionstyping.parsing.parseManifest
 import it.krzeminski.githubactionstyping.parsing.parseTypesManifest
 import it.krzeminski.githubactionstyping.reporting.toPlaintextReport
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
+import it.krzeminski.githubactionstyping.validation.buildInputOutputMismatchValidationResult
 import it.krzeminski.githubactionstyping.validation.validate
 
 fun manifestsToReport(manifest: String, typesManifest: String): Pair<Boolean, String> {
@@ -18,15 +19,17 @@ fun manifestsToReport(manifest: String, typesManifest: String): Pair<Boolean, St
     val inputsInTypesManifest = parsedTypesManifest.inputs.keys
     val inputsInManifest = parsedManifest.inputs.keys
 
-    if (inputsInManifest != inputsInTypesManifest) {
-        throw IllegalStateException("The same set of inputs should exist in action manifest and types manifest!")
-    }
-
     val outputsInTypesManifest = parsedTypesManifest.outputs.keys
     val outputsInManifest = parsedManifest.outputs.keys
 
-    if (outputsInManifest != outputsInTypesManifest) {
-        throw IllegalStateException("The same set of outputs should exist in action manifest and types manifest!")
+    if (inputsInManifest != inputsInTypesManifest || outputsInManifest != outputsInTypesManifest) {
+        val inputOutputMismatchValidationResult = buildInputOutputMismatchValidationResult(
+            inputsInManifest = inputsInManifest,
+            inputsInTypesManifest = inputsInTypesManifest,
+            outputsInManifest = outputsInManifest,
+            outputsInTypesManifest = outputsInTypesManifest,
+        )
+        return Pair(false, inputOutputMismatchValidationResult.toPlaintextReport())
     }
 
     printlnDebug("Action's manifest:")

src/main/kotlin/it/krzeminski/githubactionstyping/validation/ManifestValidation.kt

@@ -22,6 +22,43 @@ fun TypesManifest.validate(): ActionValidationResult {
     )
 }
 
+fun buildInputOutputMismatchValidationResult(
+    inputsInManifest: Set<String>,
+    inputsInTypesManifest: Set<String>,
+    outputsInManifest: Set<String>,
+    outputsInTypesManifest: Set<String>,
+): ActionValidationResult {
+    return ActionValidationResult(
+        overallResult = ItemValidationResult.Invalid(
+            "Input/output mismatch detected. Please fix it first, then rerun to see other possible violations.",
+        ),
+        inputs = (inputsInManifest + inputsInTypesManifest)
+            .associateWith {
+                if (it in inputsInManifest && it in inputsInTypesManifest) {
+                    ItemValidationResult.Valid
+                } else {
+                    if (it !in inputsInManifest) {
+                        ItemValidationResult.Invalid("This input doesn't exist in the action manifest.")
+                    } else {
+                        ItemValidationResult.Invalid("This input doesn't exist in the types manifest.")
+                    }
+                }
+            },
+        outputs = (outputsInManifest + outputsInTypesManifest)
+            .associateWith {
+                if (it in outputsInManifest && it in outputsInTypesManifest) {
+                    ItemValidationResult.Valid
+                } else {
+                    if (it !in outputsInManifest) {
+                        ItemValidationResult.Invalid("This output doesn't exist in the action manifest.")
+                    } else {
+                        ItemValidationResult.Invalid("This output doesn't exist in the types manifest.")
+                    }
+                }
+            },
+    )
+}
+
 private fun ApiItem.validate(): ItemValidationResult {
     if (this.type == null) {
         return ItemValidationResult.Invalid("Type must be specified. Use 'type' attribute.")

src/test/kotlin/it/krzeminski/githubactionstyping/validation/ManifestsToReportTest.kt

@@ -199,6 +199,72 @@ class ManifestsToReportTest : FunSpec({
                 None.
 
 
+            """.trimIndent()
+        }
+    }
+
+    test("inputs mismatch between action manifest and types manifest") {
+        // when
+        val manifest = """
+            name: GitHub Actions Typing
+            description: Bring type-safety to your GitHub actions' API!
+            author: Piotr Krzemiński
+            inputs:
+              foo:
+                description: 'Set to true to display debug information helpful when troubleshooting issues with this action.'
+                required: false
+              bar:
+                description: 'Testing enum'
+                required: false
+            outputs:
+              goo:
+                description: 'Set to true to display debug information helpful when troubleshooting issues with this action.'
+              zoo:
+                description: 'Testing enum'
+        """.trimIndent()
+        val typesManifest = """
+            inputs:
+              foo:
+                type: boolean
+              baz:
+                type: enum
+                allowed-values:
+                 - foo
+                 - bar
+            outputs:
+              goo:
+                type: boolean
+              boo:
+                type: enum
+        """.trimIndent()
+
+        // when
+        val (isValid, report) = manifestsToReport(manifest, typesManifest)
+
+        // then
+        assertSoftly {
+            isValid shouldBe false
+            report shouldBe """
+                Overall result: 
+                ${'\u001b'}[31m❌ INVALID: Input/output mismatch detected. Please fix it first, then rerun to see other possible violations.${'\u001b'}[0m
+
+                Inputs:
+                • foo:
+                  ${'\u001b'}[32m✔ VALID${'\u001b'}[0m
+                • bar:
+                  ${'\u001b'}[31m❌ INVALID: This input doesn't exist in the types manifest.${'\u001b'}[0m
+                • baz:
+                  ${'\u001b'}[31m❌ INVALID: This input doesn't exist in the action manifest.${'\u001b'}[0m
+
+                Outputs:
+                • goo:
+                  ${'\u001b'}[32m✔ VALID${'\u001b'}[0m
+                • zoo:
+                  ${'\u001b'}[31m❌ INVALID: This output doesn't exist in the types manifest.${'\u001b'}[0m
+                • boo:
+                  ${'\u001b'}[31m❌ INVALID: This output doesn't exist in the action manifest.${'\u001b'}[0m
+
+
             """.trimIndent()
         }
     }