-
Notifications
You must be signed in to change notification settings - Fork 1
/
pytddmon.py
599 lines (525 loc) · 18.3 KB
/
pytddmon.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
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
#! /usr/bin/env python
#coding: utf-8
'''
Copyright (c) 2009,2010,2011 Olof Bjarnason
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
CONTRIBUTIONS
Fredrik Wendt:
Help with Tkinter implementation (replacing the pygame dependency).
KrunoSaho:
Added always-on-top to the pytddmon window.
Neppord(Samuel Ytterbrink):
Print(".") will not screw up test-counting (it did before).
Docstring support.
Recursive discovery of tests.
Refactoring to increase Pylint score from 6 to 9.5 out of 10 (!).
Rafael Capucho:
Python shebang at start of script, enabling "./pytddmon.py" on unix systems
'''
import os
import sys
import tempfile
import atexit
import shlex
import platform
import optparse
import re
from time import gmtime, strftime
from subprocess import Popen, PIPE, STDOUT
ON_PYTHON3 = sys.version_info[0] == 3
ON_WINDOWS = platform.system() == "Windows"
if not ON_PYTHON3:
import Tkinter as tk
else:
import tkinter as tk
# Constants
TEMP_FILE_DIR_NAME = tempfile.mkdtemp()
RUN_TESTS_SCRIPT_FILE = os.path.join(TEMP_FILE_DIR_NAME, 'pytddmon_tmp.py')
TEMP_OUT_FILE_NAME = os.path.join(TEMP_FILE_DIR_NAME, "out")
# If pytddmon is run in test mode, it will:
# 1. display the GUI for a very short time
# 2. write a log file, containing the information displayed
# (most notably green/total)
# 3. exit
TEST_MODE_FLAG = '--log-and-exit'
TEST_MODE_LOG_FILE = 'pytddmon.log'
TEST_FILE_REGEXP = "test_.*\\.py"
PYTHON_FILE_REGEXP = ".*\\.py"
def re_complete_match(regexp, string_to_match):
"""Helper function that does a regexp check if the full string_to_match
matches the regexp"""
return bool(re.match(regexp+"$", string_to_match))
# End of Constants
def file_name_to_module(base_path, file_name):
r"""Converts filenames of files in packages to import friendly dot separated
paths.
Examples:
>>> print(file_name_to_module("","pytddmon.pyw"))
pytddmon
>>> print(file_name_to_module("","pytddmon.py"))
pytddmon
>>> print(file_name_to_module("","tests/pytddmon.py"))
tests.pytddmon
>>> print(file_name_to_module("","./tests/pytddmon.py"))
tests.pytddmon
>>> print(file_name_to_module("",".\\tests\\pytddmon.py"))
tests.pytddmon
>>> print(file_name_to_module("/User/pytddmon\\ geek/pytddmon/","/User/pytddmon\\ geek/pytddmon/tests/pytddmon.py"))
tests.pytddmon
"""
symbol_stripped = os.path.relpath(file_name, base_path)
for symbol in r"/\.":
symbol_stripped = symbol_stripped.replace(symbol, " ")
words = symbol_stripped.split()
module_words = words[:-1] # remove .py/.pyw
module_name = '.'.join(module_words)
return module_name
def build_run_script(files):
"""Compiles a script to run all tests in the files.
>>> print(build_run_script(["pytddmon.py"]))
import sys
import unittest
import doctest
...
import pytddmon
suite.addTests(load_module_tests(pytddmon))
try:
suite.addTests(doctest.DocTestSuite(pytddmon, optionflags=doctest.ELLIPSIS))
except:pass
...
"""
content = []
content.append("import sys")
content.append("import unittest")
content.append("import doctest")
content.append("")
content.append("sys.path[0] = %r" % os.getcwd())
content.append("suite = unittest.TestSuite()")
content.append(
"load_module_tests = unittest.defaultTestLoader.loadTestsFromModule"
)
content.append("")
for filename in files:
module = file_name_to_module("", filename)
content.append('import ' + module)
content.append('suite.addTests(load_module_tests(' + module + '))')
content.append('try:')
content.append(
' suite.addTests(doctest.DocTestSuite(' +
module +
', optionflags=doctest.ELLIPSIS))'
)
content.append('except:pass')
content.append('')
content.append("if __name__ == '__main__':")
content.append(" out = open(%r, 'w')" % TEMP_OUT_FILE_NAME)
content.append(" unittest.TextTestRunner(stream=out).run(suite)")
return "\n".join(content)
def calculate_checksum(filelist, fileinfo):
"""Generates a checksum for all the files in the file list."""
val = 0
for filename in filelist:
val += (
fileinfo.get_modified_time(filename) +
fileinfo.get_size(filename) +
fileinfo.get_name_hash(filename)
)
return val
class ColorPicker:
"""
ColorPicker decides the background color the pytddmon window,
based on the number of green tests, and the total number of
tests. Also, there is a "pulse" (light color, dark color),
to increase the feeling of continous testing.
"""
def __init__(self):
self.color = 'green'
self.light = True
def pick(self):
"returns the tuple (light, color) with the types(bool ,str)"
return (self.light, self.color)
def pulse(self):
"updates the light state"
self.light = not self.light
def reset_pulse(self):
"resets the light state"
self.light = True
def set_result(self, green, total):
"calculates what color should be used and may reset the lightness"
old_color = self.color
self.color = 'green'
if green == total-1:
self.color = 'red'
if green < total-1:
self.color = 'gray'
if self.color != old_color:
self.reset_pulse()
def win_text(total_tests, passing_tests=0):
"""
The text shown in the main window.
"""
return "%d/%d" % (passing_tests, total_tests)
class ScriptWriter:
"""
ScriptWriter: gets it's modules from the Finder, and
writes a test script using the file writer and script
builder.
"""
def __init__(self, finder, file_writer, script_builder):
self.finder = finder
self.file_writer = file_writer
self.script_builder = script_builder
def write_script(self):
"""
Finds the tests and Compiles the test runner script and writes it
to file. This is done with the help from the finder script builder and
file writer.
"""
modules = self.finder()
result = self.script_builder(modules)
self.file_writer(RUN_TESTS_SCRIPT_FILE, result)
class TestScriptRunner:
"""
TestScriptRunner has two collaborators:
cmdrunner, runs a specified command line, returns stderr as string
analyzer, analyses unittest-output into green,total number of tests
"""
def __init__(self, cmdrunner, analyzer):
self.cmdrunner = cmdrunner
self.analyzer = analyzer
def run(self, test_script):
"""
Runns the test runner script and returns the analysed output.
"""
output = self.cmdrunner('python "%s"' % test_script)
return self.analyzer.analyze(output)
class Analyzer:
"""
Analyzer
Analyzes unittest output to find green and total number of tests.
Collaborators: logger, log messages a written to the log
"""
def __init__(self, logger):
self.logger = logger
def analyze(self, txt):
"""
Analyses the out put from a unittest and returns a tupple of
(passed/green, total)
"""
if len(txt.strip()) == 0:
return (0, 0)
toprow = txt.splitlines()[0]
green = toprow.count('.')
total = len(toprow)
if green < total:
self.logger.log(txt)
return (green, total)
class Logger:
"""
Logger, remembers log messages.
"""
def __init__(self):
self.complete_log = ""
def log(self, message):
"""
Adds message to the log
"""
self.complete_log = self.complete_log + message
def get_log(self):
"""
returns the log as a string
"""
return self.complete_log
def clear(self):
"""
clears all entries in the log
"""
self.complete_log = ""
## Rows above this are unit-tested.
## Rows below this are not unit-tested.
def remove_tmp_files():
"""
Clean up all tempfiles after us.
"""
safe_remove(RUN_TESTS_SCRIPT_FILE)
if os.path.exists(TEMP_FILE_DIR_NAME):
os.removedirs(TEMP_FILE_DIR_NAME)
atexit.register(remove_tmp_files)
class RealFileInfo(object):
"""
A adapter to easy finde info of a file.
"""
@staticmethod
def get_size(filename):
"returns the size of a file"
return os.stat(filename).st_size
@staticmethod
def get_modified_time(filename):
"returns the time the file was last modified"
return os.stat(filename).st_mtime
@staticmethod
def get_name_hash(path):
"""
returns a hash of the name of the path
"""
return hash(path)
def find_monitored_files():
" Finds all python modules in current directory and subdirectories "
monitored_files = []
for path, _folders, files in os.walk("."):
for filename in files:
if re_complete_match(PYTHON_FILE_REGEXP, filename):
monitored_file = os.path.join(path, filename)
monitored_files.append(monitored_file)
return monitored_files
def find_test_files_recursively():
"""
Scan recursively for unit test files in current folder
and in folders which are packages. Packages are assumed
to contain the word 'test'. The same holds true for unit
test files, with the additional condition that they are
assumed to end with '.py'.
"""
test_files = []
for path, folders, files in os.walk("."):
for filename in files:
if re_complete_match(TEST_FILE_REGEXP, filename):
test_file = os.path.join(path, filename)
test_files.append(test_file)
folders[:] = [
folder
for folder in folders
if os.path.isfile(
os.path.join(path, folder, "__init__.py")
)
]
return test_files
def finder_with_fixed_fileset(fileset):
"""
Module finder which always returns the
same file list.
"""
def find():
"returns the sent-in file set"
return fileset
return find
def safe_remove(path):
"removes path and ignores all exceptions."
try:
os.unlink(path)
except OSError:
pass
def run_cmdline(cmdline):
"runs a cmd and returns its output"
lst = shlex.split(cmdline)
use_shell = True if ON_WINDOWS else False
cmd = Popen(lst, stdout=PIPE, stderr=STDOUT, shell=use_shell)
output = cmd.communicate()[0]
if os.path.exists(TEMP_OUT_FILE_NAME):
output = open(TEMP_OUT_FILE_NAME).read()
os.remove(TEMP_OUT_FILE_NAME)
return output
def write_file(filename, content):
"""
Writes a string of text to a file, overwriting
any previous file with the same name.
"""
f_hand = open(filename, 'w')
f_hand.write(content)
f_hand.close()
def message_window(message):
"creates and shows a window with the message"
win = tk.Toplevel()
win.wm_attributes("-topmost", 1)
if ON_WINDOWS:
win.attributes("-toolwindow", 1)
win.title('Details')
message = message.replace('\r\n', '\n')
text = tk.Text(win)
text.insert(tk.INSERT, message)
text['state'] = tk.DISABLED
text.pack(expand=1, fill='both')
text.focus_set()
class PytddmonFrame(tk.Frame):
"The Main GUI of pytddmon"
def __init__(self, root=None, files=None, test_mode=False):
tk.Frame.__init__(self, root)
self.button = None
self.test_mode = test_mode
self.master.title("pytddmon")
self.master.resizable(0, 0)
self.create_button()
self.grid()
self.failures = 0
self.last_checksum = None # important to be different from any number
self.num_tests = 0
self.num_tests_prev = 0
self.num_tests_diff = 0
self.logger = Logger()
self.color_picker = ColorPicker()
self.runner = TestScriptRunner(run_cmdline, Analyzer(self.logger))
self.monitoring = os.getcwd()
finder = None
if files != None:
self.monitoring = ' '.join(files)
finder = finder_with_fixed_fileset(files)
else:
finder = find_test_files_recursively
self.script_writer = ScriptWriter(
finder,
write_file,
build_run_script
)
self.color_table = {
(True, 'green'): '0f0',
(False, 'green'): '0c0',
(True, 'red'): 'f00',
(False, 'red'): 'c00',
(True, 'gray'): '999',
(False, 'gray'): '555'
}
self.look_for_changes()
@staticmethod
def compute_checksum():
"returns the checksum for all the sourcefiles as a single integer."
files = find_monitored_files()
try:
files.remove(RUN_TESTS_SCRIPT_FILE)
except ValueError:
pass
return calculate_checksum(files, RealFileInfo())
def get_number_of_failures(self):
"""Returns the number of faild tests"""
self.script_writer.write_script()
(green, total) = self.runner.run(RUN_TESTS_SCRIPT_FILE)
self.num_tests_prev = self.num_tests
self.num_tests = total
return total - green
@staticmethod
def clock_string():
"Formating the time for better readability"
return strftime("%H:%M:%S", gmtime())
def create_button(self):
"Initialize the Button label."
button_width = 8
if not ON_WINDOWS:
# Hack: Window title cut if button too small!
button_width = 10
self.button = tk.Label(self,
text='pytddmon',
width=button_width,
relief='raised',
font=("Helvetica", 16),
justify=tk.CENTER,
anchor=tk.CENTER)
self.button.bind("<Button-1>", self.button_clicked)
self.button.pack(expand=1, fill='both')
def button_clicked(self, _widget):
"Event method triggerd if the button is clicked."
msg = "Monitoring: %s\n%s" % (self.monitoring, self.logger.get_log())
message_window(msg)
def get_green_and_total(self):
"""
Calculate the green results and returns that together with the
total of tests as a tuple.
"""
return (self.num_tests-self.failures, self.num_tests)
def update_gui(self):
"Calls all update methods related to the gui"
(green, total) = self.get_green_and_total()
self.update_gui_color(green, total)
self.update_gui_text(green, total)
def update_gui_color(self, green, total):
"""
Calculates the new background color and tells the GUI to switch
to it.
"""
self.color_picker.set_result( green, total )
(light, color) = self.color_picker.pick()
self.color_picker.pulse()
rgb = '#' + self.color_table[(light, color)]
self.button.configure(bg=rgb, activebackground=rgb)
self.configure(background=rgb)
def update_gui_text(self, green, total):
"Updates the text of the Main GUI."
txt = win_text(
passing_tests=green,
total_tests=total
)
self.button.configure(text=txt)
def look_for_changes(self):
"Look for changes in source files and runs tests if needed."
newval = self.compute_checksum()
if newval != self.last_checksum:
self.last_checksum = newval
self.logger.clear()
self.logger.log('[%s] Running all tests...\n' % self.clock_string())
self.failures = self.get_number_of_failures()
self.logger.log(
'[%s] Number of failures: %d\n' % (
self.clock_string(),
self.failures
)
)
self.update_gui()
if self.test_mode:
file_h = open(TEST_MODE_LOG_FILE, "w")
(green, total) = self.get_green_and_total()
lines = [ 'green='+str(green), 'total='+str(total) ]
file_h.write('\n'.join(lines))
file_h.close()
self.master.destroy()
else:
self.after(750, self.look_for_changes)
def filter_existing_files(files):
"simple filtering function checking for existence of files"
return [f for f in files if os.path.exists(f)]
def parse_commandline():
"""
returns (files, test_mode) created from the command line arguments
passed to pytddmon.
"""
parser = optparse.OptionParser()
parser.add_option("--log-and-exit", action="store_true", default=False)
(options, args) = parser.parse_args()
return (args, options.log_and_exit)
def run():
"""
The main function: basic initialization and program start
"""
# Command line argument handling
(static_file_set, test_mode) = parse_commandline()
static_file_set = filter_existing_files(static_file_set)
# Basic tkinter initialization
root = tk.Tk()
root.wm_attributes("-topmost", 1)
if ON_WINDOWS:
root.attributes("-toolwindow", 1)
if not test_mode:
print("Minimize me!")
# Create main window
if len(static_file_set)>0:
PytddmonFrame(root, static_file_set, test_mode=test_mode)
else:
PytddmonFrame(root, test_mode=test_mode)
# Main loop
try:
root.mainloop()
except Exception as exception:
print(exception)
if __name__ == '__main__':
run()