Log unknown settings in configuration and theme files.

4 files changed, 56 insertions, 4 deletions

diff --git a/alot/settings/manager.py b/alot/settings/manager.py
index 10a441ed..dffe1b32 100644
--- a/alot/settings/manager.py
+++ b/alot/settings/manager.py
@@ -79,7 +79,7 @@ class SettingsManager(object):
         """parse alot's config file from path"""
         spec = os.path.join(DEFAULTSPATH, 'alot.rc.spec')
         newconfig = read_config(
-            self.alot_rc_path, spec, checks={
+            self.alot_rc_path, spec, report_extra=True, checks={
                 'mail_container': checks.mail_container,
                 'force_list': checks.force_list,
                 'align': checks.align_mode,
diff --git a/alot/settings/theme.py b/alot/settings/theme.py
index f2a59763..d74cb0e7 100644
--- a/alot/settings/theme.py
+++ b/alot/settings/theme.py
@@ -22,7 +22,7 @@ class Theme(object):
         :raises: :class:`~alot.settings.errors.ConfigError`
         """
         self._spec = os.path.join(DEFAULTSPATH, 'theme.spec')
-        self._config = read_config(path, self._spec,
+        self._config = read_config(path, self._spec, report_extra=True,
                                    checks={'align': checks.align_mode,
                                            'widthtuple': checks.width_tuple,
                                            'force_list': checks.force_list,
diff --git a/alot/settings/utils.py b/alot/settings/utils.py
index 242fa63c..8d656b79 100644
--- a/alot/settings/utils.py
+++ b/alot/settings/utils.py
@@ -5,14 +5,16 @@ from __future__ import absolute_import
 
 import logging
 
-from configobj import ConfigObj, ConfigObjError, flatten_errors
+from configobj import (ConfigObj, ConfigObjError, flatten_errors,
+                       get_extra_values)
 from validate import Validator
 from urwid import AttrSpec
 
 from .errors import ConfigError
 
 
-def read_config(configpath=None, specpath=None, checks=None):
+def read_config(configpath=None, specpath=None, checks=None,
+                report_extra=False):
     """
     get a (validated) config object for given config file path.
 
@@ -23,6 +25,8 @@ def read_config(configpath=None, specpath=None, checks=None):
     :param checks: custom checks to use for validator.
         see `validate docs <http://www.voidspace.org.uk/python/validate.html>`_
     :type checks: dict str->callable,
+    :param report_extra: log if a setting is not present in the spec file
+    :type report_extra: boolean
     :raises: :class:`~alot.settings.errors.ConfigError`
     :rtype: `configobj.ConfigObj`
     """
@@ -65,6 +69,18 @@ def read_config(configpath=None, specpath=None, checks=None):
                     msg = 'section "%s" is missing' % '.'.join(section_list)
                 error_msg += msg + '\n'
             raise ConfigError(error_msg)
+
+        extra_values = get_extra_values(config) if report_extra else None
+        if extra_values:
+            msg = ['Unknown values were found in `%s`. Please check for '
+                   'typos if a specified setting does not seem to work:'
+                   % configpath]
+            for sections, val in extra_values:
+                if sections:
+                    msg.append('%s: %s' % ('->'.join(sections), val))
+                else:
+                    msg.append(str(val))
+            logging.info('\n'.join(msg))
     return config
 
 
diff --git a/tests/settings/manager_test.py b/tests/settings/manager_test.py
index 42bc584a..eb2f37fd 100644
--- a/tests/settings/manager_test.py
+++ b/tests/settings/manager_test.py
@@ -11,6 +11,8 @@ import tempfile
 import textwrap
 import unittest
 
+import mock
+
 from alot.settings.manager import SettingsManager
 from alot.settings.errors import ConfigError, NoMatchingAccount
 
@@ -80,6 +82,40 @@ class TestSettingsManager(unittest.TestCase):
 
         manager.get_theming_attribute('global', 'body')
 
+    def test_unknown_settings_in_config_are_logged(self):
+        # todo: For py3, don't mock the logger, use assertLogs
+        unknown_settings = ['templates_dir', 'unknown_section', 'unknown_1',
+                            'unknown_2']
+        with tempfile.NamedTemporaryFile(delete=False) as f:
+            f.write(textwrap.dedent("""\
+                {x[0]} = /templates/dir
+                [{x[1]}]
+                    # Values in unknown sections are not reported.
+                    barfoo = barfoo
+                [tags]
+                    [[foobar]]
+                        {x[2]} = baz
+                        translated = translation
+                        {x[3]} = bar
+                """.format(x=unknown_settings)))
+        self.addCleanup(os.unlink, f.name)
+
+        with mock.patch('alot.settings.utils.logging') as mock_logger:
+            SettingsManager(alot_rc=f.name)
+            success = False
+            for call_args in mock_logger.info.call_args_list:
+                msg = call_args[0][0]
+                if all([s in msg for s in unknown_settings]):
+                    success = True
+                    break
+            else:
+                print('Could not find all unknown settings in logging.info.\n'
+                      'Unknown settings:')
+                print(unknown_settings)
+                print('Calls to mocked logging.info:')
+                print(mock_logger.info.call_args_list)
+        self.assertTrue(success)
+
     def test_read_notmuch_config_doesnt_exist(self):
         with tempfile.NamedTemporaryFile(delete=False) as f:
             f.write(textwrap.dedent("""\