File: test_jsonrpc.py

package info (click to toggle)
deejayd 0.9.0-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 2,596 kB
  • ctags: 2,514
  • sloc: python: 11,904; xml: 594; sh: 338; makefile: 42
file content (306 lines) | stat: -rw-r--r-- 12,360 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
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
303
304
305
306
# Deejayd, a media player daemon
# Copyright (C) 2007-2009 Mickael Royer <mickael.royer@gmail.com>
#                         Alexandre Rossi <alexandre.rossi@gmail.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

"""Deejayd JSON-RPC protocol testing"""

import re
from testdeejayd import TestCaseWithAudioAndVideoData, TestCaseWithData
from deejayd.mediafilters import *
from deejayd.interfaces import DeejaydSignal
from deejayd.net.client import _DeejayDaemon,\
        DeejaydAnswer, DeejaydKeyValue, DeejaydList,\
        DeejaydFileList, DeejaydMediaList,\
        DeejaydStaticPlaylist, DeejaydError
from deejayd.rpc.jsonbuilders import JSONRPCRequest, JSONRPCResponse,\
                                     Get_json_filter, DeejaydJSONSignal

def trim_json(json):
    return re.sub('(\s{2,})|(\\n)',' ', json)

class TestJSONRPCBuilders(TestCaseWithData):

    def test_request_builder(self):
        """ test JSON-RPC request building """
        cmd = JSONRPCRequest("m_name", ["args1", 2])
        expected_answer = """{"params": ["args1", 2],
                "method": "m_name",
                "id": %d}""" % cmd.get_id()
        self.assertEqual(trim_json(cmd.to_json()), trim_json(expected_answer))

    def test_response_builder(self):
        """ test JSON-RPC response building """
        expected_answer = """{"id": 22,
                "result": {"answer": ["r1", "r2"],
                "type": "type1"}, "error": null}"""
        ans = JSONRPCResponse({"type": "type1", "answer": ["r1", "r2"]}, 22)
        self.assertEqual(trim_json(ans.to_json()), trim_json(expected_answer))

    def test_filter_builder(self):
        """ test JSON-RPC mediafilter building """
        filter = And(Equals("artist", "artist_name"),\
                Or(Contains("genre", "Rock"), Higher("Rating", "4")))
        expected_answer = """{"type": "complex",
            "id": "and",
            "value": [{"type": "basic",
                       "id": "equals",
                       "value": {"pattern": "artist_name", "tag": "artist"}},
                      {"type": "complex",
                       "id": "or",
                       "value": [{"type": "basic",
                                  "id": "contains",
                                  "value": {"pattern": "Rock",
                                            "tag": "genre"}},
                                           {"type": "basic",
                                            "id": "higher",
                                            "value": {"pattern": "4",
                                                      "tag": "Rating"}}]}]}"""
        f = Get_json_filter(filter)
        self.assertEqual(trim_json(f.to_json()), trim_json(expected_answer))

    def test_signal_builder(self):
        """ test JSON-RPC Signal building """
        signal = DeejaydSignal("signal_name", {"attr1": "value1", "attr2": 22})
        expected_answer = """{"answer":
            {"name": "signal_name",
             "attrs": {"attr2": 22, "attr1": "value1"}},
            "type": "signal"}"""
        s = DeejaydJSONSignal(signal)
        self.assertEqual(trim_json(s.to_json()), trim_json(expected_answer))


class TestAnswerParser(TestCaseWithData):
    """Test the Deejayd client library answer parser"""

    def setUp(self):
        super(TestAnswerParser, self).setUp()
        self.deejayd = _DeejayDaemon()

    def parse_answer(self, str):
        self.deejayd._build_answer(str)

    def test_answer_parser_wrongformat(self):
        """Test the client library parsing a wrong format answer"""
        wrong_answer = """{"id": 1,
                "result": {"answer": true,
                "type": "ack"}}"""
        ans = DeejaydAnswer()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.assertRaises(DeejaydError, self.parse_answer, wrong_answer)

    def test_answer_parser_wrongid(self):
        """Test the client library parsing an answer with wrong id"""
        wrongid_answer = """{"id": 1,
                "error": null,
                "result": {"answer": true,
                "type": "ack"}}"""
        ans = DeejaydAnswer()
        ans.set_id(2)
        self.deejayd.expected_answers_queue.put(ans)
        self.assertRaises(DeejaydError, self.parse_answer, wrongid_answer)

    def test_answer_parser_ack(self):
        """Test the client library parsing an ack answer"""
        ack_answer = """{"id": 1,
                "result": {"answer": true,
                "type": "ack"}, "error": null}"""
        ans = DeejaydAnswer()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.parse_answer(ack_answer)

        self.failUnless(ans.get_contents())

    def test_answer_parser_keyvalue(self):
        """Test the client library parsing a key value answer"""
        how_much = 10
        orig_key_value = {}
        for count in range(how_much):
            key = self.testdata.getRandomString()
            value =  self.testdata.getRandomString()
            orig_key_value[key] = value
        key_value_answer = """{"id": 1,
                "error": null,
                "result": {"type": "dict",
                           "answer": {%s}}}""" \
            % ",".join([""" "%s": "%s" """ % (k,v) \
                            for k,v in orig_key_value.items()])

        ans = DeejaydKeyValue()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.parse_answer(key_value_answer)

        retrieved_key_values = ans.get_contents()
        for key in orig_key_value.keys():
            self.assertEqual(orig_key_value[key], retrieved_key_values[key])

    def test_answer_parser_list(self):
        """Test the client library parsing a list answer."""
        how_much = 10
        orig_list = []
        for count in range(how_much):
            item = self.testdata.getRandomString()
            orig_list.append(item)
        list_answer = """{"id": 1,
                "error": null,
                "result": {"type": "list",
                           "answer": [%s]}}""" \
            % ",".join([""" "%s" """ % v for v in orig_list])

        ans = DeejaydList()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.parse_answer(list_answer)
        retrieved_list = ans.get_contents()

        for item in orig_list:
            self.failUnless(item in retrieved_list)

    def test_answer_parser_fileanddir_list(self):
        """Test the client library parsing a file/dir list answer"""
        def dict_to_json(input):
            return """{%s}""" % ",".join([""" "%s": "%s" """ % (k,v)\
                    for k,v in input.items()])

        how_much = self.testdata.getRandomInt(50)
        orig_files, orig_dirs = [], []
        for count in range(how_much):
            if self.testdata.getRandomElement(['file','directory']) == 'file':
                file = {}
                file['id'] = count
                how_much_parms = self.testdata.getRandomInt()
                for parm_count in range(how_much_parms):
                    name = self.testdata.getRandomString()
                    value =  self.testdata.getRandomString()
                    file[name] = value

                orig_files.append(file)
            else:
                dirname = self.testdata.getRandomString()
                orig_dirs.append(dirname)
        fandd_list_answer = """{"id": 1,
                "error": null,
                "result": {"type": "fileAndDirList",
                           "answer": {"type": "song",
                                      "directories": [%(dirs)s],
                                      "files": [%(files)s],
                                      "root": ""}}}""" \
            % {
                "dirs": ",".join([""" "%s" """ % v for v in orig_dirs]),
                "files": ",".join([""" %s """ % dict_to_json(v)\
                                              for v in orig_files]),
            }

        ans = DeejaydFileList()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.parse_answer(fandd_list_answer)

        for file in orig_files:
            # Find corresponding file in retrieved files
            found = False
            for retrieved_file in ans.get_files():
                if file['id'] == int(retrieved_file['id']):
                    found = True
                    break

            for key in file.keys():
                self.failUnless(key in retrieved_file.keys())
                self.assertEqual(unicode(file[key]), retrieved_file[key])

        for dir in orig_dirs:
            self.failUnless(unicode(dir) in ans.get_directories())

    def test_answer_parser_medialist(self):
        """Test the client library parsing a medialist answer"""
        def dict_to_json(input):
            return """{%s}""" % ",".join([""" "%s": "%s" """ % (k,v)\
                    for k,v in input.items()])

        how_much = self.testdata.getRandomInt(50)
        orig_medias = []
        for count in range(how_much):
            media = {}
            media['id'] = count
            how_much_parms = self.testdata.getRandomInt()
            for parm_count in range(how_much_parms):
                name = self.testdata.getRandomString()
                value =  self.testdata.getRandomString()
                media[name] = value
            orig_medias.append(media)

        filter = And(Equals("artist", "artist_name"),\
                Or(Contains("genre", "Rock"), Higher("Rating", "4")))
        json_filter = Get_json_filter(filter)

        medialist_answer = """{"id": 1,
                "error": null,
                "result": {"type": "mediaList",
                           "answer": {"media_type": "song",
                                      "medias": [%(medias)s],
                                      "filter": %(filter)s}}}""" \
            % {
                "filter": json_filter.to_json(),
                "medias": ",".join([""" %s """ % dict_to_json(v)\
                                              for v in orig_medias]),
            }

        ans = DeejaydMediaList()
        ans.set_id(1)
        self.deejayd.expected_answers_queue.put(ans)
        self.parse_answer(medialist_answer)

        for media in orig_medias:
            # Find corresponding media
            found = False
            for retrieved_media in ans.get_medias():
                if media['id'] == int(retrieved_media['id']):
                    found = True
                    break

            for key in media.keys():
                self.failUnless(key in retrieved_media.keys())
                self.assertEqual(unicode(media[key]), retrieved_media[key])

        self.failUnless(ans.is_magic())
        self.failUnless(filter.equals(ans.get_filter()))

    def test_answer_parser_signal(self):
        """Parse a signal message"""
        sig_name = self.testdata.getRandomElement(DeejaydSignal.SIGNALS)
        raw_sig = """{"answer":
            {"name": "%s",
             "attrs": {"attr2": 22, "attr1": "value1"}},
            "type": "signal"}""" % sig_name
        signal_answer = """{"id": null,
                "error": null,
                "result": %s}""" % trim_json(raw_sig)

        # We use a list here as a workaround of python nested scopes
        # limitation : 'sig = None' and then in sig_received() 'sig = signal'
        # would not work.
        sig = []
        def sig_received(signal):
            sig.append(signal)
        self.deejayd.subscribe(sig_name, sig_received)

        self.parse_answer(signal_answer)
        self.assertEqual(sig.pop().get_name(), sig_name)

# vim: ts=4 sw=4 expandtab