feat: add new formatter log output for github

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>

Author: fzipi

cmd/flag_types.go

@@ -11,6 +11,8 @@ import (
 	"path/filepath"
 
 	"github.com/rs/zerolog"
+
+	loggerConfig "github.com/coreruleset/crs-toolchain/logger"
 )
 
 // The types in this file satisfy the interface of pflag.Value.
@@ -38,7 +40,10 @@ func (o *outputType) String() string {
 
 func (o *outputType) Set(value string) error {
 	switch value {
-	case string(text), string(gitHub):
+	case string(gitHub):
+		logger = loggerConfig.SetGithubOutput()
+		fallthrough
+	case string(text):
 		rootValues.output = outputType(value)
 		return nil
 	default:

logger/logger.go

@@ -4,6 +4,7 @@
 package logger
 
 import (
+	"fmt"
 	"os"
 
 	"github.com/rs/zerolog"
@@ -12,7 +13,27 @@ import (
 
 const DefaultLogLevel zerolog.Level = zerolog.InfoLevel
 
+var consoleOutput = zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: "03:04:05"}
+
 func init() {
-	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: "03:04:05"}).With().Caller().Logger()
+	log.Logger = log.Output(consoleOutput).With().Caller().Logger()
 	zerolog.SetGlobalLevel(DefaultLogLevel)
 }
+
+// SetGithubOutput changes the standard logging format to be compatible with GitHub's.
+// See https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#example-creating-an-annotation-for-an-error
+// Levels on github are:
+// - debug, notice, error, warning
+// Another possibility is to add the following strings between the level and the message:
+// file={name},line={line},endLine={endLine},title={title}
+func SetGithubOutput() zerolog.Logger {
+	// the following formatlevel func might need to rename levels to match with github naming
+	consoleOutput.FormatLevel = func(i interface{}) string {
+		return fmt.Sprintf("::%s", i)
+	}
+	consoleOutput.FormatMessage = func(i interface{}) string {
+		return fmt.Sprintf("::%s", i)
+	}
+	consoleOutput.PartsExclude = []string{zerolog.TimestampFieldName}
+	return zerolog.New(consoleOutput).With().Logger()
+}