summaryrefslogtreecommitdiff
path: root/tests/test_workers.py
blob: f949edf2be5635f49965281a51816cb64d479a5b (plain)
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
import threading
from datetime import datetime, timezone
from typing import Callable, List

import anyio
import pytest
from anyio import fail_after

from apscheduler.abc import Job
from apscheduler.datastores.sync.memory import MemoryDataStore
from apscheduler.events import (
    Event, JobAdded, JobCompleted, JobDeadlineMissed, JobFailed, JobStarted, TaskAdded,
    WorkerStarted, WorkerStopped)
from apscheduler.structures import Task
from apscheduler.workers.async_ import AsyncWorker
from apscheduler.workers.sync import Worker

pytestmark = pytest.mark.anyio


def sync_func(*args, fail: bool, **kwargs):
    if fail:
        raise Exception('failing as requested')
    else:
        return args, kwargs


async def async_func(*args, fail: bool, **kwargs):
    if fail:
        raise Exception('failing as requested')
    else:
        return args, kwargs


def fail_func():
    pytest.fail('This function should never be run')


class TestAsyncWorker:
    @pytest.mark.parametrize('target_func', [sync_func, async_func], ids=['sync', 'async'])
    @pytest.mark.parametrize('fail', [False, True], ids=['success', 'fail'])
    async def test_run_job_nonscheduled_success(self, target_func: Callable, fail: bool) -> None:
        def listener(received_event: Event):
            received_events.append(received_event)
            if len(received_events) == 5:
                event.set()

        received_events: List[Event] = []
        event = anyio.Event()
        data_store = MemoryDataStore()
        worker = AsyncWorker(data_store)
        worker.subscribe(listener)
        async with worker:
            await worker.data_store.add_task(Task(id='task_id', func=target_func))
            job = Job(task_id='task_id', args=(1, 2), kwargs={'x': 'foo', 'fail': fail})
            await worker.data_store.add_job(job)
            with fail_after(3):
                await event.wait()

        # The worker was first started
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStarted)

        # Then the task was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, TaskAdded)
        assert received_event.task_id == 'task_id'

        # Then a job was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobAdded)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id is None

        # Then the job was started
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobStarted)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id is None

        received_event = received_events.pop(0)
        if fail:
            # Then the job failed
            assert isinstance(received_event, JobFailed)
            assert isinstance(received_event.exc_type, str)
            assert isinstance(received_event.exc_val, str)
            assert isinstance(received_event.exc_tb, str)
        else:
            # Then the job finished successfully
            assert isinstance(received_event, JobCompleted)
            assert received_event.return_value == "((1, 2), {'x': 'foo'})"

        # Finally, the worker was stopped
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStopped)

        # There should be no more events on the list
        assert not received_events

    async def test_run_deadline_missed(self) -> None:
        def listener(received_event: Event):
            received_events.append(received_event)
            if len(received_events) == 4:
                event.set()

        scheduled_start_time = datetime(2020, 9, 14, tzinfo=timezone.utc)
        received_events: List[Event] = []
        event = anyio.Event()
        data_store = MemoryDataStore()
        worker = AsyncWorker(data_store)
        worker.subscribe(listener)
        async with worker:
            await worker.data_store.add_task(Task(id='task_id', func=fail_func))
            job = Job(task_id='task_id', schedule_id='foo',
                      scheduled_fire_time=scheduled_start_time,
                      start_deadline=datetime(2020, 9, 14, 1, tzinfo=timezone.utc))
            await worker.data_store.add_job(job)
            with fail_after(3):
                await event.wait()

        # The worker was first started
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStarted)

        # Then the task was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, TaskAdded)
        assert received_event.task_id == 'task_id'

        # Then a job was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobAdded)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id == 'foo'

        # Then the deadline was missed
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobDeadlineMissed)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id == 'foo'

        # Finally, the worker was stopped
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStopped)

        # There should be no more events on the list
        assert not received_events


class TestSyncWorker:
    @pytest.mark.parametrize('fail', [False, True], ids=['success', 'fail'])
    def test_run_job_nonscheduled(self, fail: bool) -> None:
        def listener(received_event: Event):
            received_events.append(received_event)
            if len(received_events) == 5:
                event.set()

        received_events: List[Event] = []
        event = threading.Event()
        data_store = MemoryDataStore()
        worker = Worker(data_store)
        worker.subscribe(listener)
        with worker:
            worker.data_store.add_task(Task(id='task_id', func=sync_func))
            job = Job(task_id='task_id', args=(1, 2), kwargs={'x': 'foo', 'fail': fail})
            worker.data_store.add_job(job)
            event.wait(5)

        # The worker was first started
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStarted)

        # Then the task was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, TaskAdded)
        assert received_event.task_id == 'task_id'

        # Then a job was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobAdded)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id is None

        # Then the job was started
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobStarted)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id is None

        received_event = received_events.pop(0)
        if fail:
            # Then the job failed
            assert isinstance(received_event, JobFailed)
            assert isinstance(received_event.exc_type, str)
            assert isinstance(received_event.exc_val, str)
            assert isinstance(received_event.exc_tb, str)
        else:
            # Then the job finished successfully
            assert isinstance(received_event, JobCompleted)
            assert received_event.return_value == "((1, 2), {'x': 'foo'})"

        # Finally, the worker was stopped
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStopped)

        # There should be no more events on the list
        assert not received_events

    def test_run_deadline_missed(self) -> None:
        def listener(worker_event: Event):
            received_events.append(worker_event)
            if len(received_events) == 4:
                event.set()

        scheduled_start_time = datetime(2020, 9, 14, tzinfo=timezone.utc)
        received_events: List[Event] = []
        event = threading.Event()
        data_store = MemoryDataStore()
        worker = Worker(data_store)
        worker.subscribe(listener)
        with worker:
            worker.data_store.add_task(Task(id='task_id', func=fail_func))
            job = Job(task_id='task_id', schedule_id='foo',
                      scheduled_fire_time=scheduled_start_time,
                      start_deadline=datetime(2020, 9, 14, 1, tzinfo=timezone.utc))
            worker.data_store.add_job(job)
            event.wait(5)

        # The worker was first started
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStarted)

        # Then the task was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, TaskAdded)
        assert received_event.task_id == 'task_id'

        # Then a job was added
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobAdded)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id == 'foo'

        # Then the deadline was missed
        received_event = received_events.pop(0)
        assert isinstance(received_event, JobDeadlineMissed)
        assert received_event.job_id == job.id
        assert received_event.task_id == 'task_id'
        assert received_event.schedule_id == 'foo'

        # Finally, the worker was stopped
        received_event = received_events.pop(0)
        assert isinstance(received_event, WorkerStopped)

        # There should be no more events on the list
        assert not received_events