1
# Copyright (C) 2007, 2009, 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Tests for profiling data collection."""
21
import cPickle as pickle
31
from ..tests import features
34
lsprof = features.lsprof_feature.module
37
_TXT_HEADER = " CallCount Recursive Total(ms) " + \
38
"Inline(ms) module:lineno(function)\n"
42
"A simple routine to profile."
43
result = sorted(['abc', 'def', 'ghi'])
47
"Collect and return some dummy profile data."
48
ret, stats = lsprof.profile(_junk_callable)
52
class TestStats(tests.TestCaseInTempDir):
54
_test_needs_features = [features.lsprof_feature]
57
super(tests.TestCaseInTempDir, self).setUp()
58
self.stats = _collect_stats()
60
def _temppath(self, ext):
61
return osutils.pathjoin(self.test_dir, "tmp_profile_data." + ext)
63
def test_save_to_txt(self):
64
path = self._temppath("txt")
68
self.assertEqual(lines[0], _TXT_HEADER)
70
def test_save_to_callgrind(self):
71
path1 = self._temppath("callgrind")
72
self.stats.save(path1)
73
with open(path1) as f:
74
self.assertEqual(f.readline(), "events: Ticks\n")
76
path2 = osutils.pathjoin(self.test_dir, "callgrind.out.foo")
77
self.stats.save(path2)
78
with open(path2) as f:
79
self.assertEqual(f.readline(), "events: Ticks\n")
81
# Test explicit format nommination
82
path3 = self._temppath("txt")
83
self.stats.save(path3, format="callgrind")
84
with open(path3) as f:
85
self.assertEqual(f.readline(), "events: Ticks\n")
87
def test_save_to_pickle(self):
88
path = self._temppath("pkl")
90
with open(path, 'rb') as f:
91
data1 = pickle.load(f)
92
self.assertEqual(type(data1), lsprof.Stats)
96
code_list = [d.inlinetime for d in self.stats.data]
97
self.assertEqual(code_list, sorted(code_list, reverse=True))
99
def test_sort_totaltime(self):
100
self.stats.sort('totaltime')
101
code_list = [d.totaltime for d in self.stats.data]
102
self.assertEqual(code_list, sorted(code_list, reverse=True))
104
def test_sort_code(self):
105
"""Cannot sort by code object would need to get filename etc."""
106
self.assertRaises(ValueError, self.stats.sort, 'code')
109
class TestBzrProfiler(tests.TestCase):
111
_test_needs_features = [features.lsprof_feature]
113
def test_start_call_stuff_stop(self):
114
profiler = lsprof.BzrProfiler()
121
stats = profiler.stop()
123
lines = [str(data) for data in stats.data]
124
lines = [line for line in lines if 'a_function' in line]
125
self.assertLength(1, lines)
127
def test_block_0(self):
128
# When profiler_block is 0, reentrant profile requests fail.
129
self.overrideAttr(lsprof.BzrProfiler, 'profiler_block', 0)
133
profiler = lsprof.BzrProfiler()
134
self.assertRaises(errors.BzrError, profiler.start)
135
inner_calls.append(True)
136
lsprof.profile(inner)
137
self.assertLength(1, inner_calls)
139
def test_block_1(self):
140
# When profiler_block is 1, concurrent profiles serialise.
141
# This is tested by manually acquiring the profiler lock, then
142
# starting a thread that tries to profile, and releasing the lock.
143
# We know due to test_block_0 that two profiles at once hit the lock,
144
# so while this isn't perfect (we'd want a callback on the lock being
145
# entered to allow lockstep evaluation of the actions), its good enough
146
# to be confident regressions would be caught. Alternatively, if this
147
# is flakey, a fake Lock object can be used to trace the calls made.
151
calls.append('profiled')
154
lsprof.profile(profiled)
155
calls.append('after_profiled')
156
thread = threading.Thread(target=do_profile)
157
lsprof.BzrProfiler.profiler_lock.acquire()
162
lsprof.BzrProfiler.profiler_lock.release()
165
self.assertLength(2, calls)