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
|
import unittest
from datetime import datetime
from unittest.mock import MagicMock, patch
from random import randint
import os
import sys
from asciimatics.effects import Print, Cycle, BannerText, Mirage, Scroll, \
Stars, Matrix, Snow, Wipe, Clock, Cog, RandomNoise, Julia, Sprite
from asciimatics.paths import Path
from asciimatics.renderers import FigletText, StaticRenderer
from asciimatics.scene import Scene
from asciimatics.screen import Screen, Canvas
from asciimatics.sprites import Sam
from tests.mock_objects import MockEffect
if sys.platform != "win32":
import curses
class TestEffects(unittest.TestCase):
def assert_blank(self, canvas):
"""
Check that a specified canvas is blank.
"""
for x in range(canvas.width):
for y in range(canvas.height):
self.assertEqual(canvas.get_from(x, y), (32, 7, 0, 0))
@staticmethod
def check_canvas(canvas, my_buffer, assert_fn):
changed = False
for x in range(canvas.width):
for y in range(canvas.height):
value = canvas.get_from(x, y)
assert_fn(value)
if value != my_buffer[y][x]:
changed = True
my_buffer[y][x] = value
return changed
def test_text_effects(self):
"""
Check effects can be played.
"""
# Skip for non-Windows if the terminal definition is incomplete.
# This typically means we're running inside a non-standard termina;.
# For example, thi happens when embedded in PyCharm.
if sys.platform != "win32":
if not (("FORCE_TTY" in os.environ and os.environ["FORCE_TTY"] == "Y") or sys.stdout.isatty()):
self.skipTest("Not a valid TTY")
curses.initscr()
if curses.tigetstr("ri") is None:
self.skipTest("No valid terminal definition")
# A lot of effects are just about the visual output working when played
# so check that playing a load of text effects doesn't crash.
#
# It's really not a great test, but it's important to show Effects are
# dynamically compatible with Screen.play().
def internal_checks(screen):
screen.play([
Scene([
MockEffect(count=5),
Print(screen, FigletText("hello"), 2),
Cycle(screen, FigletText("world"), 6),
BannerText(screen, FigletText("world"), 10, 3),
Mirage(screen, FigletText("huh?"), 14, 2)], 0)])
Screen.wrapper(internal_checks, height=25)
def test_scroll(self):
"""
Check that Scroll works.
"""
# Check that it will attempt to scroll the screen at the required rate.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
effect = Scroll(screen, 2)
effect.reset()
effect.update(1)
screen.scroll.assert_not_called()
effect.update(2)
screen.scroll.assert_called_once()
# Check there is no stop frame
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_cycle(self):
"""
Check that Cycle works.
"""
# Check that cycle swaps colours every other frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
effect = Cycle(screen, StaticRenderer(images=["hello"]), 2)
effect.reset()
# First 2 calls should do nothing and use black.
effect.update(0)
screen.centre.assert_not_called()
effect.update(1)
screen.centre.assert_called_with("hello", 2, 0)
# Next 2 calls should do nothing and use red.
screen.centre.reset_mock()
effect.update(2)
screen.centre.assert_not_called()
effect.update(3)
screen.centre.assert_called_with("hello", 2, 1)
# Check there is no stop frame
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_banner(self):
"""
Check that BannerText works.
"""
# Check that banner redraws every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 10, 0, 0)
effect = BannerText(canvas, StaticRenderer(images=["hello"]), 2, 3)
effect.reset()
effect.update(0)
self.assertEqual(canvas.get_from(canvas.width - 1, 2),
(ord("h"), 3, 0, 0))
effect.update(1)
self.assertEqual(canvas.get_from(canvas.width - 1, 2),
(ord("e"), 3, 0, 0))
my_buffer = [[(32, 7, 0, 0) for _ in range(10)] for _ in range(10)]
for i in range(2, 12):
effect.update(i)
self.assertTrue(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), " helo")))
# Check there is some stop frame - will vary according to screen width
self.assertGreater(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_print(self):
"""
Check that the Print Effect works.
"""
# Check that print only redraws on specified rate.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
effect = Print(screen, StaticRenderer(images=["hello"]), 2, 1)
effect.reset()
effect.update(0)
screen.paint.assert_called_with(
"hello", 1, 2, 7,
attr=0,
bg=0,
colour_map=[(None, None, None) for _ in range(5)],
transparent=True)
screen.paint.reset_mock()
effect.update(1)
effect.update(2)
effect.update(3)
screen.paint.assert_not_called()
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_print_clear(self):
"""
Check that clear option works on Print.
"""
# Check that Stars randomly updates the Screen every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Print(canvas, StaticRenderer(images=["hello"]), 2, 1, clear=True, stop_frame=20)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
# Should only update on first iteration
for i in range(20):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), " helo")), i in (0,19), f"Stopped on {i}")
# Should be clear by now.
self.assert_blank(canvas)
def test_mirage(self):
"""
Check that Mirage works.
"""
# Check that Mirage randomly updates the Screen every other frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Mirage(canvas, FigletText("hello"), 3, 1)
effect.reset()
effect.update(0)
self.assert_blank(canvas)
effect.update(1)
changed = False
for x in range(canvas.width):
for y in range(canvas.height):
if canvas.get_from(x, y) != (32, 7, 0, 0):
changed = True
self.assertTrue(changed)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_stars(self):
"""
Check that Stars works.
"""
# Check that Stars randomly updates the Screen every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Stars(canvas, 100)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(10):
effect.update(i)
self.assertTrue(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), " .+x*")))
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_stars_pattern(self):
"""
Check that Stars custom pattern value works.
"""
# Check that Stars randomly updates the Screen every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Stars(canvas, 100, "TESTTESTTEST")
effect.reset()
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(10):
effect.update(i)
self.assertTrue(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), " TES")))
def test_matrix(self):
"""
Check that the Matrix works.
"""
# Check that Matrix randomly updates the Screen every other frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Matrix(canvas)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(10):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertTrue(value[0] == 32 or value[1] == 2)),
i % 2 == 0)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_snow(self):
"""
Check that Snow works.
"""
# Check that Snow randomly updates the Screen every 3rd frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Snow(canvas)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(60):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), ".+* ,;#@")),
i % 3 == 0)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_wipe(self):
"""
Check that Wipe works.
"""
# Check that Wipe clears lines going down the screen.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Wipe(canvas)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for x in range(canvas.width):
for y in range(canvas.height):
canvas.print_at(chr(randint(1, 128)), x, y)
my_buffer[y][x] = canvas.get_from(x, y)
for i in range(10):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
i % 2 == 0)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
@patch("datetime.datetime")
def test_clock(self, mock_datetime):
"""
Check that Clock works.
"""
# Check that Clock updates every second.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
mock_datetime.now.return_value = datetime
mock_datetime.side_effect = lambda *args, **kw: datetime(*args, **kw)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Clock(canvas, 10, 5, 5)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
# Set a time for the next update and check it is drawn.
mock_datetime.now.return_value = \
datetime(1900, 1, 2, 3, 59, 40)
effect.update(0)
mock_datetime.now.assert_called()
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
True)
# Check redrawing with the same time has no effect.
mock_datetime.now.reset_mock()
mock_datetime.now.return_value = \
datetime(1900, 1, 2, 3, 59, 40)
effect.update(1)
mock_datetime.now.assert_called()
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
False)
# Check a new time results in an update.
mock_datetime.now.reset_mock()
mock_datetime.now.return_value = \
datetime(1900, 1, 2, 3, 59, 41)
effect.update(2)
mock_datetime.now.assert_called()
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
True)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_sprite(self):
"""
Check that Sprites work.
"""
# Check that we can move a Sprite around the screen.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
path = Path()
path.jump_to(10, 5)
path.move_straight_to(20, 10, 5)
path.move_straight_to(30, 5, 5)
path.move_straight_to(20, 0, 5)
path.move_straight_to(10, 5, 5)
effect = Sam(canvas, path)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(30):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
i % 2 == 0, "Bad update on frame %d" % i)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# Static paths should pay no attention to events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_sprite_speed(self):
"""
Check that Sprites speed parameter .
"""
# Check that sprite only redraws on specified rate.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
path = Path()
path.jump_to(10, 5)
effect = Sprite(
screen,
renderer_dict={
"default": StaticRenderer(images=["X"])
},
path=path)
effect.reset()
effect.update(0)
screen.paint.assert_called_with('X', 10, 5, 7, colour_map=[(None, None, None)])
screen.paint.reset_mock()
effect.update(1)
screen.paint.assert_not_called()
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_sprite_overlap(self):
"""
Check that Sprites detect overlap.
"""
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
path = Path()
path.jump_to(10, 5)
effect1 = Sam(canvas, path)
effect2 = Sam(canvas, path)
# These 2 sprites should overlap!
effect1.reset()
effect1.update(0)
effect2.reset()
effect2.update(0)
self.assertTrue(effect1.overlaps(effect2))
# Now create a sprite that shouldn't quite overlap
width = effect1.last_position()[2]
path = Path()
path.jump_to(10 + width, 5)
effect2 = Sam(canvas, path)
effect2.reset()
effect2.update(0)
self.assertFalse(effect1.overlaps(effect2))
def test_cog(self):
"""
Check that Cog works.
"""
# Check that Cog updates the Screen every other frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Cog(canvas, 10, 5, 5)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(20):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(
chr(value[0]), " ''^.|/7.\\|Ywbd#")),
i % 2 == 0)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_noise(self):
"""
Check that RandomNoise works.
"""
# Check that RandomNoise updates every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = RandomNoise(canvas, signal=StaticRenderer(images=["hello world!"]))
effect.reset()
effect._step = 0.1
effect2 = RandomNoise(canvas)
effect2.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(30):
effect.update(i)
effect2.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertLess(value[0], 129)),
True)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
def test_julia(self):
"""
Check that Julia works.
"""
# Check that Julia updates every frame.
screen = MagicMock(spec=Screen, colours=8, unicode_aware=False)
canvas = Canvas(screen, 10, 40, 0, 0)
effect = Julia(canvas)
effect.reset()
self.assert_blank(canvas)
my_buffer = [[(32, 7, 0, 0) for _ in range(40)] for _ in range(10)]
for i in range(20):
effect.update(i)
self.assertEqual(self.check_canvas(
canvas,
my_buffer,
lambda value: self.assertIn(chr(value[0]), '@&9#GHh32As;:. ')),
True)
# Check there is no stop frame by default.
self.assertEqual(effect.stop_frame, 0)
# This effect should ignore events.
event = object()
self.assertEqual(event, effect.process_event(event))
if __name__ == '__main__':
unittest.main()
|