Coverage for tests/test_timer.py: 20%
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
Shortcuts on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1# This file is part of utils.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# Use of this source code is governed by a 3-clause BSD-style
10# license that can be found in the LICENSE file.
12import datetime
13import logging
14import os.path
15import time
16import unittest
17from dataclasses import dataclass
19from astropy import units as u
20from lsst.utils.timer import logInfo, logPairs, time_this, timeMethod
22log = logging.getLogger("test_timer")
24THIS_FILE = os.path.basename(__file__)
26# Only use this in a single test but needs to be associated
27# with the function up front.
28test_metadata = {}
31@dataclass
32class Example1:
33 log: logging.Logger
34 metadata: dict
36 @timeMethod
37 def sleeper(self, duration: float) -> None:
38 """Sleep for some time."""
39 time.sleep(duration)
42@timeMethod
43def decorated_sleeper_nothing(self, duration: float) -> None:
44 time.sleep(duration)
47@timeMethod(logger=log)
48def decorated_sleeper_logger(self, duration: float) -> None:
49 time.sleep(duration)
52@timeMethod(logger=log, logLevel=logging.INFO)
53def decorated_sleeper_logger_level(self, duration: float) -> None:
54 time.sleep(duration)
57@timeMethod(metadata=test_metadata)
58def decorated_sleeper_metadata(self, duration: float) -> None:
59 time.sleep(duration)
62class TestTimeMethod(unittest.TestCase):
63 def testLogPairs(self):
64 # Test the non-obj case.
65 logger = logging.getLogger("test")
66 pairs = (("name1", 0), ("name2", 1))
67 metadata = {}
68 with self.assertLogs(level=logging.INFO) as cm:
69 logPairs(None, pairs, logLevel=logging.INFO, logger=logger, metadata=metadata)
70 self.assertEqual(len(cm.output), 1, cm.output)
71 self.assertTrue(cm.output[0].endswith("name1=0; name2=1"), cm.output)
72 self.assertEqual(cm.records[0].filename, THIS_FILE, "log message should originate from here")
73 self.assertEqual(metadata, {"name1": [0], "name2": [1]})
75 # Call it again with an explicit stack level.
76 # Force it to come from lsst.utils.
77 with self.assertLogs(level=logging.INFO) as cm:
78 logPairs(None, pairs, logLevel=logging.INFO, logger=logger, metadata=metadata, stacklevel=0)
79 self.assertEqual(cm.records[0].filename, "timer.py")
81 # Check that the log message is filtered by default.
82 with self.assertLogs(level=logging.INFO) as cm:
83 logPairs(None, pairs, logger=logger, metadata=metadata)
84 logger.info("Message")
85 self.assertEqual(len(cm.records), 1)
87 def testLogInfo(self):
88 metadata = {}
89 logger = logging.getLogger("testLogInfo")
90 with self.assertLogs(level=logging.INFO) as cm:
91 logInfo(None, prefix="Prefix", metadata=metadata, logger=logger, logLevel=logging.INFO)
92 self.assertEqual(cm.records[0].filename, THIS_FILE)
93 self.assertIn("PrefixUtc", metadata)
95 # Again with no log output.
96 logInfo(None, prefix="Prefix", metadata=metadata)
97 self.assertEqual(len(metadata["PrefixUtc"]), 2)
99 # With an explicit stacklevel.
100 with self.assertLogs(level=logging.INFO) as cm:
101 logInfo(
102 None, prefix="Prefix", metadata=metadata, logger=logger, logLevel=logging.INFO, stacklevel=0
103 )
104 self.assertEqual(cm.records[0].filename, "timer.py")
106 def assertTimer(self, duration, task):
107 # Call it twice to test the "add" functionality.
108 task.sleeper(duration)
109 task.sleeper(duration)
110 counter = 2
112 has_logger = getattr(task, "log", None) is not None and task.log is not None
113 has_metadata = getattr(task, "metadata", None) is not None and task.metadata is not None
115 if has_logger:
116 counter += 1
117 with self.assertLogs("timer.task", level=logging.DEBUG) as cm:
118 task.sleeper(duration)
119 self.assertEqual(cm.records[0].filename, THIS_FILE, "log message should originate from here")
121 if has_metadata:
122 self.assertEqual(len(task.metadata["sleeperStartUserTime"]), counter)
124 start = datetime.datetime.fromisoformat(task.metadata["sleeperStartUtc"][1])
125 end = datetime.datetime.fromisoformat(task.metadata["sleeperEndUtc"][1])
126 delta = end - start
127 delta_sec = delta.seconds + (delta.microseconds / 1e6)
128 self.assertGreaterEqual(delta_sec, duration)
130 def testTaskLike(self):
131 """Test timer on something that looks like a Task."""
133 # Call with different parameters.
134 parameters = (
135 (logging.getLogger("task"), {}),
136 (logging.getLogger("task"), None),
137 (None, {}),
138 (None, None),
139 )
141 duration = 0.1
142 for log, metadata in parameters:
143 with self.subTest(log=log, metadata=metadata):
144 task = Example1(log=log, metadata=metadata)
145 self.assertTimer(duration, task)
147 def testDecorated(self):
148 """Test timeMethod on non-Task like instances."""
149 duration = 0.1
151 # The "self" object shouldn't be usable but this should do nothing
152 # and not crash.
153 decorated_sleeper_nothing(self, duration)
155 # Use a function decorated for logging.
156 with self.assertLogs("timer.test_timer", level=logging.DEBUG) as cm:
157 decorated_sleeper_logger(self, duration)
158 self.assertEqual(cm.records[0].filename, THIS_FILE, "log message should originate from here")
160 # And adjust the log level
161 with self.assertLogs("timer.test_timer", level=logging.INFO):
162 decorated_sleeper_logger_level(self, duration)
164 # Use a function decorated for metadata.
165 self.assertEqual(len(test_metadata), 0)
166 with self.assertLogs("timer.test_timer", level=logging.DEBUG) as cm:
167 # Check that we only get a single log message and nothing from
168 # timeMethod itself.
169 decorated_sleeper_metadata(self, duration)
170 logging.getLogger("timer.test_timer").debug("sentinel")
171 self.assertEqual(len(cm.output), 1)
172 self.assertIn("decorated_sleeper_metadataStartUserTime", test_metadata)
175class TimerTestCase(unittest.TestCase):
176 def testTimer(self):
177 with self.assertLogs(level="DEBUG") as cm:
178 with time_this():
179 pass
180 self.assertEqual(cm.records[0].name, "timer")
181 self.assertEqual(cm.records[0].levelname, "DEBUG")
182 self.assertEqual(cm.records[0].filename, THIS_FILE)
184 with self.assertLogs(level="DEBUG") as cm:
185 with time_this(prefix=None):
186 pass
187 self.assertEqual(cm.records[0].name, "root")
188 self.assertEqual(cm.records[0].levelname, "DEBUG")
189 self.assertIn("Took", cm.output[0])
190 self.assertNotIn(": Took", cm.output[0])
191 self.assertNotIn("; ", cm.output[0])
192 self.assertEqual(cm.records[0].filename, THIS_FILE)
194 # Report memory usage.
195 with self.assertLogs(level="DEBUG") as cm:
196 with time_this(level=logging.DEBUG, prefix=None, mem_usage=True):
197 pass
198 self.assertEqual(cm.records[0].name, "root")
199 self.assertEqual(cm.records[0].levelname, "DEBUG")
200 self.assertIn("Took", cm.output[0])
201 self.assertIn("memory", cm.output[0])
202 self.assertIn("delta", cm.output[0])
203 self.assertIn("peak delta", cm.output[0])
204 self.assertIn("byte", cm.output[0])
206 # Report memory usage including child processes.
207 with self.assertLogs(level="DEBUG") as cm:
208 with time_this(level=logging.DEBUG, prefix=None, mem_usage=True, mem_child=True):
209 pass
210 self.assertEqual(cm.records[0].name, "root")
211 self.assertEqual(cm.records[0].levelname, "DEBUG")
212 self.assertIn("Took", cm.output[0])
213 self.assertIn("memory", cm.output[0])
214 self.assertIn("delta", cm.output[0])
215 self.assertIn("peak delta", cm.output[0])
216 self.assertIn("byte", cm.output[0])
218 # Report memory usage, use non-default, but a valid memory unit.
219 with self.assertLogs(level="DEBUG") as cm:
220 with time_this(level=logging.DEBUG, prefix=None, mem_usage=True, mem_unit=u.kilobyte):
221 pass
222 self.assertEqual(cm.records[0].name, "root")
223 self.assertEqual(cm.records[0].levelname, "DEBUG")
224 self.assertIn("Took", cm.output[0])
225 self.assertIn("memory", cm.output[0])
226 self.assertIn("delta", cm.output[0])
227 self.assertIn("peak delta", cm.output[0])
228 self.assertIn("kbyte", cm.output[0])
230 # Report memory usage, use an invalid memory unit.
231 with self.assertLogs(level="DEBUG") as cm:
232 with time_this(level=logging.DEBUG, prefix=None, mem_usage=True, mem_unit=u.gram):
233 pass
234 self.assertEqual(cm.records[0].name, "lsst.utils.timer")
235 self.assertEqual(cm.records[0].levelname, "WARNING")
236 self.assertIn("Invalid", cm.output[0])
237 self.assertIn("byte", cm.output[0])
238 self.assertEqual(cm.records[1].name, "root")
239 self.assertEqual(cm.records[1].levelname, "DEBUG")
240 self.assertIn("Took", cm.output[1])
241 self.assertIn("memory", cm.output[1])
242 self.assertIn("delta", cm.output[1])
243 self.assertIn("peak delta", cm.output[1])
244 self.assertIn("byte", cm.output[1])
246 # Change logging level
247 with self.assertLogs(level="INFO") as cm:
248 with time_this(level=logging.INFO, prefix=None):
249 pass
250 self.assertEqual(cm.records[0].name, "root")
251 self.assertIn("Took", cm.output[0])
252 self.assertIn("seconds", cm.output[0])
254 # Use a new logger with a message.
255 msg = "Test message %d"
256 test_num = 42
257 logname = "test"
258 with self.assertLogs(level="DEBUG") as cm:
259 with time_this(log=logging.getLogger(logname), msg=msg, args=(42,), prefix=None):
260 pass
261 self.assertEqual(cm.records[0].name, logname)
262 self.assertIn("Took", cm.output[0])
263 self.assertIn(msg % test_num, cm.output[0])
265 # Prefix the logger.
266 prefix = "prefix"
267 with self.assertLogs(level="DEBUG") as cm:
268 with time_this(prefix=prefix):
269 pass
270 self.assertEqual(cm.records[0].name, prefix)
271 self.assertIn("Took", cm.output[0])
273 # Prefix explicit logger.
274 with self.assertLogs(level="DEBUG") as cm:
275 with time_this(log=logging.getLogger(logname), prefix=prefix):
276 pass
277 self.assertEqual(cm.records[0].name, f"{prefix}.{logname}")
279 # Trigger a problem.
280 with self.assertLogs(level="ERROR") as cm:
281 with self.assertRaises(RuntimeError):
282 with time_this(log=logging.getLogger(logname), prefix=prefix):
283 raise RuntimeError("A problem")
284 self.assertEqual(cm.records[0].name, f"{prefix}.{logname}")
285 self.assertEqual(cm.records[0].levelname, "ERROR")
288if __name__ == "__main__": 288 ↛ 289line 288 didn't jump to line 289, because the condition on line 288 was never true
289 unittest.main()