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
|
import os
import sys
import tempfile
import textwrap
import locale
locale # quiet pyflakes
from pathlib import PurePath, Path
from io import StringIO, BytesIO
from threading import Thread
import time
from sys import executable
from unittest.mock import Mock
import pytest
from doit import action
from doit.exceptions import TaskError, TaskFailed
#path to test folder
TEST_PATH = os.path.dirname(__file__)
PROGRAM = "%s %s/sample_process.py" % (executable, TEST_PATH)
@pytest.fixture
def tmpfile(request):
temp = tempfile.TemporaryFile('w+')
request.addfinalizer(temp.close)
return temp
class FakeTask(object):
def __init__(self, file_dep, dep_changed, targets, options,
pos_arg=None, pos_arg_val=None):
self.name = "Fake"
self.file_dep = file_dep
self.dep_changed = dep_changed
self.targets = targets
self.options = options
self.pos_arg = pos_arg
self.pos_arg_val = pos_arg_val
############# CmdAction
class TestCmdAction(object):
# if nothing is raised it is successful
def test_success(self):
my_action = action.CmdAction(PROGRAM)
got = my_action.execute()
assert got is None
def test_success_noshell(self):
my_action = action.CmdAction(PROGRAM.split(), shell=False)
got = my_action.execute()
assert got is None
def test_error(self):
my_action = action.CmdAction("%s 1 2 3" % PROGRAM)
got = my_action.execute()
assert isinstance(got, TaskError)
def test_env(self):
env = os.environ.copy()
env['GELKIPWDUZLOVSXE'] = '1'
my_action = action.CmdAction("%s check env" % PROGRAM, env=env)
got = my_action.execute()
assert got is None
def test_failure(self):
my_action = action.CmdAction("%s please fail" % PROGRAM)
got = my_action.execute()
assert isinstance(got, TaskFailed)
def test_str(self):
my_action = action.CmdAction(PROGRAM)
assert "Cmd: %s" % PROGRAM == str(my_action)
def test_unicode(self):
action_str = PROGRAM + "中文"
my_action = action.CmdAction(action_str)
assert "Cmd: %s" % action_str == str(my_action)
def test_repr(self):
my_action = action.CmdAction(PROGRAM)
expected = "<CmdAction: '%s'>" % PROGRAM
assert expected == repr(my_action), repr(my_action)
def test_result(self):
my_action = action.CmdAction("%s 1 2" % PROGRAM)
my_action.execute()
assert "12" == my_action.result
def test_values(self):
# for cmdActions they are emtpy if save_out not specified
my_action = action.CmdAction("%s 1 2" % PROGRAM)
my_action.execute()
assert {} == my_action.values
class TestCmdActionParams(object):
def test_invalid_param_stdout(self):
pytest.raises(action.InvalidTask, action.CmdAction,
[PROGRAM], stdout=None)
def test_changePath(self, tmpdir):
path = tmpdir.mkdir("foo")
command = '%s -c "import os; print(os.getcwd())"' % executable
my_action = action.CmdAction(command, cwd=path.strpath)
my_action.execute()
assert path + os.linesep == my_action.out, repr(my_action.out)
def test_noPathSet(self, tmpdir):
path = tmpdir.mkdir("foo")
command = '%s -c "import os; print(os.getcwd())"' % executable
my_action = action.CmdAction(command)
my_action.execute()
assert path.strpath + os.linesep != my_action.out, repr(my_action.out)
class TestCmdVerbosity(object):
# Capture stderr
def test_captureStderr(self):
cmd = "%s please fail" % PROGRAM
my_action = action.CmdAction(cmd)
got = my_action.execute()
assert isinstance(got, TaskFailed)
assert "err output on failure" == my_action.err, repr(my_action.err)
# Capture stdout
def test_captureStdout(self):
my_action = action.CmdAction("%s hi_stdout hi2" % PROGRAM)
my_action.execute()
assert "hi_stdout" == my_action.out, repr(my_action.out)
# Do not capture stderr
# test using a tempfile. it is not possible (at least i dont know)
# how to test if the output went to the parent process,
# faking sys.stderr with a StringIO doesnt work.
def test_noCaptureStderr(self, tmpfile):
my_action = action.CmdAction("%s please fail" % PROGRAM)
action_result = my_action.execute(err=tmpfile)
assert isinstance(action_result, TaskFailed)
tmpfile.seek(0)
got = tmpfile.read()
assert "err output on failure" == got, repr(got)
assert "err output on failure" == my_action.err, repr(my_action.err)
# Do not capture stdout
def test_noCaptureStdout(self, tmpfile):
my_action = action.CmdAction("%s hi_stdout hi2" % PROGRAM)
my_action.execute(out=tmpfile)
tmpfile.seek(0)
got = tmpfile.read()
assert "hi_stdout" == got, repr(got)
assert "hi_stdout" == my_action.out, repr(my_action.out)
class TestCmdExpandAction(object):
def test_task_meta_reference(self):
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
cmd += " %(dependencies)s - %(changed)s - %(targets)s"
dependencies = ["data/dependency1", "data/dependency2", ":dep_on_task"]
targets = ["data/target", "data/targetXXX"]
task = FakeTask(dependencies, ["data/dependency1"], targets, {})
my_action = action.CmdAction(cmd, task)
assert my_action.execute() is None
got = my_action.out.split('-')
assert task.file_dep == got[0].split(), got[0]
assert task.dep_changed == got[1].split(), got[1]
assert targets == got[2].split(), got[2]
def test_task_options(self):
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
cmd += " %(opt1)s - %(opt2)s"
task = FakeTask([],[],[],{'opt1':'3', 'opt2':'abc def'})
my_action = action.CmdAction(cmd, task)
assert my_action.execute() is None
got = my_action.out.strip()
assert "3 - abc def" == got
def test_task_pos_arg(self):
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
cmd += " %(pos)s"
task = FakeTask([],[],[],{}, 'pos', ['hi', 'there'])
my_action = action.CmdAction(cmd, task)
assert my_action.execute() is None
got = my_action.out.strip()
assert "hi there" == got
def test_task_pos_arg_None(self):
# pos_arg_val is None when the task is not specified from
# command line but executed because it is a task_dep
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
cmd += " %(pos)s"
task = FakeTask([],[],[],{}, 'pos', None)
my_action = action.CmdAction(cmd, task)
assert my_action.execute() is None
got = my_action.out.strip()
assert "" == got
def test_callable_return_command_str(self):
def get_cmd(opt1, opt2):
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
return cmd + " %s - %s" % (opt1, opt2)
task = FakeTask([],[],[],{'opt1':'3', 'opt2':'abc def'})
my_action = action.CmdAction(get_cmd, task)
assert my_action.execute() is None
got = my_action.out.strip()
assert "3 - abc def" == got, repr(got)
def test_callable_tuple_return_command_str(self):
def get_cmd(opt1, opt2):
cmd = "%s %s/myecho.py" % (executable, TEST_PATH)
return cmd + " %s - %s" % (opt1, opt2)
task = FakeTask([],[],[],{'opt1':'3'})
my_action = action.CmdAction((get_cmd, [], {'opt2':'abc def'}), task)
assert my_action.execute() is None
got = my_action.out.strip()
assert "3 - abc def" == got, repr(got)
def test_callable_invalid(self):
def get_cmd(blabla): pass
task = FakeTask([],[],[],{'opt1':'3'})
my_action = action.CmdAction(get_cmd, task)
got = my_action.execute()
assert isinstance(got, TaskError)
def test_string_list_cant_be_expanded(self):
cmd = [executable, "%s/myecho.py" % TEST_PATH]
task = FakeTask([],[],[], {})
my_action = action.CmdAction(cmd, task)
assert cmd == my_action.expand_action()
def test_list_can_contain_path(self):
cmd = [executable, PurePath(TEST_PATH), Path("myecho.py")]
task = FakeTask([], [], [], {})
my_action = action.CmdAction(cmd, task)
assert [executable, TEST_PATH, "myecho.py"] == my_action.expand_action()
def test_list_should_contain_strings_or_paths(self):
cmd = [executable, PurePath(TEST_PATH), 42, Path("myecho.py")]
task = FakeTask([], [], [], {})
my_action = action.CmdAction(cmd, task)
assert pytest.raises(action.InvalidTask, my_action.expand_action)
class TestCmd_print_process_output_line(object):
def test_non_unicode_string_error_strict(self):
my_action = action.CmdAction("", decode_error='strict')
not_unicode = BytesIO('\xa9'.encode("latin-1"))
realtime = Mock()
realtime.encoding = 'utf-8'
pytest.raises(UnicodeDecodeError,
my_action._print_process_output,
Mock(), not_unicode, Mock(), realtime)
def test_non_unicode_string_error_replace(self):
my_action = action.CmdAction("") # default is decode_error = 'replace'
not_unicode = BytesIO('\xa9'.encode("latin-1"))
realtime = Mock()
realtime.encoding = 'utf-8'
capture = StringIO()
my_action._print_process_output(
Mock(), not_unicode, capture, realtime)
# get the replacement char
expected = '�'
assert expected == capture.getvalue()
def test_non_unicode_string_ok(self):
my_action = action.CmdAction("", encoding='iso-8859-1')
not_unicode = BytesIO('\xa9'.encode("latin-1"))
realtime = Mock()
realtime.encoding = 'utf-8'
capture = StringIO()
my_action._print_process_output(
Mock(), not_unicode, capture, realtime)
# get the correct char from latin-1 encoding
expected = '©'
assert expected == capture.getvalue()
# dont test unicode if system locale doesnt support unicode
# see https://bitbucket.org/schettino72/doit/pull-request/11
@pytest.mark.skipif('locale.getlocale()[1] is None')
def test_unicode_string(self, tmpfile):
my_action = action.CmdAction("")
unicode_in = tempfile.TemporaryFile('w+b')
unicode_in.write(" 中文".encode('utf-8'))
unicode_in.seek(0)
my_action._print_process_output(
Mock(), unicode_in, Mock(), tmpfile)
@pytest.mark.skipif('locale.getlocale()[1] is None')
def test_unicode_string2(self, tmpfile):
# this \uXXXX has a different behavior!
my_action = action.CmdAction("")
unicode_in = tempfile.TemporaryFile('w+b')
unicode_in.write(" 中文 \u2018".encode('utf-8'))
unicode_in.seek(0)
my_action._print_process_output(
Mock(), unicode_in, Mock(), tmpfile)
def test_line_buffered_output(self):
my_action = action.CmdAction("")
out, inp = os.pipe()
out, inp = os.fdopen(out, 'rb'), os.fdopen(inp, 'wb')
inp.write('abcd\nline2'.encode('utf-8'))
inp.flush()
capture = StringIO()
thread = Thread(target=my_action._print_process_output,
args=(Mock(), out, capture, None))
thread.start()
time.sleep(0.1)
try:
got = capture.getvalue()
# 'line2' is not captured because of line buffering
assert 'abcd\n' == got
print('asserted')
finally:
inp.close()
def test_unbuffered_output(self):
my_action = action.CmdAction("", buffering=1)
out, inp = os.pipe()
out, inp = os.fdopen(out, 'rb'), os.fdopen(inp, 'wb')
inp.write('abcd\nline2'.encode('utf-8'))
inp.flush()
capture = StringIO()
thread = Thread(target=my_action._print_process_output,
args=(Mock(), out, capture, None))
thread.start()
time.sleep(0.1)
try:
got = capture.getvalue()
assert 'abcd\nline2' == got
finally:
inp.close()
def test_unbuffered_env(self, monkeypatch):
my_action = action.CmdAction("", buffering=1)
proc_mock = Mock()
proc_mock.configure_mock(returncode=0)
popen_mock = Mock(return_value=proc_mock)
from doit.action import subprocess
monkeypatch.setattr(subprocess, 'Popen', popen_mock)
my_action._print_process_output = Mock()
my_action.execute()
env = popen_mock.call_args[-1]['env']
assert env and env.get('PYTHONUNBUFFERED', False) == '1'
class TestCmdSaveOuput(object):
def test_success(self):
TEST_PATH = os.path.dirname(__file__)
PROGRAM = "%s %s/sample_process.py" % (executable, TEST_PATH)
my_action = action.CmdAction(PROGRAM + " x1 x2", save_out='out')
my_action.execute()
assert {'out': 'x1'} == my_action.values
class TestWriter(object):
def test_write(self):
w1 = StringIO()
w2 = StringIO()
writer = action.Writer(w1, w2)
writer.flush() # make sure flush is supported
writer.write("hello")
assert "hello" == w1.getvalue()
assert "hello" == w2.getvalue()
def test_isatty_true(self):
w1 = StringIO()
w1.isatty = lambda: True
w2 = StringIO()
writer = action.Writer(w1, w2)
assert not writer.isatty()
def test_isatty_false(self):
w1 = StringIO()
w1.isatty = lambda: True
w2 = StringIO()
w2.isatty = lambda: True
writer = action.Writer(w1, w2)
assert writer.isatty()
def test_isatty_overwrite_yes(self):
w1 = StringIO()
w1.isatty = lambda: True
w2 = StringIO()
writer = action.Writer(w1)
writer.add_writer(w2, True)
def test_isatty_overwrite_no(self):
w1 = StringIO()
w1.isatty = lambda: True
w2 = StringIO()
w2.isatty = lambda: True
writer = action.Writer(w1)
writer.add_writer(w2, False)
############# PythonAction
class TestPythonAction(object):
def test_success_bool(self):
def success_sample():return True
my_action = action.PythonAction(success_sample)
# nothing raised it was successful
my_action.execute()
def test_success_None(self):
def success_sample():return
my_action = action.PythonAction(success_sample)
# nothing raised it was successful
my_action.execute()
def test_success_str(self):
def success_sample():return ""
my_action = action.PythonAction(success_sample)
# nothing raised it was successful
my_action.execute()
def test_success_dict(self):
def success_sample():return {}
my_action = action.PythonAction(success_sample)
# nothing raised it was successful
my_action.execute()
def test_error_object(self):
# anthing but None, bool, string or dict
def error_sample(): return object()
my_action = action.PythonAction(error_sample)
got = my_action.execute()
assert isinstance(got, TaskError)
def test_error_taskfail(self):
# should get the same exception as was returned from the
# user's function
def error_sample(): return TaskFailed("too bad")
ye_olde_action = action.PythonAction(error_sample)
ret = ye_olde_action.execute()
assert isinstance(ret, TaskFailed)
assert str(ret).endswith("too bad\n")
def test_error_taskerror(self):
def error_sample(): return TaskError("so sad")
ye_olde_action = action.PythonAction(error_sample)
ret = ye_olde_action.execute()
assert str(ret).endswith("so sad\n")
def test_error_exception(self):
def error_sample(): raise Exception("asdf")
my_action = action.PythonAction(error_sample)
got = my_action.execute()
assert isinstance(got, TaskError)
def test_fail_bool(self):
def fail_sample():return False
my_action = action.PythonAction(fail_sample)
got = my_action.execute()
assert isinstance(got, TaskFailed)
# any callable should work, not only functions
def test_callable_obj(self):
class CallMe:
def __call__(self):
return False
my_action = action.PythonAction(CallMe())
got = my_action.execute()
assert isinstance(got, TaskFailed)
# helper to test callable with parameters
def _func_par(self,par1,par2,par3=5):
if par1 == par2 and par3 > 10:
return True
else:
return False
def test_init(self):
# default values
action1 = action.PythonAction(self._func_par)
assert action1.args == []
assert action1.kwargs == {}
# not a callable
pytest.raises(action.InvalidTask, action.PythonAction, "abc")
# args not a list
pytest.raises(action.InvalidTask, action.PythonAction, self._func_par, "c")
# kwargs not a list
pytest.raises(action.InvalidTask, action.PythonAction,
self._func_par, None, "a")
# cant use a class as callable
def test_init_callable_class(self):
class CallMe(object):
pass
pytest.raises(action.InvalidTask, action.PythonAction, CallMe)
# cant use built-ins
def test_init_callable_builtin(self):
pytest.raises(action.InvalidTask, action.PythonAction, any)
def test_functionParametersArgs(self):
my_action = action.PythonAction(self._func_par,args=(2,2,25))
my_action.execute()
def test_functionParametersKwargs(self):
my_action = action.PythonAction(self._func_par,
kwargs={'par1':2,'par2':2,'par3':25})
my_action.execute()
def test_functionParameters(self):
my_action = action.PythonAction(self._func_par,args=(2,2),
kwargs={'par3':25})
my_action.execute()
def test_functionParametersFail(self):
my_action = action.PythonAction(self._func_par, args=(2,3),
kwargs={'par3':25})
got = my_action.execute()
assert isinstance(got, TaskFailed)
def test_str(self):
def str_sample(): return True
my_action = action.PythonAction(str_sample)
assert "Python: function" in str(my_action)
assert "str_sample" in str(my_action)
def test_repr(self):
def repr_sample(): return True
my_action = action.PythonAction(repr_sample)
assert "<PythonAction: '%s'>" % repr(repr_sample) == repr(my_action)
def test_result(self):
def vvv(): return "my value"
my_action = action.PythonAction(vvv)
my_action.execute()
assert "my value" == my_action.result
def test_result_dict(self):
def vvv(): return {'xxx': "my value"}
my_action = action.PythonAction(vvv)
my_action.execute()
assert {'xxx': "my value"} == my_action.result
def test_values(self):
def vvv(): return {'x': 5, 'y':10}
my_action = action.PythonAction(vvv)
my_action.execute()
assert {'x': 5, 'y':10} == my_action.values
class TestPythonVerbosity(object):
def write_stderr(self):
sys.stderr.write("this is stderr S\n")
def write_stdout(self):
sys.stdout.write("this is stdout S\n")
def test_captureStderr(self):
my_action = action.PythonAction(self.write_stderr)
my_action.execute()
assert "this is stderr S\n" == my_action.err, repr(my_action.err)
def test_captureStdout(self):
my_action = action.PythonAction(self.write_stdout)
my_action.execute()
assert "this is stdout S\n" == my_action.out, repr(my_action.out)
def test_noCaptureStderr(self, capsys):
my_action = action.PythonAction(self.write_stderr)
my_action.execute(err=sys.stderr)
got = capsys.readouterr()[1]
assert "this is stderr S\n" == got, repr(got)
def test_noCaptureStdout(self, capsys):
my_action = action.PythonAction(self.write_stdout)
my_action.execute(out=sys.stdout)
got = capsys.readouterr()[0]
assert "this is stdout S\n" == got, repr(got)
def test_redirectStderr(self):
tmpfile = tempfile.TemporaryFile('w+')
my_action = action.PythonAction(self.write_stderr)
my_action.execute(err=tmpfile)
tmpfile.seek(0)
got = tmpfile.read()
tmpfile.close()
assert "this is stderr S\n" == got, got
def test_redirectStdout(self):
tmpfile = tempfile.TemporaryFile('w+')
my_action = action.PythonAction(self.write_stdout)
my_action.execute(out=tmpfile)
tmpfile.seek(0)
got = tmpfile.read()
tmpfile.close()
assert "this is stdout S\n" == got, got
class TestPythonActionPrepareKwargsMeta(object):
@pytest.fixture
def task_depchanged(self, request):
return FakeTask(['dependencies'],['changed'],['targets'],{})
def test_no_extra_args(self, task_depchanged):
# no error trying to inject values
def py_callable():
return True
my_action = action.PythonAction(py_callable, task=task_depchanged)
my_action.execute()
def test_keyword_extra_args(self):
my_task = FakeTask(['dependencies'], None, None, {'foo': 'bar'})
got = []
def py_callable(arg=None, **kwargs):
got.append(kwargs)
my_action = action.PythonAction(py_callable, (), {'b': 4}, task=my_task)
my_action.execute()
# meta args do not leak into kwargs
assert got == [{'foo': 'bar', 'b': 4}]
def test_named_extra_args(self, task_depchanged):
got = []
def py_callable(targets, dependencies, changed, task):
got.append(targets)
got.append(dependencies)
got.append(changed)
got.append(task)
my_action = action.PythonAction(py_callable, task=task_depchanged)
my_action.execute()
assert got == [['targets'], ['dependencies'], ['changed'],
task_depchanged]
def test_mixed_args(self, task_depchanged):
got = []
def py_callable(a, b, changed):
got.append(a)
got.append(b)
got.append(changed)
my_action = action.PythonAction(py_callable, ('a', 'b'),
task=task_depchanged)
my_action.execute()
assert got == ['a', 'b', ['changed']]
def test_extra_arg_overwritten(self, task_depchanged):
got = []
def py_callable(a, b, changed):
got.append(a)
got.append(b)
got.append(changed)
my_action = action.PythonAction(py_callable, ('a', 'b', 'c'),
task=task_depchanged)
my_action.execute()
assert got == ['a', 'b', 'c']
def test_extra_kwarg_overwritten(self, task_depchanged):
got = []
def py_callable(a, b, **kwargs):
got.append(a)
got.append(b)
got.append(kwargs['changed'])
my_action = action.PythonAction(py_callable, ('a', 'b'),
{'changed': 'c'}, task_depchanged)
my_action.execute()
assert got == ['a', 'b', 'c']
def test_meta_arg_default_disallowed(self, task_depchanged):
def py_callable(a, b, changed=None): pass
my_action = action.PythonAction(py_callable, ('a', 'b'),
task=task_depchanged)
pytest.raises(action.InvalidTask, my_action.execute)
def test_callable_obj(self, task_depchanged):
got = []
class CallMe(object):
def __call__(self, a, b, changed):
got.append(a)
got.append(b)
got.append(changed)
my_action = action.PythonAction(CallMe(), ('a', 'b'),
task=task_depchanged)
my_action.execute()
assert got == ['a', 'b', ['changed']]
def test_method(self, task_depchanged):
got = []
class CallMe(object):
def xxx(self, a, b, changed):
got.append(a)
got.append(b)
got.append(changed)
my_action = action.PythonAction(CallMe().xxx, ('a', 'b'),
task=task_depchanged)
my_action.execute()
assert got == ['a', 'b', ['changed']]
def test_task_options(self):
got = []
def py_callable(opt1, opt3):
got.append(opt1)
got.append(opt3)
task = FakeTask([],[],[],{'opt1':'1', 'opt2':'abc def', 'opt3':3})
my_action = action.PythonAction(py_callable, task=task)
my_action.execute()
assert ['1',3] == got, repr(got)
def test_task_pos_arg(self):
got = []
def py_callable(pos):
got.append(pos)
task = FakeTask([],[],[],{}, 'pos', ['hi', 'there'])
my_action = action.PythonAction(py_callable, task=task)
my_action.execute()
assert [['hi', 'there']] == got, repr(got)
def test_option_default_allowed(self, task_depchanged):
got = []
def py_callable(opt2='ABC'):
got.append(opt2)
task = FakeTask([],[],[],{'opt2':'123'})
my_action = action.PythonAction(py_callable, task=task)
my_action.execute()
assert ['123'] == got, repr(got)
def test_kwonlyargs_minimal(self, task_depchanged):
got = []
scope = {'got': got}
exec(textwrap.dedent('''
def py_callable(*args, kwonly=None):
got.append(args)
got.append(kwonly)
'''), scope)
my_action = action.PythonAction(scope['py_callable'],
(1, 2, 3), {'kwonly': 4},
task=task_depchanged)
my_action.execute()
assert [(1, 2, 3), 4] == got, repr(got)
def test_kwonlyargs_full(self, task_depchanged):
got = []
scope = {'got': got}
exec(textwrap.dedent('''
def py_callable(pos, *args, kwonly=None, **kwargs):
got.append(pos)
got.append(args)
got.append(kwonly)
got.append(kwargs['foo'])
'''), scope)
my_action = action.PythonAction(scope['py_callable'],
[1,2,3], {'kwonly': 4, 'foo': 5},
task=task_depchanged)
my_action.execute()
assert [1, (2, 3), 4, 5] == got, repr(got)
def test_action_modifies_task_attributes(self, task_depchanged):
def py_callable(targets, dependencies, changed, task):
targets.append('new_target')
dependencies.append('new_dependency')
changed.append('new_changed')
my_action = action.PythonAction(py_callable, task=task_depchanged)
my_action.execute()
assert task_depchanged.file_dep == ['dependencies', 'new_dependency']
assert task_depchanged.targets == ['targets', 'new_target']
assert task_depchanged.dep_changed == ['changed', 'new_changed']
##############
class TestCreateAction(object):
class TaskStub(object):
name = 'stub'
mytask = TaskStub()
def testBaseAction(self):
class Sample(action.BaseAction): pass
my_action = action.create_action(Sample(), self.mytask, 'actions')
assert isinstance(my_action, Sample)
assert self.mytask == my_action.task
def testStringAction(self):
my_action = action.create_action("xpto 14 7", self.mytask, 'actions')
assert isinstance(my_action, action.CmdAction)
assert my_action.shell == True
def testListStringAction(self):
my_action = action.create_action(["xpto", 14, 7], self.mytask, 'actions')
assert isinstance(my_action, action.CmdAction)
assert my_action.shell == False
def testMethodAction(self):
def dumb(): return
my_action = action.create_action(dumb, self.mytask, 'actions')
assert isinstance(my_action, action.PythonAction)
def testTupleAction(self):
def dumb(): return
my_action = action.create_action((dumb,[1,2],{'a':5}), self.mytask,
'actions')
assert isinstance(my_action, action.PythonAction)
def testTupleActionMoreThanThreeElements(self):
def dumb(): return
expected = "Task 'stub': invalid 'actions' tuple length"
with pytest.raises(action.InvalidTask, match=expected):
action.create_action((dumb,[1,2],{'a':5},'oo'), self.mytask,
'actions')
def testInvalidActionNone(self):
expected = "Task 'stub': invalid 'actions' type. got: None"
with pytest.raises(action.InvalidTask, match=expected):
action.create_action(None, self.mytask, 'actions')
def testInvalidActionObject(self):
expected = "Task 'stub': invalid 'actions' type. got: <"
with pytest.raises(action.InvalidTask, match=expected):
action.create_action(self, self.mytask, 'actions')
def test_invalid_action_task_param_name(self):
expected = "Task 'stub': invalid 'clean' type. got: True"
with pytest.raises(action.InvalidTask, match=expected):
action.create_action(True, self.mytask, 'clean')
|