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
|
# Copyright (c) 2010, 2011, Canonical Ltd
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, version 3 only.
#
# 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 Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Tests of the Timeline class."""
from __future__ import absolute_import, print_function
__metaclass__ = type
import datetime
import testtools
from testtools.matchers import EndsWith
from timeline.timedaction import TimedAction
from timeline.timeline import OverlappingActionError, Timeline
class TestTimeline(testtools.TestCase):
def test_start_returns_action(self):
timeline = Timeline()
action = timeline.start("Sending mail", "Noone")
self.assertIsInstance(action, TimedAction)
self.assertEqual("Sending mail", action.category)
self.assertEqual("Noone", action.detail)
self.assertEqual(None, action.duration)
self.assertEqual(timeline, action.timeline)
def test_can_supply_list(self):
actions = "foo"
timeline = Timeline(actions)
self.assertEqual(actions, timeline.actions)
def test_start_with_unfinished_action_fails(self):
# A design constraint of timeline says that overlapping actions are not
# permitted. See the Timeline docstrings.
timeline = Timeline()
action = timeline.start("Sending mail", "Noone")
self.assertRaises(OverlappingActionError, timeline.start,
"Sending mail", "Noone")
def test_nested_start_permitted(self):
# When explicitly requested a nested start can be done
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
child = timeline.start("SQL Callback", "SELECT...")
def test_nested_start_is_not_transitive(self):
# nesting is explicit at each level - not inherited.
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
child = timeline.start("SQL Callback", "SELECT...")
self.assertRaises(OverlappingActionError, timeline.start,
"Sending mail", "Noone")
def test_multiple_nested_children_permitted(self):
# nesting is not reset by each action that is added.
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
child = timeline.start("SQL Callback", "SELECT...")
child.finish()
child = timeline.start("SQL Callback", "SELECT...")
def test_multiple_starts_after_nested_group_prevented(self):
# nesting stops being permitted when the nesting action is finished.
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
action.finish()
child = timeline.start("SQL Callback", "SELECT...")
self.assertRaises(OverlappingActionError, timeline.start,
"Sending mail", "Noone")
def test_nesting_within_nesting_permitted(self):
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
middle = timeline.start("Calling otherlibrary", "", allow_nested=True)
child = timeline.start("SQL Callback", "SELECT...")
def test_finishing_nested_within_nested_leaves_outer_nested_nesting(self):
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
middle = timeline.start("Calling otherlibrary", "", allow_nested=True)
middle.finish()
child = timeline.start("SQL Callback", "SELECT...")
def test_nested_actions_recorded_as_two_zero_length_actions(self):
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
child = timeline.start("SQL Callback", "SELECT...")
child.finish()
action.finish()
self.assertEqual(3, len(timeline.actions))
self.assertEqual(datetime.timedelta(), timeline.actions[0].duration)
self.assertEqual(datetime.timedelta(), timeline.actions[2].duration)
def test_nested_category_labels(self):
# To identify start/stop pairs '-start' and '-stop' are put onto the
# category of nested actions:
timeline = Timeline()
action = timeline.start("Calling openid", "hostname", allow_nested=True)
action.finish()
self.assertEqual('Calling openid-start', timeline.actions[0].category)
self.assertEqual('Calling openid-stop', timeline.actions[1].category)
def test_start_after_finish_works(self):
timeline = Timeline()
action = timeline.start("Sending mail", "Noone")
action.finish()
action = timeline.start("Sending mail", "Noone")
action.finish()
self.assertEqual(2, len(timeline.actions))
def test_baseline(self):
timeline = Timeline()
self.assertIsInstance(timeline.baseline, datetime.datetime)
def test_start_sets_backtrace_by_default(self):
timeline = Timeline()
action = timeline.start("Sending mail", "Noone")
self.assertNotEqual(None, action.backtrace)
self.assertIsInstance(action.backtrace, str)
self.assertThat(action.backtrace,
EndsWith(' action = timeline.start("Sending mail", "Noone")\n'))
def test_backtraces_can_be_disabled(self):
# Passing format_stack=None to Timeline prevents backtrace gathering.
timeline = Timeline(format_stack=None)
action = timeline.start("Sending mail", "Noone")
self.assertEqual(None, action.backtrace)
|
