Skip to content

--allow-unstaged-config arg #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
asottile merged 2 commits into from
May 10, 2015
Merged

--allow-unstaged-config arg #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fdc2a88
fix for #157
caffodian May 4, 2015
1c28ae1
Fix for #157 (with upstream changes)
caffodian May 10, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions pre_commit/commands/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,18 @@ def _has_unmerged_paths(runner):
return bool(stdout.strip())


def _has_unstaged_config(runner):
retcode, stdout, stderr = runner.cmd_runner.run(
[
'git', 'diff', '--exit-code', runner.config_file_path
],
retcode=None,
encoding=None,
)
# be explicit, other git errors don't mean it has an unstaged config.
return retcode == 1


def run(runner, args, write=sys_stdout_write_wrapper, environ=os.environ):
# Set up our logging handler
logger.addHandler(LoggingHandler(args.color, write=write))
Expand All @@ -141,6 +153,16 @@ def run(runner, args, write=sys_stdout_write_wrapper, environ=os.environ):
if bool(args.source) != bool(args.origin):
logger.error('Specify both --origin and --source.')
return 1
if _has_unstaged_config(runner) and not args.no_stash:
if args.allow_unstaged_config:
logger.warn('You have an unstaged config file and have '
'specified the --allow-unstaged-config option.\n'
'Note that your config will be stashed before the '
'config is parsed unless --no-stash is specified.')
else:
logger.error('You have an unstaged config file and have not '
'specified the --allow-unstaged-config option.\n')
return 1

@asottile asottile May 8, 2015

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make --no-stash silence both of these errors


# Don't stash if specified or files are specified
if args.no_stash or args.all_files or args.files:
Expand Down
5 changes: 5 additions & 0 deletions pre_commit/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ def main(argv=None):
'--source', '-s',
help='The remote branch"s commit_id when using `git push`',
)
run_parser.add_argument(
'--allow-unstaged-config', default=False, action='store_true',
help='Allow an unstaged config to be present. Note that this will'
'be stashed before parsing unless --no-stash is specified'
)
run_mutex_group = run_parser.add_mutually_exclusive_group(required=False)
run_mutex_group.add_argument(
'--all-files', '-a', action='store_true', default=False,
Expand Down
59 changes: 59 additions & 0 deletions tests/commands/run_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ def _get_opts(
no_stash=False,
origin='',
source='',
allow_unstaged_config=False,
):
# These are mutually exclusive
assert not (all_files and files)
Expand All @@ -67,6 +68,7 @@ def _get_opts(
no_stash=no_stash,
origin=origin,
source=source,
allow_unstaged_config=allow_unstaged_config,
)


Expand Down Expand Up @@ -397,3 +399,60 @@ def test_local_hook_fails(
expected_ret=1,
stage=False
)


def test_allow_unstaged_config_option(repo_with_passing_hook,
mock_out_store_directory):

with cwd(repo_with_passing_hook):
with io.open(
'.pre-commit-config.yaml', 'a+',
) as config_file:
# writing a newline should be relatively harmless to get a change
config_file.write('\n')

args = _get_opts(allow_unstaged_config=True)
ret, printed = _do_run(repo_with_passing_hook, args)
common_msg = 'You have an unstaged config file'
warning_msg = 'have specified the --allow-unstaged-config option.'

assert common_msg in printed
assert warning_msg in printed
assert ret == 0


def test_no_allow_unstaged_config_option(repo_with_passing_hook,
mock_out_store_directory):

with cwd(repo_with_passing_hook):
with io.open(
'.pre-commit-config.yaml', 'a+',
) as config_file:
# writing a newline should be relatively harmless to get a change
config_file.write('\n')

args = _get_opts(allow_unstaged_config=False)
ret, printed = _do_run(repo_with_passing_hook, args)
common_msg = 'You have an unstaged config file'
error_msg = 'have not specified the --allow-unstaged-config option.\n'

assert common_msg in printed
assert error_msg in printed
assert ret == 1


def test_no_stash_suppresses_allow_unstaged_config_option(
repo_with_passing_hook, mock_out_store_directory):

with cwd(repo_with_passing_hook):
with io.open(
'.pre-commit-config.yaml', 'a+',
) as config_file:
# writing a newline should be relatively harmless to get a change
config_file.write('\n')

args = _get_opts(allow_unstaged_config=False, no_stash=True)
ret, printed = _do_run(repo_with_passing_hook, args)
common_msg = 'You have an unstaged config file'

assert common_msg not in printed