Merge pull request #324 from commercetools/gh-printer

test GH output printer

Author: jenschude

.github/workflows/ci.yml

@@ -22,7 +22,11 @@ jobs:
           java-version: '11'
 
       - name: Build and Release
-        run: ./gradlew clean check
+        run: ./gradlew clean check shadowJar
+
+      - name: Test validate
+        continue-on-error: true
+        run: ./rmf-gen.sh validate -f GITHUB ./api-spec/api.raml
   test_node:
     name: Build npm package
 

tools/cli-application/src/main/kotlin/io/vrap/rmf/codegen/cli/DiffSubcommand.kt

@@ -83,6 +83,7 @@ class DiffSubcommand : Callable<Int> {
                 OutputFormat.PHP_MARKDOWN -> PHPMarkdownFormatPrinter()
                 OutputFormat.TS_MARKDOWN -> TSMarkdownFormatPrinter()
                 OutputFormat.DOTNET_MARKDOWN -> DotNetMarkdownFormatPrinter()
+                OutputFormat.GITHUB -> CliFormatPrinter()
                 OutputFormat.JSON -> JsonFormatPrinter()
             }
         }

tools/cli-application/src/main/kotlin/io/vrap/rmf/codegen/cli/Utils.kt

@@ -28,10 +28,11 @@ enum class OutputFormat {
     PHP_MARKDOWN,
     TS_MARKDOWN,
     DOTNET_MARKDOWN,
-    JSON;
+    JSON,
+    GITHUB;
 
     companion object {
-        const val VALID_VALUES = "CLI, JSON, MARKDOWN"
+        const val VALID_VALUES = "CLI, JSON, MARKDOWN, GITHUB"
     }
 }
 
@@ -183,8 +184,3 @@ object InternalLogger {
         }
     }
 }
-
-
-
-
-

tools/cli-application/src/main/kotlin/io/vrap/rmf/codegen/cli/ValidateSubcommand.kt

@@ -16,7 +16,6 @@ import io.vrap.rmf.raml.model.RamlDiagnostic
 import io.vrap.rmf.raml.model.RamlModelBuilder
 import io.vrap.rmf.raml.model.RamlModelResult
 import io.vrap.rmf.raml.model.modules.Api
-import io.vrap.rmf.raml.validation.Source
 import io.vrap.rmf.raml.validation.Violation
 import org.eclipse.emf.common.util.Diagnostic
 import org.eclipse.emf.common.util.URI
@@ -199,6 +198,7 @@ class ValidateSubcommand : Callable<Int> {
             OutputFormat.PHP_MARKDOWN -> MarkdownFormatPrinter(linkFormatter)
             OutputFormat.TS_MARKDOWN -> MarkdownFormatPrinter(linkFormatter)
             OutputFormat.DOTNET_MARKDOWN -> MarkdownFormatPrinter(linkFormatter)
+            OutputFormat.GITHUB -> GithubFormatPrinter(linkFormatter)
             OutputFormat.JSON -> TODO()
         }
     }
@@ -280,6 +280,26 @@ class ValidateSubcommand : Callable<Int> {
         }
     }
 
+    class GithubFormatPrinter(override val linkFormatter: LinkFormatter): FormatPrinter {
+
+        override fun print(fileURI: URI, result: RamlModelResult<Api>): String {
+            val validationResults = result.validationResults
+            var output = ""
+            if (validationResults.isNotEmpty()) {
+                val errors = validationResults.filter { diagnostic -> diagnostic.severity == Diagnostic.ERROR }
+                val warnings = validationResults.filter { diagnostic -> diagnostic.severity == Diagnostic.WARNING }
+                val infos = validationResults.filter { diagnostic -> diagnostic.severity == Diagnostic.INFO }
+
+                if (errors.isNotEmpty()) output += errors.joinToString("\n") { "::error file=${java.net.URI.create(it.location).path},line=${it.line}::${it.detailMessage()}" }
+                if (warnings.isNotEmpty()) output += errors.joinToString("\n") { "::warning file=${java.net.URI.create(it.location).path},line=${it.line}::${it.detailMessage()}" }
+                if (infos.isNotEmpty()) output += errors.joinToString("\n") { "::notice file=${java.net.URI.create(it.location).path},line=${it.line}::${it.detailMessage()}" }
+
+                return output
+            }
+            return "✅ Specification at ${fileURI.toFileString()} is valid."
+        }
+    }
+
     class MarkdownFormatPrinter(override val linkFormatter: LinkFormatter): FormatPrinter {
         override fun print(fileURI: URI, result: RamlModelResult<Api>): String {
             val relativeFileLink = Path(fileURI.toFileString()).relativeTo(linkFormatter.filePath)
@@ -321,5 +341,3 @@ class ValidateSubcommand : Callable<Int> {
         }
     }
 }
-
-