Unknown/invalid option names in pyproject.toml file will now cause fatal error (#151)

Author: bhirsz

CHANGES.md

@@ -2,9 +2,13 @@
 
 ## Unreleased
 
+### Fixes
+- Invalid option names in pyproject.toml file will now stop Robotidy (with optional hint message) [#150](https://github.com/MarketSquare/robotframework-tidy/issues/150)
+
 ### Features
 - Allow to use spaces in pyproject.toml configuration file [#148](https://github.com/MarketSquare/robotframework-tidy/issues/148)
 
+
 ## 1.3.0
 
 ### Transformers

robotidy/cli.py

@@ -140,12 +140,28 @@ def load_toml_file(path: str) -> Dict[str, Any]:
 
 
 def read_pyproject_config(path: str) -> Dict[str, Any]:
-    click.echo(f'Reading {path}')
     config = load_toml_file(path)
     config = config.get("tool", {}).get("robotidy", {})
     return {k.replace('--', '').replace('-', '_'): v for k, v in config.items()}
 
 
+def parse_opt(opt):
+    while opt and opt[0] == '-':
+        opt = opt[1:]
+    return opt.replace('-', '_')
+
+
+def validate_config_options(params, config):
+    if params is None:
+        return
+    allowed = {parse_opt(opt) for param in params for opt in param.opts}
+    for conf in config:
+        if conf not in allowed:
+            rec_finder = RecommendationFinder()
+            similar = rec_finder.find(conf, list(allowed))
+            raise click.NoSuchOption(conf, possibilities=similar)
+
+
 def read_config(ctx: click.Context, param: click.Parameter, value: Optional[str]) -> Optional[str]:
     # if --config was not used, try to find pyproject.toml or robotidy.toml file
     if value:
@@ -161,7 +177,7 @@ def read_config(ctx: click.Context, param: click.Parameter, value: Optional[str]
         k: str(v) if not isinstance(v, (list, dict)) else v
         for k, v in config.items()
     }
-
+    validate_config_options(ctx.command.params, config)
     default_map: Dict[str, Any] = {}
     if ctx.default_map:
         default_map.update(ctx.default_map)

tests/utest/test_cli.py

@@ -3,7 +3,7 @@
 
 from unittest.mock import MagicMock, Mock
 import pytest
-from click import FileError
+from click import FileError, NoSuchOption
 
 from .utils import run_tidy, save_tmp_model
 from robotidy.cli import (
@@ -142,6 +142,7 @@ def test_read_pyproject_config_e2e(self):
         config_path = str(Path(Path(__file__).parent, 'testdata', 'only_pyproject'))
         ctx_mock = MagicMock()
         ctx_mock.params = {'src': [config_path]}
+        ctx_mock.command.params = None
         param_mock = Mock()
         read_config(ctx_mock, param_mock, value=None)
         assert ctx_mock.default_map == expected_parsed_config
@@ -152,6 +153,19 @@ def test_read_invalid_config(self):
             read_pyproject_config(config_path)
         assert 'Error reading configuration file: ' in str(err)
 
+    @pytest.mark.parametrize('option, correct', [
+        ('confgure', 'configure'),
+        ('idontexist', None)
+    ])
+    def test_read_invalid_option_config(self, option, correct):
+        config_path = str(Path(Path(__file__).parent, 'testdata', 'invalid_options_config', f'pyproject_{option}.toml'))
+        ctx_mock = MagicMock()
+        param_mock = MagicMock()
+        with pytest.raises(NoSuchOption) as err:
+            read_config(ctx_mock, param_mock, config_path)
+        similar = '' if correct is None else f' Did you mean {correct}'
+        assert f'no such option: {option}{similar}'
+
     def test_read_config_from_param(self):
         expected_parsed_config = {
             'overwrite': 'False',
@@ -164,6 +178,7 @@ def test_read_config_from_param(self):
         }
         config_path = str(Path(Path(__file__).parent, 'testdata', 'robotidy.toml'))
         ctx_mock = MagicMock()
+        ctx_mock.command.params = None
         param_mock = Mock()
         read_config(ctx_mock, param_mock, config_path)
         assert ctx_mock.default_map == expected_parsed_config
@@ -181,6 +196,7 @@ def test_read_config_without_param(self):
         config_path = str(Path(Path(__file__).parent, 'testdata', 'robotidy.toml'))
         ctx_mock = MagicMock()
         ctx_mock.params = {'src': [config_path]}
+        ctx_mock.command.params = None
         param_mock = Mock()
         read_config(ctx_mock, param_mock, value=None)
         assert ctx_mock.default_map == expected_parsed_config

tests/utest/testdata/invalid_options_config/pyproject_confgure.toml

@@ -0,0 +1,13 @@
+[tool.robotidy]
+overwrite = false
+diff = false
+startline = 10
+endline = 20
+transform = [
+   "DiscardEmptySections:allow_only_comments=True",
+   "SplitTooLongLine"
+]
+confgure = [
+    "DiscardEmptySections:allow_only_comments=False",
+    "OrderSettings: keyword_before = documentation,tags,timeout,arguments"
+]

tests/utest/testdata/invalid_options_config/pyproject_idontexist.toml

@@ -0,0 +1,14 @@
+[tool.robotidy]
+idontexist = 10
+overwrite = false
+diff = false
+startline = 10
+endline = 20
+transform = [
+   "DiscardEmptySections:allow_only_comments=True",
+   "SplitTooLongLine"
+]
+configure = [
+    "DiscardEmptySections:allow_only_comments=False",
+    "OrderSettings: keyword_before = documentation,tags,timeout,arguments"
+]