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
|
#
# Standard modules
#
require 'beanstalk-client'
require 'json'
require 'logger'
#
# Implementation of our protocol tests.
#
require 'custodian/alerter.rb'
require 'custodian/protocol-tests/dns.rb'
require 'custodian/protocol-tests/ftp.rb'
require 'custodian/protocol-tests/http.rb'
require 'custodian/protocol-tests/imap.rb'
require 'custodian/protocol-tests/jabber.rb'
require 'custodian/protocol-tests/ldap.rb'
require 'custodian/protocol-tests/ping.rb'
require 'custodian/protocol-tests/rsync.rb'
require 'custodian/protocol-tests/smtp.rb'
require 'custodian/protocol-tests/ssh.rb'
require 'custodian/protocol-tests/tcp.rb'
#
# 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
#
# The log-file object
#
attr_reader :logger
#
# Constructor: Connect to the queue
#
def initialize( server, logfile )
# Connect to the queue
@queue = Beanstalk::Pool.new([server])
# Instantiate the logger.
@logger = Logger.new( logfile, "daily" )
if ( ENV['REPEAT'] )
@retry_count=ENV['REPEAT'].to_i
else
@retry_count=3
end
end
#
# Write the given message to our logfile - and show it to the console
# if we're running with '--verbose' in play
#
def log_message( msg )
@logger.info( msg )
puts msg if ( ENV['VERBOSE'] )
end
#
# Process jobs from the queue - never return.
#
def run!
while( true )
log_message( "\n" )
log_message( "\n" )
log_message( "Waiting for job.." )
process_single_job()
end
end
#
# Fetch a single job from the queue, and process it.
#
def process_single_job
result = false
begin
job = @queue.reserve()
log_message( "Job aquired - Job ID : #{job.id}" )
#
# Get the job body
#
json = job.body
raise ArgumentError, "Body doesn't look like JSON" unless( json =~ /[{}]/ )
#
# Decode the JSON body - it should return a non-empty hash.
#
hash = JSON.parse( json )
#
# Ensure we got a non-empty hash.
#
raise ArgumentError, "JSON didn't decode to a hash" unless hash.kind_of?(Hash)
raise ArgumentError, "JSON hash is empty" if (hash.empty?)
#
# Are we being verbose?
#
hash['verbose'] = 1 if ( ENV['VERBOSE'] )
#
# Output the details.
#
log_message( "Job body contains the following keys & values:")
hash.keys.each do |key|
log_message( " #{key} => #{hash[key]}" )
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 = Alerter.new( hash )
#
# Convert the test-type to a class name, to do the protocol test.
#
# Given a test-type "foo" we'll attempt to instantiate a class called FOOTest.
#
test = hash['test_type']
test = "http" if ( test == "https" )
clazz = test.upcase
clazz = "#{clazz}Test"
#
# Create the test object.
#
obj = eval(clazz).new( hash )
#
# Ensure that the object we load implements the two methods
# we expect.
#
if ( ( ! obj.respond_to?( "error") ) ||
( ! obj.respond_to?( "run_test" ) ) )
puts "Class #{clazz} doesn't implement the full protocol-test API"
end
#
# We'll run no more than MAX times.
#
# We stop the execution on a single success.
#
while ( ( count < @retry_count ) && ( success == false ) )
log_message( "Running test - [#{count}/#{@retry_count}]" )
if ( obj.run_test() )
log_message( "Test succeeed - clearing alert" )
success = true
alert.clear()
result = 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.
#
log_message( "Test failed - alerting with #{obj.error()}" )
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.
#
log_message( "Job ID : #{job.id} - Removed" )
job.delete if ( job )
end
return result
end
#
# Process jobs until we see a failure - stop then.
#
def process_until_fail
while( process_single_job() )
# nop
end
end
end
|
