add config validator subcommand (#80)

* add config validator subcommand

* add --exit-code flag

* docs & faq update

tests/ahriman/application/handlers/test_handler_dump.py

@@ -4,15 +4,12 @@ from pytest_mock import MockerFixture
 
 from ahriman.application.handlers import Dump
 from ahriman.core.configuration import Configuration
-from ahriman.core.repository import Repository
 
 
-def test_run(args: argparse.Namespace, configuration: Configuration, repository: Repository,
-             mocker: MockerFixture) -> None:
+def test_run(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None:
     """
     must run command
     """
-    mocker.patch("ahriman.core.repository.Repository.load", return_value=repository)
     print_mock = mocker.patch("ahriman.core.formatters.Printer.print")
     application_mock = mocker.patch("ahriman.core.configuration.Configuration.dump",
                                     return_value=configuration.dump())

tests/ahriman/application/handlers/test_handler_validate.py

@@ -0,0 +1,104 @@
+import argparse
+import json
+
+from pytest_mock import MockerFixture
+
+from ahriman.application.handlers import Validate
+from ahriman.core.configuration import Configuration
+from ahriman.core.configuration.schema import CONFIGURATION_SCHEMA, GITREMOTE_REMOTE_PULL_SCHEMA
+from ahriman.core.configuration.validator import Validator
+
+
+def _default_args(args: argparse.Namespace) -> argparse.Namespace:
+    """
+    default arguments for these test cases
+
+    Args:
+        args(argparse.Namespace): command line arguments fixture
+
+    Returns:
+        argparse.Namespace: generated arguments for these test cases
+    """
+    args.exit_code = False
+    return args
+
+
+def test_run(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None:
+    """
+    must run command
+    """
+    args = _default_args(args)
+    mocker.patch.object(Validator, "errors", {"node": ["error"]})
+    print_mock = mocker.patch("ahriman.core.formatters.Printer.print")
+    application_mock = mocker.patch("ahriman.core.configuration.validator.Validator.validate", return_value=False)
+
+    Validate.run(args, "x86_64", configuration, report=False, unsafe=False)
+
+    application_mock.assert_called_once_with(configuration.dump())
+    print_mock.assert_called_once_with(verbose=True)
+
+
+def test_run_skip(args: argparse.Namespace, configuration: Configuration, mocker: MockerFixture) -> None:
+    """
+    must skip print if no errors found
+    """
+    args = _default_args(args)
+    mocker.patch("ahriman.core.configuration.validator.Validator.validate", return_value=True)
+    print_mock = mocker.patch("ahriman.core.formatters.Printer.print")
+
+    Validate.run(args, "x86_64", configuration, report=False, unsafe=False)
+    print_mock.assert_not_called()
+
+
+def test_schema(configuration: Configuration) -> None:
+    """
+    must generate full schema correctly
+    """
+    schema = Validate.schema("x86_64", configuration)
+
+    # defaults
+    assert schema.pop("console")
+    assert schema.pop("email")
+    assert schema.pop("github")
+    assert schema.pop("gitremote")
+    assert schema.pop("html")
+    assert schema.pop("rsync")
+    assert schema.pop("s3")
+    assert schema.pop("telegram")
+
+    assert schema == CONFIGURATION_SCHEMA
+
+
+def test_schema_erase_required() -> None:
+    """
+    must remove required field from dictionaries recursively
+    """
+    # the easiest way is to just dump to string and check
+    assert "required" not in json.dumps(Validate.schema_erase_required(CONFIGURATION_SCHEMA))
+
+
+def test_schema_insert(configuration: Configuration) -> None:
+    """
+    must insert child schema to root
+    """
+    result = Validate.schema_insert("x86_64", configuration, CONFIGURATION_SCHEMA, "remote-pull",
+                                    lambda _: GITREMOTE_REMOTE_PULL_SCHEMA)
+    assert result["gitremote"] == GITREMOTE_REMOTE_PULL_SCHEMA
+
+
+def test_schema_insert_skip(configuration: Configuration) -> None:
+    """
+    must do nothing in case if there is no such section or option
+    """
+    configuration.remove_section("remote-pull")
+
+    result = Validate.schema_insert("x86_64", configuration, CONFIGURATION_SCHEMA, "remote-pull",
+                                    lambda _: GITREMOTE_REMOTE_PULL_SCHEMA)
+    assert result == CONFIGURATION_SCHEMA
+
+
+def test_disallow_auto_architecture_run() -> None:
+    """
+    must not allow multi architecture run
+    """
+    assert not Validate.ALLOW_AUTO_ARCHITECTURE_RUN