Merge pull request #982 from bnorquist/master

asottile · web-flow · commit a009dd6caf2c · 2019-03-30T15:53:28.000-07:00
add helpful CI message
diff --git a/pre_commit/commands/run.py b/pre_commit/commands/run.py
@@ -215,6 +215,14 @@ def _run_hooks(config, hooks, args, environ):
         if retval and config['fail_fast']:
             break
     if retval and args.show_diff_on_failure and git.has_diff():
+        if args.all_files:
+            output.write_line(
+                'pre-commit hook(s) made changes.\n'
+                'If you are seeing this message in CI, '
+                'reproduce locally with: `pre-commit run --all-files`.\n'
+                'To run `pre-commit` as part of git workflow, use '
+                '`pre-commit install`.',
+            )
         output.write_line('All changes made by hooks:')
         subprocess.call(('git', '--no-pager', 'diff', '--no-ext-diff'))
     return retval
diff --git a/tests/commands/run_test.py b/tests/commands/run_test.py
@@ -178,16 +178,41 @@ def test_global_exclude(cap_out, store, tempdir_factory):
         assert printed.endswith(expected)
 
 
-def test_show_diff_on_failure(capfd, cap_out, store, tempdir_factory):
+@pytest.mark.parametrize(
+    ('args', 'expected_out'),
+    [
+        (
+            {
+                'show_diff_on_failure': True,
+            },
+            b'All changes made by hooks:',
+        ),
+        (
+            {
+                'show_diff_on_failure': True,
+                'all_files': True,
+            },
+            b'reproduce locally with: pre-commit run --all-files',
+        ),
+    ],
+)
+def test_show_diff_on_failure(
+        args,
+        expected_out,
+        capfd,
+        cap_out,
+        store,
+        tempdir_factory,
+):
     git_path = make_consuming_repo(
         tempdir_factory, 'modified_file_returns_zero_repo',
     )
     with cwd(git_path):
         stage_a_file('bar.py')
         _test_run(
-            cap_out, store, git_path, {'show_diff_on_failure': True},
+            cap_out, store, git_path, args,
             # we're only testing the output after running
-            (), 1, True,
+            expected_out, 1, True,
         )
     out, _ = capfd.readouterr()
     assert 'diff --git' in out
