check GH printer for custom checkout dir

Author: jenschude

.github/workflows/ci.yml

@@ -24,9 +24,15 @@ jobs:
       - name: Build and Release
         run: ./gradlew clean check shadowJar
 
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: test
+
       - name: Test validate
         continue-on-error: true
-        run: ./rmf-gen.sh validate -f GITHUB -r ./api-spec/ruleset.xml ./api-spec/api.raml
+        run: ./rmf-gen.sh validate -f GITHUB ./api-spec/api.raml
+        working-directory: test
   test_node:
     name: Build npm package
 

api-spec/types/error.raml

@@ -18,6 +18,8 @@ types:
             type: string
         error_description?:
             type: string
+        error_description2?:
+          type: string
         errors?:
             type: ErrorObject[]
   ErrorObject:

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

@@ -28,10 +28,7 @@ import java.nio.file.Paths
 import java.util.*
 import java.util.concurrent.Callable
 import java.util.concurrent.TimeUnit
-import kotlin.io.path.Path
-import kotlin.io.path.relativeTo
-import kotlin.io.path.relativeToOrSelf
-import kotlin.io.path.toPath
+import kotlin.io.path.*
 
 enum class DiagnosticSeverity(val severity: String, val value: Int) {
     INFO("info", Diagnostic.INFO),
@@ -67,6 +64,9 @@ class ValidateSubcommand : Callable<Int> {
     @CommandLine.Option(names = ["-l", "--link-base"])
     var linkBase: java.net.URI? = null
 
+    @CommandLine.Option(names = ["-d", "--dir-base"])
+    var dirBase: Path? = null
+
     @CommandLine.Option(names = ["-lf", "--link-format"], description = ["Specifies the link format","Valid values: ${LinkFormat.VALID_VALUES}"] )
     var linkFormat: LinkFormat = LinkFormat.CLI
 
@@ -92,6 +92,10 @@ class ValidateSubcommand : Callable<Int> {
         return uri
     }
 
+    private fun dirBase(): Path {
+        return dirBase ?: Paths.get("").toAbsolutePath()
+    }
+
     override fun call(): Int {
         if (listRules) {
             println("Available validators:")
@@ -198,7 +202,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.GITHUB -> GithubFormatPrinter(dirBase(), linkFormatter)
             OutputFormat.JSON -> TODO()
         }
     }
@@ -280,24 +284,30 @@ class ValidateSubcommand : Callable<Int> {
         }
     }
 
-    class GithubFormatPrinter(override val linkFormatter: LinkFormatter): FormatPrinter {
+    class GithubFormatPrinter(val dirBase: Path, override val linkFormatter: LinkFormatter): FormatPrinter {
 
         override fun print(fileURI: URI, result: RamlModelResult<Api>): String {
+            System.out.println(dirBase)
             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()}" }
+                if (errors.isNotEmpty()) output += errors.joinToString("\n") { "::error file=${it.toLocation(dirBase)},line=${it.line}::${it.detailMessage()}" }
+                if (warnings.isNotEmpty()) output += errors.joinToString("\n") { "::warning file=${it.toLocation(dirBase)},line=${it.line}::${it.detailMessage()}" }
+                if (infos.isNotEmpty()) output += errors.joinToString("\n") { "::notice file=${it.toLocation(dirBase)},line=${it.line}::${it.detailMessage()}" }
 
                 return output
             }
             return "::notice ::Specification at ${fileURI.toFileString()} is valid."
         }
+
+        fun RamlDiagnostic.toLocation(filePath: Path): Path {
+            return java.net.URI.create(this.location).toPath().relativeToOrSelf(filePath)
+        }
+
     }
 
     class MarkdownFormatPrinter(override val linkFormatter: LinkFormatter): FormatPrinter {