-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
test_stats_service.py
431 lines (358 loc) · 17.1 KB
/
test_stats_service.py
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright Buildbot Team Members
import mock
from twisted.internet import defer
from twisted.internet import threads
from twisted.trial import unittest
from buildbot import config
from buildbot.statistics import capture
from buildbot.statistics import storage_backends
from buildbot.statistics.storage_backends.base import StatsStorageBase
from buildbot.statistics.storage_backends.influxdb_client import InfluxStorageService
from buildbot.test.fake import fakedb
from buildbot.test.fake import fakemaster
from buildbot.test.fake import fakestats
from buildbot.test.util import logging
from buildbot.test.util import steps
class TestStatsServicesBase(unittest.TestCase):
BUILDER_NAMES = [u'builder1', u'builder2']
BUILDER_IDS = [1, 2]
def setUp(self):
self.master = fakemaster.make_master(testcase=self, wantMq=True,
wantData=True, wantDb=True)
for builderid, name in zip(self.BUILDER_IDS, self.BUILDER_NAMES):
self.master.db.builders.addTestBuilder(builderid=builderid, name=name)
self.stats_service = fakestats.FakeStatsService(master=self.master,
storage_backends=[
fakestats.FakeStatsStorageService()
],
name="FakeStatsService")
self.stats_service.startService()
def tearDown(self):
self.stats_service.stopService()
class DummyStatsStorageBase(StatsStorageBase):
"""
A dummy class to test intialization of StatsStorageBase.
"""
def thd_postStatsValue(self, *args, **kwargs):
return defer.succeed(None)
class TestStatsServicesConfiguration(TestStatsServicesBase):
def test_reconfig_with_no_storage_backends(self):
new_storage_backends = []
self.stats_service.reconfigService(new_storage_backends)
self.checkEqual(new_storage_backends)
def test_reconfig_with_fake_storage_backend(self):
new_storage_backends = [
fakestats.FakeStatsStorageService(name='One'),
fakestats.FakeStatsStorageService(name='Two')
]
self.stats_service.reconfigService(new_storage_backends)
self.checkEqual(new_storage_backends)
def test_bad_configuration(self):
# Reconfigure with a bad configuration.
new_storage_backends = [mock.Mock()]
self.assertRaises(TypeError,
self.stats_service.reconfigService,
new_storage_backends)
def checkEqual(self, new_storage_backends):
# Check whether the new_storage_backends was set in reconfigService
registeredStorageServices = \
[s for s in self.stats_service.registeredStorageServices
if isinstance(s, StatsStorageBase)]
for s in new_storage_backends:
if s not in registeredStorageServices:
raise AssertionError("reconfigService failed."
"Not all storage services registered.")
class TestInfluxDB(TestStatsServicesBase, logging.LoggingMixin):
# Smooth test of influx db service. We don't want to force people to install influxdb, so we
# just disable this unit test if the influxdb module is not installed, using SkipTest
def test_influxdb_not_installed(self):
captures = [capture.CaptureProperty('test_builder', 'test')]
try:
# Try to import
import influxdb
# consume it somehow to please pylint
[influxdb]
except ImportError:
self.assertRaises(config.ConfigErrors,
lambda: InfluxStorageService(
"fake_url", "fake_port", "fake_user", "fake_password",
"fake_db", captures))
# if instead influxdb is installed, then intialize it - no errors should be reaised
else:
new_storage_backends = [
InfluxStorageService("fake_url", "fake_port", "fake_user", "fake_password",
"fake_db", captures)
]
self.stats_service.reconfigService(new_storage_backends)
def test_influx_storage_service_fake_install(self):
# use a fake InfluxDBClient to test InfluxStorageService in systems which
# don't have influxdb installed. Primarily useful for test coverage.
self.patch(storage_backends.influxdb_client, 'InfluxDBClient', fakestats.FakeInfluxDBClient)
captures = [capture.CaptureProperty('test_builder', 'test')]
new_storage_backends = [InfluxStorageService(
"fake_url", "fake_port", "fake_user", "fake_password", "fake_db", captures
)]
self.stats_service.reconfigService(new_storage_backends)
def test_influx_storage_service_post_value(self):
# test the thd_postStatsValue method of InfluxStorageService
self.patch(storage_backends.influxdb_client, 'InfluxDBClient', fakestats.FakeInfluxDBClient)
svc = InfluxStorageService(
"fake_url", "fake_port", "fake_user", "fake_password", "fake_db", "fake_stats")
post_data = {
'name': 'test',
'value': 'test'
}
context = {'x': 'y'}
svc.thd_postStatsValue(post_data, "test_series_name", context)
data = {
'measurement': "test_series_name",
'fields': {
"name": "test",
"value": "test"
},
'tags': {'x': 'y'}
}
points = [data]
self.assertEquals(svc.client.points, points)
def test_influx_service_not_inited(self):
self.setUpLogging()
self.patch(storage_backends.influxdb_client, 'InfluxDBClient', fakestats.FakeInfluxDBClient)
svc = InfluxStorageService(
"fake_url", "fake_port", "fake_user", "fake_password", "fake_db", "fake_stats")
svc._inited = False
svc.thd_postStatsValue("test", "test", "test")
self.assertLogged("Service.*not initialized")
def test_storage_backend_base_failure_on_init(self):
svc = DummyStatsStorageBase()
r = svc.thd_postStatsValue("test", "test", "test")
assert isinstance(r, defer.Deferred)
assert r.result == None
class TestStatsServicesConsumers(steps.BuildStepMixin, TestStatsServicesBase):
"""
Test the stats service from a fake step
"""
def setUp(self):
TestStatsServicesBase.setUp(self)
self.routingKey = ("builders", self.BUILDER_IDS[0], "builds", 1, "finished")
self.master.mq.verifyMessages = False
self.patch(threads, 'deferToThread', self.identity)
def setupBuild(self):
self.master.db.insertTestData([
fakedb.Build(id=1, masterid=1, buildslaveid=1,
builderid=self.BUILDER_IDS[0],
buildrequestid=1, number=1),
])
def setup_fake_storage(self, captures):
self.fake_storage_service = fakestats.FakeStatsStorageService()
self.fake_storage_service.captures = captures
self.stats_service.reconfigService([self.fake_storage_service])
def get_dict(self, build):
return dict(
buildid=1,
number=build['number'],
builderid=build['builderid'],
buildrequestid=build['buildrequestid'],
buildslaveid=build['buildslaveid'],
masterid=build['masterid'],
started_at=build['started_at'],
complete=True,
complete_at=build['complete_at'],
state_string=u'',
results=0,
)
@defer.inlineCallbacks
def end_build_call_consumers(self):
self.master.db.builds.finishBuild(buildid=1, results=0)
build = yield self.master.db.builds.getBuild(buildid=1)
self.master.mq.callConsumer(self.routingKey, self.get_dict(build))
@staticmethod
def identity(f, *args, **kwargs):
return f(*args, **kwargs)
@defer.inlineCallbacks
def test_property_capturing(self):
self.setup_fake_storage([capture.CaptureProperty('builder1', 'test_name')])
self.setupBuild()
self.master.db.builds.setBuildProperty(1, 'test_name', 'test_value', 'test_source')
yield self.end_build_call_consumers()
self.assertEqual([(
{'name': 'test_name', 'value': 'test_value'},
'builder1-test_name',
{'build_number': '1', 'builder_name': 'builder1'}
)], self.fake_storage_service.stored_data)
@defer.inlineCallbacks
def test_property_capturing_error(self):
self.setup_fake_storage([capture.CaptureProperty('builder1', 'test')])
self.setupBuild()
self.master.db.builds.setBuildProperty(1, 'test_name', 'test_value', 'test_source')
self.master.db.builds.finishBuild(buildid=1, results=0)
build = yield self.master.db.builds.getBuild(buildid=1)
cap = self.fake_storage_service.captures[0]
self.assertFailure(cap.consume(self.routingKey, self.get_dict(build)),
config.ConfigErrors)
@defer.inlineCallbacks
def test_property_capturing_alt_callback(self):
def cb(*args, **kwargs):
return 'test_value'
self.setup_fake_storage([capture.CaptureProperty('builder1', 'test_name', cb)])
self.setupBuild()
self.master.db.builds.setBuildProperty(1, 'test_name', 'test_value', 'test_source')
yield self.end_build_call_consumers()
self.assertEqual([(
{'name': 'test_name', 'value': 'test_value'},
'builder1-test_name',
{'build_number': '1', 'builder_name': 'builder1'}
)], self.fake_storage_service.stored_data)
@defer.inlineCallbacks
def test_build_start_time_capturing(self):
self.setup_fake_storage([capture.CaptureBuildStartTime('builder1')])
self.setupBuild()
yield self.end_build_call_consumers()
self.assertEqual('start-time', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_start_time_capturing_alt_callback(self):
def cb(*args, **kwargs):
return '2015-07-08T01:45:17.391018'
self.setup_fake_storage([capture.CaptureBuildStartTime('builder1', cb)])
self.setupBuild()
yield self.end_build_call_consumers()
self.assertEqual('start-time', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_end_time_capturing(self):
self.setup_fake_storage([capture.CaptureBuildEndTime('builder1')])
self.setupBuild()
yield self.end_build_call_consumers()
self.assertEqual('end-time', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_end_time_capturing_alt_callback(self):
def cb(*args, **kwargs):
return '2015-07-08T01:45:17.391018'
self.setup_fake_storage([capture.CaptureBuildEndTime('builder1', cb)])
self.setupBuild()
yield self.end_build_call_consumers()
self.assertEqual('end-time', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def build_time_capture_helper(self, time_type, cb=None):
self.setup_fake_storage([capture.CaptureBuildDuration('builder1', report_in=time_type,
callback=cb)])
self.setupBuild()
yield self.end_build_call_consumers()
@defer.inlineCallbacks
def test_build_duration_capturing_seconds(self):
yield self.build_time_capture_helper('seconds')
self.assertEqual('duration', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_duration_capturing_minutes(self):
yield self.build_time_capture_helper('minutes')
self.assertEqual('duration', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_duration_capturing_hours(self):
yield self.build_time_capture_helper('hours')
self.assertEqual('duration', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_duration_capturing_alt_callback(self):
def cb(*args, **kwargs):
return 10
yield self.build_time_capture_helper('seconds', cb)
self.assertEqual('duration', self.fake_storage_service.stored_data[0][0].keys()[0])
@defer.inlineCallbacks
def test_build_times_capturing_error(self):
def cb(*args, **kwargs):
raise TypeError
self.setup_fake_storage([capture.CaptureBuildStartTime('builder1', cb)])
self.setupBuild()
self.master.db.builds.setBuildProperty(1, 'test_name', 'test_value', 'test_source')
self.master.db.builds.finishBuild(buildid=1, results=0)
build = yield self.master.db.builds.getBuild(buildid=1)
cap = self.fake_storage_service.captures[0]
self.assertFailure(cap.consume(self.routingKey, self.get_dict(build)),
config.ConfigErrors)
self.setup_fake_storage([capture.CaptureBuildEndTime('builder1', cb)])
cap = self.fake_storage_service.captures[0]
self.assertFailure(cap.consume(self.routingKey, self.get_dict(build)),
config.ConfigErrors)
self.setup_fake_storage([capture.CaptureBuildDuration('builder1', callback=cb)])
cap = self.fake_storage_service.captures[0]
self.assertFailure(cap.consume(self.routingKey, self.get_dict(build)),
config.ConfigErrors)
@defer.inlineCallbacks
def test_yield_metrics_value(self):
self.setup_fake_storage([capture.CaptureBuildStartTime('builder1')])
self.setupBuild()
yield self.end_build_call_consumers()
yield self.stats_service.yieldMetricsValue('test', {'test': 'test'}, 1)
build_data = yield self.stats_service.master.data.get(('builds', 1))
routingKey = ("stats-yieldMetricsValue", "stats-yield-data")
msg = {
'data_name': 'test',
'post_data': {'test': 'test'},
'build_data': build_data
}
exp = [(routingKey, msg)]
self.stats_service.master.mq.assertProductions(exp)
@defer.inlineCallbacks
def test_capture_data(self):
self.setup_fake_storage([capture.CaptureData('test', 'builder1')])
self.setupBuild()
self.master.db.builds.finishBuild(buildid=1, results=0)
build_data = yield self.stats_service.master.data.get(('builds', 1))
msg = {
'data_name': 'test',
'post_data': {'test': 'test'},
'build_data': build_data
}
routingKey = ("stats-yieldMetricsValue", "stats-yield-data")
self.master.mq.callConsumer(routingKey, msg)
self.assertEqual([(
{'test': 'test'},
'builder1-test',
{'build_number': '1', 'builder_name': 'builder1'}
)], self.fake_storage_service.stored_data)
@defer.inlineCallbacks
def test_capture_data_alt_callback(self):
def cb(*args, **kwargs):
return {'test': 'test'}
self.setup_fake_storage([capture.CaptureData('test', 'builder1', cb)])
self.setupBuild()
self.master.db.builds.finishBuild(buildid=1, results=0)
build_data = yield self.stats_service.master.data.get(('builds', 1))
msg = {
'data_name': 'test',
'post_data': {'test': 'test'},
'build_data': build_data
}
routingKey = ("stats-yieldMetricsValue", "stats-yield-data")
self.master.mq.callConsumer(routingKey, msg)
self.assertEqual([(
{'test': 'test'},
'builder1-test',
{'build_number': '1', 'builder_name': 'builder1'}
)], self.fake_storage_service.stored_data)
@defer.inlineCallbacks
def test_capture_data_error(self):
def cb(*args, **kwargs):
raise TypeError
self.setup_fake_storage([capture.CaptureData('test', 'builder1', cb)])
self.setupBuild()
self.master.db.builds.finishBuild(buildid=1, results=0)
build_data = yield self.stats_service.master.data.get(('builds', 1))
msg = {
'data_name': 'test',
'post_data': {'test': 'test'},
'build_data': build_data
}
routingKey = ("stats-yieldMetricsValue", "stats-yield-data")
cap = self.fake_storage_service.captures[0]
self.assertFailure(cap.consume(routingKey, msg), config.ConfigErrors)