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
|
# -*- coding: utf-8 -*-
"""
Tests for the uflash module.
"""
import ctypes
import os
import os.path
import sys
import tempfile
import time
import threading
import pytest
import uflash
try:
from unittest import mock
except ImportError:
import mock
else:
# mock_open can't read binary data in < 3.4.3
# https://bugs.python.org/issue23004
if (3, 4) <= sys.version_info < (3, 4, 3):
import mock
if sys.version_info.major == 2:
import __builtin__ as builtins
else:
import builtins
TEST_SCRIPT = b"""from microbit import *
display.scroll('Hello, World!')
"""
def test_get_version():
"""
Ensure a call to get_version returns the expected string.
"""
result = uflash.get_version()
assert result == '.'.join([str(i) for i in uflash._VERSION])
def test_get_minifier():
"""
When a minifier was loaded a string identifing it should be
returned, otherwise None
"""
with mock.patch('uflash.can_minify', False):
assert uflash.get_minifier() is None
with mock.patch('uflash.can_minify', True):
assert len(uflash.get_minifier()) > 0
def test_hexlify():
"""
Ensure we get the expected .hex encoded result from a "good" call to the
function.
"""
result = uflash.hexlify(TEST_SCRIPT)
lines = result.split()
# The first line should be the extended linear address, ox0003
assert lines[0] == ':020000040003F7'
# There should be the expected number of lines.
assert len(lines) == 5
def test_unhexlify():
"""
Ensure that we can get the script back out using unhexlify and that the
result is a properly decoded string.
"""
hexlified = uflash.hexlify(TEST_SCRIPT)
unhexlified = uflash.unhexlify(hexlified)
assert unhexlified == TEST_SCRIPT.decode('utf-8')
def test_unhexlify_not_python():
"""
Test that the MicroPython script start format is present.
"""
assert '' == uflash.unhexlify(
':020000040003F7\n:10E000000000000000000000000000000000000010')
def test_unhexlify_bad_unicode():
"""
Test that invalid Unicode is dealt gracefully returning an empty string.
"""
assert '' == uflash.unhexlify(
':020000040003F7\n:10E000004D50FFFFFFFFFFFFFFFFFFFFFFFFFFFFFF')
def test_hexlify_empty_script():
"""
The function returns an empty string if the script is empty.
"""
assert uflash.hexlify('') == ''
def test_embed_hex():
"""
Ensure the good case works as expected.
"""
python = uflash.hexlify(TEST_SCRIPT)
result = uflash.embed_hex(uflash._RUNTIME, python)
# The resulting hex should be of the expected length.
assert len(result) == len(python) + len(uflash._RUNTIME) + 1 # +1 for \n
# The hex should end with a newline '\n'
assert result[-1:] == '\n'
# The Python hex should be in the correct location.
py_list = python.split()
result_list = result.split()
start_of_python_from_end = len(py_list) + 5
start_of_python = len(result_list) - start_of_python_from_end
assert result_list[start_of_python:-5] == py_list
# The firmware should enclose the Python correctly.
firmware_list = uflash._RUNTIME.split()
assert firmware_list[:-5] == result_list[:-start_of_python_from_end]
assert firmware_list[-5:] == result_list[-5:]
def test_embed_no_python():
"""
The function returns the firmware hex value if there is no Python hex.
"""
assert uflash.embed_hex('foo') == 'foo'
def test_embed_no_runtime():
"""
The function raises a ValueError if there is no runtime hex.
"""
with pytest.raises(ValueError) as ex:
uflash.embed_hex(None)
assert ex.value.args[0] == 'MicroPython runtime hex required.'
def test_extract():
"""
The script should be returned as a string (if there is one).
"""
python = uflash.hexlify(TEST_SCRIPT)
result = uflash.embed_hex(uflash._RUNTIME, python)
extracted = uflash.extract_script(result)
assert extracted == TEST_SCRIPT.decode('utf-8')
def test_extract_sandwiched():
"""
The script hex is packed with additional data above and bellow and should
still be returned as a the original string only.
"""
python = uflash.hexlify(TEST_SCRIPT)
python_hex_lines = python.split('\n')
python_sandwiched = [python_hex_lines[0]] + \
[':10DFE000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF41'] + \
python_hex_lines[1:] + [':10E50000FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF1B']
result = uflash.embed_hex(uflash._RUNTIME, '\n'.join(python_sandwiched))
extracted = uflash.extract_script(result)
assert extracted == TEST_SCRIPT.decode('utf-8')
def test_extract_not_valid_hex():
"""
Return a sensible message if the hex file isn't valid
"""
assert uflash.extract_script('invalid input') == ''
def test_extract_no_python():
"""
Ensure that if there's no Python in the input hex then just return an empty
(False) string.
"""
assert uflash.extract_script(uflash._RUNTIME) == ''
def test_find_microbit_posix_exists():
"""
Simulate being on os.name == 'posix' and a call to "mount" returns a
record indicating a connected micro:bit device.
"""
with open('tests/mount_exists.txt', 'rb') as fixture_file:
fixture = fixture_file.read()
with mock.patch('os.name', 'posix'):
with mock.patch('uflash.check_output', return_value=fixture):
assert uflash.find_microbit() == '/media/ntoll/MICROBIT'
def test_find_microbit_posix_missing():
"""
Simulate being on os.name == 'posix' and a call to "mount" returns a
no records associated with a micro:bit device.
"""
with open('tests/mount_missing.txt', 'rb') as fixture_file:
fixture = fixture_file.read()
with mock.patch('os.name', 'posix'):
with mock.patch('uflash.check_output', return_value=fixture):
assert uflash.find_microbit() is None
def test_find_microbit_nt_exists():
"""
Simulate being on os.name == 'nt' and a disk with a volume name 'MICROBIT'
exists indicating a connected micro:bit device.
"""
mock_windll = mock.MagicMock()
mock_windll.kernel32 = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW.return_value = None
#
# Have every drive claim to be removable
#
mock_windll.kernel32.GetDriveTypeW = mock.MagicMock()
mock_windll.kernel32.GetDriveTypeW.return_value = 2
with mock.patch('os.name', 'nt'):
with mock.patch('os.path.exists', return_value=True):
return_value = ctypes.create_unicode_buffer('MICROBIT')
with mock.patch('ctypes.create_unicode_buffer',
return_value=return_value):
ctypes.windll = mock_windll
assert uflash.find_microbit() == 'A:\\'
def test_find_microbit_nt_missing():
"""
Simulate being on os.name == 'nt' and a disk with a volume name 'MICROBIT'
does not exist for a micro:bit device.
"""
mock_windll = mock.MagicMock()
mock_windll.kernel32 = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW.return_value = None
with mock.patch('os.name', 'nt'):
with mock.patch('os.path.exists', return_value=True):
return_value = ctypes.create_unicode_buffer(1024)
with mock.patch('ctypes.create_unicode_buffer',
return_value=return_value):
ctypes.windll = mock_windll
assert uflash.find_microbit() is None
def test_find_microbit_nt_removable_only():
"""
We should only be considering removable drives as candidates for
micro:bit devices. (Especially so as to avoid interrogating disconnected
network drives).
Have every drive claim to be a micro:bit, but only drive B: claim
to be removable
"""
def _drive_type(letter):
if letter == "B:\\":
return 2 # removable
else:
return 4 # network
mock_windll = mock.MagicMock()
mock_windll.kernel32 = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW = mock.MagicMock()
mock_windll.kernel32.GetVolumeInformationW.return_value = None
mock_windll.kernel32.GetDriveTypeW = mock.MagicMock()
mock_windll.kernel32.GetDriveTypeW.side_effect = _drive_type
with mock.patch('os.name', 'nt'):
with mock.patch('os.path.exists', return_value=True):
return_value = ctypes.create_unicode_buffer('MICROBIT')
with mock.patch('ctypes.create_unicode_buffer',
return_value=return_value):
ctypes.windll = mock_windll
assert uflash.find_microbit() == 'B:\\'
def test_find_microbit_unknown_os():
"""
Raises a NotImplementedError if the host OS is not supported.
"""
with mock.patch('os.name', 'foo'):
with pytest.raises(NotImplementedError) as ex:
uflash.find_microbit()
assert ex.value.args[0] == 'OS "foo" not supported.'
def test_save_hex():
"""
Ensure the good case works.
"""
# Ensure we have a temporary file to write to that doesn't already exist.
path_to_hex = os.path.join(tempfile.gettempdir(), 'microbit.hex')
if os.path.exists(path_to_hex):
os.remove(path_to_hex)
assert not os.path.exists(path_to_hex)
# Create the hex file we want to "flash"
python = uflash.hexlify(TEST_SCRIPT)
hex_file = uflash.embed_hex(uflash._RUNTIME, python)
# Save the hex.
uflash.save_hex(hex_file, path_to_hex)
# Ensure the hex has been written as expected.
assert os.path.exists(path_to_hex)
with open(path_to_hex) as written_file:
assert written_file.read() == hex_file
def test_save_hex_no_hex():
"""
The function raises a ValueError if no hex content is provided.
"""
with pytest.raises(ValueError) as ex:
uflash.save_hex('', 'foo')
assert ex.value.args[0] == 'Cannot flash an empty .hex file.'
def test_save_hex_path_not_to_hex_file():
"""
The function raises a ValueError if the path is NOT to a .hex file.
"""
with pytest.raises(ValueError) as ex:
uflash.save_hex('foo', '')
assert ex.value.args[0] == 'The path to flash must be for a .hex file.'
def test_flash_no_args():
"""
The good case with no arguments to the flash() function. When it's
possible to find a path to the micro:bit.
If no path to a Python script is supplied then just flash the unmodified
MicroPython firmware onto the device.
"""
with mock.patch('uflash.find_microbit', return_value='foo'):
with mock.patch('uflash.save_hex') as mock_save:
uflash.flash()
assert mock_save.call_count == 1
assert mock_save.call_args[0][0] == uflash._RUNTIME
expected_path = os.path.join('foo', 'micropython.hex')
assert mock_save.call_args[0][1] == expected_path
def test_flash_has_python_no_path_to_microbit():
"""
The good case with a path to a Python file. When it's possible to find a
path to the micro:bit.
The resulting payload should be a correctly created micropython.hex file.
"""
with mock.patch('uflash.find_microbit', return_value='foo'):
with mock.patch('uflash.save_hex') as mock_save:
uflash.flash('tests/example.py')
assert mock_save.call_count == 1
# Create the hex we're expecting to flash onto the device.
with open('tests/example.py', 'rb') as py_file:
python = uflash.hexlify(py_file.read())
assert python
expected_hex = uflash.embed_hex(uflash._RUNTIME, python)
assert mock_save.call_args[0][0] == expected_hex
expected_path = os.path.join('foo', 'micropython.hex')
assert mock_save.call_args[0][1] == expected_path
def test_flash_with_path_to_multiple_microbits():
"""
Flash the referenced paths to the micro:bit with a hex file generated from
the MicroPython firmware and the referenced Python script.
"""
with mock.patch('uflash.save_hex') as mock_save:
uflash.flash('tests/example.py', ['test_path1', 'test_path2'])
assert mock_save.call_count == 2
# Create the hex we're expecting to flash onto the device.
with open('tests/example.py', 'rb') as py_file:
python = uflash.hexlify(py_file.read())
assert python
expected_hex = uflash.embed_hex(uflash._RUNTIME, python)
assert mock_save.call_args_list[0][0][0] == expected_hex
expected_path = os.path.join('test_path1', 'micropython.hex')
assert mock_save.call_args_list[0][0][1] == expected_path
assert mock_save.call_args_list[1][0][0] == expected_hex
expected_path = os.path.join('test_path2', 'micropython.hex')
assert mock_save.call_args_list[1][0][1] == expected_path
def test_flash_with_path_to_microbit():
"""
Flash the referenced path to the micro:bit with a hex file generated from
the MicroPython firmware and the referenced Python script.
"""
with mock.patch('uflash.save_hex') as mock_save:
uflash.flash('tests/example.py', ['test_path'])
assert mock_save.call_count == 1
# Create the hex we're expecting to flash onto the device.
with open('tests/example.py', 'rb') as py_file:
python = uflash.hexlify(py_file.read())
assert python
expected_hex = uflash.embed_hex(uflash._RUNTIME, python)
assert mock_save.call_args[0][0] == expected_hex
expected_path = os.path.join('test_path', 'micropython.hex')
assert mock_save.call_args[0][1] == expected_path
def test_flash_with_path_to_runtime():
"""
Use the referenced runtime hex file when building the hex file to be
flashed onto the device.
"""
mock_o = mock.mock_open(read_data=b'script')
with mock.patch.object(builtins, 'open', mock_o) as mock_open:
with mock.patch('uflash.embed_hex', return_value='foo') as em_h:
with mock.patch('uflash.find_microbit', return_value='bar'):
with mock.patch('uflash.save_hex') as mock_save:
uflash.flash('tests/example.py',
path_to_runtime='tests/fake.hex')
assert mock_open.call_args[0][0] == 'tests/fake.hex'
assert em_h.call_args[0][0] == b'script'
expected_hex_path = os.path.join('bar', 'micropython.hex')
mock_save.assert_called_once_with('foo', expected_hex_path)
def test_flash_with_python_script():
"""
If a byte representation of a Python script is passed into the function it
should hexlify that.
"""
python_script = b'import this'
with mock.patch('uflash.save_hex'):
with mock.patch('uflash.find_microbit', return_value='bar'):
with mock.patch('uflash.hexlify') as mock_hexlify:
uflash.flash(python_script=python_script)
mock_hexlify.assert_called_once_with(python_script, False)
def test_flash_cannot_find_microbit():
"""
Ensure an IOError is raised if it is not possible to find the micro:bit.
"""
with mock.patch('uflash.find_microbit', return_value=None):
with pytest.raises(IOError) as ex:
uflash.flash()
expected = 'Unable to find micro:bit. Is it plugged in?'
assert ex.value.args[0] == expected
def test_flash_wrong_python():
"""
Ensures a call to flash will fail if it's not reported that we're using
Python 3.
"""
for version in [(2, 6, 3), (3, 2, 0)]:
with pytest.raises(RuntimeError) as ex:
with mock.patch('sys.version_info', version):
uflash.flash()
assert 'Will only run on Python ' in ex.value.args[0]
def test_hexlify_minify_without_minifier():
"""
When minification but no minifier is available a ValueError
should be raised
"""
with pytest.raises(ValueError):
with mock.patch('uflash.can_minify', False):
uflash.hexlify(TEST_SCRIPT, minify=True)
def test_hexlify_minify():
"""
Check mangle is called as expected
"""
with mock.patch('nudatus.mangle') as mangle:
uflash.hexlify(TEST_SCRIPT, minify=True)
mangle.assert_called_once_with(TEST_SCRIPT.decode('utf-8'))
def test_main_no_args():
"""
If there are no args into the main function, it simply calls flash with
no arguments.
"""
with mock.patch('sys.argv', ['uflash', ]):
with mock.patch('uflash.flash') as mock_flash:
uflash.main()
mock_flash.assert_called_once_with(path_to_python=None,
paths_to_microbits=[],
path_to_runtime=None,
minify=False)
def test_main_first_arg_python():
"""
If there is a single argument that ends with ".py", it calls flash with
it as the path to the source Python file.
"""
with mock.patch('uflash.flash') as mock_flash:
uflash.main(argv=['foo.py'])
mock_flash.assert_called_once_with(path_to_python='foo.py',
paths_to_microbits=[],
path_to_runtime=None,
minify=False)
def test_main_first_arg_help(capsys):
"""
If there is a single argument of "--help", it prints some help and exits.
"""
with pytest.raises(SystemExit):
uflash.main(argv=['--help'])
stdout, _ = capsys.readouterr()
# argparse manipulates the help text (e.g. changes line wrap)
# so it isn't trivial to compare the output to uflash._HELP_TEXT.
expected = 'Flash Python onto the BBC micro:bit'
assert expected in stdout
def test_main_first_arg_version(capsys):
"""
If there is a single argument of "--version", it prints the version
and exits.
"""
with pytest.raises(SystemExit):
uflash.main(argv=['--version'])
stdout, stderr = capsys.readouterr()
expected = uflash.get_version()
# On python 2 --version prints to stderr. On python 3 to stdout.
# https://bugs.python.org/issue18920
assert (expected in stdout) or (expected in stderr)
def test_main_first_arg_not_python(capsys):
"""
If the first argument does not end in ".py" then it should display a useful
error message.
"""
with pytest.raises(SystemExit):
uflash.main(argv=['foo.bar'])
_, stderr = capsys.readouterr()
expected = 'Python files must end in ".py".'
assert expected in stderr
def test_flash_raises(capsys):
"""
If the flash system goes wrong, it should say that's what happened
"""
with mock.patch('uflash.flash', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['test.py'])
_, stderr = capsys.readouterr()
expected = 'Error flashing test.py'
assert expected in stderr
def test_flash_raises_with_info(capsys):
"""
When flash goes wrong it should mention everything you tell it
"""
with mock.patch('uflash.flash', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['test.py'])
_, stderr = capsys.readouterr()
expected = 'Error flashing test.py to microbit: boom\n'
assert stderr == expected
with mock.patch('uflash.flash', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['test.py', 'D:\\'])
_, stderr = capsys.readouterr()
expected = 'Error flashing test.py to ' + repr(['D:\\']) + ': boom\n'
assert stderr == expected
with mock.patch('uflash.flash', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['-r', 'foo.hex', 'test.py', 'D:\\'])
_, stderr = capsys.readouterr()
expected = 'Error flashing test.py to ' + repr(['D:\\']) + \
'with runtime foo.hex: boom\n'
assert stderr == expected
def test_watch_raises(capsys):
"""
If the watch system goes wrong, it should say that's what happened
"""
with mock.patch('uflash.watch_file', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['--watch', 'test.py'])
_, stderr = capsys.readouterr()
expected = 'Error watching test.py'
assert expected in stderr
def test_extract_raises(capsys):
"""
If the extract system goes wrong, it should say that's what happened
"""
with mock.patch('uflash.extract', side_effect=RuntimeError("boom")):
with pytest.raises(SystemExit):
uflash.main(argv=['--extract', 'test.py'])
_, stderr = capsys.readouterr()
expected = 'Error extracting test.py'
assert expected in stderr
def test_main_two_args():
"""
If there are two arguments passed into main, then it should pass them onto
the flash() function.
"""
with mock.patch('uflash.flash', return_value=None) as mock_flash:
uflash.main(argv=['foo.py', '/media/foo/bar'])
mock_flash.assert_called_once_with(
path_to_python='foo.py',
paths_to_microbits=['/media/foo/bar'],
path_to_runtime=None,
minify=False)
def test_main_multiple_microbits():
"""
If there are more than two arguments passed into main, then it should pass
them onto the flash() function.
"""
with mock.patch('uflash.flash', return_value=None) as mock_flash:
uflash.main(argv=[
'foo.py', '/media/foo/bar', '/media/foo/baz', '/media/foo/bob'])
mock_flash.assert_called_once_with(
path_to_python='foo.py',
paths_to_microbits=[
'/media/foo/bar', '/media/foo/baz', '/media/foo/bob'],
path_to_runtime=None,
minify=False)
def test_main_runtime():
"""
If there are three arguments passed into main, then it should pass them
onto the flash() function.
"""
with mock.patch('uflash.flash') as mock_flash:
uflash.main(argv=['-r' 'baz.hex', 'foo.py', '/media/foo/bar'])
mock_flash.assert_called_once_with(
path_to_python='foo.py',
paths_to_microbits=['/media/foo/bar'],
path_to_runtime='baz.hex',
minify=False)
def test_main_named_args():
"""
Ensure that named arguments are passed on properly to the flash() function.
"""
with mock.patch('uflash.flash') as mock_flash:
uflash.main(argv=['-r', 'baz.hex'])
mock_flash.assert_called_once_with(path_to_python=None,
paths_to_microbits=[],
path_to_runtime='baz.hex',
minify=False)
def test_main_watch_flag():
"""
The watch flag cause a call the correct function.
"""
with mock.patch('uflash.watch_file') as mock_watch_file:
uflash.main(argv=['-w'])
mock_watch_file.assert_called_once_with(None,
uflash.flash,
path_to_python=None,
paths_to_microbits=[],
path_to_runtime=None)
def test_extract_command():
"""
Test the command-line script extract feature
"""
with mock.patch('uflash.extract') as mock_extract:
uflash.main(argv=['-e', 'hex.hex', 'foo.py'])
mock_extract.assert_called_once_with('hex.hex', ['foo.py'])
def test_extract_paths():
"""
Test the different paths of the extract() function.
It should open and extract the contents of the file (input arg)
When called with only an input it should print the output of extract_script
When called with two arguments it should write the output to the output arg
"""
mock_e = mock.MagicMock(return_value=b'print("hello, world!")')
mock_o = mock.mock_open(read_data='script')
with mock.patch('uflash.extract_script', mock_e) as mock_extract_script, \
mock.patch.object(builtins, 'print') as mock_print, \
mock.patch.object(builtins, 'open', mock_o) as mock_open:
uflash.extract('foo.hex')
mock_open.assert_called_once_with('foo.hex', 'r')
mock_extract_script.assert_called_once_with('script')
mock_print.assert_called_once_with(b'print("hello, world!")')
uflash.extract('foo.hex', 'out.py')
assert mock_open.call_count == 3
mock_open.assert_called_with('out.py', 'w')
assert mock_open.return_value.write.call_count == 1
def test_extract_command_source_only():
"""
If there is no target file the extract command should write to stdout.
"""
mock_e = mock.MagicMock(return_value=b'print("hello, world!")')
mock_o = mock.mock_open(read_data='script')
with mock.patch('uflash.extract_script', mock_e) as mock_extract_script, \
mock.patch.object(builtins, 'open', mock_o) as mock_open, \
mock.patch.object(builtins, 'print') as mock_print:
uflash.main(argv=['-e', 'hex.hex'])
mock_open.assert_any_call('hex.hex', 'r')
mock_extract_script.assert_called_once_with('script')
mock_print.assert_any_call(b'print("hello, world!")')
def test_extract_command_no_source():
"""
If there is no source file the extract command should complain
"""
with pytest.raises(TypeError):
uflash.extract(None, None)
def test_watch_no_source():
"""
If there is no source file the watch command should complain.
"""
with pytest.raises(ValueError):
uflash.watch_file(None, lambda: "should never be called!")
@mock.patch('uflash.time')
@mock.patch('uflash.os')
def test_watch_file(mock_os, mock_time):
"""
Make sure that the callback is called each time the file changes.
"""
# Our function will throw KeyboardInterrupt when called for the 2nd time,
# ending the watching gracefully.This will help in testing the
# watch_file function.
call_count = [0]
def func():
call_count[0] = call_count[0] + 1
if call_count[0] == 2:
raise KeyboardInterrupt()
# Instead of modifying any file, let's change the return value of
# os.path.getmtime. Start with initial value of 0.
mock_os.path.getmtime.return_value = 0
t = threading.Thread(target=uflash.watch_file,
args=('path/to/file', func))
t.start()
time.sleep(0.01)
mock_os.path.getmtime.return_value = 1 # Simulate file change
time.sleep(0.01)
assert t.is_alive()
assert call_count[0] == 1
mock_os.path.getmtime.return_value = 2 # Simulate file change
t.join()
assert call_count[0] == 2
def test_hexlify_validates_script_length():
input = b"A" * 8193
with pytest.raises(ValueError) as excinfo:
uflash.hexlify(input)
assert str(excinfo.value) == "Python script must be less than 8188 bytes."
|