Class: Fluent::Test::Driver::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/fluent/test/driver/base.rb

Direct Known Subclasses

BaseOwned, BaseOwner

Constant Summary collapse

DEFAULT_TIMEOUT = 
300

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass, opts: {}, &block) ⇒ Base

Returns a new instance of Base.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/fluent/test/driver/base.rb', line 38

def initialize(klass, opts: {}, &block)
  if klass.is_a?(Class)
    @instance = klass.new
    if block
      @instance.singleton_class.module_eval(&block)
      @instance.send(:initialize)
    end
  else
    @instance = klass
  end
  @instance.under_plugin_development = true

  @socket_manager_server = nil

  @logs = []

  @run_post_conditions = []
  @run_breaking_conditions = []
  @broken = false
end

Instance Attribute Details

#instance ⇒ Object (readonly)

Returns the value of attribute instance.



34
35
36
 
# File 'lib/fluent/test/driver/base.rb', line 34

def instance
  @instance
end

#logs ⇒ Object (readonly)

Returns the value of attribute logs.



34
35
36
 
# File 'lib/fluent/test/driver/base.rb', line 34

def logs
  @logs
end

Instance Method Details

#break_if(&block) ⇒ Object

Raises:

  • (ArgumentError) 


68
69
70
71
 
# File 'lib/fluent/test/driver/base.rb', line 68

def break_if(&block)
  raise ArgumentError, "block is not given" unless block_given?
  @run_breaking_conditions << block
end

#broken? ⇒ Boolean

Returns:

  • (Boolean) 


73
74
75
 
# File 'lib/fluent/test/driver/base.rb', line 73

def broken?
  @broken
end

#configure(conf, syntax: :v1) ⇒ Object

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/fluent/test/driver/base.rb', line 59

def configure(conf, syntax: :v1)
  raise NotImplementedError
end

#end_if(&block) ⇒ Object

Raises:

  • (ArgumentError) 


63
64
65
66
 
# File 'lib/fluent/test/driver/base.rb', line 63

def end_if(&block)
  raise ArgumentError, "block is not given" unless block_given?
  @run_post_conditions << block
end

#instance_hook_after_started ⇒ Object 



137
138
139
 
# File 'lib/fluent/test/driver/base.rb', line 137

def instance_hook_after_started
  # insert hooks for tests available after instance.start
end

#instance_hook_before_stopped ⇒ Object 



141
142
143
 
# File 'lib/fluent/test/driver/base.rb', line 141

def instance_hook_before_stopped
  # same with above
end

#instance_shutdown(log: Logger.new($stdout)) ⇒ Object 



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
 
# File 'lib/fluent/test/driver/base.rb', line 145

def instance_shutdown(log: Logger.new($stdout))
  instance_hook_before_stopped

  show_errors_if_exists = ->(label, block){
    begin
      block.call
    rescue => e
      log.error "unexpected error while #{label}, #{e.class}:#{e.message}"
      e.backtrace.each do |bt|
        log.error "\t#{bt}"
      end
    end
  }

  show_errors_if_exists.call(:stop,            ->(){ @instance.stop unless @instance.stopped? })
  show_errors_if_exists.call(:before_shutdown, ->(){ @instance.before_shutdown unless @instance.before_shutdown? })
  show_errors_if_exists.call(:shutdown,        ->(){ @instance.shutdown unless @instance.shutdown? })
  show_errors_if_exists.call(:after_shutdown,  ->(){ @instance.after_shutdown unless @instance.after_shutdown? })

  if @instance.respond_to?(:server_wait_until_stop)
    @instance.server_wait_until_stop
  end

  if @instance.respond_to?(:event_loop_wait_until_stop)
    @instance.event_loop_wait_until_stop
  end

  show_errors_if_exists.call(:close, ->(){ @instance.close unless @instance.closed? })

  if @instance.respond_to?(:thread_wait_until_stop)
    @instance.thread_wait_until_stop
  end

  show_errors_if_exists.call(:terminate, ->(){ @instance.terminate unless @instance.terminated? })

  if @socket_manager_server
    @socket_manager_server.close
    if @socket_manager_path.is_a?(String) && File.exist?(@socket_manager_path)
      FileUtils.rm_f @socket_manager_path
    end
  end
end

#instance_start ⇒ Object 



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
 
# File 'lib/fluent/test/driver/base.rb', line 104

def instance_start
  if @instance.respond_to?(:server_wait_until_start)
    if Fluent.windows?
      @socket_manager_server = ServerEngine::SocketManager::Server.open
      @socket_manager_path = @socket_manager_server.path
    else
      @socket_manager_path = ServerEngine::SocketManager::Server.generate_path
      if @socket_manager_path.is_a?(String) && File.exist?(@socket_manager_path)
        FileUtils.rm_f @socket_manager_path
      end
      @socket_manager_server = ServerEngine::SocketManager::Server.open(@socket_manager_path)
    end
    ENV['SERVERENGINE_SOCKETMANAGER_PATH'] = @socket_manager_path.to_s
  end

  unless @instance.started?
    @instance.start
  end
  unless @instance.after_started?
    @instance.after_start
  end

  if @instance.respond_to?(:thread_wait_until_start)
    @instance.thread_wait_until_start
  end

  if @instance.respond_to?(:event_loop_wait_until_start)
    @instance.event_loop_wait_until_start
  end

  instance_hook_after_started
end

#run(timeout: nil, start: true, shutdown: true, &block) ⇒ Object 



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
 
# File 'lib/fluent/test/driver/base.rb', line 77

def run(timeout: nil, start: true, shutdown: true, &block)
  instance_start if start

  timeout ||= DEFAULT_TIMEOUT
  stop_at = Fluent::Clock.now + timeout
  @run_breaking_conditions << ->(){ Fluent::Clock.now >= stop_at }

  if !block_given? && @run_post_conditions.empty? && @run_breaking_conditions.empty?
    raise ArgumentError, "no stop conditions nor block specified"
  end

  sleep_with_watching_threads = ->(){
    if @instance.respond_to?(:_threads)
      @instance._threads.values.each{|t| t.join(0) }
    end
    sleep 0.1
  }

  begin
    retval = run_actual(timeout: timeout, &block)
    sleep_with_watching_threads.call until stop?
    retval
  ensure
    instance_shutdown if shutdown
  end
end

#run_actual(timeout: DEFAULT_TIMEOUT, &block) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/fluent/test/driver/base.rb', line 188

def run_actual(timeout: DEFAULT_TIMEOUT, &block)
  if @instance.respond_to?(:_threads)
    sleep 0.1 until @instance._threads.values.all?(&:alive?)
  end

  if @instance.respond_to?(:event_loop_running?)
    sleep 0.1 until @instance.event_loop_running?
  end

  if @instance.respond_to?(:_child_process_processes)
    sleep 0.1 until @instance._child_process_processes.values.all?{|pinfo| pinfo.alive }
  end

  return_value = nil
  begin
    Timeout.timeout(timeout * 2) do |sec|
      return_value = block.call if block_given?
    end
  rescue Timeout::Error
    raise TestTimedOut, "Test case timed out with hard limit."
  end
  return_value
end

#stop? ⇒ Boolean

Returns:

  • (Boolean) 


212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/fluent/test/driver/base.rb', line 212

def stop?
  # Should stop running if post conditions are not registered.
  return true unless @run_post_conditions || @run_post_conditions.empty?

  # Should stop running if all of the post conditions are true.
  return true if @run_post_conditions.all? {|proc| proc.call }

  # Should stop running if some of the breaking conditions is true.
  # In this case, some post conditions may be not true.
  if @run_breaking_conditions.any? {|proc| proc.call }
    @broken = true
    return true
  end

  false
end