🧪 TEST: Add test_malformed_file_parse (#17)

Author: chrisjsewell

README.md

@@ -317,7 +317,6 @@ Questions / TODOs:
 - Should `titlesonly` default to `True` (as in jupyter-book)?
 - nested numbered toctree not allowed (logs warning), so should be handled if `numbered: true` is in defaults
 - Add additional top-level keys, e.g. `appendices` (see https://github.com/sphinx-doc/sphinx/issues/2502) and `bibliography`
-- Add tests for "bad" toc files
 - Using `external_toc_exclude_missing` to exclude a certain file suffix:
   currently if you had files `doc.md` and `doc.rst`, and put `doc.md` in your ToC,
   it will add `doc.rst` to the excluded patterns but then, when looking for `doc.md`,

tests/_bad_toc_files/empty.yml

@@ -0,0 +1,4 @@
+root: index
+sections:
+- file: doc
+  glob: doc*

tests/_bad_toc_files/file_and_glob_present.yml

@@ -0,0 +1,2 @@
+- 1
+- 2

tests/_bad_toc_files/list.yml

@@ -0,0 +1 @@
+x: a

tests/_bad_toc_files/no_root.yml

@@ -0,0 +1,5 @@
+root: index
+sections:
+- glob: doc*
+  sections:
+  - file: other

tests/_bad_toc_files/section_in_glob.yml

@@ -0,0 +1,5 @@
+root: index
+sections:
+- url: http://example.com
+  sections:
+  - file: other

tests/_bad_toc_files/section_in_url.yml

@@ -2,9 +2,10 @@
 
 import pytest
 
-from sphinx_external_toc.api import create_toc_dict, parse_toc_yaml
+from sphinx_external_toc.api import MalformedError, create_toc_dict, parse_toc_yaml
 
 TOC_FILES = list(Path(__file__).parent.joinpath("_toc_files").glob("*.yml"))
+TOC_FILES_BAD = list(Path(__file__).parent.joinpath("_bad_toc_files").glob("*.yml"))
 
 
 @pytest.mark.parametrize(
@@ -22,3 +23,11 @@ def test_create_toc_dict(path: Path, data_regression):
     site_map = parse_toc_yaml(path)
     data = create_toc_dict(site_map)
     data_regression.check(data)
+
+
+@pytest.mark.parametrize(
+    "path", TOC_FILES_BAD, ids=[path.name.rsplit(".", 1)[0] for path in TOC_FILES_BAD]
+)
+def test_malformed_file_parse(path: Path):
+    with pytest.raises(MalformedError):
+        parse_toc_yaml(path)