#1 Added tests passing

Author: staticdev

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": "/home/static/.cache/pypoetry/virtualenvs/toml-validator-zr_HNKMd-py3.7/bin/python"
+}

mypy.ini

@@ -1,4 +1,4 @@
 [mypy]
 
-[mypy-nox.*,tomlkit.*,pytest]
+[mypy-nox.*,tomlkit.*,pytest,pytest_mock]
 ignore_missing_imports = True

noxfile.py

@@ -88,7 +88,9 @@ def tests(session: Session) -> None:
     """Run the test suite."""
     args = session.posargs or ["--cov", "-m", "not e2e"]
     session.run("poetry", "install", "--no-dev", external=True)
-    install_with_constraints(session, "coverage[toml]", "pytest", "pytest-cov")
+    install_with_constraints(
+        session, "coverage[toml]", "pytest", "pytest-cov", "pytest-mock"
+    )
     session.run("pytest", *args)
 
 

poetry.lock

@@ -27,6 +27,7 @@ flake8-import-order = "^0.18.1"
 safety = "^1.8.5"
 mypy = "^0.770"
 codecov = "^2.0.22"
+pytest-mock = "^3.0.0"
 
 [tool.poetry.scripts]
 toml-validator = "toml_validator.console:main"

pyproject.toml

@@ -1,32 +1,21 @@
-""" Toml Validator CLI """
-
-import sys
+"""Toml Validator CLI."""
 
 import click
-from tomlkit import parse
-from tomlkit.exceptions import ParseError, TOMLKitError
 
-from . import __version__
+from . import __version__, validation
 
 
 @click.command()
 @click.argument("filename", type=click.Path(exists=True))
 @click.version_option(version=__version__)
-def main(filename) -> None:
-    """ Gets TOML file and validate  """
-    if not filename.endswith(".toml"):
-        sys.exit('Error: "FILANAME" %s does not have a ".toml" extension.' % filename)
-
-    with open(filename) as toml:
-        lines = toml.read()
-
-    click.secho("Reading file %s" % filename, fg="blue")
-    try:
-        parse(lines)
-        click.secho("No problems found parsing file %s!" % filename, fg="green")
-    except (TOMLKitError, ParseError) as error:
-        click.secho("Error found: " + str(error), fg="red")
+def main(filename: str) -> None:
+    """Makes validations and echos errors if found."""
+    validation.validate_extension(filename)
 
+    click.secho("Reading file {}.".format(filename), fg="blue")
 
-if __name__ == "__main__":
-    main()
+    errors = validation.validate_toml(filename)
+    if errors:
+        click.secho("Error(s) found: {}.".format(errors), fg="red")
+    else:
+        click.secho("No problems found parsing file {}!".format(filename), fg="green")

src/toml_validator/console.py

@@ -0,0 +1,25 @@
+"""Toml Validator validations."""
+
+import sys
+
+import tomlkit
+from tomlkit.exceptions import ParseError, TOMLKitError
+
+
+def validate_extension(filename: str) -> bool:
+    valid_extensions = [".toml"]
+    for extension in valid_extensions:
+        if filename.endswith(extension):
+            return True
+    sys.exit('Error: "FILANAME" {} does not have a valid extension.'.format(filename))
+
+
+def validate_toml(filename: str) -> str:
+    with open(filename) as toml:
+        lines = toml.read()
+
+    try:
+        tomlkit.parse(lines)
+        return ""
+    except (TOMLKitError, ParseError) as errors:
+        return str(errors)

src/toml_validator/validation.py

@@ -0,0 +1 @@
+"""Test suite for the toml_validator package."""

tests/__init__.py

@@ -1,24 +1,78 @@
-import click.testing
+"""Test cases for the console module."""
+from unittest.mock import Mock
+
+from click.testing import CliRunner
 import pytest
+from pytest_mock import MockFixture
 
 from toml_validator import console
 
 
 @pytest.fixture
 def runner():
-    return click.testing.CliRunner()
+    return CliRunner()
+
+
+@pytest.fixture
+def mock_validation_validate_extension(mocker: MockFixture) -> Mock:
+    """Fixture for mocking validation.validate_extension."""
+    return mocker.patch("toml_validator.validation.validate_extension")
+
+
+@pytest.fixture
+def mock_validation_validate_toml_no_error(mocker: MockFixture) -> Mock:
+    """Fixture for mocking validation.validate_toml with no errors."""
+    mock = mocker.patch("toml_validator.validation.validate_toml")
+    mock.return_value = ""
+    return mock
 
 
-# TODO make the two success cases
-# (one using mock file and one running a valid file in e2e)
+@pytest.fixture
+def mock_validation_validate_toml_with_error(mocker: MockFixture) -> Mock:
+    """Fixture for mocking validation.validate_toml with error."""
+    mock = mocker.patch("toml_validator.validation.validate_toml")
+    mock.return_value = "|some error description|"
+    return mock
 
 
-def test_main_without_arguments(runner):
+def test_main_without_argument(runner: CliRunner):
     result = runner.invoke(console.main)
     assert result.exit_code == 2
 
 
+def test_main_with_argument_success(
+    runner: CliRunner,
+    mock_validation_validate_extension: Mock,
+    mock_validation_validate_toml_no_error: Mock,
+):
+    with runner.isolated_filesystem():
+        with open("file.toml", "w") as f:
+            f.write("content doesnt matter")
+
+        result = runner.invoke(console.main, ["file.toml"])
+        assert result.output == (
+            "Reading file file.toml.\n" "No problems found parsing file file.toml!\n"
+        )
+        assert result.exit_code == 0
+
+
+def test_main_with_argument_fail(
+    runner: CliRunner,
+    mock_validation_validate_extension: Mock,
+    mock_validation_validate_toml_with_error: Mock,
+):
+    with runner.isolated_filesystem():
+        with open("file.toml", "w") as f:
+            f.write("content doesnt matter")
+
+        result = runner.invoke(console.main, ["file.toml"])
+        assert result.output == (
+            "Reading file file.toml.\n" "Error(s) found: |some error description|.\n"
+        )
+        assert result.exit_code == 0
+
+
 @pytest.mark.e2e
-def test_main_without_arguments_in_production_env(runner):
+def test_main_without_arguments_in_production_env(runner: CliRunner):
     result = runner.invoke(console.main)
     assert result.exit_code == 2