mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
8f4811b350
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
126 lines
4.5 KiB
Python
126 lines
4.5 KiB
Python
#
|
|
# This file is part of FreedomBox.
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
"""
|
|
Test module for utilities.
|
|
"""
|
|
|
|
import tempfile
|
|
from unittest import TestCase
|
|
from unittest.mock import Mock, MagicMock
|
|
|
|
import ruamel.yaml
|
|
from django.test.client import RequestFactory
|
|
|
|
from plinth.utils import YAMLFile
|
|
from plinth.utils import is_user_admin
|
|
|
|
|
|
class TestIsAdminUser(TestCase):
|
|
"""Test class for is_user_admin utility."""
|
|
|
|
def setUp(self):
|
|
"""Setup each test case befor execution."""
|
|
request = RequestFactory().get('/plinth/mockapp')
|
|
request.user = Mock()
|
|
request.session = MagicMock()
|
|
self.request = request
|
|
|
|
def test_is_false_for_anonymous_user(self):
|
|
"""Test anonymous user is reported as non-admin."""
|
|
super(TestIsAdminUser, self).setUp()
|
|
self.request.user = Mock()
|
|
self.request.user.is_authenticated = False
|
|
self.assertFalse(is_user_admin(self.request))
|
|
self.assertFalse(is_user_admin(self.request, cached=True))
|
|
|
|
def test_values_for_authenticated_users(self):
|
|
"""Test correct return values for authenticated users."""
|
|
self.request.user.groups.filter().exists = Mock(return_value=False)
|
|
self.assertFalse(is_user_admin(self.request))
|
|
self.request.user.groups.filter().exists = Mock(return_value=True)
|
|
self.assertTrue(is_user_admin(self.request))
|
|
|
|
def test_caching_of_values(self):
|
|
"""Test that caching of values for authenticate users."""
|
|
session_mock = MagicMock()
|
|
session_dict = {}
|
|
session_mock.__setitem__.side_effect = session_dict.__setitem__
|
|
session_mock.__getitem__.side_effect = session_dict.__getitem__
|
|
session_mock.__contains__.side_effect = session_dict.__contains__
|
|
self.request.session = session_mock
|
|
|
|
mock = Mock(return_value=False)
|
|
self.request.user.groups.filter().exists = mock
|
|
self.assertFalse(is_user_admin(self.request))
|
|
mock.assert_called_once_with()
|
|
session_mock.__setitem__.assert_called_once_with(
|
|
'cache_user_is_admin', False)
|
|
|
|
mock = Mock(return_value=False)
|
|
self.request.user.groups.filter().exists = mock
|
|
self.assertFalse(is_user_admin(self.request, cached=True))
|
|
mock.assert_not_called()
|
|
session_mock.__getitem__.assert_called_once_with(
|
|
'cache_user_is_admin')
|
|
|
|
mock = Mock(return_value=False)
|
|
self.request.user.groups.filter().exists = mock
|
|
self.assertFalse(is_user_admin(self.request, cached=False))
|
|
mock.assert_called_once_with()
|
|
session_mock.__getitem__.assert_called_once_with(
|
|
'cache_user_is_admin')
|
|
|
|
|
|
class TestYAMLFileUtil(TestCase):
|
|
"""Check updating YAML files"""
|
|
|
|
kv_pair = {'key': 'value'}
|
|
|
|
def test_update_empty_yaml_file(self):
|
|
"""
|
|
Update an empty YAML file with content.
|
|
"""
|
|
fp = tempfile.NamedTemporaryFile()
|
|
conf = {'property1': self.kv_pair}
|
|
|
|
with YAMLFile(fp.name) as file_conf:
|
|
for key in conf.keys():
|
|
file_conf[key] = conf[key]
|
|
|
|
with open(fp.name, 'r') as retrieved_conf:
|
|
assert retrieved_conf.read() == ruamel.yaml.round_trip_dump(conf)
|
|
|
|
def test_update_non_empty_yaml_file(self):
|
|
"""
|
|
Update a non-empty YAML file with modifications
|
|
"""
|
|
fp = tempfile.NamedTemporaryFile()
|
|
|
|
with open(fp.name, 'w') as conf_file:
|
|
conf_file.write(
|
|
ruamel.yaml.round_trip_dump({
|
|
'property1': self.kv_pair
|
|
}))
|
|
|
|
with YAMLFile(fp.name) as file_conf:
|
|
file_conf['property2'] = self.kv_pair
|
|
|
|
with open(fp.name, 'r') as retrieved_conf:
|
|
file_conf = ruamel.yaml.round_trip_load(retrieved_conf)
|
|
assert file_conf == {'property1': self.kv_pair,
|
|
'property2': self.kv_pair}
|