Two tests used the correct spelling "Hackertours" where they meant a
wrong one, so they expected errors the lint rightly doesn't report
("Hackertours" should be "Hackertours"). Use "HackerTours" there.
CI now runs the tests before building the site.
64 lines
2.4 KiB
Python
64 lines
2.4 KiB
Python
import shutil
|
|
import subprocess
|
|
import tempfile
|
|
import unittest
|
|
from pathlib import Path
|
|
|
|
|
|
ROOT = Path(__file__).resolve().parents[1]
|
|
|
|
|
|
class BrandLintTest(unittest.TestCase):
|
|
def build(self, source):
|
|
with tempfile.TemporaryDirectory() as directory:
|
|
root = Path(directory)
|
|
(root / "content").mkdir()
|
|
(root / "layouts" / "_partials").mkdir(parents=True)
|
|
(root / "hugo.toml").write_text('baseURL = "https://example.org/"\n')
|
|
(root / "content" / "_index.md").write_text(source)
|
|
(root / "layouts" / "home.html").write_text(
|
|
'{{ partial "lint-brand.html" . }}{{ .Content }}'
|
|
)
|
|
shutil.copy(
|
|
ROOT / "layouts" / "_partials" / "lint-brand.html",
|
|
root / "layouts" / "_partials" / "lint-brand.html",
|
|
)
|
|
return subprocess.run(
|
|
["hugo", "--source", str(root)],
|
|
capture_output=True,
|
|
text=True,
|
|
check=False,
|
|
)
|
|
|
|
def test_errors_include_spelling_and_source_line(self):
|
|
result = self.build("---\ntitle: HackerTours\n---\nHACKERTOURS and hackertours\n")
|
|
self.assertNotEqual(result.returncode, 0)
|
|
for line, spelling in [(2, "HackerTours"), (4, "HACKERTOURS"), (4, "hackertours")]:
|
|
self.assertIn(f':{line}: "{spelling}" should be "Hackertours"', result.stderr)
|
|
|
|
def test_valid_names_identifiers_and_explicit_exceptions(self):
|
|
result = self.build(
|
|
"---\n"
|
|
"title: HackerTours # hackertours-lint-ignore\n"
|
|
"---\n"
|
|
"Hackertours\n"
|
|
"HackerTours <!-- hackertours-lint-ignore -->\n"
|
|
"[Shop](https://hackertours.example/hackertours) "
|
|
"ticket@hackertours.example @hackertours "
|
|
"#easterhegg-hackertours:example.org\n"
|
|
)
|
|
self.assertEqual(result.returncode, 0, result.stderr)
|
|
|
|
def test_marker_only_ignores_its_own_line(self):
|
|
result = self.build(
|
|
"---\ntitle: Hackertours\n---\n"
|
|
"HackerTours <!-- hackertours-lint-ignore -->\n"
|
|
"HackerTours\n"
|
|
)
|
|
self.assertNotEqual(result.returncode, 0)
|
|
self.assertIn(':5: "HackerTours" should be "Hackertours"', result.stderr)
|
|
self.assertNotIn(':4: "HackerTours" should be "Hackertours"', result.stderr)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main()
|