forked from openlp/openlp
155 lines
4.9 KiB
Python
155 lines
4.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
##########################################################################
|
|
# OpenLP - Open Source Lyrics Projection #
|
|
# ---------------------------------------------------------------------- #
|
|
# Copyright (c) 2008-2022 OpenLP Developers #
|
|
# ---------------------------------------------------------------------- #
|
|
# 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 3 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, see <https://www.gnu.org/licenses/>. #
|
|
##########################################################################
|
|
"""
|
|
Functional tests to test the Http init.
|
|
"""
|
|
from unittest.mock import MagicMock
|
|
|
|
from openlp.core.api.http import authenticate, check_auth, requires_auth
|
|
|
|
|
|
password = 'c3VwZXJmbHk6bGFtYXM='
|
|
|
|
|
|
def test_auth(settings):
|
|
"""
|
|
Test the check_auth method with a match
|
|
:return:
|
|
"""
|
|
# GIVEN: a known user
|
|
settings.setValue('api/user id', "superfly")
|
|
settings.setValue('api/password', "lamas")
|
|
|
|
# WHEN : I check the authorisation
|
|
is_valid = check_auth(['aaaaa', password])
|
|
|
|
# THEN:
|
|
assert is_valid is True
|
|
|
|
|
|
def test_auth_falure(settings):
|
|
"""
|
|
Test the check_auth method with a match
|
|
:return:
|
|
"""
|
|
# GIVEN: a known user
|
|
settings.setValue('api/user id', 'superfly')
|
|
settings.setValue('api/password', 'lamas')
|
|
|
|
# WHEN : I check the authorisation
|
|
is_valid = check_auth(['aaaaa', 'monkey123'])
|
|
|
|
# THEN:
|
|
assert is_valid is False
|
|
|
|
|
|
def test_requires_auth_disabled(settings):
|
|
"""
|
|
Test the requires_auth wrapper with disabled security
|
|
:return:
|
|
"""
|
|
# GIVEN: A disabled security
|
|
settings.setValue('api/authentication enabled', False)
|
|
|
|
# WHEN: I call the function
|
|
wrapped_function = requires_auth(func)
|
|
value = wrapped_function()
|
|
|
|
# THEN: the result will be as expected
|
|
assert value == 'called'
|
|
|
|
|
|
def test_requires_auth_enabled(settings):
|
|
"""
|
|
Test the requires_auth wrapper with enabled security
|
|
:return:
|
|
"""
|
|
# GIVEN: A disabled security
|
|
settings.setValue('api/authentication enabled', True)
|
|
|
|
# WHEN: I call the function
|
|
wrapped_function = requires_auth(func)
|
|
req = MagicMock()
|
|
value = wrapped_function(req)
|
|
|
|
# THEN: the result will be as expected
|
|
assert str(value) == str(authenticate())
|
|
|
|
|
|
def test_requires_auth_enabled_auth_error(settings):
|
|
"""
|
|
Test the requires_auth wrapper with enabled security and authorization taken place and and error
|
|
:return:
|
|
"""
|
|
# GIVEN: A enabled security
|
|
settings.setValue('api/authentication enabled', True)
|
|
|
|
# WHEN: I call the function with the wrong password
|
|
wrapped_function = requires_auth(func)
|
|
req = MagicMock()
|
|
req.authorization = ['Basic', 'cccccccc']
|
|
value = wrapped_function(req)
|
|
|
|
# THEN: the result will be as expected - try again
|
|
assert str(value) == str(authenticate())
|
|
|
|
|
|
def test_requires_auth_enabled_auth(settings):
|
|
"""
|
|
Test the requires_auth wrapper with enabled security and authorization taken place and and error
|
|
:return:
|
|
"""
|
|
# GIVEN: An enabled security and a known user
|
|
settings.setValue('api/authentication enabled', True)
|
|
settings.setValue('api/user id', 'superfly')
|
|
settings.setValue('api/password', 'lamas')
|
|
|
|
# WHEN: I call the function with the wrong password
|
|
wrapped_function = requires_auth(func)
|
|
req = MagicMock()
|
|
req.authorization = ['Basic', password]
|
|
value = wrapped_function(req)
|
|
|
|
# THEN: the result will be as expected - try again
|
|
assert str(value) == 'called'
|
|
|
|
|
|
def test_requires_auth_missing_credentials(settings):
|
|
"""
|
|
Test the requires_auth wrapper with enabled security and authorization taken place and and error
|
|
:return:
|
|
"""
|
|
# GIVEN: An enabled security and a known user
|
|
settings.setValue('api/authentication enabled', True)
|
|
settings.setValue('api/user id', 'superfly')
|
|
settings.setValue('api/password', 'lamas')
|
|
|
|
# WHEN: I call the function with no password
|
|
wrapped_function = requires_auth(func)
|
|
value = wrapped_function(0)
|
|
|
|
# THEN: the result will be as expected (unauthorized)
|
|
assert str(value) == str(authenticate())
|
|
|
|
|
|
def func(field=None):
|
|
return 'called'
|