Config: Refactor to use YamlLintConfig objects
This commit is contained in:
Adrien Vergé
@@ -18,7 +18,7 @@ import unittest
|
||||
|
||||
import yaml
|
||||
|
||||
from yamllint.config import parse_config
|
||||
from yamllint.config import YamlLintConfig
|
||||
from yamllint.errors import LintProblem
|
||||
from yamllint import lint
|
||||
|
||||
@@ -31,7 +31,7 @@ class RuleTestCase(unittest.TestCase):
|
||||
conf = yaml.safe_load(conf)
|
||||
conf = {'extends': 'default',
|
||||
'rules': conf}
|
||||
return parse_config(yaml.safe_dump(conf))
|
||||
return YamlLintConfig(yaml.safe_dump(conf))
|
||||
|
||||
def check(self, source, conf, **kwargs):
|
||||
expected_problems = []
|
||||
|
||||
@@ -14,56 +14,164 @@
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
import os
|
||||
import unittest
|
||||
|
||||
from yamllint import config
|
||||
|
||||
|
||||
class ConfigTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.base = config.parse_config_from_file(os.path.join(
|
||||
os.path.dirname(os.path.dirname(os.path.realpath(__file__))),
|
||||
'yamllint', 'conf', 'default.yml'))
|
||||
class SimpleConfigTestCase(unittest.TestCase):
|
||||
def test_parse_config(self):
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n')
|
||||
|
||||
self.assertEqual(list(new.rules.keys()), ['colons'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 1)
|
||||
|
||||
def test_unknown_rule(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: no such rule: "this-one-does-not-exist"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' this-one-does-not-exist: {}\n')
|
||||
|
||||
def test_missing_option(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: missing option "max-spaces-before" '
|
||||
'for rule "colons"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-after: 1\n')
|
||||
|
||||
def test_unknown_option(self):
|
||||
with self.assertRaisesRegexp(
|
||||
config.YamlLintConfigError,
|
||||
'invalid config: unknown option "abcdef" for rule "colons"'):
|
||||
config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' abcdef: yes\n')
|
||||
|
||||
|
||||
class ExtendedConfigTestCase(unittest.TestCase):
|
||||
def test_extend_add_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
def test_extend_remove_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons: disable\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons'], False)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 1)
|
||||
|
||||
def test_extend_edit_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 3\n'
|
||||
' max-spaces-after: 4\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 3)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 4)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
def test_extend_reenable_rule(self):
|
||||
old = config.YamlLintConfig('rules:\n'
|
||||
' colons:\n'
|
||||
' max-spaces-before: 0\n'
|
||||
' max-spaces-after: 1\n'
|
||||
' hyphens: disable\n')
|
||||
new = config.YamlLintConfig('rules:\n'
|
||||
' hyphens:\n'
|
||||
' max-spaces-after: 2\n')
|
||||
new.extend(old)
|
||||
|
||||
self.assertEqual(sorted(new.rules.keys()), ['colons', 'hyphens'])
|
||||
self.assertEqual(new.rules['colons']['max-spaces-before'], 0)
|
||||
self.assertEqual(new.rules['colons']['max-spaces-after'], 1)
|
||||
self.assertEqual(new.rules['hyphens']['max-spaces-after'], 2)
|
||||
|
||||
self.assertEqual(len(new.enabled_rules()), 2)
|
||||
|
||||
|
||||
class ExtendedLibraryConfigTestCase(unittest.TestCase):
|
||||
def test_extend_config_disable_rule(self):
|
||||
new = config.parse_config('extends: default\n'
|
||||
'rules:\n'
|
||||
' trailing-spaces: disable\n')
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' trailing-spaces: disable\n')
|
||||
|
||||
base = self.base.copy()
|
||||
del base['trailing-spaces']
|
||||
old.rules['trailing-spaces'] = False
|
||||
|
||||
self.assertEqual(sorted(new.keys()), sorted(base.keys()))
|
||||
for rule in new:
|
||||
self.assertEqual(new[rule], base[rule])
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
|
||||
def test_extend_config_override_whole_rule(self):
|
||||
new = config.parse_config('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max: 42\n'
|
||||
' max-start: 43\n'
|
||||
' max-end: 44\n')
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max: 42\n'
|
||||
' max-start: 43\n'
|
||||
' max-end: 44\n')
|
||||
|
||||
base = self.base.copy()
|
||||
base['empty-lines']['max'] = 42
|
||||
base['empty-lines']['max-start'] = 43
|
||||
base['empty-lines']['max-end'] = 44
|
||||
old.rules['empty-lines']['max'] = 42
|
||||
old.rules['empty-lines']['max-start'] = 43
|
||||
old.rules['empty-lines']['max-end'] = 44
|
||||
|
||||
self.assertEqual(sorted(new.keys()), sorted(base.keys()))
|
||||
for rule in new:
|
||||
self.assertEqual(new[rule], base[rule])
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
|
||||
def test_extend_config_override_rule_partly(self):
|
||||
new = config.parse_config('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max-start: 42\n')
|
||||
old = config.YamlLintConfig('extends: default')
|
||||
new = config.YamlLintConfig('extends: default\n'
|
||||
'rules:\n'
|
||||
' empty-lines:\n'
|
||||
' max-start: 42\n')
|
||||
|
||||
base = self.base.copy()
|
||||
base['empty-lines']['max-start'] = 42
|
||||
old.rules['empty-lines']['max-start'] = 42
|
||||
|
||||
self.assertEqual(sorted(new.keys()), sorted(base.keys()))
|
||||
for rule in new:
|
||||
self.assertEqual(new[rule], base[rule])
|
||||
self.assertEqual(sorted(new.rules.keys()), sorted(old.rules.keys()))
|
||||
for rule in new.rules:
|
||||
self.assertEqual(new.rules[rule], old.rules[rule])
|
||||
|
||||
Reference in New Issue
Block a user