def get_config(ctx, target, config_path, c, ignore, verbose, silent):
""" Creates a LintConfig object based on a set of commandline parameters. """
try:
# Config precedence:
# First, load default config or config from configfile
lint_config = load_config_from_path(ctx, config_path)
# default to default configuration when no config file was loaded
if lint_config:
click.echo("Using config from {0}".format(lint_config.config_path))
else:
lint_config = LintConfig()
# Then process any commandline configuration flags
lint_config.apply_config_options(c)
# Finally, overwrite with any convenience commandline flags
lint_config.apply_on_csv_string(ignore, lint_config.disable_rule)
if silent:
lint_config.verbosity = 0
elif verbose > 0:
lint_config.verbosity = verbose
# Set target
lint_config.target = target
return lint_config
except LintConfigError as e:
click.echo("Config Error: {0}".format(str(e)))
ctx.exit(CONFIG_ERROR_CODE) # return CONFIG_ERROR_CODE on config error
def test_set_rule_option_negative(self):
config = LintConfig()
# non-existing rule
expected_error_msg = "No such rule 'foobar'"
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('foobar', 'line-length', 60)
# non-existing option
expected_error_msg = "Rule 'title-max-length' has no option 'foobar'"
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('title-max-length', 'foobar', 60)
# invalid option value
expected_error_msg = "'foo' is not a valid value for option 'title-max-length.line-length'. " + \
"Option 'line-length' must be a positive integer \(current value: 'foo'\)."
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('title-max-length', 'line-length', "foo")
# invalid verbosity
with self.assertRaisesRegexp(LintConfigError,
"verbosity must be set between 0 and 3"):
config.verbosity = -1
with self.assertRaisesRegexp(LintConfigError,
"verbosity must be set between 0 and 3"):
config.verbosity = 4
def test_set_general_option_negative(self):
config = LintConfig()
with self.assertRaisesRegexp(LintConfigError, "'foo' is not a valid gitlint option"):
config.set_general_option("foo", "bar")
# invalid verbosity
incorrect_values = [-1, "foo"]
for value in incorrect_values:
expected_msg = r"Option 'verbosity' must be a positive integer \(current value: '{0}'\)".format(value)
with self.assertRaisesRegexp(LintConfigError, expected_msg):
config.verbosity = value
incorrect_values = [4]
for value in incorrect_values:
with self.assertRaisesRegexp(LintConfigError, "Option 'verbosity' must be set between 0 and 3"):
config.verbosity = value
# invalid ignore_merge_commits
incorrect_values = [-1, 4, "foo"]
for value in incorrect_values:
with self.assertRaisesRegexp(LintConfigError,
r"Option 'ignore-merge-commits' must be either 'true' or 'false'"):
config.ignore_merge_commits = value
# invalid debug
with self.assertRaisesRegexp(LintConfigError, r"Option 'debug' must be either 'true' or 'false'"):
config.debug = "foobar"
def test_set_general_option_negative(self):
config = LintConfig()
# Note that we should't test whether we can set unicode because python just doesn't allow unicode attributes
with self.assertRaisesRegex(LintConfigError,
"'foo' is not a valid gitlint option"):
config.set_general_option("foo", u"bår")
# try setting _config_path, this is a real attribute of LintConfig, but the code should prevent it from
# being set
with self.assertRaisesRegex(
LintConfigError,
"'_config_path' is not a valid gitlint option"):
config.set_general_option("_config_path", u"bår")
# invalid verbosity`
incorrect_values = [-1, u"föo"]
for value in incorrect_values:
expected_msg = u"Option 'verbosity' must be a positive integer \(current value: '{0}'\)".format(
value)
with self.assertRaisesRegex(LintConfigError, expected_msg):
config.verbosity = value
incorrect_values = [4]
for value in incorrect_values:
with self.assertRaisesRegex(
LintConfigError,
"Option 'verbosity' must be set between 0 and 3"):
config.verbosity = value
# invalid ignore_merge_commits
incorrect_values = [-1, 4, u"föo"]
for value in incorrect_values:
with self.assertRaisesRegex(
LintConfigError,
"Option 'ignore-merge-commits' must be either 'true' or 'false'"
):
config.ignore_merge_commits = value
# invalid ignore -> not here because ignore is a ListOption which converts everything to a string before
# splitting which means it it will accept just about everything
# invalid debug
with self.assertRaisesRegex(
LintConfigError,
"Option 'debug' must be either 'true' or 'false'"):
config.debug = u"föobar"
# extra-path has its own negative test
# invalid target
with self.assertRaisesRegex(
LintConfigError,
u"Option target must be an existing directory \(current value: 'föo/bar'\)"
):
config.target = u"föo/bar"
def test_set_general_option_negative(self):
config = LintConfig()
# Note that we shouldn't test whether we can set unicode because python just doesn't allow unicode attributes
with self.assertRaisesRegex(LintConfigError, "'foo' is not a valid gitlint option"):
config.set_general_option("foo", u"bår")
# try setting _config_path, this is a real attribute of LintConfig, but the code should prevent it from
# being set
with self.assertRaisesRegex(LintConfigError, "'_config_path' is not a valid gitlint option"):
config.set_general_option("_config_path", u"bår")
# invalid verbosity
incorrect_values = [-1, u"föo"]
for value in incorrect_values:
expected_msg = u"Option 'verbosity' must be a positive integer (current value: '{0}')".format(value)
with self.assertRaisesRegex(LintConfigError, expected_msg):
config.verbosity = value
incorrect_values = [4]
for value in incorrect_values:
with self.assertRaisesRegex(LintConfigError, "Option 'verbosity' must be set between 0 and 3"):
config.verbosity = value
# invalid ignore_xxx_commits
ignore_attributes = ["ignore_merge_commits", "ignore_fixup_commits", "ignore_squash_commits",
"ignore_revert_commits"]
incorrect_values = [-1, 4, u"föo"]
for attribute in ignore_attributes:
for value in incorrect_values:
option_name = attribute.replace("_", "-")
with self.assertRaisesRegex(LintConfigError,
"Option '{0}' must be either 'true' or 'false'".format(option_name)):
setattr(config, attribute, value)
# invalid ignore -> not here because ignore is a ListOption which converts everything to a string before
# splitting which means it it will accept just about everything
# invalid boolean options
for attribute in ['debug', 'staged', 'ignore_stdin']:
option_name = attribute.replace("_", "-")
with self.assertRaisesRegex(LintConfigError,
"Option '{0}' must be either 'true' or 'false'".format(option_name)):
setattr(config, attribute, u"föobar")
# extra-path has its own negative test
# invalid target
with self.assertRaisesRegex(LintConfigError,
u"Option target must be an existing directory (current value: 'föo/bar')"):
config.target = u"föo/bar"
def test_set_general_option_negative(self):
config = LintConfig()
with self.assertRaisesRegex(LintConfigError, "'foo' is not a valid gitlint option"):
config.set_general_option("foo", "bar")
# try setting _config_path, this is a real attribute of LintConfig, but the code should prevent it from
# being set
with self.assertRaisesRegex(LintConfigError, "'_config_path' is not a valid gitlint option"):
config.set_general_option("_config_path", "bar")
# invalid verbosity`
incorrect_values = [-1, "foo"]
for value in incorrect_values:
expected_msg = r"Option 'verbosity' must be a positive integer \(current value: '{0}'\)".format(value)
with self.assertRaisesRegex(LintConfigError, expected_msg):
config.verbosity = value
incorrect_values = [4]
for value in incorrect_values:
with self.assertRaisesRegex(LintConfigError, "Option 'verbosity' must be set between 0 and 3"):
config.verbosity = value
# invalid ignore_merge_commits
incorrect_values = [-1, 4, "foo"]
for value in incorrect_values:
with self.assertRaisesRegex(LintConfigError,
r"Option 'ignore-merge-commits' must be either 'true' or 'false'"):
config.ignore_merge_commits = value
# invalid ignore -> not here because ignore is a ListOption which converts everything to a string before
# splitting which means it it will accept just about everything
# invalid debug
with self.assertRaisesRegex(LintConfigError, r"Option 'debug' must be either 'true' or 'false'"):
config.debug = "foobar"
# invalid extra-path
with self.assertRaisesRegex(LintConfigError,
r"Option extra-path must be an existing directory \(current value: 'foo/bar'\)"):
config.extra_path = "foo/bar"
# invalid target
with self.assertRaisesRegex(LintConfigError,
r"Option target must be an existing directory \(current value: 'foo/bar'\)"):
config.target = "foo/bar"
def test_rebuild_config(self):
# normal config build
config_builder = LintConfigBuilder()
config_builder.set_option('general', 'verbosity', 3)
lint_config = config_builder.build()
self.assertEqual(lint_config.verbosity, 3)
# check that existing config changes when we rebuild it
existing_lintconfig = LintConfig()
existing_lintconfig.verbosity = 2
lint_config = config_builder.build(existing_lintconfig)
self.assertEqual(lint_config.verbosity, 3)
def test_rebuild_config(self):
# normal config build
config_builder = LintConfigBuilder()
config_builder.set_option('general', 'verbosity', 3)
lint_config = config_builder.build()
self.assertEqual(lint_config.verbosity, 3)
# check that existing config changes when we rebuild it
existing_lintconfig = LintConfig()
existing_lintconfig.verbosity = 2
lint_config = config_builder.build(existing_lintconfig)
self.assertEqual(lint_config.verbosity, 3)
def test_rebuild_config(self):
# normal config build
config_builder = LintConfigBuilder()
config_builder.set_option('general', 'verbosity', 3)
lint_config = config_builder.build()
self.assertEqual(lint_config.verbosity, 3)
# check that existing config gets overwritten when we pass it to a configbuilder with different options
existing_lintconfig = LintConfig()
existing_lintconfig.verbosity = 2
lint_config = config_builder.build(existing_lintconfig)
self.assertEqual(lint_config.verbosity, 3)
self.assertEqual(existing_lintconfig.verbosity, 3)
def test_set_general_option_negative(self):
config = LintConfig()
with self.assertRaisesRegexp(LintConfigError, "'foo' is not a valid gitlint option"):
config.set_general_option("foo", "bar")
# invalid verbosity
incorrect_values = [-1, "foo"]
for value in incorrect_values:
expected_msg = r"Option 'verbosity' must be a positive integer \(current value: '{0}'\)".format(value)
with self.assertRaisesRegexp(LintConfigError, expected_msg):
config.verbosity = value
incorrect_values = [4]
for value in incorrect_values:
with self.assertRaisesRegexp(LintConfigError, "Option 'verbosity' must be set between 0 and 3"):
config.verbosity = value
# invalid ignore_merge_commits
incorrect_values = [-1, 4, "foo"]
for value in incorrect_values:
with self.assertRaisesRegexp(LintConfigError,
r"Option 'ignore-merge-commits' must be either 'true' or 'false'"):
config.ignore_merge_commits = value
def test_set_rule_option_negative(self):
config = LintConfig()
# non-existing rule
expected_error_msg = "No such rule 'foobar'"
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('foobar', 'line-length', 60)
# non-existing option
expected_error_msg = "Rule 'title-max-length' has no option 'foobar'"
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('title-max-length', 'foobar', 60)
# invalid option value
expected_error_msg = "'foo' is not a valid value for option 'title-max-length.line-length'. " + \
"Option 'line-length' must be a positive integer \(current value: 'foo'\)."
with self.assertRaisesRegexp(LintConfigError, expected_error_msg):
config.set_rule_option('title-max-length', 'line-length', "foo")
# invalid verbosity
with self.assertRaisesRegexp(LintConfigError, "verbosity must be set between 0 and 3"):
config.verbosity = -1
with self.assertRaisesRegexp(LintConfigError, "verbosity must be set between 0 and 3"):
config.verbosity = 4
def get_config(ctx, target, config_path, c, extra_path, ignore, verbose,
silent, debug):
""" Creates a LintConfig object based on a set of commandline parameters. """
try:
# Config precedence:
# First, load default config or config from configfile
lint_config = load_config_from_path(ctx, config_path)
# default to default configuration when no config file was loaded
if lint_config:
if debug:
click.echo("Using config from {0}".format(
lint_config.config_path))
else:
lint_config = LintConfig()
# Then process any commandline configuration flags
lint_config.apply_config_options(c)
# Finally, overwrite with any convenience commandline flags
lint_config.apply_on_csv_string(ignore, lint_config.disable_rule)
if silent:
lint_config.verbosity = 0
elif verbose > 0:
lint_config.verbosity = verbose
if extra_path:
lint_config.extra_path = extra_path
if debug:
lint_config.debug = True
# Set target
lint_config.target = target
return lint_config
except LintConfigError as e:
click.echo("Config Error: {0}".format(str(e)))
ctx.exit(CONFIG_ERROR_CODE) # return CONFIG_ERROR_CODE on config error
