|
| 1 | +// Copyright 2024 OWASP ModSecurity Core Rule Set Project |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package logger |
| 5 | + |
| 6 | +import ( |
| 7 | + "bytes" |
| 8 | + "testing" |
| 9 | + |
| 10 | + "github.com/rs/zerolog" |
| 11 | + "github.com/stretchr/testify/suite" |
| 12 | +) |
| 13 | + |
| 14 | +type loggerTestSuite struct { |
| 15 | + suite.Suite |
| 16 | + out *bytes.Buffer |
| 17 | + logger zerolog.Logger |
| 18 | +} |
| 19 | + |
| 20 | +func TestRunLoggerTestSuite(t *testing.T) { |
| 21 | + suite.Run(t, new(loggerTestSuite)) |
| 22 | +} |
| 23 | + |
| 24 | +var testJsonBase = []struct { |
| 25 | + name string |
| 26 | + text string |
| 27 | + logType zerolog.Level |
| 28 | + want string |
| 29 | +}{ |
| 30 | + { |
| 31 | + name: "JsonBaseOutput", |
| 32 | + text: "hello", |
| 33 | + logType: zerolog.InfoLevel, |
| 34 | + want: "message\":\"hello\"", |
| 35 | + }, |
| 36 | +} |
| 37 | + |
| 38 | +var testConsoleBase = []struct { |
| 39 | + name string |
| 40 | + text string |
| 41 | + logType zerolog.Level |
| 42 | + want string |
| 43 | +}{ |
| 44 | + { |
| 45 | + name: "BaseConsoleOutput", |
| 46 | + text: "hello", |
| 47 | + logType: zerolog.InfoLevel, |
| 48 | + want: "INF hello component=parser-test", |
| 49 | + }, |
| 50 | +} |
| 51 | + |
| 52 | +var testGithub = []struct { |
| 53 | + name string |
| 54 | + text string |
| 55 | + logType zerolog.Level |
| 56 | + want string |
| 57 | +}{ |
| 58 | + { |
| 59 | + name: "TestGithubInfoOutput", |
| 60 | + text: "this is an info message", |
| 61 | + logType: zerolog.InfoLevel, |
| 62 | + want: "::notice ::this is an info message", |
| 63 | + }, |
| 64 | + { |
| 65 | + name: "TestGithubWarningOutput", |
| 66 | + text: "this is a warning message", |
| 67 | + logType: zerolog.WarnLevel, |
| 68 | + want: "::warn ::this is a warning message", |
| 69 | + }, |
| 70 | + { |
| 71 | + name: "TestGithubTraceOutput", |
| 72 | + text: "this is a trace message that will show as debug", |
| 73 | + logType: zerolog.TraceLevel, |
| 74 | + want: "::debug ::this is a trace message that will show as debug", |
| 75 | + }, |
| 76 | + { |
| 77 | + name: "TestGithubDebugOutput", |
| 78 | + text: "this is a debug message", |
| 79 | + logType: zerolog.DebugLevel, |
| 80 | + want: "::debug ::this is a debug message", |
| 81 | + }, |
| 82 | +} |
| 83 | + |
| 84 | +func (s *loggerTestSuite) SetupTest() { |
| 85 | + // reset logger |
| 86 | + s.out = &bytes.Buffer{} |
| 87 | + s.logger = zerolog.New(s.out).With().Str("component", "parser-test").Logger() |
| 88 | + zerolog.SetGlobalLevel(zerolog.TraceLevel) |
| 89 | +} |
| 90 | + |
| 91 | +func (s *loggerTestSuite) TestJsonOutput() { |
| 92 | + for _, t := range testJsonBase { |
| 93 | + s.Run(t.name, func() { |
| 94 | + s.logger.WithLevel(t.logType).Msg(t.text) |
| 95 | + s.Contains(s.out.String(), t.want) |
| 96 | + s.out.Reset() |
| 97 | + }) |
| 98 | + } |
| 99 | +} |
| 100 | + |
| 101 | +func (s *loggerTestSuite) TestConsoleOutput() { |
| 102 | + s.logger = s.logger.Output(zerolog.ConsoleWriter{Out: s.out, NoColor: true, TimeFormat: "03:04:05"}) |
| 103 | + for _, t := range testConsoleBase { |
| 104 | + s.Run(t.name, func() { |
| 105 | + s.logger.WithLevel(t.logType).Msg(t.text) |
| 106 | + s.Contains(s.out.String(), t.want) |
| 107 | + s.out.Reset() |
| 108 | + }) |
| 109 | + } |
| 110 | +} |
| 111 | + |
| 112 | +//s.log = log.Output(zerolog.ConsoleWriter{Out: os.Stderr, TimeFormat: "03:04:05"}).With().Caller().Logger() |
| 113 | + |
| 114 | +func (s *loggerTestSuite) TestSetGithubOutput() { |
| 115 | + // send logs to buffer |
| 116 | + logger := SetGithubOutput(s.out) |
| 117 | + for _, t := range testGithub { |
| 118 | + s.Run(t.name, func() { |
| 119 | + logger.WithLevel(t.logType).Msg(t.text) |
| 120 | + s.Contains(s.out.String(), t.want) |
| 121 | + s.out.Reset() |
| 122 | + }) |
| 123 | + } |
| 124 | +} |
0 commit comments