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
|
import os
import unittest
import subprocess
import random
from os import path
from typing import List, Tuple
from tests.utils.fixture import FixtureTempDir
class TaskipyTestCase(unittest.TestCase):
def setUp(self):
self._tmp_dirs: List[FixtureTempDir] = []
def tearDown(self):
for tmp_dir in self._tmp_dirs:
tmp_dir.clean()
def run_task(self, task: str, args: List[str] = None, cwd=os.curdir) -> Tuple[int, str, str]:
executable_path = path.abspath('task')
args = args or []
proc = subprocess.Popen([executable_path, task] + args, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, cwd=cwd)
stdout, stderr = proc.communicate()
return proc.returncode, str(stdout), str(stderr)
def create_test_dir_from_fixture(self, fixture_name: str):
tmp_dir = FixtureTempDir(path.join('tests', 'fixtures', fixture_name))
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}"')
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') 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(f'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(f'the argument count is 5', 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(f'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(f'the number in posthook is', stdout)
self.assertNotSubstr(f'the number in posthook is {some_random_number}', stdout)
self.assertEqual(exit_code, 0)
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_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', 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)
|