add fail_on_diagnostic toml flag

Author: madelinezec

snooty/main.py

@@ -25,7 +25,7 @@
 import watchdog.events
 import watchdog.observers
 from pathlib import Path, PurePath
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union, Sequence
 from docopt import docopt
 
 from . import language_server
@@ -39,6 +39,7 @@
 logger = logging.getLogger(__name__)
 SNOOTY_ENV = os.getenv("SNOOTY_ENV", "development")
 PACKAGE_ROOT = Path(sys.modules["snooty"].__file__).resolve().parent
+
 if PACKAGE_ROOT.is_file():
     PACKAGE_ROOT = PACKAGE_ROOT.parent
 
@@ -82,6 +83,7 @@ def dispatch(self, event: watchdog.events.FileSystemEvent) -> None:
 
 
 class Backend:
+
     def __init__(self) -> None:
         self.total_errors = 0
 
@@ -249,9 +251,10 @@ def _generate_build_identifiers(args: Dict[str, Optional[str]]) -> BuildIdentifi
     return identifiers
 
 
-def main() -> None:
+def main(argv: Optional[Sequence[str]] = None) -> None:
     # docopt will terminate here and display usage instructions if snooty is run improperly
-    args = docopt(__doc__)
+    print(argv)
+    args = docopt(__doc__, argv)
 
     logging.basicConfig(level=logging.INFO)
 
@@ -263,6 +266,7 @@ def main() -> None:
         return
 
     url = args["<mongodb-url>"]
+
     connection = (
         None if not url else pymongo.MongoClient(url, password=getpass.getpass())
     )
@@ -288,5 +292,11 @@ def main() -> None:
             print("Closing connection...")
             connection.close()
 
+    if(project.config.fail_on_diagnostics):
+      EXIT_STATUS_ERROR_DIAGNOSTICS = 1
+      #print("TOTAL ERRORS: ", project.config.fail_on_diagnostics, "\n\n cheese")
+      print(backend.total_errors)
+      assert False
+      
     if args["build"] and backend.total_errors > 0:
         sys.exit(EXIT_STATUS_ERROR_DIAGNOSTICS)

snooty/test_main.py

@@ -1,6 +1,9 @@
 import os
 import json
 import builtins
+import subprocess
+from subprocess import run
+from pathlib import Path
 from typing import Any, List
 from .types import FileId
 from .diagnostics import InvalidLiteralInclude, InvalidURL, UnknownSubstitution
@@ -72,3 +75,8 @@ def test_print(*values: Any, **kwargs: Any) -> None:
             }
         },
     ]
+
+def test_main():
+  subprocess.call(["snooty", "build", "test_data/test_parser_failure"])
+  #subprocess.call(["ls", "-l"])
+  #main.main(["build", 'test_data'])

snooty/test_parser.py

@@ -23,6 +23,8 @@
 def test_tabs() -> None:
     tabs_path = ROOT_PATH.joinpath(Path("test_tabs.rst"))
     project_config = ProjectConfig(ROOT_PATH, "")
+    print(project_config)
+    assert False
     parser = rstparser.Parser(project_config, JSONVisitor)
     page, diagnostics = parse_rst(parser, tabs_path, None)
     page.finish(diagnostics)
@@ -86,6 +88,8 @@ def test_tabs_invalid_yaml() -> None:
 def test_codeblock() -> None:
     tabs_path = ROOT_PATH.joinpath(Path("test.rst"))
     project_config = ProjectConfig(ROOT_PATH, "")
+    print(project_config)
+    assert False
     parser = rstparser.Parser(project_config, JSONVisitor)
 
     # Test a simple code-block
@@ -166,8 +170,9 @@ def test_codeblock() -> None:
 def test_literalinclude() -> None:
     path = ROOT_PATH.joinpath(Path("test.rst"))
     project_config = ProjectConfig(ROOT_PATH, "", source="./")
+    print(ProjectConfig.open(path))
     parser = rstparser.Parser(project_config, JSONVisitor)
-
+   
     # Test a simple literally-included code block
     page, diagnostics = parse_rst(
         parser,
@@ -177,6 +182,7 @@ def test_literalinclude() -> None:
 """,
     )
     page.finish(diagnostics)
+    print(parser.project_config.open(ROOT_PATH))
     assert diagnostics == []
     check_ast_testing_string(
         page.ast,
@@ -207,6 +213,7 @@ def test_literalinclude() -> None:
 """,
     )
     page.finish(diagnostics)
+    print(parser.project_config)
     assert diagnostics == []
     check_ast_testing_string(
         page.ast,
@@ -319,6 +326,7 @@ def test_literalinclude() -> None:
    :end-before: end example 1
 """,
     )
+    print(parser.project_config)
     page.finish(diagnostics)
     assert len(diagnostics) == 1
     assert isinstance(diagnostics[0], InvalidLiteralInclude)
@@ -331,7 +339,7 @@ def test_literalinclude() -> None:
         </directive>
         </root>""",
     )
-
+    print(parser.project_config)
     # Test poorly specified linenos: out-of-bounds (greater than file length)
     page, diagnostics = parse_rst(
         parser,
@@ -383,7 +391,8 @@ def test_literalinclude() -> None:
     page.finish(diagnostics)
     assert len(diagnostics) == 1
     assert isinstance(diagnostics[0], DocUtilsParseError)
-
+    print(parser.project_config)
+    assert False
 
 def test_include() -> None:
     path = ROOT_PATH.joinpath(Path("test.rst"))
@@ -599,6 +608,7 @@ def test_roles() -> None:
             </list>
             </root>""",
     )
+    assert False
 
 
 def test_doc_role() -> None:

snooty/types.py

@@ -373,6 +373,7 @@ def finish(
 class ProjectConfig:
     root: Path
     name: str
+    fail_on_diagnostics: bool
     default_domain: Optional[str] = field(default=None)
     title: str = field(default="untitled")
     source: str = field(default="source")
@@ -401,6 +402,7 @@ def open(cls, root: Path) -> Tuple["ProjectConfig", List[Diagnostic]]:
             try:
                 with path.joinpath("snooty.toml").open(encoding="utf-8") as f:
                     data = toml.load(f)
+                    print(data)
                     data["root"] = path
                     result, parsed_diagnostics = check_type(
                         ProjectConfig, data
@@ -409,6 +411,7 @@ def open(cls, root: Path) -> Tuple["ProjectConfig", List[Diagnostic]]:
             except FileNotFoundError:
                 pass
             except LoadError as err:
+                
                 diagnostics.append(UnmarshallingError(str(err), 0))
 
             path = path.parent