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
|
# SPDX-License-Identifier: AGPL-3.0-or-later
"""Test module for gitweb module operations."""
import pathlib
import subprocess
from unittest.mock import call, patch
import pytest
from django.forms import ValidationError
from plinth.modules.gitweb import privileged
REPO_NAME = 'Test-repo'
REPO_DATA = {
'name': REPO_NAME,
'description': '',
'owner': '',
'access': 'private',
}
pytestmark = pytest.mark.usefixtures('mock_privileged', 'mock_run_as_user')
privileged_modules_to_mock = ['plinth.modules.gitweb.privileged']
git_installed = pytest.mark.skipif(not pathlib.Path('/usr/bin/git').exists(),
reason='git is not installed')
@pytest.fixture(autouse=True)
def fixture_set_repo_path(tmp_path):
"""Set a repository path in the actions module."""
privileged.GIT_REPO_PATH = tmp_path
@pytest.fixture(name='existing_repo')
def fixture_existing_repo():
"""A fixture to create a repository."""
try:
privileged.delete_repo(REPO_NAME)
except FileNotFoundError:
pass
privileged.create_repo(name=REPO_NAME, description='', owner='',
keep_ownership=True, is_private=True)
@git_installed
def test_create_repo():
"""Test creating a repository."""
privileged.create_repo(name=REPO_NAME, description='', owner='',
is_private=True, keep_ownership=True)
repo = privileged.repo_info(REPO_NAME)
default_branch = repo.pop('default_branch')
assert repo == REPO_DATA
assert default_branch
@git_installed
def test_change_repo_medatada(existing_repo):
"""Test change a metadata of the repository."""
new_data = {
'name': REPO_NAME,
'description': 'description2',
'owner': 'owner2',
'access': 'public',
}
privileged.set_repo_description(REPO_NAME, new_data['description'])
privileged.set_repo_owner(REPO_NAME, new_data['owner'])
privileged.set_repo_access(REPO_NAME, new_data['access'])
repo = privileged.repo_info(REPO_NAME)
del repo['default_branch']
assert repo == new_data
@git_installed
def test_rename_repository(existing_repo):
"""Test renaming a repository."""
new_name = 'Test-repo_2'
privileged.rename_repo(REPO_NAME, new_name)
with pytest.raises(RuntimeError, match='Repository not found'):
privileged.repo_info(REPO_NAME)
repo = privileged.repo_info(new_name)
assert repo['name'] == new_name
@git_installed
def test_get_branches(existing_repo):
"""Test getting all the branches of the repository."""
result = privileged.get_branches(REPO_NAME)
assert 'default_branch' in result
assert result['branches'] == []
@git_installed
def test_delete_repository(existing_repo):
"""Test deleting a repository."""
privileged.delete_repo(REPO_NAME)
with pytest.raises(RuntimeError, match='Repository not found'):
privileged.repo_info(REPO_NAME)
@pytest.mark.parametrize(
'name',
['.Test-repo', 'Test-repo.git.git', '/root/Test-repo', 'Test-repö'])
def test_action_create_repo_with_invalid_names(name):
"""Test that creating repository with invalid names fails."""
with pytest.raises(ValidationError):
privileged.create_repo(name=name, description='', owner='',
keep_ownership=True)
@pytest.mark.parametrize('url', [
'Test-repo', 'file://root/Test-repo', 'localhost/Test-repo',
'ssh://localhost/Test-repo', 'https://localhost/.Test-repo'
])
def test_action_create_repo_with_invalid_urls(url):
"""Test that cloning repository with invalid URL fails."""
with pytest.raises(ValidationError):
privileged.create_repo(url=url, description='', owner='',
keep_ownership=True)
@patch('plinth.action_utils.run')
def test_setup_git_creentials(run):
"""Test that setting up git credentials works."""
url = 'https://user:pass@host.example/path?key=value'
safe_url = privileged._setup_git_credentials(url)
assert safe_url == 'https://host.example/path?key=value'
input_ = b'protocol=https\nhost=host.example\nusername=user\n' \
b'password=pass\n\n'
env = run.mock_calls[0].kwargs.pop('env')
assert env['GIT_TERMINAL_PROMPT'] == '0'
assert run.mock_calls == [
call(['git', 'credential', 'approve'], input=input_,
stdout=subprocess.DEVNULL, check=True)
]
run.reset_mock()
url = 'https://host2.example/path?key=value'
safe_url = privileged._setup_git_credentials(url)
assert safe_url == 'https://host2.example/path?key=value'
run.assert_not_called()
|