diff options
Diffstat (limited to 'gitlint/tests/config/test_config_builder.py')
| -rw-r--r-- | gitlint/tests/config/test_config_builder.py | 81 |
1 files changed, 71 insertions, 10 deletions
diff --git a/gitlint/tests/config/test_config_builder.py b/gitlint/tests/config/test_config_builder.py index 051a52f..5a28c9f 100644 --- a/gitlint/tests/config/test_config_builder.py +++ b/gitlint/tests/config/test_config_builder.py @@ -1,9 +1,12 @@ # -*- coding: utf-8 -*- +import copy from gitlint.tests.base import BaseTestCase from gitlint.config import LintConfig, LintConfigBuilder, LintConfigError +from gitlint import rules + class LintConfigBuilderTests(BaseTestCase): def test_set_option(self): @@ -88,12 +91,13 @@ class LintConfigBuilderTests(BaseTestCase): # bad config file load foo_path = self.get_sample_path(u"föo") expected_error_msg = u"Invalid file path: {0}".format(foo_path) - with self.assertRaisesRegex(LintConfigError, expected_error_msg): + with self.assertRaisesMessage(LintConfigError, expected_error_msg): config_builder.set_from_config_file(foo_path) # error during file parsing path = self.get_sample_path("config/no-sections") expected_error_msg = u"File contains no section headers." + # We only match the start of the message here, since the exact message can vary depending on platform with self.assertRaisesRegex(LintConfigError, expected_error_msg): config_builder.set_from_config_file(path) @@ -102,7 +106,7 @@ class LintConfigBuilderTests(BaseTestCase): config_builder = LintConfigBuilder() config_builder.set_from_config_file(path) expected_error_msg = u"No such rule 'föobar'" - with self.assertRaisesRegex(LintConfigError, expected_error_msg): + with self.assertRaisesMessage(LintConfigError, expected_error_msg): config_builder.build() # non-existing general option @@ -110,7 +114,7 @@ class LintConfigBuilderTests(BaseTestCase): config_builder = LintConfigBuilder() config_builder.set_from_config_file(path) expected_error_msg = u"'foo' is not a valid gitlint option" - with self.assertRaisesRegex(LintConfigError, expected_error_msg): + with self.assertRaisesMessage(LintConfigError, expected_error_msg): config_builder.build() # non-existing option @@ -118,7 +122,7 @@ class LintConfigBuilderTests(BaseTestCase): config_builder = LintConfigBuilder() config_builder.set_from_config_file(path) expected_error_msg = u"Rule 'title-max-length' has no option 'föobar'" - with self.assertRaisesRegex(LintConfigError, expected_error_msg): + with self.assertRaisesMessage(LintConfigError, expected_error_msg): config_builder.build() # invalid option value @@ -127,7 +131,7 @@ class LintConfigBuilderTests(BaseTestCase): config_builder.set_from_config_file(path) expected_error_msg = u"'föo' is not a valid value for option 'title-max-length.line-length'. " + \ u"Option 'line-length' must be a positive integer (current value: 'föo')." - with self.assertRaisesRegex(LintConfigError, expected_error_msg): + with self.assertRaisesMessage(LintConfigError, expected_error_msg): config_builder.build() def test_set_config_from_string_list(self): @@ -150,27 +154,27 @@ class LintConfigBuilderTests(BaseTestCase): # assert error on incorrect rule - this happens at build time config_builder.set_config_from_string_list([u"föo.bar=1"]) - with self.assertRaisesRegex(LintConfigError, u"No such rule 'föo'"): + with self.assertRaisesMessage(LintConfigError, u"No such rule 'föo'"): config_builder.build() # no equal sign expected_msg = u"'föo.bar' is an invalid configuration option. Use '<rule>.<option>=<value>'" - with self.assertRaisesRegex(LintConfigError, expected_msg): + with self.assertRaisesMessage(LintConfigError, expected_msg): config_builder.set_config_from_string_list([u"föo.bar"]) # missing value expected_msg = u"'föo.bar=' is an invalid configuration option. Use '<rule>.<option>=<value>'" - with self.assertRaisesRegex(LintConfigError, expected_msg): + with self.assertRaisesMessage(LintConfigError, expected_msg): config_builder.set_config_from_string_list([u"föo.bar="]) # space instead of equal sign expected_msg = u"'föo.bar 1' is an invalid configuration option. Use '<rule>.<option>=<value>'" - with self.assertRaisesRegex(LintConfigError, expected_msg): + with self.assertRaisesMessage(LintConfigError, expected_msg): config_builder.set_config_from_string_list([u"föo.bar 1"]) # no period between rule and option names expected_msg = u"'föobar=1' is an invalid configuration option. Use '<rule>.<option>=<value>'" - with self.assertRaisesRegex(LintConfigError, expected_msg): + with self.assertRaisesMessage(LintConfigError, expected_msg): config_builder.set_config_from_string_list([u'föobar=1']) def test_rebuild_config(self): @@ -201,3 +205,60 @@ class LintConfigBuilderTests(BaseTestCase): # Modify the original and make sure we're not modifying the clone (i.e. check that the copy is a deep copy) config_builder.set_option('title-max-length', 'line-length', 120) self.assertDictEqual(cloned_builder._config_blueprint, expected) + + def test_named_rules(self): + # Store a copy of the default rules from the config, so we can reference it later + config_builder = LintConfigBuilder() + config = config_builder.build() + default_rules = copy.deepcopy(config.rules) + self.assertEqual(default_rules, config.rules) # deepcopy should be equal + + # Add a named rule by setting an option in the config builder that follows the named rule pattern + # Assert that whitespace in the rule name is stripped + rule_qualifiers = [u'T7:my-extra-rüle', u' T7 : my-extra-rüle ', u'\tT7:\tmy-extra-rüle\t', + u'T7:\t\n \tmy-extra-rüle\t\n\n', u"title-match-regex:my-extra-rüle"] + for rule_qualifier in rule_qualifiers: + config_builder = LintConfigBuilder() + config_builder.set_option(rule_qualifier, 'regex', u"föo") + + expected_rules = copy.deepcopy(default_rules) + my_rule = rules.TitleRegexMatches({'regex': u"föo"}) + my_rule.id = rules.TitleRegexMatches.id + u":my-extra-rüle" + my_rule.name = rules.TitleRegexMatches.name + u":my-extra-rüle" + expected_rules._rules[u'T7:my-extra-rüle'] = my_rule + self.assertEqual(config_builder.build().rules, expected_rules) + + # assert that changing an option on the newly added rule is passed correctly to the RuleCollection + # we try this with all different rule qualifiers to ensure they all are normalized and map + # to the same rule + for other_rule_qualifier in rule_qualifiers: + cb = config_builder.clone() + cb.set_option(other_rule_qualifier, 'regex', other_rule_qualifier + u"bōr") + # before setting the expected rule option value correctly, the RuleCollection should be different + self.assertNotEqual(cb.build().rules, expected_rules) + # after setting the option on the expected rule, it should be equal + my_rule.options['regex'].set(other_rule_qualifier + u"bōr") + self.assertEqual(cb.build().rules, expected_rules) + my_rule.options['regex'].set(u"wrong") + + def test_named_rules_negative(self): + # T7 = title-match-regex + # Invalid rule name + for invalid_name in ["", " ", " ", "\t", "\n", u"å b", u"å:b", u"åb:", u":åb"]: + config_builder = LintConfigBuilder() + config_builder.set_option(u"T7:{0}".format(invalid_name), 'regex', u"tëst") + expected_msg = u"The rule-name part in 'T7:{0}' cannot contain whitespace, colons or be empty" + with self.assertRaisesMessage(LintConfigError, expected_msg.format(invalid_name)): + config_builder.build() + + # Invalid parent rule name + config_builder = LintConfigBuilder() + config_builder.set_option(u"Ž123:foöbar", u"fåke-option", u"fåke-value") + with self.assertRaisesMessage(LintConfigError, u"No such rule 'Ž123' (named rule: 'Ž123:foöbar')"): + config_builder.build() + + # Invalid option name (this is the same as with regular rules) + config_builder = LintConfigBuilder() + config_builder.set_option(u"T7:foöbar", u"blå", u"my-rëgex") + with self.assertRaisesMessage(LintConfigError, u"Rule 'T7:foöbar' has no option 'blå'"): + config_builder.build() |