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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
|
# -*- coding: utf-8 -*-
# Copyright 2017 - 2022 Avram Lubkin, All Rights Reserved
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
"""
Test module for enlighten._manager
"""
import signal
import sys
import time
import enlighten
from enlighten import _manager
from tests import (unittest, TestCase, mock, MockTTY, MockCounter,
redirect_output, OUTPUT, STDOUT_NO_FD)
TERMINAL = 'blessed.Terminal'
# pylint: disable=missing-docstring, protected-access, too-many-statements, too-many-public-methods
# pylint: disable=too-many-lines
class TestManager(TestCase):
def setUp(self):
self.tty = MockTTY()
self.resize_sig = signal.getsignal(signal.SIGWINCH)
def tearDown(self):
self.tty.close()
signal.signal(signal.SIGWINCH, self.resize_sig)
def test_init_safe(self):
with redirect_output('stdout', self.tty.stdout):
# Companion stream is stderr if stream is stdout
manager = enlighten.Manager(stream=sys.stdout)
self.assertIs(manager.stream, sys.stdout)
self.assertIs(manager.term.stream, sys.stdout)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init(self):
# Companion stream is __stderr__ if stream is __stdout__
# Need to mock isatty() for some build and test environments
with mock.patch.object(sys, '__stderr__') as mock_stderr:
mock_stderr.isatty.return_value = True
manager = enlighten.Manager(stream=sys.__stdout__)
self.assertIs(manager.stream, sys.__stdout__)
self.assertIs(manager.term.stream, sys.__stdout__)
self.assertIs(manager.companion_stream, mock_stderr)
self.assertIs(manager.companion_term.stream, mock_stderr)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_companion_hc(self):
# Hard-coded companion stream always wins
manager = enlighten.Manager(companion_stream=OUTPUT)
self.assertIs(manager.companion_stream, OUTPUT)
self.assertIs(manager.companion_term.stream, OUTPUT)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_stderr(self):
# Companion stream is __stdout__ if stream is __stderr__
# Need to mock isatty() for some build and test environments
with mock.patch.object(sys, '__stdout__') as mock_stdout:
mock_stdout.isatty.return_value = True
manager = enlighten.Manager(stream=sys.__stderr__)
self.assertIs(manager.stream, sys.__stderr__)
self.assertIs(manager.term.stream, sys.__stderr__)
self.assertIs(manager.companion_stream, mock_stdout)
self.assertIs(manager.companion_term.stream, mock_stdout)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_redirect(self):
# If stdout is redirected, but stderr is still a tty, use it for companion
with redirect_output('stdout', OUTPUT):
# Need to mock isatty() for some build and test environments
with mock.patch.object(sys, 'stderr') as mock_stderr:
mock_stderr.isatty.return_value = True
manager = enlighten.Manager(stream=sys.stdout)
self.assertIs(manager.stream, sys.stdout)
self.assertIs(manager.term.stream, sys.stdout)
self.assertIs(manager.companion_stream, mock_stderr)
self.assertIs(manager.companion_term.stream, mock_stderr)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_stderr_redirect(self):
# If stderr is redirected, but stdout is still a tty, use it for companion
with redirect_output('stderr', OUTPUT):
# Need to mock isatty() for some build and test environments
with mock.patch.object(sys, 'stdout') as mock_stdout:
mock_stdout.isatty.return_value = True
manager = enlighten.Manager(stream=sys.stderr)
self.assertIs(manager.stream, sys.stderr)
self.assertIs(manager.term.stream, sys.stderr)
self.assertIs(manager.companion_stream, mock_stdout)
self.assertIs(manager.companion_term.stream, mock_stdout)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_stderr_companion_hc(self):
# Hard-coded companion stream always wins
manager = enlighten.Manager(stream=sys.__stderr__, companion_stream=OUTPUT)
self.assertIs(manager.companion_stream, OUTPUT)
self.assertIs(manager.companion_term.stream, OUTPUT)
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_init_hc(self):
# Nonstandard stream doesn't get a companion stream by default
manager = enlighten.Manager(stream=OUTPUT)
self.assertIs(manager.stream, OUTPUT)
self.assertIs(manager.term.stream, OUTPUT)
self.assertIsNone(manager.companion_stream)
self.assertIsNone(manager.companion_term)
def test_width(self):
"""Width hard-coded"""
manager = enlighten.Manager(width=100)
ctr = manager.counter(total=100)
self.assertEqual(len(ctr.format()), 100)
def test_repr(self):
manager = enlighten.Manager()
self.assertEqual(repr(manager), "Manager(stream=%r)" % sys.__stdout__)
def test_counter_and_remove(self):
# pylint: disable=no-member,assigning-non-slot
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
self.assertEqual(len(manager.counters), 0)
with mock.patch.object(manager, '_set_scroll_area') as ssa:
counter1 = manager.counter(leave=True)
self.assertTrue(counter1.leave)
self.assertEqual(len(manager.counters), 1)
self.assertEqual(manager.counters[counter1], 1)
self.assertEqual(counter1.calls, [])
self.assertEqual(ssa.call_count, 1)
with mock.patch.object(manager, '_set_scroll_area') as ssa:
counter2 = manager.counter(leave=False)
self.assertFalse(counter2.leave)
self.assertEqual(len(manager.counters), 2)
self.assertEqual(manager.counters[counter1], 2)
self.assertEqual(manager.counters[counter2], 1)
self.assertEqual(counter1.calls,
['clear(flush=False)', 'refresh(flush=False, elapsed=None)'])
self.assertEqual(counter2.calls, [])
self.assertEqual(ssa.call_count, 1)
counter1.calls = []
with mock.patch.object(manager, '_set_scroll_area') as ssa:
counter3 = manager.counter(leave=False)
self.assertFalse(counter3.leave)
self.assertEqual(len(manager.counters), 3)
self.assertEqual(manager.counters[counter1], 3)
self.assertEqual(manager.counters[counter2], 2)
self.assertEqual(manager.counters[counter3], 1)
self.assertEqual(counter1.calls,
['clear(flush=False)', 'refresh(flush=False, elapsed=None)'])
self.assertEqual(counter2.calls,
['clear(flush=False)', 'refresh(flush=False, elapsed=None)'])
self.assertEqual(counter3.calls, [])
self.assertEqual(ssa.call_count, 1)
counter1.calls = []
counter2.calls = []
manager.remove(counter3)
self.assertEqual(len(manager.counters), 2)
self.assertFalse(counter3 in manager.counters)
# Remove again, no error
manager.remove(counter3)
self.assertEqual(len(manager.counters), 2)
manager.remove(counter1)
self.assertEqual(len(manager.counters), 2)
self.assertTrue(counter1 in manager.counters)
with mock.patch.object(manager, '_set_scroll_area') as ssa:
counter4 = manager.counter(leave=False)
self.assertFalse(counter4.leave)
self.assertEqual(len(manager.counters), 3)
self.assertEqual(manager.counters[counter1], 3)
self.assertEqual(manager.counters[counter2], 2)
self.assertEqual(manager.counters[counter4], 1)
self.assertEqual(counter1.calls, [])
self.assertEqual(counter2.calls, [])
self.assertEqual(counter4.calls, [])
self.assertEqual(ssa.call_count, 1)
def test_counter_position(self):
manager = enlighten.Manager(stream=self.tty.stdout, set_scroll=False)
counter1 = manager.counter(position=4)
self.assertEqual(manager.counters[counter1], 4)
with self.assertRaisesRegex(ValueError, 'Counter position 0 is less than 1'):
manager.counter(position=0)
with self.assertRaisesRegex(ValueError, 'Counter position 4 is already occupied'):
manager.counter(position=4)
with self.assertRaisesRegex(ValueError,
'Counter position 200 is greater than terminal height'):
manager.counter(position=200)
def test_counter_position_pinned(self):
"""If a position is taken, use next available"""
manager = enlighten.Manager(stream=self.tty.stdout, set_scroll=False)
counter1 = manager.counter(position=2)
self.assertEqual(manager.counters[counter1], 2)
counter2 = manager.counter()
self.assertEqual(manager.counters[counter1], 2)
self.assertEqual(manager.counters[counter2], 1)
counter3 = manager.counter()
self.assertEqual(manager.counters[counter1], 2)
self.assertEqual(manager.counters[counter2], 3)
self.assertEqual(manager.counters[counter3], 1)
status1 = manager.status_bar(position=3)
self.assertEqual(manager.counters[counter1], 2)
self.assertEqual(manager.counters[counter2], 4)
self.assertEqual(manager.counters[counter3], 1)
self.assertEqual(manager.counters[status1], 3)
status2 = manager.status_bar()
self.assertEqual(manager.counters[counter1], 2)
self.assertEqual(manager.counters[counter2], 5)
self.assertEqual(manager.counters[counter3], 4)
self.assertEqual(manager.counters[status1], 3)
self.assertEqual(manager.counters[status2], 1)
def test_counter_replaced(self):
"""Counter replaces an existing counter"""
manager = enlighten.Manager(stream=self.tty.stdout, set_scroll=False)
# Pinned replacement
counter1 = manager.counter(position=2)
self.assertEqual(manager.counters[counter1], 2)
counter2 = manager.counter(replace=counter1)
self.assertEqual(len(manager.counters), 1)
self.assertEqual(manager.counters[counter2], 2)
self.assertTrue(counter2._pinned)
# Unpinned replacement
counter3 = manager.counter()
self.assertEqual(len(manager.counters), 2)
self.assertEqual(manager.counters[counter3], 1)
counter4 = manager.counter(replace=counter3)
self.assertEqual(len(manager.counters), 2)
self.assertEqual(manager.counters[counter4], 1)
self.assertFalse(counter4._pinned)
# Unmanaged counter given
with self.assertRaisesRegex(ValueError, 'Counter to replace is not currently managed'):
manager.counter(replace=counter1)
def test_inherit_kwargs(self):
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
unit='knights', not_real=True, desc='Default')
self.assertTrue('unit' in manager.defaults)
self.assertTrue('desc' in manager.defaults)
self.assertTrue('not_real' in manager.defaults)
with mock.patch.object(manager, '_set_scroll_area'):
ctr = manager.counter(desc='Huzzah')
self.assertEqual(ctr.unit, 'knights')
self.assertEqual(ctr.desc, 'Huzzah')
self.assertFalse(hasattr(ctr, 'not_real'))
def test_write(self):
msg = 'test message'
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager = enlighten.Manager(stream=self.tty.stdout)
counter = manager.counter(position=3)
term = manager.term
manager.write(msg, counter=counter)
self.tty.stdout.write(u'X\n')
# Carriage return is getting converted to newline
self.assertEqual(self.tty.stdread.readline(),
term.move(22, 0) + '\r' + term.clear_eol + msg + 'X\n')
self.assertEqual(ssa.call_count, 2)
def test_write_no_flush(self):
"""
Output is stored in buffer, but not flushed to stream
"""
msg = u'test message'
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager = enlighten.Manager(stream=self.tty.stdout, companion_stream=OUTPUT)
counter = manager.counter(position=3)
term = manager.term
manager.write(msg, counter=counter, flush=False)
self.assertEqual(manager._buffer,
[term.move(term.height - 3, 0), '\r', term.clear_eol, msg])
self.assertEqual(manager._companion_buffer, [])
self.tty.stdout.write(u'X\n')
# No output
self.assertEqual(self.tty.stdread.readline(), 'X\n')
self.assertEqual(ssa.call_count, 2)
def test_flush_companion_buffer(self):
"""
Output is stored in buffer, but only written in companion stream is defined
"""
manager = enlighten.Manager(stream=self.tty.stdout)
msg = u'test message'
manager._companion_buffer = [msg]
manager._flush_streams()
# Companion buffer flushed, but not outputted
self.assertEqual(manager._companion_buffer, [])
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
# set companion stream and test again
manager.companion_stream = OUTPUT
manager._companion_buffer = [msg]
manager._flush_streams()
self.assertEqual(manager._companion_buffer, [])
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
self.assertEqual(OUTPUT.getvalue(), msg)
def test_autorefresh(self):
"""
Ensure auto-refreshed counters are updated when others are
"""
manager = enlighten.Manager(stream=self.tty.stdout)
counter1 = manager.counter(count=1, total=0, counter_format=u'counter1', autorefresh=True)
counter2 = manager.counter(count=1, total=0, counter_format=u'counter2')
self.tty.clear()
# Counter 1 in auto-refresh list
self.assertIn(counter1, manager.autorefresh)
# If auto-refreshed counter hasn't been refreshed recently, refresh
counter1.last_update = 0
counter2.refresh()
self.tty.stdout.write(u'X\n')
output = self.tty.stdread.readline()
self.assertRegex(output, 'counter2.+counter1')
# If auto-refreshed counter has been refreshed recently, skip
counter1.last_update = time.time() + 5
counter2.refresh()
self.tty.stdout.write(u'X\n')
output = self.tty.stdread.readline()
self.assertRegex(output, 'counter2')
self.assertNotRegex(output, 'counter1')
# If already auto-refreshing, skip
manager.refresh_lock = True
counter1.last_update = 0
counter2.refresh()
# Have to explicitly flush
manager._flush_streams()
self.tty.stdout.write(u'X\n')
output = self.tty.stdread.readline()
self.assertRegex(output, 'counter2')
self.assertNotRegex(output, 'counter1')
def test_set_scroll_area_disabled(self):
manager = enlighten.Manager(stream=self.tty.stdout,
counter_class=MockCounter, set_scroll=False)
manager.counters['dummy'] = 3
manager._set_scroll_area()
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
def test_set_scroll_area_no_change(self):
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
manager.counters['dummy'] = 3
manager.scroll_offset = 4
manager._set_scroll_area()
self.assertEqual(manager._buffer, [manager.term.move(21, 0)])
def test_set_scroll_area_companion(self):
"""
Ensure when no change is made, a term.move is still called for the companion stream
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
companion_stream=self.tty.stdout)
manager.counters['dummy'] = 3
manager.scroll_offset = 4
term = manager.term
manager._set_scroll_area()
self.assertEqual(manager._buffer, [term.move(21, 0)])
self.assertEqual(manager._companion_buffer, [term.move(21, 0)])
def test_set_scroll_area(self):
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
manager.counters['dummy'] = 3
term = manager.term
stdread = self.tty.stdread
self.assertEqual(manager.scroll_offset, 1)
self.assertFalse(manager.process_exit)
self.assertNotEqual(signal.getsignal(signal.SIGWINCH), manager._stage_resize)
old_offset = manager.scroll_offset
with mock.patch('enlighten._manager.atexit') as atexit:
manager._set_scroll_area()
self.assertEqual(manager.scroll_offset, 4)
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager._stage_resize)
self.assertTrue(manager.process_exit)
atexit.register.assert_called_with(manager._at_exit)
offset = manager.scroll_offset
scroll_position = term.height - offset
self.assertEqual(manager._buffer,
[term.move(term.height - old_offset, 0),
'\n' * (offset - old_offset),
term.hide_cursor, term.csr(0, scroll_position),
term.move(scroll_position, 0)])
# No companion buffer defined
self.assertEqual(manager._companion_buffer, [])
# Make sure nothing was flushed
self.tty.stdout.write(u'X\n')
self.assertEqual(stdread.readline(), 'X\n')
# Run it again and make sure exit handling isn't reset
del manager._buffer[:]
del manager._companion_buffer[:]
with mock.patch('enlighten._manager.atexit') as atexit:
manager._set_scroll_area(force=True)
self.assertFalse(atexit.register.called)
self.assertEqual(manager._buffer,
[term.hide_cursor, term.csr(0, scroll_position),
term.move(scroll_position, 0)])
# Set max counter lower and make sure scroll_offset hasn't changed
manager.counters['dummy'] = 1
with mock.patch('enlighten._manager.atexit') as atexit:
manager._set_scroll_area()
self.assertEqual(manager.scroll_offset, 4)
def test_set_scroll_area_force(self):
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
manager.counters['dummy'] = 3
manager.scroll_offset = 4
manager.height = 20
scroll_position = manager.height - manager.scroll_offset
term = manager.term
with mock.patch('enlighten._manager.atexit') as atexit:
manager._set_scroll_area(force=True)
self.assertEqual(manager.scroll_offset, 4)
self.assertTrue(manager.process_exit)
self.assertEqual(manager._buffer,
[term.hide_cursor,
term.csr(0, scroll_position),
term.move(scroll_position, 0)])
self.assertEqual(manager._companion_buffer, [])
atexit.register.assert_called_with(manager._at_exit)
def test_at_exit(self):
tty = MockTTY()
try:
with mock.patch.object(tty, 'stdout', wraps=tty.stdout) as mockstdout:
manager = enlighten.Manager(stream=tty.stdout, counter_class=MockCounter)
term = manager.term
reset = (term.normal_cursor +
term.csr(0, term.height - 1) +
term.move(term.height, 0))
# process_exit is False
manager._at_exit()
self.assertFalse(mockstdout.flush.called)
# No output
tty.stdout.write(u'X\n')
self.assertEqual(tty.stdread.readline(), 'X\n')
# process_exit is True, set_scroll False
manager.process_exit = True
manager.set_scroll = False
manager._at_exit()
self.assertEqual(mockstdout.flush.call_count, 1)
self.assertEqual(tty.stdread.readline(), term.move(25, 0) + term.cud1)
# process_exit is True, set_scroll True
manager.set_scroll = True
manager._at_exit()
self.assertEqual(mockstdout.flush.call_count, 2)
self.assertEqual(tty.stdread.readline(), reset + term.cud1)
# Ensure companion stream gets flushed
manager.companion_stream = tty.stdout
manager._at_exit()
self.assertEqual(mockstdout.flush.call_count, 4)
self.assertEqual(tty.stdread.readline(), reset + term.cud1)
term = manager.term
finally:
# Ensure no errors if tty closes before _at_exit is called
tty.close()
manager._at_exit()
def test_stop(self):
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
term = manager.term
self.assertIsNone(manager.companion_term)
with mock.patch('enlighten._manager.atexit'):
manager._set_scroll_area()
self.assertEqual(manager.scroll_offset, 5)
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager._stage_resize)
self.assertTrue(manager.process_exit)
# Clear buffer
del manager._buffer[:]
manager.enabled = False
manager.stop()
# No output, No changes
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager._stage_resize)
self.assertTrue(manager.process_exit)
manager.enabled = True
manager.stop()
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager.sigwinch_orig)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(),
term.move(term.height - 2, 0) + term.clear_eol +
term.move(term.height - 1, 0) + term.clear_eol +
term.normal_cursor + term.csr(0, term.height - 1) +
term.move(term.height, 0) + 'X\n')
self.assertFalse(manager.process_exit)
self.assertFalse(manager.enabled)
for counter in manager.counters:
self.assertFalse(counter.enabled)
def test_stop_no_set_scroll(self):
"""
set_scroll is False
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
set_scroll=False)
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
term = manager.term
with mock.patch('enlighten._manager.atexit'):
with mock.patch.object(term, 'change_scroll'):
manager._set_scroll_area()
self.assertEqual(manager.scroll_offset, 5)
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager._stage_resize)
self.assertTrue(manager.process_exit)
# Stream empty
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
manager.stop()
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager.sigwinch_orig)
self.assertFalse(manager.process_exit)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(),
term.move(term.height - 2, 0) + term.clear_eol +
term.move(term.height - 1, 0) + term.clear_eol +
term.move(25, 0) + 'X\n')
def test_stop_never_used(self):
"""
In this case, _set_scroll_area() was never called
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
term = manager.term
self.assertFalse(manager.process_exit)
manager.stop()
self.assertEqual(signal.getsignal(signal.SIGWINCH), manager.sigwinch_orig)
# Only reset terminal
self.tty.stdout.write(u'X\n')
reset = term.normal_cursor + term.csr(0, term.height - 1) + term.move(term.height, 0)
self.assertEqual(self.tty.stdread.readline(), reset + 'X\n')
def test_stop_companion(self):
"""
In this case, we have a companion terminal
Just make sure we have an extra reset
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
companion_stream=self.tty.stdout)
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
term = manager.term
with mock.patch('enlighten._manager.atexit'):
manager._set_scroll_area()
del manager._buffer[:]
del manager._companion_buffer[:]
with mock.patch.object(manager, '_flush_streams'):
manager.stop()
self.assertEqual(manager._buffer,
[term.move(term.height - 2, 0), term.clear_eol,
term.move(term.height - 1, 0), term.clear_eol,
term.normal_cursor, term.csr(0, term.height - 1),
term.move(term.height, 0)])
self.assertEqual(manager._companion_buffer,
[term.normal_cursor, term.csr(0, term.height - 1),
term.move(term.height, 0)])
def test_stop_position_1(self):
"""
Ensure a line feed is given if there is a counter at position 1
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
term = manager.term
manager.counters[MockCounter(manager=manager)] = 3
with mock.patch.object(manager, '_flush_streams'):
manager.stop()
self.assertEqual(manager._buffer,
[term.normal_cursor, term.csr(0, term.height - 1),
term.move(term.height, 0)])
del manager._buffer[:]
manager.enabled = True
manager.counters[MockCounter(manager=manager)] = 1
with mock.patch.object(manager, '_flush_streams'):
manager.stop()
self.assertEqual(manager._buffer,
[term.normal_cursor, term.csr(0, term.height - 1),
term.move(term.height, 0), term.cud1 or '\n'])
def test_resize(self):
"""
Resize lock must be False for handler to run
Terminal size is cached unless resize handler runs
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
counter3 = MockCounter(manager=manager)
manager.counters[counter3] = 3
manager.scroll_offset = 4
term = manager.term
with mock.patch('%s.width' % TERMINAL, new_callable=mock.PropertyMock) as mockwidth:
mockwidth.return_value = 70
manager.resize_lock = True
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager._stage_resize()
self.assertFalse(ssa.called)
self.assertEqual(manager.width, 80)
self.assertTrue(manager.resize_lock)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
self.assertEqual(counter3.calls, [])
manager.resize_lock = False
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager._resize_handler()
self.assertEqual(ssa.call_count, 1)
self.assertEqual(manager.width, 70)
self.assertFalse(manager.resize_lock)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), term.move(21, 0) + term.clear_eos + 'X\n')
self.assertEqual(counter3.calls, ['refresh(flush=False, elapsed=None)'])
def test_threaded_eval(self):
"""
Dynamic value for threaded determined when scroll area is first set
"""
# Not dynamic if explicitly True
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
threaded=True)
self.assertTrue(manager.threaded)
with mock.patch('threading.active_count', return_value=4):
manager.counter()
self.assertTrue(manager.threaded)
# Not dynamic if explicitly False
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
threaded=False)
self.assertFalse(manager.threaded)
with mock.patch('threading.active_count', return_value=4):
manager.counter()
self.assertFalse(manager.threaded)
# False by default
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
self.assertIsNone(manager.threaded)
manager.counter()
self.assertFalse(manager.threaded)
# True if threaded
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
self.assertIsNone(manager.threaded)
with mock.patch('threading.active_count', return_value=4):
manager.counter()
self.assertTrue(manager.threaded)
# True if has child processes
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
self.assertIsNone(manager.threaded)
with mock.patch('multiprocessing.active_children', return_value=[1, 2]):
manager.counter()
self.assertTrue(manager.threaded)
# True if is child processes
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
self.assertIsNone(manager.threaded)
with mock.patch('multiprocessing.current_process') as c_process:
c_process.name = 'Process1'
manager.counter()
self.assertTrue(manager.threaded)
def test_resize_threaded(self):
"""
Test a resize event threading behavior
"""
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
threaded=True)
counter3 = MockCounter(manager=manager)
counter3.last_update = time.time()
manager.counters[counter3] = 3
manager.scroll_offset = 4
term = manager.term
# simulate resize
manager._stage_resize()
self.assertTrue(manager._resize)
self.assertEqual(counter3.last_update, 0)
with mock.patch('%s.width' % TERMINAL, new_callable=mock.PropertyMock) as mockwidth:
mockwidth.return_value = 70
# resize doesn't happen until a write is called
self.assertEqual(manager.width, 80)
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager.write()
self.assertEqual(ssa.call_count, 1)
self.assertEqual(manager.width, 70)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), term.move(21, 0) + term.clear_eos + 'X\n')
self.assertFalse(manager.resize_lock)
self.assertFalse(manager._resize)
self.assertEqual(counter3.calls, ['refresh(flush=False, elapsed=None)'])
def test_resize_handler_height_less(self):
with mock.patch('%s.height' % TERMINAL, new_callable=mock.PropertyMock) as mockheight:
mockheight.side_effect = [25, 23]
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter)
counter3 = MockCounter(manager=manager)
manager.counters[counter3] = 3
manager.scroll_offset = 4
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager._resize_handler()
self.assertEqual(ssa.call_count, 1)
self.assertEqual(manager.height, 23)
self.assertEqual(self.tty.stdread.readline(), manager.term.move(19, 0) + '\n')
for _ in range(5):
self.assertEqual(self.tty.stdread.readline(), '\n')
self.assertEqual(counter3.calls, ['refresh(flush=False, elapsed=None)'])
def test_resize_handler_height_greater_threaded(self):
with mock.patch('%s.height' % TERMINAL, new_callable=mock.PropertyMock) as mockheight:
mockheight.side_effect = [25, 27]
manager = enlighten.Manager(stream=self.tty.stdout, counter_class=MockCounter,
threaded=True)
counter3 = MockCounter(manager=manager)
manager.counters[counter3] = 3
manager.scroll_offset = 4
term = manager.term
with mock.patch('enlighten._manager.Manager._set_scroll_area') as ssa:
manager._resize_handler()
self.assertEqual(ssa.call_count, 1)
self.assertEqual(manager.height, 27)
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), term.move(27, 0) + '\n')
self.assertEqual(self.tty.stdread.readline(), '\n')
self.assertEqual(self.tty.stdread.readline(), '\n')
self.assertEqual(self.tty.stdread.readline(), term.move(23, 0) + term.clear_eos + 'X\n')
self.assertEqual(counter3.calls, ['refresh(flush=False, elapsed=None)'])
def test_disable(self):
mgr = enlighten.Manager(stream=self.tty.stdout, enabled=False)
self.assertFalse(mgr.enabled)
ctr = mgr.counter()
self.assertIsInstance(ctr, enlighten._counter.Counter)
self.assertFalse(ctr.enabled)
# Make sure this doesn't error
ctr.update()
ctr.update(4)
ctr.refresh()
ctr.close()
ctr.leave = False
ctr.close()
mgr.write()
mgr.stop()
# No Output
self.tty.stdout.write(u'X\n')
self.assertEqual(self.tty.stdread.readline(), 'X\n')
def test_context_manager(self):
mgr = None
with enlighten.Manager(stream=self.tty.stdout) as manager:
self.assertIsInstance(manager, _manager.Manager)
self.assertTrue(manager.enabled)
mgr = manager
self.assertFalse(mgr.enabled)
def test_no_resize_signal(self):
# Test normal case initialization
stdmgr = enlighten.Manager(stream=self.tty.stdout)
self.assertTrue(hasattr(stdmgr, 'sigwinch_orig'))
stdmgr.counters[MockCounter(manager=stdmgr)] = 3
stdmgr.counters[MockCounter(manager=stdmgr)] = 4
# Test no resize signal initialization
with mock.patch.object(_manager, 'RESIZE_SUPPORTED', False):
manager = enlighten.Manager(stream=self.tty.stdout)
self.assertFalse(hasattr(manager, 'sigwinch_orig'))
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
# Test set_scroll_area()
with mock.patch.object(_manager.signal, 'signal',
wraps=_manager.signal.signal) as mocksignal:
with mock.patch('enlighten._manager.atexit'):
# Test no resize signal set_scroll_area
with mock.patch.object(_manager, 'RESIZE_SUPPORTED', False):
with mock.patch.object(manager.term, 'change_scroll'):
manager._set_scroll_area()
self.assertFalse(mocksignal.called)
# Test normal case set_scroll_area
with mock.patch.object(stdmgr.term, 'change_scroll'):
stdmgr._set_scroll_area()
self.assertTrue(mocksignal.called)
# Test stop()
with mock.patch.object(_manager.signal, 'signal',
wraps=_manager.signal.signal) as mocksignal:
# Test no resize signal stop
with mock.patch.object(_manager, 'RESIZE_SUPPORTED', False):
manager.stop()
self.assertFalse(mocksignal.called)
# Test normal case stop
stdmgr.stop()
self.assertTrue(mocksignal.called)
def test_no_resize(self):
with mock.patch.object(_manager.signal, 'signal',
wraps=_manager.signal.signal) as mocksignal:
manager = enlighten.Manager(stream=self.tty.stdout, no_resize=True)
self.assertFalse(hasattr(manager, 'sigwinch_orig'))
self.assertFalse(mocksignal.called)
manager.counters[MockCounter(manager=manager)] = 3
manager.counters[MockCounter(manager=manager)] = 4
with mock.patch.object(manager.term, 'change_scroll'):
manager._set_scroll_area()
self.assertFalse(mocksignal.called)
manager.stop()
self.assertFalse(mocksignal.called)
class TestGetManager(TestCase):
def setUp(self):
self.tty = MockTTY()
def tearDown(self):
self.tty.close()
def test_get_manager_tty(self):
# stdout is attached to a tty
with redirect_output('__stdout__', self.tty.stdout):
self.assertTrue(sys.__stdout__.isatty())
manager = enlighten.get_manager(unit='knights')
self.assertIsInstance(manager, _manager.Manager)
self.assertTrue('unit' in manager.defaults)
self.assertTrue('enabled' in manager.defaults)
self.assertTrue(manager.enabled)
self.assertTrue(manager.defaults['enabled'])
@unittest.skipIf(STDOUT_NO_FD, 'No file descriptor for stdout')
def test_get_manager_no_tty(self):
# stdout is not attached to a tty
with redirect_output('__stdout__', OUTPUT):
self.assertFalse(sys.__stdout__.isatty())
manager = enlighten.get_manager(unit='knights')
self.assertIsInstance(manager, _manager.Manager)
self.assertTrue('unit' in manager.defaults)
self.assertFalse(manager.enabled)
self.assertTrue('enabled' in manager.defaults)
self.assertFalse(manager.defaults['enabled'])
|