File: test_async_flushing.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 (194 lines) | stat: -rw-r--r-- 5,906 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

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

module TestLogging
module TestAppenders

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

    def setup
      super
      @appender = Logging.appenders.string_io \
        'test_appender',
        :flush_period => 2

      @appender.clear
      @sio = @appender.sio
      @levels = Logging::LEVELS
      begin readline rescue EOFError end
      Thread.pass  # give the flusher thread a moment to start
    end

    def teardown
      @appender.close
      @appender = nil
      super
    end

    def test_flush_period_set
      assert_equal 2, @appender.flush_period
      assert_equal Logging::Appenders::Buffering::DEFAULT_BUFFER_SIZE, @appender.auto_flushing

      @appender.flush_period = '01:30:45'
      assert_equal 5445, @appender.flush_period

      @appender.flush_period = '245'
      assert_equal 245, @appender.flush_period

      @appender.auto_flushing = true
      assert_equal Logging::Appenders::Buffering::DEFAULT_BUFFER_SIZE, @appender.auto_flushing

      @appender.auto_flushing = 200
      assert_equal 200, @appender.auto_flushing
    end

    def test_async_flusher_running
      flusher = @appender.instance_variable_get(:@async_flusher)
      assert_instance_of Logging::Appenders::Buffering::AsyncFlusher, flusher

      sleep 0.250  # give the flusher thread another moment to start
      assert flusher.waiting?, 'the async flusher should be waiting for a signal'
    end

    def test_append
      event = Logging::LogEvent.new('TestLogger', @levels['warn'],
                                    [1, 2, 3, 4], false)
      @appender.append event
      @appender.append event
      event.level = @levels['debug']
      event.data = 'the big log message'
      @appender.append event

      assert_nil(readline)
      sleep 3

      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal "DEBUG  TestLogger : the big log message\n", readline
      assert_nil(readline)

      @appender.close
      assert_raise(RuntimeError) {@appender.append event}
    end

    def test_flush_on_close
      assert_equal false, @sio.closed?
      assert_equal false, @appender.closed?

      event = Logging::LogEvent.new('TestLogger', @levels['warn'],
                                    [1, 2, 3, 4], false)

      @appender.flush_period = "24:00:00"
      @appender.append event
      event.level = @levels['debug']
      event.data = 'the big log message'
      @appender.append event

      assert_nil(readline)

      @appender.close_method = :close_write
      @appender.close
      assert_equal false, @sio.closed?
      assert_equal true, @appender.closed?

      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal "DEBUG  TestLogger : the big log message\n", readline
      assert_nil(readline)

      @sio.close
      assert_equal true, @sio.closed?
    end

    def test_auto_flushing
      @appender.auto_flushing = 3

      event = Logging::LogEvent.new('TestLogger', @levels['warn'],
                                    [1, 2, 3, 4], false)

      @appender.append event
      @appender.append event
      event.level = @levels['debug']
      event.data = 'the big log message'
      @appender.append event
      event.level = @levels['info']
      event.data = 'just FYI'
      @appender.append event
      event.level = @levels['warn']
      event.data = 'this is your last warning!'
      @appender.append event

      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal "DEBUG  TestLogger : the big log message\n", readline

      assert_nil(readline)
      sleep 3

      assert_equal " INFO  TestLogger : just FYI\n", readline
      assert_equal " WARN  TestLogger : this is your last warning!\n", readline
      assert_nil(readline)
    end

    def test_setting_flush_period_to_nil
      flusher = @appender.instance_variable_get(:@async_flusher)
      assert_instance_of Logging::Appenders::Buffering::AsyncFlusher, flusher

      @appender.flush_period = nil

      assert_nil @appender.instance_variable_get(:@async_flusher)
    end

    def test_setting_negative_flush_period
      assert_raise(ArgumentError) { @appender.flush_period = -1 }
    end

    def test_async_writes
      @appender.auto_flushing = 3
      @appender.flush_period = nil
      @appender.async = true

      event = Logging::LogEvent.new('TestLogger', @levels['warn'],
                                    [1, 2, 3, 4], false)

      flusher = @appender.instance_variable_get(:@async_flusher)
      assert_instance_of Logging::Appenders::Buffering::AsyncFlusher, flusher

      @appender.append event
      assert_nil(readline)

      event.level = @levels['debug']
      event.data = 'the big log message'
      @appender.append event
      sleep 0.250
      assert_nil(readline)

      event.level = @levels['info']
      event.data = 'just FYI'
      @appender.append event  # might write here, might not
      sleep 0.250             # so sleep a little to let the write occur

      assert_equal " WARN  TestLogger : <Array> #{[1, 2, 3, 4]}\n", readline
      assert_equal "DEBUG  TestLogger : the big log message\n", readline
      assert_equal " INFO  TestLogger : just FYI\n", readline

      event.level = @levels['warn']
      event.data = 'this is your last warning!'
      @appender.append event
      assert_nil(readline)

      @appender.close_method = :close_write
      @appender.close

      assert_equal " WARN  TestLogger : this is your last warning!\n", readline

      assert_nil @appender.instance_variable_get(:@async_flusher)
    end

  private
    def readline
      @appender.readline
    end
  end
end
end