mirror of
https://github.com/django-components/django-components.git
synced 2025-07-09 18:34:58 +00:00
ab75cfdb8f
* feat: allow globs when specifynigg additionall JS and CSS * refactor: fix tests and linter errors
338 lines
12 KiB
Python
338 lines
12 KiB
Python
import re
|
|
import os
|
|
from pathlib import Path
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import pytest
|
|
from django.conf import settings
|
|
|
|
from django_components.util.loader import _filepath_to_python_module, get_component_dirs, get_component_files
|
|
|
|
from django_components.testing import djc_test
|
|
from .testutils import setup_test_config
|
|
|
|
setup_test_config({"autodiscover": False})
|
|
|
|
|
|
@djc_test
|
|
class TestComponentDirs:
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
)
|
|
def test_get_dirs__base_dir(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = [dirs[0], dirs[2]]
|
|
own_dirs = [dirs[1], *dirs[3:]]
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 2
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-2:] == ("django_components", "components")
|
|
assert apps_dirs[1].parts[-3:] == ("tests", "test_app", "components")
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve() / "test_structures" / "test_structure_1", # noqa
|
|
},
|
|
)
|
|
def test_get_dirs__base_dir__complex(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = dirs[:2]
|
|
own_dirs = dirs[2:]
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 2
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-2:] == ("django_components", "components")
|
|
assert apps_dirs[1].parts[-3:] == ("tests", "test_app", "components")
|
|
|
|
expected = [
|
|
Path(__file__).parent.resolve() / "test_structures" / "test_structure_1" / "components",
|
|
]
|
|
assert own_dirs == expected
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
"STATICFILES_DIRS": [
|
|
Path(__file__).parent.resolve() / "components",
|
|
("with_alias", Path(__file__).parent.resolve() / "components"),
|
|
("too_many", Path(__file__).parent.resolve() / "components", Path(__file__).parent.resolve()),
|
|
("with_not_str_alias", 3),
|
|
], # noqa
|
|
},
|
|
)
|
|
@patch("django_components.util.loader.logger.warning")
|
|
def test_get_dirs__components_dirs(self, mock_warning: MagicMock):
|
|
mock_warning.reset_mock()
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = [dirs[0], dirs[2]]
|
|
own_dirs = [dirs[1], *dirs[3:]]
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 2
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-2:] == ("django_components", "components")
|
|
assert apps_dirs[1].parts[-3:] == ("tests", "test_app", "components")
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
warn_inputs = [warn.args[0] for warn in mock_warning.call_args_list]
|
|
assert "Got <class 'int'> : 3" in warn_inputs[0]
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"dirs": [],
|
|
},
|
|
)
|
|
def test_get_dirs__components_dirs__empty(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = dirs
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 2
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-2:] == ("django_components", "components")
|
|
assert apps_dirs[1].parts[-3:] == ("tests", "test_app", "components")
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"dirs": ["components"],
|
|
},
|
|
)
|
|
def test_get_dirs__componenents_dirs__raises_on_relative_path_1(self):
|
|
with pytest.raises(ValueError, match=re.escape("COMPONENTS.dirs must contain absolute paths")):
|
|
get_component_dirs()
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"dirs": [("with_alias", "components")],
|
|
},
|
|
)
|
|
def test_get_dirs__component_dirs__raises_on_relative_path_2(self):
|
|
with pytest.raises(ValueError, match=re.escape("COMPONENTS.dirs must contain absolute paths")):
|
|
get_component_dirs()
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"app_dirs": ["custom_comps_dir"],
|
|
},
|
|
)
|
|
def test_get_dirs__app_dirs(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = dirs[1:]
|
|
own_dirs = dirs[:1]
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 1
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-3:] == ("tests", "test_app", "custom_comps_dir")
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"app_dirs": [],
|
|
},
|
|
)
|
|
def test_get_dirs__app_dirs_empty(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
own_dirs = dirs
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
components_settings={
|
|
"app_dirs": ["this_dir_does_not_exist"],
|
|
},
|
|
)
|
|
def test_get_dirs__app_dirs_not_found(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
own_dirs = dirs
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
"INSTALLED_APPS": ("django_components", "tests.test_app_nested.app"),
|
|
},
|
|
)
|
|
def test_get_dirs__nested_apps(self):
|
|
dirs = sorted(get_component_dirs())
|
|
|
|
apps_dirs = [dirs[0], *dirs[2:]]
|
|
own_dirs = [dirs[1]]
|
|
|
|
# Apps with a `components` dir
|
|
assert len(apps_dirs) == 2
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert apps_dirs[0].parts[-2:] == ("django_components", "components")
|
|
assert apps_dirs[1].parts[-4:] == ("tests", "test_app_nested", "app", "components")
|
|
|
|
assert own_dirs == [
|
|
# Top-level /components dir
|
|
Path(__file__).parent.resolve()
|
|
/ "components",
|
|
]
|
|
|
|
|
|
@djc_test
|
|
class TestComponentFiles:
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
)
|
|
def test_get_files__py(self):
|
|
files = sorted(get_component_files(".py"))
|
|
|
|
dot_paths = [f.dot_path for f in files]
|
|
file_paths = [f.filepath for f in files]
|
|
|
|
assert dot_paths == [
|
|
"components",
|
|
"components.glob.glob",
|
|
"components.multi_file.multi_file",
|
|
"components.relative_file.relative_file",
|
|
"components.relative_file_pathobj.relative_file_pathobj",
|
|
"components.single_file",
|
|
"components.staticfiles.staticfiles",
|
|
"components.urls",
|
|
"django_components.components",
|
|
"django_components.components.dynamic",
|
|
"tests.test_app.components.app_lvl_comp.app_lvl_comp",
|
|
]
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert file_paths[0].parts[-3:] == ("tests", "components", "__init__.py")
|
|
assert file_paths[1].parts[-4:] == ("tests", "components", "glob", "glob.py")
|
|
assert file_paths[2].parts[-4:] == ("tests", "components", "multi_file", "multi_file.py")
|
|
assert file_paths[3].parts[-4:] == ("tests", "components", "relative_file", "relative_file.py")
|
|
assert file_paths[4].parts[-4:] == ("tests", "components", "relative_file_pathobj", "relative_file_pathobj.py")
|
|
assert file_paths[5].parts[-3:] == ("tests", "components", "single_file.py")
|
|
assert file_paths[6].parts[-4:] == ("tests", "components", "staticfiles", "staticfiles.py")
|
|
assert file_paths[7].parts[-3:] == ("tests", "components", "urls.py")
|
|
assert file_paths[8].parts[-3:] == ("django_components", "components", "__init__.py")
|
|
assert file_paths[9].parts[-3:] == ("django_components", "components", "dynamic.py")
|
|
assert file_paths[10].parts[-5:] == ("tests", "test_app", "components", "app_lvl_comp", "app_lvl_comp.py")
|
|
|
|
@djc_test(
|
|
django_settings={
|
|
"BASE_DIR": Path(__file__).parent.resolve(),
|
|
},
|
|
)
|
|
def test_get_files__js(self):
|
|
files = sorted(get_component_files(".js"))
|
|
|
|
dot_paths = [f.dot_path for f in files]
|
|
file_paths = [f.filepath for f in files]
|
|
|
|
assert dot_paths == [
|
|
"components.glob.glob_1",
|
|
"components.glob.glob_2",
|
|
"components.relative_file.relative_file",
|
|
"components.relative_file_pathobj.relative_file_pathobj",
|
|
"components.staticfiles.staticfiles",
|
|
"tests.test_app.components.app_lvl_comp.app_lvl_comp",
|
|
]
|
|
|
|
# NOTE: Compare parts so that the test works on Windows too
|
|
assert file_paths[0].parts[-4:] == ("tests", "components", "glob", "glob_1.js")
|
|
assert file_paths[1].parts[-4:] == ("tests", "components", "glob", "glob_2.js")
|
|
assert file_paths[2].parts[-4:] == ("tests", "components", "relative_file", "relative_file.js")
|
|
assert file_paths[3].parts[-4:] == ("tests", "components", "relative_file_pathobj", "relative_file_pathobj.js")
|
|
assert file_paths[4].parts[-4:] == ("tests", "components", "staticfiles", "staticfiles.js")
|
|
assert file_paths[5].parts[-5:] == ("tests", "test_app", "components", "app_lvl_comp", "app_lvl_comp.js")
|
|
|
|
|
|
@djc_test
|
|
class TestFilepathToPythonModule:
|
|
def test_prepares_path(self):
|
|
base_path = str(settings.BASE_DIR)
|
|
|
|
the_path = os.path.join(base_path, "tests.py")
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests"
|
|
|
|
the_path = os.path.join(base_path, "tests/components/relative_file/relative_file.py")
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests.components.relative_file.relative_file"
|
|
|
|
def test_handles_separators_based_on_os_name(self):
|
|
base_path = str(settings.BASE_DIR)
|
|
|
|
with patch("os.name", new="posix"):
|
|
the_path = base_path + "/" + "tests.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests"
|
|
|
|
the_path = base_path + "/" + "tests/components/relative_file/relative_file.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests.components.relative_file.relative_file" # noqa: E501
|
|
|
|
base_path = str(settings.BASE_DIR).replace("/", "\\")
|
|
with patch("os.name", new="nt"):
|
|
the_path = base_path + "\\" + "tests.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests"
|
|
|
|
the_path = base_path + "\\" + "tests\\components\\relative_file\\relative_file.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests.components.relative_file.relative_file" # noqa: E501
|
|
|
|
# NOTE: Windows should handle also POSIX separator
|
|
the_path = base_path + "/" + "tests.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests"
|
|
|
|
the_path = base_path + "/" + "tests/components/relative_file/relative_file.py"
|
|
assert _filepath_to_python_module(the_path, base_path, None) == "tests.components.relative_file.relative_file" # noqa: E501
|