Sunil Mohan Adapa 1dcbfce713
users: Use privileged decorator for actions
Tests:

- Functional tests work (failing already)
- DONE: Showing front page shortcuts according to user groups works
  - DONE: Only user who is party of syncthing group is shown syncthing
  - DONE: Admin users are always shown all the apps
- DONE: Syncthing:
  - Not tested: When upgrading from version 2 or below, renaming group works
  - DONE: Syncthing is added to freedombox-share group
- DONE: Initial setup of users app works
  - DONE: freedombox-share group is created
- DONE: Retriving last admin user works
  - DONE: Last admin is not allowed to delete account
- DONE: Creating a new user works
  - DONE: Password is set properly (user can login with 'su - user' after)
  - DONE: Incorrect confirmation password leads to error
  - DONE: Adding the user to groups works (edit page shows correct list of groups)
- DONE: Editing a user works
  - DONE: User is renamed properly
  - DONE: Removing user from groups works
  - DONE: Adding user to new groups works
  - DONE: Providing incorrect auth password results in error message
  - DONE: Enabling/disabling account work (confirm with 'su - user'). See #2277.
- DONE: Updating user password works
  - DONE: New password is set (confirm with 'su - user')
  - DONE: Providing incorrect auth password results in error message
- DONE: Initial user account creation works
  - DONE: User account can be used (confirm with 'su - user')
  - DONE: User is added to admin group
- DONE: Exception while getting SSH keys results in showing empty field
- DONE: Removing a user works
  - DONE: Command provided in a message in users_firstboot.html works for
    deleting users.
- DONE: If an admin users exists when running first wizard, list of admin users
  is shown.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2022-10-08 18:53:52 -04:00

343 lines
12 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""
Tests for users views.
"""
from unittest.mock import Mock, patch
import pytest
from django import urls
from django.contrib.auth.models import User
from django.contrib.messages.storage.fallback import FallbackStorage
from django.core.exceptions import PermissionDenied
from plinth import module_loader
from plinth.modules.users import views
from ..components import UsersAndGroups
# For all tests, plinth.urls instead of urls configured for testing, and
# django database
pytestmark = [pytest.mark.urls('plinth.urls'), pytest.mark.django_db]
@pytest.fixture(autouse=True, scope='module')
def fixture_users_urls():
"""Make sure users app's URLs are part of plinth.urls."""
with patch('plinth.module_loader._modules_to_load', new=[]) as modules, \
patch('plinth.urls.urlpatterns', new=[]):
modules.append('plinth.modules.users')
module_loader.include_urls()
yield
@pytest.fixture(autouse=True)
def module_patch():
"""Patch users module."""
pwd_users = [Mock(pw_name='root'), Mock(pw_name='plinth')]
UsersAndGroups._all_components = set()
UsersAndGroups('test-users-and-groups',
groups={'admin': 'The admin group'})
UsersAndGroups('users-and-groups-minetest',
reserved_usernames=['debian-minetest'])
privileged = 'plinth.modules.users.privileged'
with patch('pwd.getpwall', return_value=pwd_users), \
patch(f'{privileged}.create_user'), \
patch(f'{privileged}.add_user_to_group'), \
patch(f'{privileged}.set_user_password'), \
patch(f'{privileged}.set_user_status'), \
patch(f'{privileged}.rename_user'), \
patch(f'{privileged}.get_group_users') as get_group_users, \
patch('plinth.modules.ssh.privileged.set_keys'), \
patch('plinth.modules.ssh.privileged.get_keys') as get_keys, \
patch(f'{privileged}.get_user_groups') as get_user_groups:
get_group_users.return_value = ['admin']
get_keys.return_value = []
get_user_groups.return_value = []
yield
def make_request(request, view, as_admin=True, **kwargs):
"""Make request with a message storage and users created."""
setattr(request, 'session', 'session')
messages = FallbackStorage(request)
setattr(request, '_messages', messages)
user = User.objects.create(username='tester')
admin_user = User.objects.create(username='admin')
admin_user.set_password('adminpassword')
request.user = admin_user if as_admin else user
with patch('plinth.modules.users.forms.is_user_admin',
return_value=as_admin),\
patch('plinth.modules.users.views.is_user_admin',
return_value=as_admin),\
patch('plinth.modules.users.views.update_session_auth_hash'):
response = view(request, **kwargs)
return response, messages
def test_users_list_view(rf):
"""Test that users list view has correct view data."""
with patch('plinth.views.AppView.get_context_data',
return_value={'is_enabled': True}):
view = views.UserList.as_view()
response, messages = make_request(rf.get('/'), view)
assert response.context_data['last_admin_user'] == 'admin'
assert response.status_code == 200
@pytest.mark.parametrize('username', ['test-new', 'test-neW@2_'])
def test_create_user_view(rf, username):
"""Test that user creation with valid usernames succeeds."""
password = 'testingtesting'
form_data = {
'username': username,
'password1': password,
'password2': password,
'confirm_password': 'adminpassword',
}
request = rf.post(urls.reverse('users:create'), data=form_data)
view = views.UserCreate.as_view()
response, messages = make_request(request, view)
assert list(messages)[0].message == 'User {} created.'.format(username)
assert response.status_code == 302
assert response.url == urls.reverse('users:index')
@pytest.mark.parametrize('password,error', [
('', {
'confirm_password': ['This field is required.']
}),
('wrong_password', {
'confirm_password': ['Invalid password.']
}),
])
def test_create_user_invalid_admin_view(rf, password, error):
"""Test that user creation with an invalid admin password fails."""
user_password = 'testingtesting'
form_data = {
'username': 'test-new',
'password1': user_password,
'password2': user_password,
'confirm_password': password,
}
request = rf.post(urls.reverse('users:create'), data=form_data)
view = views.UserCreate.as_view()
response, messages = make_request(request, view)
assert response.context_data['form'].errors == error
def test_create_user_form_view(rf):
"""Test that a username field on create form has correct attributes."""
request = rf.get(urls.reverse('users:create'))
view = views.UserCreate.as_view()
response, messages = make_request(request, view)
assert response.context_data['form'].fields['username'].widget.attrs == {
'maxlength': '150',
'autofocus': 'autofocus',
'autocapitalize': 'none',
'autocomplete': 'username'
}
assert response.status_code == 200
@pytest.mark.parametrize('username',
['-tester', 'testér', 'test+test', 't', 'test test'])
def test_create_user_invalid_username_view(rf, username):
"""Test that user creation with invalid username fails."""
form_data = {
'username': username,
'password1': 'testingtesting',
'password2': 'testingtesting',
'confirm_password': 'adminpassword',
}
request = rf.post(urls.reverse('users:create'), data=form_data)
view = views.UserCreate.as_view()
response, messages = make_request(request, view)
assert response.context_data['form'].errors['username'][
0] == 'Enter a valid username.'
assert response.status_code == 200
@pytest.mark.parametrize(
'username,error',
[('testuser', 'A user with that username already exists.'),
('root', 'Username is taken or is reserved.'),
('rooT', 'Username is taken or is reserved.'),
('debian-minetest', 'Username is taken or is reserved.')])
def test_create_user_taken_or_reserved_username_view(rf, username, error):
"""Test that user creation with taken or reserved username fails."""
User.objects.create(username='testuser')
form_data = {
'username': username,
'password1': 'testingtesting',
'password2': 'testingtesting',
'confirm_password': 'adminpassword',
}
request = rf.post(urls.reverse('users:create'), data=form_data)
view = views.UserCreate.as_view()
response, messages = make_request(request, view)
assert response.context_data['form'].errors['username'][0] == error
assert response.status_code == 200
def test_update_user_view(rf):
"""Test that updating username succeeds."""
user = 'tester'
new_username = 'tester-renamed'
form_data = {
'username': new_username,
'password1': 'testingtesting',
'password2': 'testingtesting',
'confirm_password': 'adminpassword',
}
url = urls.reverse('users:edit', kwargs={'slug': user})
request = rf.post(url, data=form_data)
view = views.UserUpdate.as_view()
response, messages = make_request(request, view, as_admin=True, slug=user)
assert list(messages)[0].message == 'User {} updated.'.format(new_username)
assert response.status_code == 302
assert response.url == urls.reverse('users:edit',
kwargs={'slug': new_username})
@pytest.mark.parametrize('password,error', [
('', {
'confirm_password': ['This field is required.']
}),
('wrong_password', {
'confirm_password': ['Invalid password.']
}),
])
def test_update_user_invalid_admin_view(rf, password, error):
"""Test that updating username with an invalid admin password fails."""
user = 'tester'
new_username = 'tester-renamed'
form_data = {
'username': new_username,
'password1': 'testingtesting',
'password2': 'testingtesting',
'confirm_password': password,
}
url = urls.reverse('users:edit', kwargs={'slug': user})
request = rf.post(url, data=form_data)
view = views.UserUpdate.as_view()
response, messages = make_request(request, view, as_admin=True, slug=user)
assert response.context_data['form'].errors == error
def test_update_user_without_permissions_view(rf):
"""Test that updating other user as non-admin user raises exception."""
form_data = {
'username': 'admin-renamed',
'password1': 'testingtesting',
'password2': 'testingtesting',
'confirm_password': 'adminpassword',
}
url = urls.reverse('users:edit', kwargs={'slug': 'admin'})
request = rf.post(url, data=form_data)
view = views.UserUpdate.as_view()
with pytest.raises(PermissionDenied):
make_request(request, view, as_admin=False, slug='admin')
def test_delete_user_view(rf):
"""Test that user deletion succeeds."""
user = 'tester'
url = urls.reverse('users:delete', kwargs={'slug': user})
request = rf.post(url)
view = views.UserDelete.as_view()
response, messages = make_request(request, view, as_admin=True, slug=user)
assert list(messages)[0].message == 'User {} deleted.'.format(user)
assert response.status_code == 302
assert response.url == urls.reverse('users:index')
def test_user_change_password_view(rf):
"""Test that changing password succeeds."""
user = 'admin'
form_data = {
'new_password1': 'testingtesting2',
'new_password2': 'testingtesting2',
'confirm_password': 'adminpassword',
}
url = urls.reverse('users:change_password', kwargs={'slug': user})
request = rf.post(url, data=form_data)
view = views.UserChangePassword.as_view()
response, messages = make_request(request, view, as_admin=True, slug=user)
assert list(messages)[0].message == 'Password changed successfully.'
assert response.status_code == 302
assert response.url == urls.reverse('users:edit', kwargs={'slug': user})
@pytest.mark.parametrize('password,error', [
('', {
'confirm_password': ['This field is required.']
}),
('wrong_password', {
'confirm_password': ['Invalid password.']
}),
])
def test_user_change_password_invalid_admin_view(rf, password, error):
"""Test that changing password with an invalid admin password fails."""
user = 'admin'
form_data = {
'new_password1': 'testingtesting2',
'new_password2': 'testingtesting2',
'confirm_password': password,
}
url = urls.reverse('users:change_password', kwargs={'slug': user})
request = rf.post(url, data=form_data)
view = views.UserChangePassword.as_view()
response, messages = make_request(request, view, as_admin=True, slug=user)
assert response.context_data['form'].errors == error
assert response.status_code == 200
def test_user_change_password_without_permissions_view(rf):
"""
Test that changing other user password as a non-admin user raises
exception.
"""
user = 'admin'
form_data = {
'new_password1': 'adminadmin2',
'new_password2': 'adminadmin2',
'confirm_password': 'adminpassword',
}
url = urls.reverse('users:change_password', kwargs={'slug': user})
request = rf.post(url, data=form_data)
view = views.UserChangePassword.as_view()
with pytest.raises(PermissionDenied):
make_request(request, view, as_admin=False, slug=user)