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
|
# 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 gc, sys
from twisted.trial import unittest
from twisted.internet import task
from buildbot.process import metrics
from buildbot.test.fake import fakemaster
class TestMetricBase(unittest.TestCase):
def setUp(self):
self.clock = task.Clock()
self.observer = metrics.MetricLogObserver()
self.observer.parent = self.master = fakemaster.make_master()
self.master.config.db['db_poll_interval'] = 60
self.master.config.metrics = dict(log_interval=0, periodic_interval=0)
self.observer._reactor = self.clock
self.observer.startService()
self.observer.reconfigService(self.master.config)
def tearDown(self):
if self.observer.running:
self.observer.stopService()
class TestMetricCountEvent(TestMetricBase):
def testIncrement(self):
metrics.MetricCountEvent.log('num_widgets', 1)
report = self.observer.asDict()
self.assertEquals(report['counters']['num_widgets'], 1)
metrics.MetricCountEvent.log('num_widgets', 1)
report = self.observer.asDict()
self.assertEquals(report['counters']['num_widgets'], 2)
def testDecrement(self):
metrics.MetricCountEvent.log('num_widgets', 1)
report = self.observer.asDict()
self.assertEquals(report['counters']['num_widgets'], 1)
metrics.MetricCountEvent.log('num_widgets', -1)
report = self.observer.asDict()
self.assertEquals(report['counters']['num_widgets'], 0)
def testAbsolute(self):
metrics.MetricCountEvent.log('num_widgets', 10, absolute=True)
report = self.observer.asDict()
self.assertEquals(report['counters']['num_widgets'], 10)
def testCountMethod(self):
@metrics.countMethod('foo_called')
def foo():
return "foo!"
for i in range(10):
foo()
report = self.observer.asDict()
self.assertEquals(report['counters']['foo_called'], 10)
class TestMetricTimeEvent(TestMetricBase):
def testManualEvent(self):
metrics.MetricTimeEvent.log('foo_time', 0.001)
report = self.observer.asDict()
self.assertEquals(report['timers']['foo_time'], 0.001)
def testTimer(self):
clock = task.Clock()
t = metrics.Timer('foo_time')
t._reactor = clock
t.start()
clock.advance(5)
t.stop()
report = self.observer.asDict()
self.assertEquals(report['timers']['foo_time'], 5)
def testStartStopDecorators(self):
clock = task.Clock()
t = metrics.Timer('foo_time')
t._reactor = clock
@t.startTimer
def foo():
clock.advance(5)
return "foo!"
@t.stopTimer
def bar():
clock.advance(5)
return "bar!"
foo()
bar()
report = self.observer.asDict()
self.assertEquals(report['timers']['foo_time'], 10)
def testTimeMethod(self):
clock = task.Clock()
@metrics.timeMethod('foo_time', _reactor=clock)
def foo():
clock.advance(5)
return "foo!"
foo()
report = self.observer.asDict()
self.assertEquals(report['timers']['foo_time'], 5)
def testAverages(self):
data = range(10)
for i in data:
metrics.MetricTimeEvent.log('foo_time', i)
report = self.observer.asDict()
self.assertEquals(report['timers']['foo_time'], sum(data)/float(len(data)))
class TestPeriodicChecks(TestMetricBase):
def testPeriodicCheck(self):
# fake out that there's no garbage (since we can't rely on Python
# not having any garbage while running tests)
self.patch(gc, 'garbage', [])
clock = task.Clock()
metrics.periodicCheck(_reactor=clock)
clock.pump([0.1, 0.1, 0.1])
# We should have 0 reactor delay since we're using a fake clock
report = self.observer.asDict()
self.assertEquals(report['timers']['reactorDelay'], 0)
self.assertEquals(report['counters']['gc.garbage'], 0)
self.assertEquals(report['alarms']['gc.garbage'][0], 'OK')
def testUncollectable(self):
# make some fake garbage
self.patch(gc, 'garbage', [ 1, 2 ])
clock = task.Clock()
metrics.periodicCheck(_reactor=clock)
clock.pump([0.1, 0.1, 0.1])
# We should have 0 reactor delay since we're using a fake clock
report = self.observer.asDict()
self.assertEquals(report['timers']['reactorDelay'], 0)
self.assertEquals(report['counters']['gc.garbage'], 2)
self.assertEquals(report['alarms']['gc.garbage'][0], 'WARN')
def testGetRSS(self):
self.assert_(metrics._get_rss() > 0)
if sys.platform != 'linux2':
testGetRSS.skip = "only available on linux2 platforms"
class TestReconfig(TestMetricBase):
def testReconfig(self):
observer = self.observer
new_config = self.master.config
# starts up without running tasks
self.assertEquals(observer.log_task, None)
self.assertEquals(observer.periodic_task, None)
# enable log_interval
new_config.metrics = dict(log_interval=10, periodic_interval=0)
observer.reconfigService(new_config)
self.assert_(observer.log_task)
self.assertEquals(observer.periodic_task, None)
# disable that and enable periodic_interval
new_config.metrics = dict(periodic_interval=10, log_interval=0)
observer.reconfigService(new_config)
self.assert_(observer.periodic_task)
self.assertEquals(observer.log_task, None)
# Make the periodic check run
self.clock.pump([0.1])
# disable the whole listener
new_config.metrics = None
observer.reconfigService(new_config)
self.assertFalse(observer.enabled)
self.assertEquals(observer.log_task, None)
self.assertEquals(observer.periodic_task, None)
# disable both
new_config.metrics = dict(periodic_interval=0, log_interval=0)
observer.reconfigService(new_config)
self.assertEquals(observer.log_task, None)
self.assertEquals(observer.periodic_task, None)
# enable both
new_config.metrics = dict(periodic_interval=10, log_interval=10)
observer.reconfigService(new_config)
self.assert_(observer.log_task)
self.assert_(observer.periodic_task)
# (service will be stopped by tearDown)
class _LogObserver:
def __init__(self):
self.events = []
def gotEvent(self, event):
self.events.append(event)
class TestReports(unittest.TestCase):
def testMetricCountReport(self):
handler = metrics.MetricCountHandler(None)
handler.handle({}, metrics.MetricCountEvent('num_foo', 1))
self.assertEquals("Counter num_foo: 1", handler.report())
self.assertEquals({"counters": {"num_foo": 1}}, handler.asDict())
def testMetricTimeReport(self):
handler = metrics.MetricTimeHandler(None)
handler.handle({}, metrics.MetricTimeEvent('time_foo', 1))
self.assertEquals("Timer time_foo: 1", handler.report())
self.assertEquals({"timers": {"time_foo": 1}}, handler.asDict())
def testMetricAlarmReport(self):
handler = metrics.MetricAlarmHandler(None)
handler.handle({}, metrics.MetricAlarmEvent('alarm_foo', msg='Uh oh', level=metrics.ALARM_WARN))
self.assertEquals("WARN alarm_foo: Uh oh", handler.report())
self.assertEquals({"alarms": {"alarm_foo": ("WARN", "Uh oh")}}, handler.asDict())
|
