File: test_api_comments.py

package info (click to toggle)
todoist-api-python 3.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 520 kB
  • sloc: python: 3,822; makefile: 3
file content (212 lines) | stat: -rw-r--r-- 5,795 bytes parent folder | download
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
from __future__ import annotations

from typing import TYPE_CHECKING, Any

import pytest
import responses

from tests.data.test_defaults import (
    DEFAULT_API_URL,
    PaginatedResults,
)
from tests.utils.test_utils import (
    auth_matcher,
    data_matcher,
    enumerate_async,
    param_matcher,
    request_id_matcher,
)
from todoist_api_python.models import Attachment

if TYPE_CHECKING:
    from todoist_api_python.api import TodoistAPI
    from todoist_api_python.api_async import TodoistAPIAsync

from todoist_api_python.models import Comment


@pytest.mark.asyncio
async def test_get_comment(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    requests_mock: responses.RequestsMock,
    default_comment_response: dict[str, Any],
    default_comment: Comment,
) -> None:
    comment_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/comments/{comment_id}"

    requests_mock.add(
        method=responses.GET,
        url=endpoint,
        json=default_comment_response,
        status=200,
        match=[auth_matcher(), request_id_matcher()],
    )

    comment = todoist_api.get_comment(comment_id)

    assert len(requests_mock.calls) == 1
    assert comment == default_comment

    comment = await todoist_api_async.get_comment(comment_id)

    assert len(requests_mock.calls) == 2
    assert comment == default_comment


@pytest.mark.asyncio
async def test_get_comments(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    requests_mock: responses.RequestsMock,
    default_comments_response: list[PaginatedResults],
    default_comments_list: list[list[Comment]],
) -> None:
    task_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/comments"

    cursor: str | None = None
    for page in default_comments_response:
        requests_mock.add(
            method=responses.GET,
            url=endpoint,
            json=page,
            status=200,
            match=[
                auth_matcher(),
                request_id_matcher(),
                param_matcher({"task_id": task_id}, cursor),
            ],
        )
        cursor = page["next_cursor"]

    count = 0

    comments_iter = todoist_api.get_comments(task_id=task_id)

    for i, comments in enumerate(comments_iter):
        assert len(requests_mock.calls) == count + 1
        assert comments == default_comments_list[i]
        count += 1

    comments_async_iter = await todoist_api_async.get_comments(task_id=task_id)

    async for i, comments in enumerate_async(comments_async_iter):
        assert len(requests_mock.calls) == count + 1
        assert comments == default_comments_list[i]
        count += 1


@pytest.mark.asyncio
async def test_add_comment(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    requests_mock: responses.RequestsMock,
    default_comment_response: dict[str, Any],
    default_comment: Comment,
) -> None:
    content = "A Comment"
    project_id = "6HWcc9PJCvPjCxC9"
    attachment = Attachment(
        resource_type="file",
        file_url="https://s3.amazonaws.com/domorebetter/Todoist+Setup+Guide.pdf",
        file_type="application/pdf",
        file_name="File.pdf",
    )

    requests_mock.add(
        method=responses.POST,
        url=f"{DEFAULT_API_URL}/comments",
        json=default_comment_response,
        status=200,
        match=[
            auth_matcher(),
            request_id_matcher(),
            data_matcher(
                {
                    "content": content,
                    "project_id": project_id,
                    "attachment": attachment.to_dict(),
                }
            ),
        ],
    )

    new_comment = todoist_api.add_comment(
        content=content,
        project_id=project_id,
        attachment=attachment,
    )

    assert len(requests_mock.calls) == 1
    assert new_comment == default_comment

    new_comment = await todoist_api_async.add_comment(
        content=content,
        project_id=project_id,
        attachment=attachment,
    )

    assert len(requests_mock.calls) == 2
    assert new_comment == default_comment


@pytest.mark.asyncio
async def test_update_comment(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    requests_mock: responses.RequestsMock,
    default_comment: Comment,
) -> None:
    args = {
        "content": "An updated comment",
    }
    updated_comment_dict = default_comment.to_dict() | args

    requests_mock.add(
        method=responses.POST,
        url=f"{DEFAULT_API_URL}/comments/{default_comment.id}",
        json=updated_comment_dict,
        status=200,
        match=[auth_matcher(), request_id_matcher(), data_matcher(args)],
    )

    response = todoist_api.update_comment(comment_id=default_comment.id, **args)

    assert len(requests_mock.calls) == 1
    assert response == Comment.from_dict(updated_comment_dict)

    response = await todoist_api_async.update_comment(
        comment_id=default_comment.id, **args
    )

    assert len(requests_mock.calls) == 2
    assert response == Comment.from_dict(updated_comment_dict)


@pytest.mark.asyncio
async def test_delete_comment(
    todoist_api: TodoistAPI,
    todoist_api_async: TodoistAPIAsync,
    requests_mock: responses.RequestsMock,
) -> None:
    comment_id = "6X7rM8997g3RQmvh"
    endpoint = f"{DEFAULT_API_URL}/comments/{comment_id}"

    requests_mock.add(
        method=responses.DELETE,
        url=endpoint,
        status=204,
        match=[auth_matcher(), request_id_matcher()],
    )

    response = todoist_api.delete_comment(comment_id)

    assert len(requests_mock.calls) == 1
    assert response is True

    response = await todoist_api_async.delete_comment(comment_id)

    assert len(requests_mock.calls) == 2
    assert response is True