Перейти к содержанию

AsyncTestCase

Async test classes.

AsyncTestCase

Bases: BaseTestCase

Асинхронный кейс тестирования.

Пример

from qtasks import QueueTasks
from qtasks.tests import AsyncTestCase

app = QueueTasks()

test_case = AsyncTestCase(app=app)
Source code in src/qtasks/tests/async_testcase.py 
 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
class AsyncTestCase(BaseTestCase):
    """
    Асинхронный кейс тестирования.

    ## Пример

    ```python
    from qtasks import QueueTasks
    from qtasks.tests import AsyncTestCase

    app = QueueTasks()

    test_case = AsyncTestCase(app=app)
    ```
    """

    def __init__(
        self,
        app: Annotated[
            "QueueTasks",
            Doc(
                """
                    Основной экземпляр.
                    """
            ),
        ],
        name: Annotated[
            Optional[str],
            Doc(
                """
                    Имя проекта. Это имя может быть использовано для тестовых компонентов.

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
    ):
        """Асинхронный тестовый кейс.

        Args:
            app (QueueTasks, Doc): Основной экземпляр.
            name (str, optional): Имя проекта. Это имя может быть использовано для тестовых компонентов. По умолчанию: `None`.
        """
        super().__init__(app=app, name=name)

        self._global_loop: Union[asyncio.AbstractEventLoop, None] = None

    def start_in_background(
        self,
        starter: Annotated[
            Optional["BaseStarter"],
            Doc(
                """
                    Стартер. Хранит в себе способы запуска компонентов.

                    По умолчанию: `qtasks.starters.AsyncStarter`.
                    """
            ),
        ] = None,
        num_workers: Annotated[
            int,
            Doc(
                """
                    Количество запущенных воркеров.

                    По умолчанию: `4`.
                    """
            ),
        ] = 4,
        reset_config: Annotated[
            bool,
            Doc(
                """
                    Обновить config у воркера и брокера.

                    По умолчанию: `True`.
                    """
            ),
        ] = True,
    ):  # TODO: fix!
        """Запустить `app.run_forever()` в фоновом режиме.

        Args:
            starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.AsyncStarter`.
            num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
            reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
        """

        def run_loop():
            loop = asyncio.new_event_loop()
            asyncio.set_event_loop(loop)
            try:
                loop.run_until_complete(self.start(loop=loop, num_workers=num_workers))
            finally:
                loop.close()

        thread = threading.Thread(target=run_loop, daemon=True)
        thread.start()

    def start(
        self,
        loop: Annotated[
            Optional[asyncio.AbstractEventLoop],
            Doc(
                """
                    Асинхронный loop.

                    По умолчанию: `None`.
                    """
            ),
        ] = None,
        starter: Annotated[
            Optional["BaseStarter"],
            Doc(
                """
                    Стартер. Хранит в себе способы запуска компонентов.

                    По умолчанию: `qtasks.starters.AsyncStarter`.
                    """
            ),
        ] = None,
        num_workers: Annotated[
            int,
            Doc(
                """
                    Количество запущенных воркеров.

                    По умолчанию: `4`.
                    """
            ),
        ] = 4,
        reset_config: Annotated[
            bool,
            Doc(
                """
                    Обновить config у воркера и брокера.

                    По умолчанию: `True`.
                    """
            ),
        ] = True,
    ) -> None:
        """Запускает `app.run_forever()`.

        Args:
            loop (asyncio.AbstractEventLoop, optional): асинхронный loop. По умолчанию: None.
            starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.AsyncStarter`.
            num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
            reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
        """
        self.app.run_forever(
            loop=loop,
            starter=starter,
            num_workers=num_workers,
            reset_config=reset_config,
        )

    async def stop(self):
        """Останавливает кейс тестирования."""
        if self.test_config.global_config:
            self.app.broker.storage.global_config.stop()

        if self.test_config.storage:
            self.app.broker.storage.stop()

        if self.test_config.broker:
            self.app.broker.stop()

        if self.test_config.worker:
            await self.app.worker.stop()
        return

    async def add_task(
        self,
        task_name: Annotated[
            str,
            Doc(
                """
                    Имя задачи.
                    """
            ),
        ],
        *args: Annotated[
            Optional[tuple],
            Doc(
                """
                    args задачи.

                    По умолчанию: `()`.
                    """
            ),
        ],
        priority: Annotated[
            Optional[int],
            Doc(
                """
                    Приоритет у задачи.

                    По умолчанию: Значение приоритета у задачи.
                    """
            ),
        ] = None,
        timeout: Annotated[
            Optional[float],
            Doc(
                """
                    Таймаут задачи.

                    Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                    """
            ),
        ] = None,
        **kwargs: Annotated[
            Optional[dict],
            Doc(
                """
                    kwargs задачи.

                    По умолчанию: `{}`.
                    """
            ),
        ],
    ) -> Union["Task", None]:
        """Добавить задачу.

        Args:
            task_name (str): Имя задачи.
            priority (int, optional): Приоритет задачи. По умолчанию: `0`.
            args (tuple, optional): args задачи. По умолчанию: `()`.
            kwargs (dict, optional): kwargs задачи. По умолчанию: `{}`

            timeout (float, optional): Таймаут задачи. Если указан, задача вызывается через `qtasks.results.AsyncResult`.

        Returns:
            Task|None: Данные задачи или None.
        """
        if self.test_config.broker:
            args, kwargs = args or (), kwargs or {}
            return await self.app.add_task(
                *args,
                task_name=task_name,
                priority=priority,
                timeout=timeout,
                **kwargs
            )
        elif self.test_config.worker:
            return await self.app.worker.add(
                name=task_name,
                uuid=uuid4(),
                priority=priority,
                created_at=time(),
                args=args or (),
                kwargs=kwargs or {},
            )
        else:
            print(
                f"[AsyncTestCase: {self.name}] Обязательно включить Воркер или Брокер!"
            )
            return

    async def get(
        self,
        uuid: Annotated[
            Union[UUID, str],
            Doc(
                """
                    UUID задачи.
                    """
            ),
        ],
    ) -> Union["Task", None]:
        """Получить задачу.

        Args:
            uuid (UUID|str): UUID Задачи.

        Returns:
            Task|None: Данные задачи или None.
        """
        if isinstance(uuid, str):
            uuid = UUID(uuid)
        if not self.test_config.broker:
            print(f"[AsyncTestCase: {self.name}] Обязательно включить Брокер!")
            return
        return await self.app.broker.get(uuid=uuid)

__init__(app, name=None)

Асинхронный тестовый кейс.

Parameters:

Name Type Description Default
app (QueueTasks, Doc)

Основной экземпляр.

 required
name str

Имя проекта. Это имя может быть использовано для тестовых компонентов. По умолчанию: None.

 None
Source code in src/qtasks/tests/async_testcase.py 
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
def __init__(
    self,
    app: Annotated[
        "QueueTasks",
        Doc(
            """
                Основной экземпляр.
                """
        ),
    ],
    name: Annotated[
        Optional[str],
        Doc(
            """
                Имя проекта. Это имя может быть использовано для тестовых компонентов.

                По умолчанию: `None`.
                """
        ),
    ] = None,
):
    """Асинхронный тестовый кейс.

    Args:
        app (QueueTasks, Doc): Основной экземпляр.
        name (str, optional): Имя проекта. Это имя может быть использовано для тестовых компонентов. По умолчанию: `None`.
    """
    super().__init__(app=app, name=name)

    self._global_loop: Union[asyncio.AbstractEventLoop, None] = None

add_task(task_name, *args, priority=None, timeout=None, **kwargs) async

Добавить задачу.

Parameters:

Name Type Description Default
task_name str

Имя задачи.

 required
priority int

Приоритет задачи. По умолчанию: 0.

 None
args tuple

args задачи. По умолчанию: ().

 ()
kwargs dict

kwargs задачи. По умолчанию: {}

 {}
timeout float

Таймаут задачи. Если указан, задача вызывается через qtasks.results.AsyncResult.

 None

Returns:

Type Description
Union[Task, None]

Task|None: Данные задачи или None.
Source code in src/qtasks/tests/async_testcase.py 
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
async def add_task(
    self,
    task_name: Annotated[
        str,
        Doc(
            """
                Имя задачи.
                """
        ),
    ],
    *args: Annotated[
        Optional[tuple],
        Doc(
            """
                args задачи.

                По умолчанию: `()`.
                """
        ),
    ],
    priority: Annotated[
        Optional[int],
        Doc(
            """
                Приоритет у задачи.

                По умолчанию: Значение приоритета у задачи.
                """
        ),
    ] = None,
    timeout: Annotated[
        Optional[float],
        Doc(
            """
                Таймаут задачи.

                Если указан, задача возвращается через `qtasks.results.AsyncTask`.
                """
        ),
    ] = None,
    **kwargs: Annotated[
        Optional[dict],
        Doc(
            """
                kwargs задачи.

                По умолчанию: `{}`.
                """
        ),
    ],
) -> Union["Task", None]:
    """Добавить задачу.

    Args:
        task_name (str): Имя задачи.
        priority (int, optional): Приоритет задачи. По умолчанию: `0`.
        args (tuple, optional): args задачи. По умолчанию: `()`.
        kwargs (dict, optional): kwargs задачи. По умолчанию: `{}`

        timeout (float, optional): Таймаут задачи. Если указан, задача вызывается через `qtasks.results.AsyncResult`.

    Returns:
        Task|None: Данные задачи или None.
    """
    if self.test_config.broker:
        args, kwargs = args or (), kwargs or {}
        return await self.app.add_task(
            *args,
            task_name=task_name,
            priority=priority,
            timeout=timeout,
            **kwargs
        )
    elif self.test_config.worker:
        return await self.app.worker.add(
            name=task_name,
            uuid=uuid4(),
            priority=priority,
            created_at=time(),
            args=args or (),
            kwargs=kwargs or {},
        )
    else:
        print(
            f"[AsyncTestCase: {self.name}] Обязательно включить Воркер или Брокер!"
        )
        return

get(uuid) async

Получить задачу.

Parameters:

Name Type Description Default
uuid UUID | str

UUID Задачи.

 required

Returns:

Type Description
Union[Task, None]

Task|None: Данные задачи или None.
Source code in src/qtasks/tests/async_testcase.py 
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
async def get(
    self,
    uuid: Annotated[
        Union[UUID, str],
        Doc(
            """
                UUID задачи.
                """
        ),
    ],
) -> Union["Task", None]:
    """Получить задачу.

    Args:
        uuid (UUID|str): UUID Задачи.

    Returns:
        Task|None: Данные задачи или None.
    """
    if isinstance(uuid, str):
        uuid = UUID(uuid)
    if not self.test_config.broker:
        print(f"[AsyncTestCase: {self.name}] Обязательно включить Брокер!")
        return
    return await self.app.broker.get(uuid=uuid)

start(loop=None, starter=None, num_workers=4, reset_config=True)

Запускает app.run_forever().

Parameters:

Name Type Description Default
loop AbstractEventLoop

асинхронный loop. По умолчанию: None.

 None
starter BaseStarter

Стартер. По умолчанию: qtasks.starters.AsyncStarter.

 None
num_workers int

Количество запущенных воркеров. По умолчанию: 4.

 4
reset_config bool

Обновить config у воркера и брокера. По умолчанию: True.

 True
Source code in src/qtasks/tests/async_testcase.py 
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
def start(
    self,
    loop: Annotated[
        Optional[asyncio.AbstractEventLoop],
        Doc(
            """
                Асинхронный loop.

                По умолчанию: `None`.
                """
        ),
    ] = None,
    starter: Annotated[
        Optional["BaseStarter"],
        Doc(
            """
                Стартер. Хранит в себе способы запуска компонентов.

                По умолчанию: `qtasks.starters.AsyncStarter`.
                """
        ),
    ] = None,
    num_workers: Annotated[
        int,
        Doc(
            """
                Количество запущенных воркеров.

                По умолчанию: `4`.
                """
        ),
    ] = 4,
    reset_config: Annotated[
        bool,
        Doc(
            """
                Обновить config у воркера и брокера.

                По умолчанию: `True`.
                """
        ),
    ] = True,
) -> None:
    """Запускает `app.run_forever()`.

    Args:
        loop (asyncio.AbstractEventLoop, optional): асинхронный loop. По умолчанию: None.
        starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.AsyncStarter`.
        num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
        reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
    """
    self.app.run_forever(
        loop=loop,
        starter=starter,
        num_workers=num_workers,
        reset_config=reset_config,
    )

start_in_background(starter=None, num_workers=4, reset_config=True)

Запустить app.run_forever() в фоновом режиме.

Parameters:

Name Type Description Default
starter BaseStarter

Стартер. По умолчанию: qtasks.starters.AsyncStarter.

 None
num_workers int

Количество запущенных воркеров. По умолчанию: 4.

 4
reset_config bool

Обновить config у воркера и брокера. По умолчанию: True.

 True
Source code in src/qtasks/tests/async_testcase.py 
 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
def start_in_background(
    self,
    starter: Annotated[
        Optional["BaseStarter"],
        Doc(
            """
                Стартер. Хранит в себе способы запуска компонентов.

                По умолчанию: `qtasks.starters.AsyncStarter`.
                """
        ),
    ] = None,
    num_workers: Annotated[
        int,
        Doc(
            """
                Количество запущенных воркеров.

                По умолчанию: `4`.
                """
        ),
    ] = 4,
    reset_config: Annotated[
        bool,
        Doc(
            """
                Обновить config у воркера и брокера.

                По умолчанию: `True`.
                """
        ),
    ] = True,
):  # TODO: fix!
    """Запустить `app.run_forever()` в фоновом режиме.

    Args:
        starter (BaseStarter, optional): Стартер. По умолчанию: `qtasks.starters.AsyncStarter`.
        num_workers (int, optional): Количество запущенных воркеров. По умолчанию: 4.
        reset_config (bool, optional): Обновить config у воркера и брокера. По умолчанию: True.
    """

    def run_loop():
        loop = asyncio.new_event_loop()
        asyncio.set_event_loop(loop)
        try:
            loop.run_until_complete(self.start(loop=loop, num_workers=num_workers))
        finally:
            loop.close()

    thread = threading.Thread(target=run_loop, daemon=True)
    thread.start()

stop() async

Останавливает кейс тестирования.

Source code in src/qtasks/tests/async_testcase.py 
175
176
177
178
179
180
181
182
183
184
185
186
187
188
async def stop(self):
    """Останавливает кейс тестирования."""
    if self.test_config.global_config:
        self.app.broker.storage.global_config.stop()

    if self.test_config.storage:
        self.app.broker.storage.stop()

    if self.test_config.broker:
        self.app.broker.stop()

    if self.test_config.worker:
        await self.app.worker.stop()
    return