File: test_trello.py

package info (click to toggle)
bugwarrior 1.8.0-12
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,280 kB
  • sloc: python: 9,226; makefile: 147
file content (228 lines) | stat: -rw-r--r-- 9,685 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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
from __future__ import unicode_literals, print_function
from builtins import next
from unittest.mock import patch

from six.moves import configparser
import responses

from dateutil.parser import parse as parse_date
from dateutil.tz import tzlocal

from bugwarrior.config import ServiceConfig
from bugwarrior.services.trello import TrelloService, TrelloIssue
from .base import ConfigTest, ServiceTest


class TestTrelloIssue(ServiceTest):
    JSON = {
        "due": "2018-12-02T12:59:00.000Z",
        "id": "542bbb6583d705eb05bbe491",
        "idShort": 42,
        "name": "So long, and thanks for all the fish!",
        "shortLink": "AAaaBBbb",
        "shortUrl": "https://trello.com/c/AAaaBBbb",
        "url": "https://trello.com/c/AAaBBbb/42-so-long",
        "labels": [{'name': "foo"}, {"name": "bar"}],
        "desc": "some description",
        }

    def setUp(self):
        super(TestTrelloIssue, self).setUp()
        origin = dict(inline_links=True, description_length=31,
                      import_labels_as_tags=True, default_priority='M')
        extra = {'boardname': 'Hyperspatial express route',
                 'listname': 'Something'}
        self.issue = TrelloIssue(self.JSON, origin, extra)

    def test_default_description(self):
        """ Test the generated description """
        expected_desc = "(bw)#42 - So long, and thanks for all the" \
                        " .. https://trello.com/c/AAaaBBbb"
        self.assertEqual(expected_desc, self.issue.get_default_description())

    def test_to_taskwarrior__project(self):
        """ By default, the project is the board name """
        expected_project = "Hyperspatial express route"
        self.assertEqual(expected_project,
                         self.issue.to_taskwarrior().get('project', None))


class TestTrelloService(ConfigTest):
    BOARD = {'id': 'B04RD', 'name': 'My Board'}
    CARD1 = {'id': 'C4RD', 'name': 'Card 1', 'members': [{'username': 'tintin'}],
             'due': '2018-12-02T12:59:00.000Z',
             'idShort': 1,
             'shortLink': 'abcd',
             'shortUrl': 'https://trello.com/c/AAaaBBbb',
             'desc': 'some description',
             'url': 'https://trello.com/c/AAaBBbb/42-so-long'}
    CARD2 = {'id': 'kard', 'name': 'Card 2', 'members': [{'username': 'mario'}]}
    CARD3 = {'id': 'K4rD', 'name': 'Card 3', 'members': []}
    LIST1 = {'id': 'L15T', 'name': 'List 1'}
    LIST2 = {'id': 'ZZZZ', 'name': 'List 2'}
    COMMENT1 = { "type": "commentCard",
                 "data": { "text": "Preums" },
                 "memberCreator": { "username": "luidgi" } }
    COMMENT2 = { "type": "commentCard",
                 "data": { "text": "Deuz" },
                 "memberCreator": { "username": "mario" } }

    def setUp(self):
        super(TestTrelloService, self).setUp()
        self.config = configparser.RawConfigParser()
        self.config.add_section('general')
        self.config.add_section('mytrello')
        self.config.set('mytrello', 'trello.api_key', 'XXXX')
        self.config.set('mytrello', 'trello.token', 'YYYY')
        self.service_config = ServiceConfig(
            TrelloService.CONFIG_PREFIX, self.config, 'mytrello')
        responses.add(responses.GET,
                      'https://api.trello.com/1/lists/L15T/cards/open',
                      json=[self.CARD1, self.CARD2, self.CARD3])
        responses.add(responses.GET,
                      'https://api.trello.com/1/boards/B04RD/lists/open',
                      json=[self.LIST1, self.LIST2])
        responses.add(responses.GET,
                      'https://api.trello.com/1/boards/F00',
                      json={'id': 'F00', 'name': 'Foo Board'})
        responses.add(responses.GET,
                      'https://api.trello.com/1/boards/B4R',
                      json={'id': 'B4R', 'name': 'Bar Board'})
        responses.add(responses.GET,
                      'https://api.trello.com/1/members/me/boards',
                      json=[self.BOARD])
        responses.add(responses.GET,
                      'https://api.trello.com/1/cards/C4RD/actions',
                      json=[self.COMMENT1, self.COMMENT2])

    @responses.activate
    def test_get_boards_config(self):
        self.config.set('mytrello', 'trello.include_boards', 'F00, B4R')
        service = TrelloService(self.config, 'general', 'mytrello')
        boards = service.get_boards()
        self.assertEqual(list(boards), [{'id': 'F00', 'name': 'Foo Board'},
                                        {'id': 'B4R', 'name': 'Bar Board'}])

    @responses.activate
    def test_get_boards_api(self):
        service = TrelloService(self.config, 'general', 'mytrello')
        boards = service.get_boards()
        self.assertEqual(list(boards), [self.BOARD])

    @responses.activate
    def test_get_lists(self):
        service = TrelloService(self.config, 'general', 'mytrello')
        lists = service.get_lists('B04RD')
        self.assertEqual(list(lists), [self.LIST1, self.LIST2])

    @responses.activate
    def test_get_lists_include(self):
        self.config.set('mytrello', 'trello.include_lists', 'List 1')
        service = TrelloService(self.config, 'general', 'mytrello')
        lists = service.get_lists('B04RD')
        self.assertEqual(list(lists), [self.LIST1])

    @responses.activate
    def test_get_lists_exclude(self):
        self.config.set('mytrello', 'trello.exclude_lists', 'List 1')
        service = TrelloService(self.config, 'general', 'mytrello')
        lists = service.get_lists('B04RD')
        self.assertEqual(list(lists), [self.LIST2])

    @responses.activate
    def test_get_cards(self):
        service = TrelloService(self.config, 'general', 'mytrello')
        cards = service.get_cards('L15T')
        self.assertEqual(list(cards), [self.CARD1, self.CARD2, self.CARD3])

    @responses.activate
    def test_get_cards_assigned(self):
        self.config.set('mytrello', 'trello.only_if_assigned', 'tintin')
        service = TrelloService(self.config, 'general', 'mytrello')
        cards = service.get_cards('L15T')
        self.assertEqual(list(cards), [self.CARD1])

    @responses.activate
    def test_get_cards_assigned_unassigned(self):
        self.config.set('mytrello', 'trello.only_if_assigned', 'tintin')
        self.config.set('mytrello', 'trello.also_unassigned', 'true')
        service = TrelloService(self.config, 'general', 'mytrello')
        cards = service.get_cards('L15T')
        self.assertEqual(list(cards), [self.CARD1, self.CARD3])

    @responses.activate
    def test_get_comments(self):
        service = TrelloService(self.config, 'general', 'mytrello')
        comments = service.get_comments('C4RD')
        self.assertEqual(list(comments), [self.COMMENT1, self.COMMENT2])

    @responses.activate
    def test_annotations(self):
        service = TrelloService(self.config, 'general', 'mytrello')
        annotations = service.annotations(self.CARD1)
        self.assertEqual(
            list(annotations), ["@luidgi - Preums", "@mario - Deuz"])

    @responses.activate
    def test_annotations_with_link(self):
        self.config.set('general', 'annotation_links', 'true')
        service = TrelloService(self.config, 'general', 'mytrello')
        annotations = service.annotations(self.CARD1)
        self.assertEqual(
            list(annotations),
            ["https://trello.com/c/AAaaBBbb",
             "@luidgi - Preums",
             "@mario - Deuz"])

    @responses.activate
    def test_issues(self):
        self.config.set('mytrello', 'trello.include_lists', 'List 1')
        self.config.set('mytrello', 'trello.only_if_assigned', 'tintin')
        service = TrelloService(self.config, 'general', 'mytrello')
        issues = service.issues()
        expected = {
            'due': parse_date('2018-12-02T12:59:00.000Z'),
            'description': u'(bw)#1 - Card 1 .. https://trello.com/c/AAaaBBbb',
            'priority': 'M',
            'project': 'My Board',
            'trelloboard': 'My Board',
            'trellolist': 'List 1',
            'trellocard': 'Card 1',
            'trellocardid': 'C4RD',
            'trellocardidshort': 1,
            'trellodescription': 'some description',
            'trelloshortlink': 'abcd',
            'trelloshorturl': 'https://trello.com/c/AAaaBBbb',
            'trellourl': 'https://trello.com/c/AAaBBbb/42-so-long',
            'annotations': [
                "@luidgi - Preums",
                "@mario - Deuz" ],
            'tags': []}
        actual = next(issues).get_taskwarrior_record()
        self.assertEqual(expected, actual)

    maxDiff = None

    @patch('bugwarrior.services.trello.die')
    def test_validate_config(self, die):
        TrelloService.validate_config(self.service_config, 'mytrello')
        die.assert_not_called()

    @patch('bugwarrior.services.trello.die')
    def test_valid_config_no_access_token(self, die):
        self.config.remove_option('mytrello', 'trello.token')
        TrelloService.validate_config(self.service_config, 'mytrello')
        die.assert_called_with("[mytrello] has no 'trello.token'")

    @patch('bugwarrior.services.trello.die')
    def test_valid_config_no_api_key(self, die):
        self.config.remove_option('mytrello', 'trello.api_key')
        TrelloService.validate_config(self.service_config, 'mytrello')
        die.assert_called_with("[mytrello] has no 'trello.api_key'")


    def test_keyring_service(self):
        """ Checks that the keyring service name """
        keyring_service = TrelloService.get_keyring_service(self.service_config)
        self.assertEqual("trello://XXXX@trello.com", keyring_service)