import difflib import os import shutil import subprocess from pathlib import Path from unittest import TestCase try: import tomllib # New in Python 3.11 except ImportError: import tomli as tomllib from bx_django_utils.filename import clean_filename from bx_py_utils.path import assert_is_dir, assert_is_file from django_tools.unittest_utils.project_setup import check_editor_config from django_yunohost_integration.test_utils import assert_project_version from for_runners import __version__ PACKAGE_ROOT = Path(__file__).parent.parent def assert_file_contains_string(file_path, string): with file_path.open('r') as f: for line in f: if string in line: return raise AssertionError(f'File {file_path} does not contain {string!r} !') def test_version(): if 'GITHUB_ACTION' not in os.environ: # Github has a rate-limiting... So don't fetch the API if we run as GitHub action assert_project_version( current_version=__version__, github_project_url='https://github.com/jedie/django-for-runners', ) pyproject_toml_path = Path(PACKAGE_ROOT, 'pyproject.toml') pyproject_toml = tomllib.loads(pyproject_toml_path.read_text(encoding='UTF-8')) pyproject_version = pyproject_toml['tool']['poetry']['version'] assert pyproject_version.startswith( f'{__version__}+ynh' ), f'{pyproject_version!r} does not start with "{__version__}+ynh"' # pyproject.toml needs a PEP 440 conform version and used "+ynh" # the YunoHost syntax is: "~ynh", just "convert this: manifest_version = pyproject_version.replace('+', '~') assert_file_contains_string( file_path=Path(PACKAGE_ROOT, 'manifest.json'), string=f'"version": "{manifest_version}"', ) def poetry_check_output(*args): poerty_bin = shutil.which('poetry') output = subprocess.check_output( (poerty_bin,) + args, text=True, env=os.environ, stderr=subprocess.STDOUT, cwd=str(PACKAGE_ROOT), ) print(output) return output def test_poetry_check(): output = poetry_check_output('check') assert output == 'All set!\n' def test_requirements_txt(): requirements_txt = PACKAGE_ROOT / 'conf' / 'requirements.txt' assert_is_file(requirements_txt) output = poetry_check_output('export', '-f', 'requirements.txt') assert 'Warning' not in output current_content = requirements_txt.read_text() diff = '\n'.join( difflib.unified_diff( current_content.splitlines(), output.splitlines(), fromfile=str(requirements_txt), tofile='FRESH EXPORT', ) ) print(diff) assert diff == '', f'{requirements_txt} is not up-to-date! (Hint: call: "make update")' def test_screenshot_filenames(): """ https://forum.yunohost.org/t/yunohost-bot-cant-handle-spaces-in-screenshots/19483 """ screenshot_path = PACKAGE_ROOT / 'doc' / 'screenshots' assert_is_dir(screenshot_path) renamed = [] for file_path in screenshot_path.iterdir(): file_name = file_path.name if file_name.startswith('.'): continue cleaned_name = clean_filename(file_name) if cleaned_name != file_name: new_path = file_path.with_name(cleaned_name) file_path.rename(new_path) renamed.append(f'{file_name!r} renamed to {cleaned_name!r}') assert not renamed, f'Bad screenshots file names found: {", ".join(renamed)}' def test_check_editor_config(): check_editor_config(package_root=PACKAGE_ROOT) def _call_make(*args): make_bin = shutil.which('make') assert make_bin return subprocess.check_output( (make_bin,) + args, text=True, env=dict(PATH=os.environ['PATH']), stderr=subprocess.STDOUT, cwd=str(PACKAGE_ROOT), ) def test_check_code_style(): # First try: try: _call_make('lint') except subprocess.CalledProcessError: # Fix and test again: try: _call_make('fix-code-style') _call_make('lint') except subprocess.CalledProcessError as err: raise AssertionError(f'Linting error:\n{"-"*100}\n{err.stdout}\n{"-"*100}') class ConfigPanelTestCase(TestCase): def test_config_panel_toml(self): config_panel_path = PACKAGE_ROOT / 'config_panel.toml' assert_is_file(config_panel_path) cfg = tomllib.loads(config_panel_path.read_text(encoding='UTF-8')) self.assertEqual(cfg['version'], '1.0') self.assertEqual( set(cfg['main']['config'].keys()), {'name', 'default_from_email', 'admin_email', 'debug_enabled', 'log_level'}, )