1
0
mirror of https://github.com/spl0k/supysonic.git synced 2024-09-20 03:11:04 +00:00
supysonic/tests/api/apitestbase.py
2017-11-03 23:15:48 +01:00

113 lines
3.8 KiB
Python

# -*- coding: utf-8 -*-
# vim:fenc=utf-8
#
# This file is part of Supysonic.
# Supysonic is a Python implementation of the Subsonic server API.
#
# Copyright (C) 2017 Alban 'spl0k' Féron
#
# Distributed under terms of the GNU AGPLv3 license.
import unittest
import re
import sys
from lxml import etree
from supysonic.managers.user import UserManager
from .appmock import AppMock
path_replace_regexp = re.compile(r'/(\w+)')
NS = '{http://subsonic.org/restapi}'
class ApiTestBase(unittest.TestCase):
def setUp(self):
app_mock = AppMock()
self.app = app_mock.app
self.store = app_mock.store
self.client = self.app.test_client()
sys.modules['supysonic.web'] = app_mock
import supysonic.api
UserManager.add(self.store, 'alice', 'Alic3', 'test@example.com', True)
UserManager.add(self.store, 'bob', 'B0b', 'bob@example.com', False)
xsd = etree.parse('tests/assets/subsonic-rest-api-1.8.0.xsd')
self.schema = etree.XMLSchema(xsd)
def tearDown(self):
self.store.close()
to_unload = [ m for m in sys.modules if m.startswith('supysonic') ]
for m in to_unload:
del sys.modules[m]
def _find(self, xml, path):
"""
Helper method that insert the namespace in XPath 'path'
"""
path = path_replace_regexp.sub(r'/{}\1'.format(NS), path)
return xml.find(path)
def _findall(self, xml, path):
"""
Helper method that insert the namespace in XPath 'path'
"""
path = path_replace_regexp.sub(r'/{}\1'.format(NS), path)
return xml.findall(path)
def _make_request(self, endpoint, args = {}, tag = None, error = None, skip_post = False):
"""
Makes both a GET and POST requests against the API, assert both get the same response.
If the user isn't provided with the 'u' and 'p' in 'args', the default 'alice' is used.
Validate the response against the Subsonic API XSD and assert it matches the expected tag or error.
:param endpoint: request endpoint, with the '/rest/'prefix nor the '.view' suffix
:param args: dict of parameters. 'u', 'p', 'c' and 'v' are automatically added
:param tag: topmost expected element, right beneath 'subsonic-response'
:param error: if the given 'args' should produce an error at 'endpoint', this is the expected error code
:param skip_post: don't do the POST request
:return: a 2-tuple (resp, child) if no error, where 'resp' is the full response object, 'child' a
'lxml.etree.Element' mathching 'tag' (if any). If there's an error (when expected), only returns
the response object
"""
if not isinstance(args, dict):
raise TypeError("'args', expecting a dict, got " + type(args).__name__)
if tag and not isinstance(tag, basestring):
raise TypeError("'tag', expecting a str, got " + type(tag).__name__)
args.update({ 'c': 'tests', 'v': '1.8.0' })
if 'u' not in args:
args.update({ 'u': 'alice', 'p': 'Alic3' })
uri = '/rest/{}.view'.format(endpoint)
rg = self.client.get(uri, query_string = args)
if not skip_post:
rp = self.client.post(uri, data = args)
self.assertEqual(rg.data, rp.data)
xml = etree.fromstring(rg.data)
self.schema.assert_(xml)
if 'status="ok"' in rg.data:
self.assertIsNone(error)
if tag:
self.assertEqual(xml[0].tag, NS + tag)
return rg, xml[0]
else:
self.assertEqual(len(xml), 0)
return rg, None
else:
self.assertIsNone(tag)
self.assertEqual(xml[0].tag, NS + 'error')
self.assertEqual(xml[0].get('code'), str(error))
return rg