mirror of
https://github.com/django-components/django-components.git
synced 2025-08-04 06:18:17 +00:00
23d91218bd
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
103 lines
3.9 KiB
Python
103 lines
3.9 KiB
Python
from pathlib import Path
|
|
|
|
from django.contrib.staticfiles.management.commands.collectstatic import Command
|
|
from django.test import SimpleTestCase, override_settings
|
|
|
|
from .django_test_setup import * # NOQA
|
|
|
|
|
|
# This subclass allows us to call the `collectstatic` command from within Python.
|
|
# We call the `collect` method, which returns info about what files were collected.
|
|
#
|
|
# The methods below are overriden to ensure we don't make any filesystem changes
|
|
# (copy/delete), as the original command copies files. Thus we can safely test that
|
|
# our `safer_staticfiles` app works as intended.
|
|
class MockCollectstaticCommand(Command):
|
|
# NOTE: We do not expect this to be called
|
|
def clear_dir(self, path):
|
|
raise NotImplementedError()
|
|
|
|
# NOTE: We do not expect this to be called
|
|
def link_file(self, path, prefixed_path, source_storage):
|
|
raise NotImplementedError()
|
|
|
|
def copy_file(self, path, prefixed_path, source_storage):
|
|
# Skip this file if it was already copied earlier
|
|
if prefixed_path in self.copied_files:
|
|
return self.log("Skipping '%s' (already copied earlier)" % path)
|
|
# Delete the target file if needed or break
|
|
if not self.delete_file(path, prefixed_path, source_storage):
|
|
return
|
|
# The full path of the source file
|
|
source_path = source_storage.path(path)
|
|
# Finally start copying
|
|
if self.dry_run:
|
|
self.log("Pretending to copy '%s'" % source_path, level=1)
|
|
else:
|
|
self.log("Copying '%s'" % source_path, level=2)
|
|
# ############# OUR CHANGE ##############
|
|
# with source_storage.open(path) as source_file:
|
|
# self.storage.save(prefixed_path, source_file)
|
|
# ############# OUR CHANGE ##############
|
|
self.copied_files.append(prefixed_path)
|
|
|
|
|
|
def do_collect():
|
|
cmd = MockCollectstaticCommand()
|
|
cmd.set_options(
|
|
interactive=False,
|
|
verbosity=1,
|
|
link=False,
|
|
clear=False,
|
|
dry_run=False,
|
|
ignore_patterns=[],
|
|
use_default_ignore_patterns=True,
|
|
post_process=True,
|
|
)
|
|
collected = cmd.collect()
|
|
return collected
|
|
|
|
|
|
common_settings = {
|
|
"STATIC_URL": "static/",
|
|
"STATICFILES_DIRS": [Path(__file__).resolve().parent / "components"],
|
|
"STATIC_ROOT": "staticfiles",
|
|
"ROOT_URLCONF": __name__,
|
|
"SECRET_KEY": "secret",
|
|
}
|
|
|
|
|
|
# Check that .py and .html files are INCLUDED with the original staticfiles app
|
|
@override_settings(
|
|
**common_settings,
|
|
INSTALLED_APPS=("django_components", "django.contrib.staticfiles"),
|
|
)
|
|
class OrigStaticFileTests(SimpleTestCase):
|
|
def test_python_and_html_included(self):
|
|
collected = do_collect()
|
|
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.css", collected["modified"])
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.js", collected["modified"])
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.html", collected["modified"])
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.py", collected["modified"])
|
|
|
|
self.assertListEqual(collected["unmodified"], [])
|
|
self.assertListEqual(collected["post_processed"], [])
|
|
|
|
|
|
# Check that .py and .html files are OMITTED from our version of staticfiles app
|
|
@override_settings(
|
|
**common_settings,
|
|
INSTALLED_APPS=("django_components", "django_components.safer_staticfiles"),
|
|
)
|
|
class SaferStaticFileTests(SimpleTestCase):
|
|
def test_python_and_html_omitted(self):
|
|
collected = do_collect()
|
|
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.css", collected["modified"])
|
|
self.assertIn("safer_staticfiles/safer_staticfiles.js", collected["modified"])
|
|
self.assertNotIn("safer_staticfiles/safer_staticfiles.html", collected["modified"])
|
|
self.assertNotIn("safer_staticfiles/safer_staticfiles.py", collected["modified"])
|
|
|
|
self.assertListEqual(collected["unmodified"], [])
|
|
self.assertListEqual(collected["post_processed"], [])
|