test: add some bad typings test cases (#289)

Co-authored-by: Piotr Krzemiński <[email protected]>

Author: Vampire

src/jvmTest/kotlin/it/krzeminski/githubactionstyping/LogicConsistencyTest.kt

@@ -1,5 +1,7 @@
 package it.krzeminski.githubactionstyping
 
+import com.charleskorn.kaml.IncorrectTypeException
+import com.charleskorn.kaml.InvalidPropertyValueException
 import io.kotest.assertions.assertSoftly
 import io.kotest.assertions.withClue
 import io.kotest.matchers.should
@@ -29,14 +31,23 @@ class LogicConsistencyTest : UseCaseTest() {
             .trimMargin("#")
             .trim()
 
-        val validationResult = parseTypesManifest(typesManifest).validate(typing.toPath().fileName)
-        assertSoftly {
-            validationResult.overallResult should beOfType<ItemValidationResult.Invalid>()
-            validationResult
-                .toPlaintextReport()
-                .trim()
-                .replace("\u001B", "\\x1B")
-                .shouldBe(expectedValidationError)
+        val parsedTypesManifest = runCatching {
+            parseTypesManifest(typesManifest).validate(typing.toPath().fileName)
+        }
+        if (parsedTypesManifest.isFailure &&
+            ((parsedTypesManifest.exceptionOrNull() is InvalidPropertyValueException) || (parsedTypesManifest.exceptionOrNull() is IncorrectTypeException))
+        ) {
+            parsedTypesManifest.exceptionOrNull()!!.message shouldBe expectedValidationError
+        } else {
+            val validationResult = parsedTypesManifest.getOrThrow()
+            assertSoftly {
+                validationResult.overallResult should beOfType<ItemValidationResult.Invalid>()
+                validationResult
+                    .toPlaintextReport()
+                    .trim()
+                    .replace("\u001B", "\\x1B")
+                    .shouldBe(expectedValidationError)
+            }
         }
     }
 }

src/test/resources/bad-typings/inputs_enum_list_item_with_non_sequence_allowed_values.yml

@@ -0,0 +1,14 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  granted-scopes:
+    type: list
+    separator: ','
+    list-item:
+      type: enum
+      allowed-values: foo
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'granted-scopes' is invalid: Value for 'list-item' is invalid: Value for 'allowed-values' is invalid: Expected a list, but got a scalar value
+#

src/test/resources/bad-typings/inputs_enum_with_non_sequence_allowed_values.yml

@@ -0,0 +1,11 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  permissions:
+    type: enum
+    allowed-values: foo
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'permissions' is invalid: Value for 'allowed-values' is invalid: Expected a list, but got a scalar value
+#

src/test/resources/bad-typings/inputs_integer_list_item_with_non_mapping_named_values.yml

@@ -0,0 +1,15 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  list-of-integer:
+    type: list
+    separator: ','
+    list-item:
+      type: integer
+      name: AllowedValues
+      named-values: []
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'list-of-integer' is invalid: Value for 'list-item' is invalid: Value for 'named-values' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/inputs_integer_with_non_mapping_named_values.yml

@@ -0,0 +1,12 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  retries:
+    type: integer
+    name: AllowedValues
+    named-values: []
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'retries' is invalid: Value for 'named-values' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/inputs_list_with_null_separator.yml

@@ -0,0 +1,22 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  input-files:
+    type: list
+    separator:
+    list-item:
+      type: string
+
+# Expected validation error
+#
+#For action with manifest at 'inputs_list_with_null_separator.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#• input-files:
+#  \x1B[31m❌ INVALID: Separator must be specified.\x1B[0m
+#
+#Outputs:
+#None.
+#

src/test/resources/bad-typings/inputs_with_non_string_type.yml

@@ -0,0 +1,19 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  permissions:
+    type: 0x0
+
+# Expected validation error
+#
+#For action with manifest at 'inputs_with_non_string_type.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#• permissions:
+#  \x1B[31m❌ INVALID: Unknown type: '0x0'.\x1B[0m
+#
+#Outputs:
+#None.
+#

src/test/resources/bad-typings/inputs_with_null_type.yml

@@ -0,0 +1,19 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  permissions:
+    type:
+
+# Expected validation error
+#
+#For action with manifest at 'inputs_with_null_type.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#• permissions:
+#  \x1B[31m❌ INVALID: Type must be specified. Use 'type' attribute.\x1B[0m
+#
+#Outputs:
+#None.
+#

src/test/resources/bad-typings/outputs_enum_list_item_with_non_sequence_allowed_values.yml

@@ -0,0 +1,14 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  granted-scopes:
+    type: list
+    separator: ','
+    list-item:
+      type: enum
+      allowed-values: foo
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'granted-scopes' is invalid: Value for 'list-item' is invalid: Value for 'allowed-values' is invalid: Expected a list, but got a scalar value
+#

src/test/resources/bad-typings/outputs_enum_with_non_sequence_allowed_values.yml

@@ -0,0 +1,11 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  permissions:
+    type: enum
+    allowed-values: foo
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'permissions' is invalid: Value for 'allowed-values' is invalid: Expected a list, but got a scalar value
+#

src/test/resources/bad-typings/outputs_integer_list_item_with_non_mapping_named_values.yml

@@ -0,0 +1,14 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  list-of-integer:
+    type: list
+    separator: ','
+    list-item:
+      type: integer
+      named-values: []
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'list-of-integer' is invalid: Value for 'list-item' is invalid: Value for 'named-values' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/outputs_integer_with_non_mapping_named_values.yml

@@ -0,0 +1,11 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  retries:
+    type: integer
+    named-values: []
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'retries' is invalid: Value for 'named-values' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/outputs_list_with_null_separator.yml

@@ -0,0 +1,22 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  input-files:
+    type: list
+    separator:
+    list-item:
+      type: string
+
+# Expected validation error
+#
+#For action with manifest at 'outputs_list_with_null_separator.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#None.
+#
+#Outputs:
+#• input-files:
+#  \x1B[31m❌ INVALID: Separator must be specified.\x1B[0m
+#

src/test/resources/bad-typings/outputs_with_non_string_type.yml

@@ -0,0 +1,20 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  permissions:
+    type: 0x0
+
+# Expected validation error
+#
+#For action with manifest at 'outputs_with_non_string_type.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#None.
+#
+#Outputs:
+#• permissions:
+#  \x1B[31m❌ INVALID: Unknown type: '0x0'.\x1B[0m
+#
+#

src/test/resources/bad-typings/outputs_with_null_type.yml

@@ -0,0 +1,19 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  permissions:
+    type:
+
+# Expected validation error
+#
+#For action with manifest at 'outputs_with_null_type.yml':
+#Result:
+#\x1B[31m❌ INVALID: Some typing is invalid.\x1B[0m
+#
+#Inputs:
+#None.
+#
+#Outputs:
+#• permissions:
+#  \x1B[31m❌ INVALID: Type must be specified. Use 'type' attribute.\x1B[0m
+#

src/test/resources/bad-typings/scalar_input.yml

@@ -0,0 +1,9 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  foo: bar
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'foo' is invalid: Expected an object, but got a scalar value
+#

src/test/resources/bad-typings/scalar_inputs.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs: foo
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Expected a map, but got a scalar value
+#

src/test/resources/bad-typings/scalar_output.yml

@@ -0,0 +1,9 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  foo: bar
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'foo' is invalid: Expected an object, but got a scalar value
+#

src/test/resources/bad-typings/scalar_outputs.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs: foo
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Expected a map, but got a scalar value
+#

src/test/resources/bad-typings/sequence_input.yml

@@ -0,0 +1,9 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs:
+  foo: []
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Value for 'foo' is invalid: Expected an object, but got a list
+#

src/test/resources/bad-typings/sequence_inputs.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+inputs: []
+
+# Expected validation error
+#
+#Value for 'inputs' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/sequence_output.yml

@@ -0,0 +1,9 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs:
+  foo: []
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Value for 'foo' is invalid: Expected an object, but got a list
+#

src/test/resources/bad-typings/sequence_outputs.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+outputs: []
+
+# Expected validation error
+#
+#Value for 'outputs' is invalid: Expected a map, but got a list
+#

src/test/resources/bad-typings/top_level_scalar.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+foo
+
+# Expected validation error
+#
+#Expected an object, but got a scalar value
+#

src/test/resources/bad-typings/top_level_sequence.yml

@@ -0,0 +1,8 @@
+# yaml-language-server: $schema=../../../../github-actions-typing.schema.json
+# See https://github.com/typesafegithub/github-actions-typing
+[]
+
+# Expected validation error
+#
+#Expected an object, but got a list
+#