test_offline_assets.py 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081
  1. """Browser resources must work on a fresh client without internet/CDN access."""
  2. import hashlib
  3. import json
  4. import re
  5. import unittest
  6. from html.parser import HTMLParser
  7. from pathlib import Path
  8. from urllib.parse import unquote, urlsplit
  9. from fastapi import FastAPI
  10. from fastapi.staticfiles import StaticFiles
  11. from fastapi.testclient import TestClient
  12. ROOT = Path(__file__).resolve().parents[1]
  13. CSS_URL = re.compile(r"url\(\s*(['\"]?)([^)'\"]+)\1\s*\)")
  14. class Resources(HTMLParser):
  15. def __init__(self):
  16. super().__init__()
  17. self.urls = []
  18. def handle_starttag(self, tag, attrs):
  19. attrs = dict(attrs)
  20. if tag in {"script", "img"} and "src" in attrs:
  21. self.urls.append(attrs["src"])
  22. if tag == "link" and "href" in attrs:
  23. self.urls.append(attrs["href"])
  24. class OfflineAssetTests(unittest.TestCase):
  25. def test_resource_graph_is_local_complete_and_served(self):
  26. # Traverse actual template resources, CSS imports, fonts and lazy scripts.
  27. # The conditional IE resources count too, even though HTMLParser skips comments.
  28. pending = []
  29. for template in (ROOT / "templates").rglob("*.html"):
  30. markup = template.read_text(encoding="utf-8")
  31. resources = Resources()
  32. resources.feed(re.sub(r"<!--\[if .*?\]>(.*?)<!\[endif\]-->", r"\1", markup, flags=re.S))
  33. pending.extend((ROOT, url) for url in resources.urls)
  34. for script in (ROOT / "static/assets/js").glob("*.js"):
  35. text = script.read_text(encoding="utf-8")
  36. pending.extend((script.parent, url) for url in re.findall(r"\.src\s*=\s*['\"]([^'\"]+)", text))
  37. app = FastAPI()
  38. app.mount("/static", StaticFiles(directory=ROOT / "static"), name="static")
  39. visited = set()
  40. with TestClient(app) as client:
  41. while pending:
  42. parent, url = pending.pop()
  43. if url.startswith(("data:", "#")):
  44. continue
  45. with self.subTest(resource=url, parent=parent):
  46. parts = urlsplit(url)
  47. self.assertFalse(parts.scheme or parts.netloc, f"External browser dependency: {url}")
  48. path = ((ROOT / parts.path.lstrip("/")) if parts.path.startswith("/") else parent / unquote(parts.path)).resolve()
  49. self.assertTrue(path.is_relative_to(ROOT / "static"), f"Resource outside static assets: {path}")
  50. self.assertTrue(path.is_file(), f"Missing resource: {path}")
  51. if path in visited:
  52. continue
  53. visited.add(path)
  54. response = client.get("/" + path.relative_to(ROOT).as_posix())
  55. self.assertEqual(response.status_code, 200)
  56. self.assertTrue(response.content)
  57. if path.suffix == ".css":
  58. pending.extend((path.parent, match[2]) for match in CSS_URL.finditer(path.read_text(encoding="utf-8")))
  59. self.assertIn(ROOT / "static/assets/vendor/chartjs/chart.umd.min.js", visited)
  60. def test_vendored_files_match_source_manifest(self):
  61. manifest = json.loads((ROOT / "static/assets/vendor/manifest.json").read_text(encoding="utf-8"))
  62. self.assertTrue(manifest)
  63. for name, metadata in manifest.items():
  64. with self.subTest(asset=name):
  65. path = ROOT / "static/assets" / name
  66. self.assertEqual(hashlib.sha256(path.read_bytes()).hexdigest(), metadata["sha256"])
  67. if __name__ == "__main__":
  68. unittest.main()