Show More
test_repo_readme.py
102 lines
| 3.4 KiB
| text/x-python
|
PythonLexer
r772 | ||||
r5088 | # Copyright (C) 2010-2023 RhodeCode GmbH | |||
r772 | # | |||
# This program is free software: you can redistribute it and/or modify | ||||
# it under the terms of the GNU Affero General Public License, version 3 | ||||
# (only), as published by the Free Software Foundation. | ||||
# | ||||
# 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 Affero General Public License | ||||
# along with this program. If not, see <http://www.gnu.org/licenses/>. | ||||
# | ||||
# This program is dual-licensed. If you wish to learn more about the | ||||
# RhodeCode Enterprise Edition, including its added features, Support services, | ||||
# and proprietary license terms, please see https://rhodecode.com/licenses/ | ||||
import pytest | ||||
from rhodecode.lib.vcs import nodes | ||||
from rhodecode.model.repo import ReadmeFinder | ||||
r3946 | @pytest.fixture() | |||
r772 | def commit_util(vcsbackend_stub): | |||
""" | ||||
Provide a commit which has certain files in it's tree. | ||||
This is based on the fixture "vcsbackend" and will automatically be | ||||
parametrized for all vcs backends. | ||||
""" | ||||
return CommitUtility(vcsbackend_stub) | ||||
class CommitUtility: | ||||
def __init__(self, vcsbackend): | ||||
self.vcsbackend = vcsbackend | ||||
r5087 | def commit_with_files(self, filenames: list[bytes]): | |||
r772 | commits = [ | |||
{'message': 'Adding all requested files', | ||||
'added': [ | ||||
r5087 | nodes.FileNode(filename, content=b'') for filename in filenames | |||
r772 | ]}] | |||
repo = self.vcsbackend.create_repo(commits=commits) | ||||
return repo.get_commit() | ||||
def test_no_matching_file_returns_none(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'LIESMICH']) | |||
r772 | finder = ReadmeFinder(default_renderer='rst') | |||
r774 | filenode = finder.search(commit) | |||
assert filenode is None | ||||
r772 | ||||
def test_matching_file_returns_the_file_name(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'README']) | |||
r772 | finder = ReadmeFinder(default_renderer='rst') | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == 'README' | ||||
r772 | ||||
def test_matching_file_with_extension(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'README.rst']) | |||
r772 | finder = ReadmeFinder(default_renderer='rst') | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == 'README.rst' | ||||
r772 | ||||
def test_prefers_readme_without_extension(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'README.rst', b'Readme']) | |||
r772 | finder = ReadmeFinder() | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == 'Readme' | ||||
r772 | ||||
@pytest.mark.parametrize('renderer, expected', [ | ||||
('rst', 'readme.rst'), | ||||
('markdown', 'readme.md'), | ||||
]) | ||||
def test_prefers_renderer_extensions(commit_util, renderer, expected): | ||||
r5087 | commit = commit_util.commit_with_files([b'readme.rst', b'readme.md', b'readme.txt']) | |||
r772 | finder = ReadmeFinder(default_renderer=renderer) | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == expected | ||||
r772 | ||||
def test_finds_readme_in_subdirectory(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'doc/README.rst', b'LIESMICH']) | |||
r772 | finder = ReadmeFinder() | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == 'doc/README.rst' | ||||
r772 | ||||
def test_prefers_subdirectory_with_priority(commit_util): | ||||
r5087 | commit = commit_util.commit_with_files([b'Doc/Readme.rst', b'Docs/Readme.rst']) | |||
r772 | finder = ReadmeFinder() | |||
r774 | filenode = finder.search(commit) | |||
assert filenode.path == 'Doc/Readme.rst' | ||||