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
|
import os
import platform
import random
import signal
import subprocess
import time
import unittest
import warnings
from os import path
from typing import List, Optional, Tuple
from parameterized import parameterized # type: ignore
import psutil # type: ignore
from tests.utils.project import (
GenerateProjectFromFixture,
GenerateProjectWithPyProjectToml,
TempProjectDir
)
class TaskipyTestCase(unittest.TestCase):
def setUp(self):
self._tmp_dirs: List[TempProjectDir] = []
def tearDown(self):
for tmp_dir in self._tmp_dirs:
tmp_dir.clean()
def run_task(
self,
task: str,
args: Optional[List[str]] = None,
cwd=os.curdir,
) -> Tuple[int, str, str]:
args = args or []
proc = self.start_taskipy_process(task, args=args, cwd=cwd)
stdout, stderr = proc.communicate()
return proc.returncode, stdout.decode(), str(stderr)
def start_taskipy_process(
self,
task: str,
args: Optional[List[str]] = None,
cwd=os.curdir,
) -> subprocess.Popen:
executable_path = path.abspath('task.bat' if platform.system() == 'Windows' else 'task')
args = args or []
return subprocess.Popen([executable_path, task] + args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=cwd)
def create_test_dir_from_fixture(self, fixture_name: str):
project_generator = GenerateProjectFromFixture(path.join('tests', 'fixtures', fixture_name))
tmp_dir = TempProjectDir(project_generator)
self._tmp_dirs.append(tmp_dir)
return tmp_dir.path
def create_test_dir_with_py_project_toml(self, py_project_toml: str):
project_generator = GenerateProjectWithPyProjectToml(py_project_toml)
tmp_dir = TempProjectDir(project_generator)
self._tmp_dirs.append(tmp_dir)
return tmp_dir.path
# pylint: disable=invalid-name
def assertSubstr(self, substr: str, full_string: str):
self.assertTrue(substr in full_string, msg=f'Expected \n "{substr}"\nto be in\n "{full_string}"')
# pylint: disable=invalid-name
def assertNotSubstr(self, substr: str, full_string: str):
self.assertFalse(substr in full_string, msg=f'Expected \n "{substr}"\nnot to be in\n "{full_string}"')
# pylint: disable=invalid-name
def assertSubstrsInOrder(self, substrs: List[str], full_string: str):
self.assertGreater(len(substrs), 0, 'please provide at least one substr')
for substr_a, substr_b in zip(substrs[:-1], substrs[1:]):
self.assertSubstr(substr_a, full_string)
self.assertSubstr(substr_b, full_string)
self.assertLess(full_string.find(substr_a),
full_string.find(substr_b),
msg=f'Expected \n "{substr_a}"\nto appear before\n "{substr_b}"\nin\n "{full_string}"')
def assertTerminalTextEqual(self, expected: str, actual: str):
expected_without_ansi_chars = expected.encode('ascii', 'ignore')
actual_without_ansi_chars = actual.encode('ascii', 'ignore')
self.assertEqual(expected_without_ansi_chars, actual_without_ansi_chars)
class RunTaskTestCase(TaskipyTestCase):
def test_running_task(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
self.run_task('create_hello_txt', cwd=cwd)
with open(path.join(cwd, 'hello.txt'), 'r', encoding='utf-8') as f:
hello_file_contents = f.readline().strip()
self.assertEqual(hello_file_contents, 'hello, world')
def test_exit_code_matches_task_exit_code(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
exit_code, _, _ = self.run_task('exit_17', cwd=cwd)
self.assertEqual(exit_code, 17)
def test_stdout_contains_task_stdout(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
_, stdout, _ = self.run_task('print_hello_stdout', cwd=cwd)
self.assertSubstr('hello stdout', stdout)
def test_stderr_contains_task_stderr(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
_, _, stderr = self.run_task('print_hello_stderr', cwd=cwd)
self.assertSubstr('hello stderr', stderr)
class TaskPrePostHooksTestCase(TaskipyTestCase):
def test_running_pre_task_hook(self):
cwd = self.create_test_dir_from_fixture('project_with_pre_post_task_hooks')
_, stdout, _ = self.run_task('hello', cwd=cwd)
self.assertSubstrsInOrder(['pre_task', 'hello'], stdout)
def test_running_post_task_hook(self):
cwd = self.create_test_dir_from_fixture('project_with_pre_post_task_hooks')
_, stdout, _ = self.run_task('hello', cwd=cwd)
self.assertSubstrsInOrder(['hello', 'post_task'], stdout)
def test_exiting_after_pre_task_hook_if_exit_code_not_0(self):
cwd = self.create_test_dir_from_fixture('project_with_pre_post_task_hooks')
exit_code, stdout, _ = self.run_task('hello_failed_pretask', cwd=cwd)
self.assertSubstr('pre_task', stdout)
self.assertNotSubstr('hello', stdout)
self.assertEqual(exit_code, 1)
def test_exiting_with_post_task_hook_exit_code_if_not_0(self):
cwd = self.create_test_dir_from_fixture('project_with_pre_post_task_hooks')
exit_code, stdout, _ = self.run_task('hello_failed_posttask', cwd=cwd)
self.assertSubstr('post_task', stdout)
self.assertEqual(exit_code, 1)
class PassArgumentsTestCase(TaskipyTestCase):
def test_running_task_with_positional_arguments(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_accept_arguments')
some_random_number = random.randint(1, 1000)
exit_code, stdout, _ = self.run_task('echo_number', args=[f'{some_random_number}'], cwd=cwd)
self.assertSubstr(f'the number is {some_random_number}', stdout)
self.assertEqual(exit_code, 0)
def test_running_task_with_named_arguments(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_accept_arguments')
exit_code, stdout, _ = self.run_task('echo_named', args=['-h'], cwd=cwd)
self.assertSubstr('got a named argument -h', stdout)
self.assertEqual(exit_code, 0)
def test_running_task_with_multiple_arguments(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_accept_arguments')
args = ['one', 'two', 'three', 'four', 'five']
exit_code, stdout, _ = self.run_task('echo_args_count', args=args, cwd=cwd)
self.assertSubstr('the argument count is 5', stdout)
self.assertEqual(exit_code, 0)
def test_running_task_with_arguments_with_spaces(self):
cwd = self.create_test_dir_from_fixture('project_with_task_that_checks_args_passed_with_spaces')
name = 'Roy Sommer'
age = random.randrange(1, 100)
exit_code, stdout, _ = self.run_task('identify', args=['--full-name', name, '--age', f'{age}'], cwd=cwd)
self.assertSubstr(f'name: {name} age: {age}', stdout)
self.assertEqual(exit_code, 0)
def test_running_task_arguments_not_passed_to_pre_hook(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_accept_arguments')
some_random_number = random.randint(1, 1000)
exit_code, stdout, _ = self.run_task('echo_on_prehook', args=[f'{some_random_number}'], cwd=cwd)
self.assertSubstr('the number in prehook is', stdout)
self.assertNotSubstr(f'the number in prehook is {some_random_number}', stdout)
self.assertEqual(exit_code, 0)
def test_running_task_arguments_not_passed_to_post_hook(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_accept_arguments')
some_random_number = random.randint(1, 1000)
exit_code, stdout, _ = self.run_task('echo_on_posthook', args=[f'{some_random_number}'], cwd=cwd)
self.assertSubstr('the number in posthook is', stdout)
self.assertNotSubstr(f'the number in posthook is {some_random_number}', stdout)
self.assertEqual(exit_code, 0)
class ListTasksTestCase(TaskipyTestCase):
project_tasks_output = "\n".join([
"one echo first task",
"two echo second task",
"three echo third task",
])
def test_running_task_list(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_to_list')
exit_code, stdout, _ = self.run_task('--list', cwd=cwd)
self.assertTerminalTextEqual(self.project_tasks_output, stdout.strip())
self.assertEqual(exit_code, 0)
def test_running_task_list_with_shorthand(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_to_list')
exit_code, stdout, _ = self.run_task('-l', cwd=cwd)
self.assertTerminalTextEqual(self.project_tasks_output, stdout.strip())
self.assertEqual(exit_code, 0)
def test_running_task_list_before_name(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_to_list')
# anything following the flag should be ignored
exit_code, stdout, _ = self.run_task('--list', ['one'], cwd=cwd)
self.assertTerminalTextEqual(self.project_tasks_output, stdout.strip())
self.assertEqual(exit_code, 0)
def test_running_task_list_with_arg(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_to_list')
# when --list follows after task name it should be passed as an argument
exit_code, stdout, _ = self.run_task('one', ['--list'], cwd=cwd)
expected = "first task --list"
self.assertTerminalTextEqual(expected, stdout.strip())
self.assertEqual(exit_code, 0)
def test_running_task_list_no_tasks(self):
py_project_toml = '''
[tool.taskipy.tasks]
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('--list', cwd=cwd)
self.assertTerminalTextEqual('no tasks found. create your first task by adding it to your pyproject.toml file under [tool.taskipy.tasks]', stdout.strip())
self.assertEqual(exit_code, 127)
def test_running_task_list_no_tasks_section(self):
py_project_toml = ''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('--list', cwd=cwd)
self.assertTerminalTextEqual('no tasks found. add a [tool.taskipy.tasks] section to your pyproject.toml', stdout.strip())
self.assertEqual(exit_code, 127)
class TaskDescriptionTestCase(TaskipyTestCase):
def test_running_task_with_description(self):
py_project_toml = '''
[tool.taskipy.tasks]
print_age = { cmd = "echo age is 29", help = "prints the age" }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
_, stdout, _ = self.run_task('print_age', cwd=cwd)
self.assertSubstr('age is 29', stdout)
def test_listing_task_with_description(self):
py_project_toml = '''
[tool.taskipy.tasks]
print_age = { cmd = "echo age is 29", help = "prints the age" }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
_, stdout, _ = self.run_task('--list', cwd=cwd)
self.assertSubstr('prints the age', stdout)
def test_reject_task_for_not_having_cmd(self):
py_project_toml = '''
[tool.taskipy.tasks]
print_age = { help = "prints the age" }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('print_age', cwd=cwd)
self.assertEqual(exit_code, 1)
self.assertSubstr('the task item does not have the "cmd" property', stdout)
def test_allow_task_to_not_have_help(self):
py_project_toml = '''
[tool.taskipy.tasks]
print_age = { cmd = "echo age is 29" }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('print_age', cwd=cwd)
self.assertEqual(exit_code, 0)
self.assertSubstr('age is 29', stdout)
def test_reject_task_that_is_not_string_nor_object(self):
py_project_toml = '''
[tool.taskipy.tasks]
print_age = 5
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('print_age', cwd=cwd)
self.assertEqual(exit_code, 1)
self.assertSubstr('tasks must be strings, or dicts that contain { cmd, cwd, help, use_vars }', stdout)
class TaskRunFailTestCase(TaskipyTestCase):
def test_exiting_with_code_127_and_printing_if_task_not_found(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
exit_code, stdout, _ = self.run_task('task_that_does_not_exist', cwd=cwd)
self.assertSubstr('could not find task "task_that_does_not_exist"', stdout)
self.assertEqual(exit_code, 127)
def test_exiting_with_code_127_and_printing_suggestion_if_task_not_found(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_suggestion')
exit_code, stdout, _ = self.run_task('stdout', cwd=cwd)
self.assertSubstr('could not find task "stdout", did you mean "print_hello_stdout"?', stdout)
self.assertEqual(exit_code, 127)
def test_exiting_with_code_127_and_printing_if_task_not_found_and_suggestion(self):
cwd = self.create_test_dir_from_fixture("project_with_tasks_suggestion")
exit_code, stdout, _ = self.run_task("task_that_does_not_exist", cwd=cwd)
self.assertEqual('could not find task "task_that_does_not_exist"\n', stdout)
self.assertEqual(exit_code, 127)
def test_exiting_with_code_127_and_printing_if_no_arg_is_passed(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_and_tasks')
executable_path = path.abspath('task')
proc = subprocess.Popen(
executable_path,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=cwd
)
stdout, _ = proc.communicate()
self.assertSubstr('usage: task', stdout.decode())
self.assertEqual(proc.returncode, 127)
def test_exiting_with_code_127_and_printing_if_no_tasks_section(self):
cwd = self.create_test_dir_from_fixture('project_with_pyproject_without_tasks_section')
exit_code, stdout, _ = self.run_task('task_that_does_not_exist', cwd=cwd)
self.assertSubstr('no tasks found. add a [tool.taskipy.tasks] section to your pyproject.toml', stdout)
self.assertEqual(exit_code, 127)
def test_exiting_with_code_1_and_printing_if_no_pyproject_toml_file_found(self):
cwd = self.create_test_dir_from_fixture('project_without_pyproject')
exit_code, stdout, _ = self.run_task('some_task', cwd=cwd)
self.assertSubstr('no pyproject.toml file found in this directory or parent directories', stdout)
self.assertEqual(exit_code, 1)
def test_exiting_with_code_1_and_printing_if_pyproject_toml_file_is_malformed(self):
cwd = self.create_test_dir_from_fixture('project_with_malformed_pyproject')
exit_code, stdout, _ = self.run_task('some_task', cwd=cwd)
self.assertSubstr('pyproject.toml file is malformed and could not be read', stdout)
self.assertEqual(exit_code, 1)
class InterruptingTaskTestCase(TaskipyTestCase):
def setUp(self):
super().setUp()
# suppress resource warnings, as they are false positives caused by psutil
warnings.simplefilter('ignore', category=ResourceWarning)
def interrupt_task(self, process: subprocess.Popen):
psutil_process_wrapper = psutil.Process(process.pid)
processes = psutil_process_wrapper.children(recursive=True)
innermost_process = next(filter(lambda p: p.name().lower().startswith('python'), processes))
innermost_process.send_signal(signal.SIGINT)
@unittest.skip("skip tests due to sgnal error for risk64 and armel")
def test_handling_sigint_according_to_subprocess_if_it_handles_it_gracefully(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_handle_interrupts')
process = self.start_taskipy_process('run_loop_with_interrupt_handling', cwd=cwd)
time.sleep(.2)
self.interrupt_task(process)
exit_code = process.wait()
self.assertEqual(exit_code, 0)
@unittest.skip("skip tests due to sgnal error for risk64 and armel")
def test_handling_sigint_according_to_subprocess_if_it_does_not_handle_it_gracefully(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_handle_interrupts')
process = self.start_taskipy_process('run_loop_without_interrupt_handling', cwd=cwd)
time.sleep(.2)
self.interrupt_task(process)
exit_code = process.wait()
self.assertEqual(exit_code, 130)
@unittest.skip("skip tests due to sgnal error for risk64 and armel")
def test_sigterm_should_be_sent_to_subprocess(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_that_handle_sigterm')
process = self.start_taskipy_process('run_loop_with_sigterm_handling', cwd=cwd)
time.sleep(.2)
process.send_signal(signal.SIGTERM)
exit_code = process.wait()
stdout, _ = process.communicate()
self.assertEqual(exit_code, 123)
self.assertSubstr('sigterm', str(stdout))
class CustomRunnerTestCase(TaskipyTestCase):
def test_running_command_with_custom_runner(self):
py_project_toml = '''
[tool.taskipy.settings]
runner = "time"
[tool.taskipy.tasks]
print_with_python = "python -c 'print(1337)'"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
_, _, stderr = self.run_task('print_with_python', cwd=cwd)
time_cmd_output_format = 'user'
self.assertSubstr(time_cmd_output_format, stderr)
def test_running_command_with_custom_runner_with_trailing_space(self):
py_project_toml = '''
[tool.taskipy.settings]
runner = "time "
[tool.taskipy.tasks]
print_with_python = "python -c 'print(1337)'"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
_, _, stderr = self.run_task('print_with_python', cwd=cwd)
time_cmd_output_format = 'user'
self.assertSubstr(time_cmd_output_format, stderr)
def test_running_command_with_custom_runner_fails_if_custom_runner_is_not_string(self):
py_project_toml = '''
[tool.taskipy.settings]
runner = 55
[tool.taskipy.tasks]
print_with_python = "python -c 'print(1337)'"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('print_with_python', cwd=cwd)
self.assertSubstr('invalid value: runner is not a string. please check [tool.taskipy.settings.runner]', stdout)
self.assertEqual(exit_code, 1)
class TaskFromChildTestCase(TaskipyTestCase):
def test_running_parent_pyproject_task_from_child_directory(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_from_child')
_, stdout, _ = self.run_task('print_current_dir_name', cwd=path.join(cwd, 'child_without_pyproject'))
self.assertSubstr('child_without_pyproject', stdout)
def test_find_nearest_pyproject_from_child_directory(self):
cwd = self.create_test_dir_from_fixture('project_with_tasks_from_child')
_, stdout, _ = self.run_task('hello', cwd=path.join(cwd, 'child_with_pyproject'))
self.assertSubstr('hello from child', stdout)
class UseVarsTestCase(TaskipyTestCase):
def test_use_vars_working(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name:<10}:", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello John Doe :', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_no_param(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}" }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello {name}', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_param_disabled(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}", use_vars = false }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello {name}', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_str_task_no_param(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = "echo hello {name}"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello {name}', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_param_malformed(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}", use_vars = 1 }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('task\'s "use_vars" arg has to be bool', stdout)
self.assertEqual(exit_code, 1)
def test_use_vars_missing_var(self):
py_project_toml = '''
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr("reason: 'name' variable expected in [tool.taskipy.variables]", stdout)
self.assertEqual(exit_code, 1)
def test_use_vars_setting(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = "echo hello {name:<10}:"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello John Doe :', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_setting_override_to_false(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}:", use_vars = false }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello {name}:', stdout)
self.assertEqual(exit_code, 0)
def test_use_vars_setting_override_to_true(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = false
[tool.taskipy.variables]
name = "John Doe"
[tool.taskipy.tasks]
echo = { cmd = "echo hello {name}:", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello John Doe:', stdout)
self.assertEqual(exit_code, 0)
class RecursiveVariablesTestCase(TaskipyTestCase):
def test_recursive_variables_can_use_other_variables(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
first_name = "John"
last_name = "Doe"
full_name = { var = "{first_name} {last_name}", recursive = true }
[tool.taskipy.tasks]
echo = "echo hello {full_name}"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello John Doe', stdout)
self.assertEqual(exit_code, 0)
def test_recursive_variables_can_use_other_recursive_variables(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
first_name = "John"
last_name = "Doe"
full_name = { var = "{first_name} {last_name}", recursive = true }
another_name = { var = "{full_name} another name!", recursive = true }
even_another_name = { var = "{another_name} {full_name}", recursive = true }
[tool.taskipy.tasks]
echo = "echo hello {even_another_name}"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('hello John Doe another name! John Doe', stdout)
self.assertEqual(exit_code, 0)
def test_error_is_raised_if_a_cycle_is_detected(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
last_name = { var = "{first_name}", recursive = true }
first_name = { var = "{last_name}", recursive = true }
[tool.taskipy.tasks]
echo = "echo hello {first_name} {last_name}!"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('cannot resolve variables, found variables that depend on each other', stdout)
self.assertEqual(exit_code, 127)
def test_non_recursive_variables_cant_use_other_variables(self):
py_project_toml = '''
[tool.taskipy.settings]
use_vars = true
[tool.taskipy.variables]
first_name = "John"
last_name = "Doe"
full_name_1 = "{first_name} {last_name}"
full_name_2 = { var = "{first_name} {last_name}", recursive = false }
[tool.taskipy.tasks]
echo = "echo full_name_1: {full_name_1} full_name_2: {full_name_2}!"
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('full_name_1: {first_name} {last_name} full_name_2: {first_name} {last_name}', stdout)
self.assertEqual(exit_code, 0)
class VariableSchemaTestCase(TaskipyTestCase):
def test_variables_can_be_strings(self):
py_project_toml = '''
[tool.taskipy.variables]
name = "John"
[tool.taskipy.tasks]
echo = { cmd = "echo {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('John', stdout)
self.assertEqual(exit_code, 0)
def test_variables_can_be_a_table_with_var_key_and_no_recursive_key(self):
py_project_toml = '''
[tool.taskipy.variables]
name = { var = "John" }
[tool.taskipy.tasks]
echo = { cmd = "echo {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('John', stdout)
self.assertEqual(exit_code, 0)
def test_variables_can_be_a_table_with_var_key_and_recursive_key(self):
py_project_toml = '''
[tool.taskipy.variables]
name = { var = "John", recursive = true }
[tool.taskipy.tasks]
echo = { cmd = "echo {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('John', stdout)
self.assertEqual(exit_code, 0)
def test_variable_table_by_default_is_not_recursive(self):
py_project_toml = '''
[tool.taskipy.variables]
test = "test var"
name = { var = "{test}" }
[tool.taskipy.tasks]
echo = { cmd = "echo {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('{test}', stdout)
self.assertEqual(exit_code, 0)
def test_regular_string_variable_are_not_recursive(self):
py_project_toml = '''
[tool.taskipy.variables]
test = "test var"
name = "{test}"
[tool.taskipy.tasks]
echo = { cmd = "echo {name}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('{test}', stdout)
self.assertEqual(exit_code, 0)
@parameterized.expand([(5,), (5.5, ), ([], ), ("false",), ({},)])
def test_other_variable_schemas_are_rejected_with_invalid_variable_error(
self, value
):
py_project_toml = f'''
[tool.taskipy.variables]
test = {value}
''' + '''
[tool.taskipy.tasks]
echo = { cmd = "echo {test}", use_vars = true }
'''
cwd = self.create_test_dir_with_py_project_toml(py_project_toml)
exit_code, stdout, _ = self.run_task('echo', cwd=cwd)
self.assertSubstr('variable test is invalid', stdout)
self.assertEqual(exit_code, 127)
class SetCWDTestCase(TaskipyTestCase):
def test_project_with_cwd_under_settings(self):
cwd = self.create_test_dir_from_fixture("project_with_cwd_under_settings")
exit_code, stdout, _ = self.run_task("pwd", cwd=cwd)
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwd", cwd=path.join(cwd, "child_without_pyproject"))
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwd", cwd=path.join(cwd, "child_with_pyproject"))
self.assertTrue(stdout.strip().endswith("child_without_pyproject"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwd", cwd=path.join(cwd, "child_with_pyproject/alternative_calling_folder"))
self.assertTrue(stdout.strip().endswith("child_without_pyproject"))
self.assertEqual(exit_code, 0)
def test_project_with_cwd_under_specific_task(self):
cwd = self.create_test_dir_from_fixture("project_with_cwd_under_specific_task")
exit_code, stdout, _ = self.run_task("pwd", cwd=cwd)
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwd", cwd=path.join(cwd, "subfolder"))
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwd", cwd=path.join(cwd, "alternative_calling_folder"))
self.assertTrue(stdout.strip().endswith("alternative_calling_folder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=cwd)
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=path.join(cwd, "subfolder"))
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=path.join(cwd, "alternative_calling_folder"))
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
def test_project_with_cwd_under_specific_task_and_settings(self):
cwd = self.create_test_dir_from_fixture("project_with_cwd_under_specific_task_and_settings")
exit_code, stdout, _ = self.run_task("pwdglobalcwd", cwd=cwd)
self.assertTrue(stdout.strip().endswith("global_cwd"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdglobalcwd", cwd=path.join(cwd, "subfolder"))
self.assertTrue(stdout.strip().endswith("global_cwd"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdglobalcwd", cwd=path.join(cwd, "global_cwd"))
self.assertTrue(stdout.strip().endswith("global_cwd"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdpyproject", cwd=cwd)
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdpyproject", cwd=path.join(cwd, "subfolder"))
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdpyproject", cwd=path.join(cwd, "global_cwd"))
self.assertTrue(stdout.strip().endswith(cwd))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=cwd)
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=path.join(cwd, "subfolder"))
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
exit_code, stdout, _ = self.run_task("pwdsub", cwd=path.join(cwd, "global_cwd"))
self.assertTrue(stdout.strip().endswith("subfolder"))
self.assertEqual(exit_code, 0)
|