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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
|
#!/usr/bin/ruby
#
# This script will pull tests to complete from the Beanstalk Queue,
# where they will be found in JSON form, and executes them.
#
#
# TODO: Command line parsing:
#
# 1. enable/disable logging to a file
#
#
#
# Steve
# --
#
require 'beanstalk-client'
require 'getoptlong'
require 'json'
require 'mauve/sender'
require 'mauve/proto'
#
# Implementation of our protocol tests.
#
require 'tests/ftp'
require 'tests/http'
require 'tests/https'
require 'tests/jabber'
require 'tests/ldap'
require 'tests/ping'
require 'tests/rsync'
require 'tests/smtp'
require 'tests/ssh'
#
# This class encapsulates the raising and clearing of alerts via Mauve.
#
class Alert
attr_reader :details
def initialize( test_details )
@details = test_details
end
#
# Raise the alert.
#
def raise( detail )
puts "RAISE: #{detail}"
return
update = Mauve::Proto::AlertUpdate.new
update.alert = []
update.source = "custodian"
update.replace = true
alert = Mauve::Proto::Alert.new
alert.id = @details['test_type']
alert.summary = "#{@details['test_host']} #{@details['test_alert']}"
alert.detail = "The #{@details['test_type']} test failed against #{@details['test_host']}: #{detail}"
alert.raise_time = Time.now.to_i
update.alert << alert
Mauve::Sender.new("alert.bytemark.co.uk").send(update)
end
#
# Clear the alert.
#
def clear
puts "CLEAR"
return
update = Mauve::Proto::AlertUpdate.new
update.alert = []
update.source = "custodian"
update.replace = true
alert = Mauve::Proto::Alert.new
alert.id = @details['test_type']
alert.summary = "#{@details['test_host']} #{@details['test_alert']}"
alert.detail = "The #{@details['test_type']} test succeeded against #{@details['test_host']}"
alert.clear_time = Time.now.to_i
update.alert << alert
Mauve::Sender.new("alert.bytemark.co.uk").send(update)
end
end
#
# This class contains the code for connecting to a Beanstalk queue,
# fetching tests from it, and executing them
#
class Custodian
#
# The beanstalk queue.
#
attr_reader :queue
#
# How many times we re-test before we detect a failure
#
attr_reader :retry_count
#
# Constructor: Connect to the queue
#
def initialize( server )
@queue = Beanstalk::Pool.new([server])
if ( ENV['REPEAT'] )
@retry_count=ENV['REPEAT'].to_i
else
@retry_count=5
end
puts "We'll run each test #{@retry_count} before alerting failures." if ( ENV['VERBOSE'] )
end
#
# Flush the queue.
#
def flush_queue!
while( true )
begin
job = @queue.reserve(1)
id = job.id
puts "\tDeleted job #{id}" if ( ENV['VERBOSE'] )
job.delete
rescue Beanstalk::TimedOut => ex
return
end
end
end
#
# Process jobs from the queue - never return.
#
def run!
while( true )
puts "\n\nWaiting for job.." if ( ENV['VERBOSE'] )
process_single_job()
end
end
#
# Fetch a single job from the queue, and process it.
#
def process_single_job
begin
job = @queue.reserve()
puts "Job acquired: #{Time.new.inspect}" if ( ENV['VERBOSE'] )
#
# Parse the JSON of the job body.
#
json = job.body
hash = JSON.parse( json )
hash['verbose'] = 1 if ( ENV['VERBOSE'] )
#
# Output the details.
#
if ( ENV['VERBOSE'] )
puts "JOB: #{job.id}"
puts "Type of test is #{hash['test_type']}"
hash.keys.each do |key|
puts "\t#{key} => #{hash[key]}"
end
end
#
# Did the test succeed? If not count the number of times it failed in
# a row. We'll repeat several times
#
success = false
count = 0
#
# As a result of this test we'll either raise/clear with mauve.
#
# This helper will do that job.
#
alert = Alert.new( hash )
#
# Convert the test-type to a className
#
# Given a test-type "foo" we'll attempt to instantiate a class
# called FOOTest.
#
test = hash['test_type']
clazz = test.upcase
clazz = "#{clazz}Test"
#
# Create the test object.
#
obj = eval(clazz).new( hash )
#
# We'll run no more than MAX times.
#
# We stop the execution on a single success.
#
while ( ( count < @retry_count ) && ( success == false ) )
if ( obj.run_test() )
alert.clear()
success= true
end
count += 1
end
#
# If we didn't succeed on any of the attempts raise the alert.
#
if ( ! success )
# Raise the alert, passing the error message.
alert.raise( obj.error )
end
rescue => ex
puts "Exception raised processing job: #{ex}"
ensure
#
# Delete the job - either we received an error, in which case
# we should remove it to avoid picking it up again, or we handled
# it successfully so it should be removed.
#
job.delete
end
end
end
#
# Entry-point to our code.
#
if __FILE__ == $0 then
$SERVER = "127.0.0.1:11300";
begin
opts = GetoptLong.new(
[ "--verbose", "-v", GetoptLong::NO_ARGUMENT ],
[ "--flush", "-f", GetoptLong::NO_ARGUMENT ],
[ "--server", "-S", GetoptLong::REQUIRED_ARGUMENT ],
[ "--repeat", "-r", GetoptLong::REQUIRED_ARGUMENT ],
[ "--single", "-s", GetoptLong::NO_ARGUMENT ]
)
opts.each do |opt, arg|
case opt
when "--verbose":
ENV["VERBOSE"] = "1"
when "--flush":
ENV["FLUSH"] = "1"
when "--repeat":
ENV["REPEAT"] = arg
when "--server":
ENV["SERVER"] = arg
when "--single":
ENV["SINGLE"] = "1"
end
end
rescue StandardError => ex
puts "Option parsing failed: #{ex.to_s}"
exit
end
#
# Create the object
#
worker = Custodian.new( $SERVER )
#
# Are we flushing the queue?
#
if ( ENV['FLUSH'] )
worker.flush_queue!
exit(0)
end
#
# Single step?
#
if ( ENV['SINGLE'] )
worker.process_single_job
exit(0)
end
#
# Otherwise loop indefinitely
#
worker.run!
end
|