File: test_pattern.rb

package info (click to toggle)
ruby-logging 2.2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 660 kB
  • sloc: ruby: 6,139; sh: 11; makefile: 2
file content (249 lines) | stat: -rw-r--r-- 7,630 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249

require File.expand_path('../../setup', __FILE__)

module TestLogging
module TestLayouts

  class TestPattern < Test::Unit::TestCase
    include LoggingTestCase

    def setup
      super
      @layout = Logging.layouts.pattern({})
      @levels = Logging::LEVELS
      @date_fmt = '\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}'
      Thread.current[:name] = nil
    end

    def test_date_method
      assert_nil @layout.date_method
    end

    def test_date_method_eq
      @layout.date_method = :to_f
      assert_equal :to_f, @layout.date_method
      assert_instance_of Float, @layout.format_date(Time.now)

      @layout.date_method = 'usec'
      assert_equal 'usec', @layout.date_method
      assert_kind_of Integer, @layout.format_date(Time.now)

      @layout.date_method = :to_s
      assert_equal :to_s, @layout.date_method
      assert_instance_of String, @layout.format_date(Time.now)

      # now, even if we have defined a date_pattern, the date_method should
      # supersede the date_pattern
      @layout.date_pattern = '%Y'

      @layout.date_method = 'usec'
      assert_equal 'usec', @layout.date_method
      assert_kind_of Integer, @layout.format_date(Time.now)
    end

    def test_date_pattern
      assert_equal '%Y-%m-%dT%H:%M:%S', @layout.date_pattern
    end

    def test_date_pattern_eq
      @layout.date_pattern = '%Y'
      assert_equal '%Y', @layout.date_pattern
      assert_match %r/\A\d{4}\z/, @layout.format_date(Time.now)

      @layout.date_pattern = '%H:%M'
      assert_equal '%H:%M', @layout.date_pattern
      assert_match %r/\A\d{2}:\d{2}\z/, @layout.format_date(Time.now)
    end

    def test_format
      fmt = '\[' + @date_fmt + '\] %s -- %s : %s\n'

      event = Logging::LogEvent.new('ArrayLogger', @levels['info'],
                                    'log message', false)
      rgxp  = Regexp.new(sprintf(fmt, 'INFO ', 'ArrayLogger', 'log message'))
      assert_match rgxp, @layout.format(event)

      event.data = [1, 2, 3, 4]
      rgxp  = Regexp.new(sprintf(fmt, 'INFO ', 'ArrayLogger',
                                 Regexp.escape("<Array> #{[1,2,3,4]}")))
      assert_match rgxp, @layout.format(event)

      event.level = @levels['debug']
      event.data = 'and another message'
      rgxp  = Regexp.new(
                  sprintf(fmt, 'DEBUG', 'ArrayLogger', 'and another message'))
      assert_match rgxp, @layout.format(event)

      event.logger = 'Test'
      event.level = @levels['fatal']
      event.data = Exception.new
      rgxp  = Regexp.new(
                  sprintf(fmt, 'FATAL', 'Test', '<Exception> Exception'))
      assert_match rgxp, @layout.format(event)
    end

    def test_format_date
      rgxp = Regexp.new @date_fmt
      assert_match rgxp, @layout.format_date(Time.now)
    end

    def test_pattern
      assert_equal "[%d] %-5l -- %c : %m\n", @layout.pattern
    end

    def test_pattern_eq
      event = Logging::LogEvent.new('TestLogger', @levels['info'],
                                    ['log message'], false)

      @layout.pattern = '%d'
      assert_equal '%d', @layout.pattern
      assert_match Regexp.new(@date_fmt), @layout.format(event)
    end

    def test_pattern_all
      event = Logging::LogEvent.new('TestLogger', @levels['info'],
                                    'log message', false)
      event.file = 'test_file.rb'
      event.line = '123'
      event.method = 'method_name'

      @layout.pattern = '%c'
      assert_equal 'TestLogger', @layout.format(event)

      @layout.pattern = '%d'
      assert_match Regexp.new(@date_fmt), @layout.format(event)

      @layout.pattern = '%F'
      assert_equal 'test_file.rb', @layout.format(event)

      @layout.pattern = '%l'
      assert_equal 'INFO', @layout.format(event)

      @layout.pattern = '%L'
      assert_equal '123', @layout.format(event)

      @layout.pattern = '%m'
      assert_equal 'log message', @layout.format(event)

      @layout.pattern = '%M'
      assert_equal 'method_name', @layout.format(event)

      @layout.pattern = '%p'
      assert_match %r/\A\d+\z/, @layout.format(event)

      @layout.pattern = '%r'
      assert_match %r/\A\d+\z/, @layout.format(event)

      @layout.pattern = '%t'
      assert_match %r/\A-?\d+\z/, @layout.format(event)

      @layout.pattern = '%T'
      assert_equal "", @layout.format(event)
      Thread.current[:name] = "Main"
      assert_equal "Main", @layout.format(event)

      @layout.pattern = '%h'
      hostname = Socket.gethostname
      assert_equal hostname, @layout.format(event)

      @layout.pattern = '%%'
      assert_equal '%', @layout.format(event)

      # 'z' is not a recognized format character
      assert_raise(ArgumentError) {
        @layout.pattern = '[%d] %% %c - %l %z blah'
      }
      assert_equal '%', @layout.format(event)

      @layout.pattern = '%5l'
      assert_equal ' INFO', @layout.format(event)

      @layout.pattern = '%-5l'
      assert_equal 'INFO ', @layout.format(event)

      @layout.pattern = '%.1l, %c'
      assert_equal 'I, TestLogger', @layout.format(event)

      @layout.pattern = '%7.7m'
      assert_equal 'log mes', @layout.format(event)

      event.data = 'tim'
      assert_equal '    tim', @layout.format(event)

      @layout.pattern = '%-7.7m'
      assert_equal 'tim    ', @layout.format(event)
    end

    def test_pattern_logger_name_precision
      event = Logging::LogEvent.new('Foo', @levels['info'], 'message', false)

      @layout.pattern = '%c{2}'
      assert_equal 'Foo', @layout.format(event)

      event.logger = 'Foo::Bar::Baz::Buz'
      assert_equal 'Baz::Buz', @layout.format(event)

      assert_raise(ArgumentError) {
        @layout.pattern = '%c{0}'
      }

      @layout.pattern = '%c{foo}'
      event.logger = 'Foo::Bar'
      assert_equal 'Foo::Bar{foo}', @layout.format(event)

      @layout.pattern = '%m{42}'
      assert_equal 'message{42}', @layout.format(event)
    end

    def test_pattern_mdc
      @layout.pattern = 'S:%X{X-Session} C:%X{Cookie}'
      event = Logging::LogEvent.new('TestLogger', @levels['info'], 'log message', false)

      Logging.mdc['X-Session'] = '123abc'
      Logging.mdc['Cookie'] = 'monster'
      assert_equal 'S:123abc C:monster', @layout.format(event)

      Logging.mdc.delete 'Cookie'
      assert_equal 'S:123abc C:', @layout.format(event)

      Logging.mdc.delete 'X-Session'
      assert_equal 'S: C:', @layout.format(event)
    end

    def test_pattern_mdc_requires_key_name
      assert_raise(ArgumentError) { @layout.pattern = '%X' }
      assert_raise(ArgumentError) { @layout.pattern = '%X{}' }
    end

    def test_pattern_ndc
      @layout.pattern = '%x'
      event = Logging::LogEvent.new('TestLogger', @levels['info'], 'log message', false)

      Logging.ndc << 'context a'
      Logging.ndc << 'context b'
      assert_equal 'context a context b', @layout.format(event)

      @layout.pattern = '%x{, }'
      assert_equal 'context a, context b', @layout.format(event)

      Logging.ndc.pop
      assert_equal 'context a', @layout.format(event)
    end

    def test_utc_offset
      layout = Logging.layouts.pattern(:pattern => "%d", :utc_offset => "UTC")
      event = Logging::LogEvent.new('DateLogger', @levels['info'], 'log message', false)
      event.time = Time.utc(2016, 12, 1, 12, 0, 0).freeze

      assert_equal "2016-12-01T12:00:00", layout.format(event)

      layout.utc_offset = "-06:00"
      assert_equal "2016-12-01T06:00:00", layout.format(event)

      layout.utc_offset = "+01:00"
      assert_equal "2016-12-01T13:00:00", layout.format(event)
    end
  end  # TestBasic
end  # TestLayouts
end  # TestLogging