2006-10-12 20:22:14 +08:00
|
|
|
#!/bin/sh
|
|
|
|
#
|
|
|
|
# Copyright (c) 2006 Johannes E. Schindelin
|
|
|
|
#
|
|
|
|
|
|
|
|
test_description='Test special whitespace in diff engine.
|
|
|
|
|
|
|
|
'
|
|
|
|
. ./test-lib.sh
|
2008-08-08 17:26:28 +08:00
|
|
|
. "$TEST_DIRECTORY"/diff-lib.sh
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
test_expect_success "Ray Lehtiniemi's example" '
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
do {
|
|
|
|
nothing;
|
|
|
|
} while (0);
|
|
|
|
EOF
|
|
|
|
git update-index --add x &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
cat <<-\EOF >x &&
|
|
|
|
do
|
|
|
|
{
|
|
|
|
nothing;
|
|
|
|
}
|
|
|
|
while (0);
|
|
|
|
EOF
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
cat <<-\EOF >expect &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
index adf3937..6edc172 100644
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,3 +1,5 @@
|
|
|
|
-do {
|
|
|
|
+do
|
|
|
|
+{
|
|
|
|
nothing;
|
|
|
|
-} while (0);
|
|
|
|
+}
|
|
|
|
+while (0);
|
|
|
|
EOF
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git diff >out &&
|
|
|
|
test_cmp expect out &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git diff -w >out &&
|
|
|
|
test_cmp expect out &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git diff -b >out &&
|
|
|
|
test_cmp expect out
|
|
|
|
'
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
test_expect_success 'another test, without options' '
|
|
|
|
tr Q "\015" <<-\EOF >x &&
|
|
|
|
whitespace at beginning
|
|
|
|
whitespace change
|
|
|
|
whitespace in the middle
|
|
|
|
whitespace at end
|
|
|
|
unchanged line
|
|
|
|
CR at endQ
|
|
|
|
EOF
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git update-index x &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
tr "_" " " <<-\EOF >x &&
|
|
|
|
_ whitespace at beginning
|
|
|
|
whitespace change
|
|
|
|
white space in the middle
|
|
|
|
whitespace at end__
|
|
|
|
unchanged line
|
|
|
|
CR at end
|
|
|
|
EOF
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
tr "Q_" "\015 " <<-\EOF >expect &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
index d99af23..22d9f73 100644
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,6 @@
|
|
|
|
-whitespace at beginning
|
|
|
|
-whitespace change
|
|
|
|
-whitespace in the middle
|
|
|
|
-whitespace at end
|
|
|
|
+ whitespace at beginning
|
|
|
|
+whitespace change
|
|
|
|
+white space in the middle
|
|
|
|
+whitespace at end__
|
|
|
|
unchanged line
|
|
|
|
-CR at endQ
|
|
|
|
+CR at end
|
|
|
|
EOF
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git diff >out &&
|
|
|
|
test_cmp expect out &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
git diff -w >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out &&
|
2015-05-27 02:19:52 +08:00
|
|
|
|
|
|
|
git diff -w -b >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out &&
|
2015-05-27 02:19:52 +08:00
|
|
|
|
|
|
|
git diff -w --ignore-space-at-eol >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out &&
|
2015-05-27 02:19:52 +08:00
|
|
|
|
|
|
|
git diff -w -b --ignore-space-at-eol >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out &&
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2017-10-26 14:32:27 +08:00
|
|
|
git diff -w --ignore-cr-at-eol >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out &&
|
2015-05-27 02:19:52 +08:00
|
|
|
|
|
|
|
tr "Q_" "\015 " <<-\EOF >expect &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
index d99af23..22d9f73 100644
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,6 @@
|
|
|
|
-whitespace at beginning
|
|
|
|
+_ whitespace at beginning
|
|
|
|
whitespace change
|
|
|
|
-whitespace in the middle
|
|
|
|
+white space in the middle
|
|
|
|
whitespace at end__
|
|
|
|
unchanged line
|
|
|
|
CR at end
|
|
|
|
EOF
|
|
|
|
git diff -b >out &&
|
|
|
|
test_cmp expect out &&
|
|
|
|
|
|
|
|
git diff -b --ignore-space-at-eol >out &&
|
|
|
|
test_cmp expect out &&
|
|
|
|
|
2017-10-26 14:32:27 +08:00
|
|
|
git diff -b --ignore-cr-at-eol >out &&
|
|
|
|
test_cmp expect out &&
|
|
|
|
|
2015-05-27 02:19:52 +08:00
|
|
|
tr "Q_" "\015 " <<-\EOF >expect &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
index d99af23..22d9f73 100644
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,6 @@
|
|
|
|
-whitespace at beginning
|
|
|
|
-whitespace change
|
|
|
|
-whitespace in the middle
|
|
|
|
+_ whitespace at beginning
|
|
|
|
+whitespace change
|
|
|
|
+white space in the middle
|
|
|
|
whitespace at end__
|
|
|
|
unchanged line
|
|
|
|
CR at end
|
|
|
|
EOF
|
|
|
|
git diff --ignore-space-at-eol >out &&
|
2017-10-26 14:32:27 +08:00
|
|
|
test_cmp expect out &&
|
|
|
|
|
|
|
|
git diff --ignore-space-at-eol --ignore-cr-at-eol >out &&
|
|
|
|
test_cmp expect out &&
|
|
|
|
|
|
|
|
tr "Q_" "\015 " <<-\EOF >expect &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
index_d99af23..22d9f73 100644
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,6 @@
|
|
|
|
-whitespace at beginning
|
|
|
|
-whitespace change
|
|
|
|
-whitespace in the middle
|
|
|
|
-whitespace at end
|
|
|
|
+_ whitespace at beginning
|
|
|
|
+whitespace_ _change
|
|
|
|
+white space in the middle
|
|
|
|
+whitespace at end__
|
|
|
|
unchanged line
|
|
|
|
CR at end
|
|
|
|
EOF
|
|
|
|
git diff --ignore-cr-at-eol >out &&
|
2015-05-27 02:19:52 +08:00
|
|
|
test_cmp expect out
|
|
|
|
'
|
2006-10-12 20:22:14 +08:00
|
|
|
|
2013-06-20 02:46:07 +08:00
|
|
|
test_expect_success 'ignore-blank-lines: only new lines' '
|
|
|
|
test_seq 5 >x &&
|
|
|
|
git update-index x &&
|
2013-10-28 05:26:48 +08:00
|
|
|
test_seq 5 | sed "/3/i\\
|
2013-06-20 02:46:07 +08:00
|
|
|
" >x &&
|
|
|
|
git diff --ignore-blank-lines >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out
|
2013-06-20 02:46:07 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: only new lines with space' '
|
|
|
|
test_seq 5 >x &&
|
|
|
|
git update-index x &&
|
2013-10-28 05:26:48 +08:00
|
|
|
test_seq 5 | sed "/3/i\\
|
|
|
|
" >x &&
|
2013-06-20 02:46:07 +08:00
|
|
|
git diff -w --ignore-blank-lines >out &&
|
2018-07-28 01:48:11 +08:00
|
|
|
test_must_be_empty out
|
2013-06-20 02:46:07 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: after change' '
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
1
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
7
|
|
|
|
EOF
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
6
|
|
|
|
|
|
|
|
7
|
|
|
|
EOF
|
|
|
|
git diff --inter-hunk-context=100 --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,7 @@
|
|
|
|
+change
|
|
|
|
+
|
|
|
|
1
|
|
|
|
2
|
|
|
|
-
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: before change' '
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
1
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
6
|
|
|
|
7
|
|
|
|
EOF
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
7
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --inter-hunk-context=100 --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -4,5 +4,7 @@
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
+
|
|
|
|
6
|
|
|
|
7
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: between changes' '
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
|
|
|
|
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
9
|
|
|
|
10
|
|
|
|
EOF
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
|
|
|
|
9
|
|
|
|
10
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,5 +1,7 @@
|
|
|
|
+change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
+
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
@@ -8,5 +8,7 @@
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
+
|
|
|
|
9
|
|
|
|
10
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: between changes (with interhunkctx)' '
|
|
|
|
test_seq 10 >x &&
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
9
|
|
|
|
|
|
|
|
10
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --inter-hunk-context=2 --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,10 +1,15 @@
|
|
|
|
+change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
+
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
+
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
9
|
|
|
|
+
|
|
|
|
10
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: scattered spaces' '
|
|
|
|
test_seq 10 >x &&
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
|
|
|
|
4
|
|
|
|
|
|
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
|
|
|
|
|
|
|
|
7
|
|
|
|
|
|
|
|
8
|
|
|
|
9
|
|
|
|
10
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --inter-hunk-context=4 --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,3 +1,4 @@
|
|
|
|
+change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
@@ -8,3 +15,4 @@
|
|
|
|
8
|
|
|
|
9
|
|
|
|
10
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: spaces coalesce' '
|
|
|
|
test_seq 6 >x &&
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
|
|
|
|
4
|
|
|
|
|
|
|
|
5
|
|
|
|
|
|
|
|
6
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --inter-hunk-context=4 --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,6 +1,11 @@
|
|
|
|
+change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
3
|
|
|
|
+
|
|
|
|
4
|
|
|
|
+
|
|
|
|
5
|
|
|
|
+
|
|
|
|
6
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ignore-blank-lines: mix changes and blank lines' '
|
|
|
|
test_seq 16 >x &&
|
|
|
|
git update-index x &&
|
|
|
|
cat <<-\EOF >x &&
|
|
|
|
change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
change
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
|
|
|
|
9
|
|
|
|
10
|
|
|
|
11
|
|
|
|
change
|
|
|
|
12
|
|
|
|
13
|
|
|
|
14
|
|
|
|
|
|
|
|
15
|
|
|
|
16
|
|
|
|
change
|
|
|
|
EOF
|
|
|
|
git diff --ignore-blank-lines >out.tmp &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
diff --git a/x b/x
|
|
|
|
--- a/x
|
|
|
|
+++ b/x
|
|
|
|
@@ -1,8 +1,11 @@
|
|
|
|
+change
|
|
|
|
1
|
|
|
|
2
|
|
|
|
+
|
|
|
|
3
|
|
|
|
4
|
|
|
|
5
|
|
|
|
+change
|
|
|
|
6
|
|
|
|
7
|
|
|
|
8
|
|
|
|
@@ -9,8 +13,11 @@
|
|
|
|
9
|
|
|
|
10
|
|
|
|
11
|
|
|
|
+change
|
|
|
|
12
|
|
|
|
13
|
|
|
|
14
|
|
|
|
+
|
|
|
|
15
|
|
|
|
16
|
|
|
|
+change
|
|
|
|
EOF
|
|
|
|
compare_diff_patch expected out.tmp
|
|
|
|
'
|
|
|
|
|
2007-12-13 00:22:59 +08:00
|
|
|
test_expect_success 'check mixed spaces and tabs in indent' '
|
|
|
|
# This is indented with SP HT SP.
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-14 19:23:43 +08:00
|
|
|
git diff --check | grep "space before tab in indent"
|
2007-12-13 00:22:59 +08:00
|
|
|
'
|
|
|
|
|
2007-12-17 00:31:40 +08:00
|
|
|
test_expect_success 'check mixed tabs and spaces in indent' '
|
|
|
|
# This is indented with HT SP HT.
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-17 00:31:40 +08:00
|
|
|
git diff --check | grep "space before tab in indent"
|
|
|
|
'
|
|
|
|
|
2007-12-14 04:24:52 +08:00
|
|
|
test_expect_success 'check with no whitespace errors' '
|
|
|
|
git commit -m "snapshot" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with trailing whitespace' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo(); " >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with space before tab in indent' '
|
2007-12-14 04:24:52 +08:00
|
|
|
# indent has space followed by hard tab
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-14 15:40:27 +08:00
|
|
|
test_expect_success '--check and --exit-code are not exclusive' '
|
2007-12-14 04:24:52 +08:00
|
|
|
git checkout x &&
|
|
|
|
git diff --check --exit-code
|
|
|
|
'
|
|
|
|
|
2007-12-14 15:40:27 +08:00
|
|
|
test_expect_success '--check and --quiet are not exclusive' '
|
2007-12-14 04:24:52 +08:00
|
|
|
git diff --check --quiet
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check staged with no whitespace errors' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
|
|
|
git diff --cached --check
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check staged with trailing whitespace' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo(); " >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --cached --check
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check staged with space before tab in indent' '
|
2007-12-14 04:24:52 +08:00
|
|
|
# indent has space followed by hard tab
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --cached --check
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check with no whitespace errors (diff-index)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
|
|
|
git diff-index --check HEAD
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with trailing whitespace (diff-index)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo(); " >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-index --check HEAD
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with space before tab in indent (diff-index)' '
|
2007-12-14 04:24:52 +08:00
|
|
|
# indent has space followed by hard tab
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-index --check HEAD
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check staged with no whitespace errors (diff-index)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
|
|
|
git diff-index --cached --check HEAD
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check staged with trailing whitespace (diff-index)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo(); " >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-index --cached --check HEAD
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check staged with space before tab in indent (diff-index)' '
|
2007-12-14 04:24:52 +08:00
|
|
|
# indent has space followed by hard tab
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git add x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-index --cached --check HEAD
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check with no whitespace errors (diff-tree)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git commit -m "new commit" x &&
|
|
|
|
git diff-tree --check HEAD^ HEAD
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with trailing whitespace (diff-tree)' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo(); " >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git commit -m "another commit" x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-tree --check HEAD^ HEAD
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check with space before tab in indent (diff-tree)' '
|
2007-12-14 04:24:52 +08:00
|
|
|
# indent has space followed by hard tab
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo();" >x &&
|
2007-12-14 04:24:52 +08:00
|
|
|
git commit -m "yet another" x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff-tree --check HEAD^ HEAD
|
2007-12-13 21:32:31 +08:00
|
|
|
'
|
|
|
|
|
2017-12-07 06:02:56 +08:00
|
|
|
test_expect_success 'check with ignored trailing whitespace attr (diff-tree)' '
|
|
|
|
test_when_finished "git reset --hard HEAD^" &&
|
|
|
|
|
|
|
|
# create a whitespace error that should be ignored
|
|
|
|
echo "* -whitespace" >.gitattributes &&
|
|
|
|
git add .gitattributes &&
|
|
|
|
echo "foo(); " >x &&
|
|
|
|
git add x &&
|
|
|
|
git commit -m "add trailing space" &&
|
|
|
|
|
|
|
|
# with a worktree diff-tree ignores the whitespace error
|
|
|
|
git diff-tree --root --check HEAD &&
|
|
|
|
|
|
|
|
# without a worktree diff-tree still ignores the whitespace error
|
|
|
|
git -C .git diff-tree --root --check HEAD
|
|
|
|
'
|
|
|
|
|
2007-12-13 21:32:31 +08:00
|
|
|
test_expect_success 'check trailing whitespace (trailing-space: off)' '
|
|
|
|
git config core.whitespace "-trailing-space" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo (); " >x &&
|
2007-12-13 21:32:31 +08:00
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check trailing whitespace (trailing-space: on)' '
|
|
|
|
git config core.whitespace "trailing-space" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo (); " >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-13 21:32:31 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check space before tab in indent (space-before-tab: off)' '
|
|
|
|
# indent contains space followed by HT
|
|
|
|
git config core.whitespace "-space-before-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2007-12-13 21:32:31 +08:00
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check space before tab in indent (space-before-tab: on)' '
|
|
|
|
# indent contains space followed by HT
|
|
|
|
git config core.whitespace "space-before-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo (); " >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-13 21:32:31 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check spaces as indentation (indent-with-non-tab: off)' '
|
2010-10-31 09:46:54 +08:00
|
|
|
git config core.whitespace "-indent-with-non-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2007-12-13 21:32:31 +08:00
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check spaces as indentation (indent-with-non-tab: on)' '
|
|
|
|
git config core.whitespace "indent-with-non-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-14 04:24:52 +08:00
|
|
|
'
|
|
|
|
|
2010-11-30 16:29:11 +08:00
|
|
|
test_expect_success 'ditto, but tabwidth=9' '
|
|
|
|
git config core.whitespace "indent-with-non-tab,tabwidth=9" &&
|
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
2007-12-17 00:31:40 +08:00
|
|
|
test_expect_success 'check tabs and spaces as indentation (indent-with-non-tab: on)' '
|
|
|
|
git config core.whitespace "indent-with-non-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2008-07-12 23:47:52 +08:00
|
|
|
test_must_fail git diff --check
|
2007-12-17 00:31:40 +08:00
|
|
|
'
|
2008-02-16 12:30:05 +08:00
|
|
|
|
2010-11-30 16:29:11 +08:00
|
|
|
test_expect_success 'ditto, but tabwidth=10' '
|
|
|
|
git config core.whitespace "indent-with-non-tab,tabwidth=10" &&
|
|
|
|
test_must_fail git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'ditto, but tabwidth=20' '
|
|
|
|
git config core.whitespace "indent-with-non-tab,tabwidth=20" &&
|
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
2010-04-03 07:37:15 +08:00
|
|
|
test_expect_success 'check tabs as indentation (tab-in-indent: off)' '
|
|
|
|
git config core.whitespace "-tab-in-indent" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2010-04-03 07:37:15 +08:00
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check tabs as indentation (tab-in-indent: on)' '
|
|
|
|
git config core.whitespace "tab-in-indent" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2010-04-03 07:37:15 +08:00
|
|
|
test_must_fail git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check tabs and spaces as indentation (tab-in-indent: on)' '
|
|
|
|
git config core.whitespace "tab-in-indent" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo " foo ();" >x &&
|
2010-04-03 07:37:15 +08:00
|
|
|
test_must_fail git diff --check
|
|
|
|
'
|
|
|
|
|
2010-11-30 16:29:11 +08:00
|
|
|
test_expect_success 'ditto, but tabwidth=1 (must be irrelevant)' '
|
|
|
|
git config core.whitespace "tab-in-indent,tabwidth=1" &&
|
|
|
|
test_must_fail git diff --check
|
|
|
|
'
|
|
|
|
|
2010-04-03 07:37:15 +08:00
|
|
|
test_expect_success 'check tab-in-indent and indent-with-non-tab conflict' '
|
|
|
|
git config core.whitespace "tab-in-indent,indent-with-non-tab" &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "foo ();" >x &&
|
2010-04-03 07:37:15 +08:00
|
|
|
test_must_fail git diff --check
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'check tab-in-indent excluded from wildcard whitespace attribute' '
|
|
|
|
git config --unset core.whitespace &&
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "x whitespace" >.gitattributes &&
|
|
|
|
echo " foo ();" >x &&
|
2010-04-03 07:37:15 +08:00
|
|
|
git diff --check &&
|
|
|
|
rm -f .gitattributes
|
|
|
|
'
|
|
|
|
|
2008-02-16 12:30:05 +08:00
|
|
|
test_expect_success 'line numbers in --check output are correct' '
|
2015-05-27 02:19:52 +08:00
|
|
|
echo "" >x &&
|
|
|
|
echo "foo(); " >>x &&
|
2008-02-16 12:30:05 +08:00
|
|
|
git diff --check | grep "x:2:"
|
|
|
|
'
|
|
|
|
|
2009-09-04 13:30:27 +08:00
|
|
|
test_expect_success 'checkdiff detects new trailing blank lines (1)' '
|
2008-06-27 06:36:59 +08:00
|
|
|
echo "foo();" >x &&
|
|
|
|
echo "" >>x &&
|
2009-09-04 13:30:27 +08:00
|
|
|
git diff --check | grep "new blank line"
|
2008-06-27 06:36:59 +08:00
|
|
|
'
|
|
|
|
|
2009-09-04 14:39:43 +08:00
|
|
|
test_expect_success 'checkdiff detects new trailing blank lines (2)' '
|
|
|
|
{ echo a; echo b; echo; echo; } >x &&
|
|
|
|
git add x &&
|
|
|
|
{ echo a; echo; echo; echo; echo; } >x &&
|
|
|
|
git diff --check | grep "new blank line"
|
2008-06-27 06:36:59 +08:00
|
|
|
'
|
|
|
|
|
2008-08-21 02:47:55 +08:00
|
|
|
test_expect_success 'checkdiff allows new blank lines' '
|
|
|
|
git checkout x &&
|
|
|
|
mv x y &&
|
|
|
|
(
|
|
|
|
echo "/* This is new */" &&
|
|
|
|
echo "" &&
|
|
|
|
cat y
|
|
|
|
) >x &&
|
|
|
|
git diff --check
|
|
|
|
'
|
|
|
|
|
2009-11-20 05:12:24 +08:00
|
|
|
cat <<EOF >expect
|
|
|
|
EOF
|
|
|
|
test_expect_success 'whitespace-only changes not reported' '
|
|
|
|
git reset --hard &&
|
|
|
|
echo >x "hello world" &&
|
|
|
|
git add x &&
|
|
|
|
git commit -m "hello 1" &&
|
|
|
|
echo >x "hello world" &&
|
|
|
|
git diff -b >actual &&
|
|
|
|
test_cmp expect actual
|
|
|
|
'
|
|
|
|
|
2010-05-26 10:50:12 +08:00
|
|
|
cat <<EOF >expect
|
|
|
|
diff --git a/x b/z
|
|
|
|
similarity index NUM%
|
|
|
|
rename from x
|
|
|
|
rename to z
|
|
|
|
index 380c32a..a97b785 100644
|
|
|
|
EOF
|
|
|
|
test_expect_success 'whitespace-only changes reported across renames' '
|
|
|
|
git reset --hard &&
|
|
|
|
for i in 1 2 3 4 5 6 7 8 9; do echo "$i$i$i$i$i$i"; done >x &&
|
|
|
|
git add x &&
|
|
|
|
git commit -m "base" &&
|
|
|
|
sed -e "5s/^/ /" x >z &&
|
|
|
|
git rm x &&
|
|
|
|
git add z &&
|
|
|
|
git diff -w -M --cached |
|
|
|
|
sed -e "/^similarity index /s/[0-9][0-9]*/NUM/" >actual &&
|
|
|
|
test_cmp expect actual
|
|
|
|
'
|
|
|
|
|
|
|
|
cat >expected <<\EOF
|
|
|
|
diff --git a/empty b/void
|
|
|
|
similarity index 100%
|
|
|
|
rename from empty
|
|
|
|
rename to void
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_expect_success 'rename empty' '
|
|
|
|
git reset --hard &&
|
|
|
|
>empty &&
|
|
|
|
git add empty &&
|
|
|
|
git commit -m empty &&
|
|
|
|
git mv empty void &&
|
|
|
|
git diff -w --cached -M >current &&
|
|
|
|
test_cmp expected current
|
|
|
|
'
|
|
|
|
|
2008-08-24 03:21:21 +08:00
|
|
|
test_expect_success 'combined diff with autocrlf conversion' '
|
|
|
|
|
|
|
|
git reset --hard &&
|
|
|
|
echo >x hello &&
|
|
|
|
git commit -m "one side" x &&
|
|
|
|
git checkout HEAD^ &&
|
|
|
|
echo >x goodbye &&
|
|
|
|
git commit -m "the other side" x &&
|
|
|
|
git config core.autocrlf true &&
|
|
|
|
test_must_fail git merge master &&
|
|
|
|
|
|
|
|
git diff | sed -e "1,/^@@@/d" >actual &&
|
|
|
|
! grep "^-" actual
|
|
|
|
|
|
|
|
'
|
|
|
|
|
2010-10-21 06:17:26 +08:00
|
|
|
# Start testing the colored format for whitespace checks
|
|
|
|
|
|
|
|
test_expect_success 'setup diff colors' '
|
|
|
|
git config color.diff.plain normal &&
|
|
|
|
git config color.diff.meta bold &&
|
|
|
|
git config color.diff.frag cyan &&
|
|
|
|
git config color.diff.func normal &&
|
|
|
|
git config color.diff.old red &&
|
|
|
|
git config color.diff.new green &&
|
|
|
|
git config color.diff.commit yellow &&
|
2015-05-27 02:43:08 +08:00
|
|
|
git config color.diff.whitespace blue &&
|
2010-10-21 06:17:26 +08:00
|
|
|
|
2015-05-27 02:43:08 +08:00
|
|
|
git config core.autocrlf false
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'diff that introduces a line with only tabs' '
|
|
|
|
git config core.whitespace blank-at-eol &&
|
|
|
|
git reset --hard &&
|
|
|
|
echo "test" >x &&
|
|
|
|
git commit -m "initial" x &&
|
|
|
|
echo "{NTN}" | tr "NT" "\n\t" >>x &&
|
2017-10-03 21:40:19 +08:00
|
|
|
git diff --color | test_decode_color >current &&
|
2015-05-27 02:19:52 +08:00
|
|
|
|
2015-05-27 02:43:08 +08:00
|
|
|
cat >expected <<-\EOF &&
|
2015-05-27 02:19:52 +08:00
|
|
|
<BOLD>diff --git a/x b/x<RESET>
|
|
|
|
<BOLD>index 9daeafb..2874b91 100644<RESET>
|
|
|
|
<BOLD>--- a/x<RESET>
|
|
|
|
<BOLD>+++ b/x<RESET>
|
|
|
|
<CYAN>@@ -1 +1,4 @@<RESET>
|
|
|
|
test<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>{<RESET>
|
2015-05-27 02:43:08 +08:00
|
|
|
<GREEN>+<RESET><BLUE> <RESET>
|
2015-05-27 02:19:52 +08:00
|
|
|
<GREEN>+<RESET><GREEN>}<RESET>
|
|
|
|
EOF
|
2010-10-21 06:17:26 +08:00
|
|
|
|
|
|
|
test_cmp expected current
|
|
|
|
'
|
|
|
|
|
2015-05-27 01:11:28 +08:00
|
|
|
test_expect_success 'diff that introduces and removes ws breakages' '
|
|
|
|
git reset --hard &&
|
|
|
|
{
|
|
|
|
echo "0. blank-at-eol " &&
|
|
|
|
echo "1. blank-at-eol "
|
|
|
|
} >x &&
|
|
|
|
git commit -a --allow-empty -m preimage &&
|
|
|
|
{
|
|
|
|
echo "0. blank-at-eol " &&
|
|
|
|
echo "1. still-blank-at-eol " &&
|
|
|
|
echo "2. and a new line "
|
|
|
|
} >x &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git diff --color |
|
2015-05-27 01:11:28 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
|
|
|
|
cat >expected <<-\EOF &&
|
|
|
|
<BOLD>diff --git a/x b/x<RESET>
|
|
|
|
<BOLD>index d0233a2..700886e 100644<RESET>
|
|
|
|
<BOLD>--- a/x<RESET>
|
|
|
|
<BOLD>+++ b/x<RESET>
|
|
|
|
<CYAN>@@ -1,2 +1,3 @@<RESET>
|
|
|
|
0. blank-at-eol <RESET>
|
|
|
|
<RED>-1. blank-at-eol <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>1. still-blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>2. and a new line<RESET><BLUE> <RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected current
|
|
|
|
'
|
|
|
|
|
2016-10-05 06:21:38 +08:00
|
|
|
test_expect_success 'ws-error-highlight test setup' '
|
|
|
|
|
2015-05-27 01:11:28 +08:00
|
|
|
git reset --hard &&
|
|
|
|
{
|
|
|
|
echo "0. blank-at-eol " &&
|
|
|
|
echo "1. blank-at-eol "
|
|
|
|
} >x &&
|
|
|
|
git commit -a --allow-empty -m preimage &&
|
|
|
|
{
|
|
|
|
echo "0. blank-at-eol " &&
|
|
|
|
echo "1. still-blank-at-eol " &&
|
|
|
|
echo "2. and a new line "
|
|
|
|
} >x &&
|
|
|
|
|
2016-10-05 06:21:38 +08:00
|
|
|
cat >expect.default-old <<-\EOF &&
|
2015-05-27 01:11:28 +08:00
|
|
|
<BOLD>diff --git a/x b/x<RESET>
|
|
|
|
<BOLD>index d0233a2..700886e 100644<RESET>
|
|
|
|
<BOLD>--- a/x<RESET>
|
|
|
|
<BOLD>+++ b/x<RESET>
|
|
|
|
<CYAN>@@ -1,2 +1,3 @@<RESET>
|
|
|
|
0. blank-at-eol <RESET>
|
|
|
|
<RED>-<RESET><RED>1. blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>1. still-blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>2. and a new line<RESET><BLUE> <RESET>
|
|
|
|
EOF
|
|
|
|
|
2016-10-05 06:21:38 +08:00
|
|
|
cat >expect.all <<-\EOF &&
|
2015-05-27 01:11:28 +08:00
|
|
|
<BOLD>diff --git a/x b/x<RESET>
|
|
|
|
<BOLD>index d0233a2..700886e 100644<RESET>
|
|
|
|
<BOLD>--- a/x<RESET>
|
|
|
|
<BOLD>+++ b/x<RESET>
|
|
|
|
<CYAN>@@ -1,2 +1,3 @@<RESET>
|
|
|
|
<RESET>0. blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<RED>-<RESET><RED>1. blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>1. still-blank-at-eol<RESET><BLUE> <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>2. and a new line<RESET><BLUE> <RESET>
|
|
|
|
EOF
|
|
|
|
|
2016-10-05 06:21:38 +08:00
|
|
|
cat >expect.none <<-\EOF
|
2015-05-27 01:11:28 +08:00
|
|
|
<BOLD>diff --git a/x b/x<RESET>
|
|
|
|
<BOLD>index d0233a2..700886e 100644<RESET>
|
|
|
|
<BOLD>--- a/x<RESET>
|
|
|
|
<BOLD>+++ b/x<RESET>
|
|
|
|
<CYAN>@@ -1,2 +1,3 @@<RESET>
|
|
|
|
0. blank-at-eol <RESET>
|
|
|
|
<RED>-1. blank-at-eol <RESET>
|
|
|
|
<GREEN>+1. still-blank-at-eol <RESET>
|
|
|
|
<GREEN>+2. and a new line <RESET>
|
|
|
|
EOF
|
|
|
|
|
2016-10-05 06:21:38 +08:00
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'test --ws-error-highlight option' '
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git diff --color --ws-error-highlight=default,old |
|
2016-10-05 06:21:38 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.default-old current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git diff --color --ws-error-highlight=all |
|
2016-10-05 06:21:38 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.all current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git diff --color --ws-error-highlight=none |
|
2016-10-05 06:21:38 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.none current
|
|
|
|
|
2015-05-27 01:11:28 +08:00
|
|
|
'
|
|
|
|
|
2016-10-05 06:26:27 +08:00
|
|
|
test_expect_success 'test diff.wsErrorHighlight config' '
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=default,old diff --color |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.default-old current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=all diff --color |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.all current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=none diff --color |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.none current
|
|
|
|
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'option overrides diff.wsErrorHighlight' '
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=none \
|
|
|
|
diff --color --ws-error-highlight=default,old |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.default-old current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=default \
|
|
|
|
diff --color --ws-error-highlight=all |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.all current &&
|
|
|
|
|
2017-10-03 21:40:19 +08:00
|
|
|
git -c diff.wsErrorHighlight=all \
|
|
|
|
diff --color --ws-error-highlight=none |
|
2016-10-05 06:26:27 +08:00
|
|
|
test_decode_color >current &&
|
|
|
|
test_cmp expect.none current
|
|
|
|
|
|
|
|
'
|
|
|
|
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
test_expect_success 'detect moved code, complete file' '
|
|
|
|
git reset --hard &&
|
|
|
|
cat <<-\EOF >test.c &&
|
|
|
|
#include<stdio.h>
|
|
|
|
main()
|
|
|
|
{
|
|
|
|
printf("Hello World");
|
|
|
|
}
|
|
|
|
EOF
|
|
|
|
git add test.c &&
|
|
|
|
git commit -m "add main function" &&
|
|
|
|
git mv test.c main.c &&
|
|
|
|
test_config color.diff.oldMoved "normal red" &&
|
|
|
|
test_config color.diff.newMoved "normal green" &&
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --color-moved=zebra --color --no-renames | test_decode_color >actual &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
cat >expected <<-\EOF &&
|
|
|
|
<BOLD>diff --git a/main.c b/main.c<RESET>
|
|
|
|
<BOLD>new file mode 100644<RESET>
|
|
|
|
<BOLD>index 0000000..a986c57<RESET>
|
|
|
|
<BOLD>--- /dev/null<RESET>
|
|
|
|
<BOLD>+++ b/main.c<RESET>
|
|
|
|
<CYAN>@@ -0,0 +1,5 @@<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>#include<stdio.h><RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>main()<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>{<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>printf("Hello World");<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>}<RESET>
|
|
|
|
<BOLD>diff --git a/test.c b/test.c<RESET>
|
|
|
|
<BOLD>deleted file mode 100644<RESET>
|
|
|
|
<BOLD>index a986c57..0000000<RESET>
|
|
|
|
<BOLD>--- a/test.c<RESET>
|
|
|
|
<BOLD>+++ /dev/null<RESET>
|
|
|
|
<CYAN>@@ -1,5 +0,0 @@<RESET>
|
|
|
|
<BRED>-#include<stdio.h><RESET>
|
|
|
|
<BRED>-main()<RESET>
|
|
|
|
<BRED>-{<RESET>
|
|
|
|
<BRED>-printf("Hello World");<RESET>
|
|
|
|
<BRED>-}<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'detect malicious moved code, inside file' '
|
|
|
|
test_config color.diff.oldMoved "normal red" &&
|
|
|
|
test_config color.diff.newMoved "normal green" &&
|
|
|
|
test_config color.diff.oldMovedAlternative "blue" &&
|
|
|
|
test_config color.diff.newMovedAlternative "yellow" &&
|
|
|
|
git reset --hard &&
|
|
|
|
cat <<-\EOF >main.c &&
|
|
|
|
#include<stdio.h>
|
|
|
|
int stuff()
|
|
|
|
{
|
|
|
|
printf("Hello ");
|
|
|
|
printf("World\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
int secure_foo(struct user *u)
|
|
|
|
{
|
|
|
|
if (!u->is_allowed_foo)
|
|
|
|
return;
|
|
|
|
foo(u);
|
|
|
|
}
|
|
|
|
|
|
|
|
int main()
|
|
|
|
{
|
|
|
|
foo();
|
|
|
|
}
|
|
|
|
EOF
|
|
|
|
cat <<-\EOF >test.c &&
|
|
|
|
#include<stdio.h>
|
|
|
|
int bar()
|
|
|
|
{
|
|
|
|
printf("Hello World, but different\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
int another_function()
|
|
|
|
{
|
|
|
|
bar();
|
|
|
|
}
|
|
|
|
EOF
|
|
|
|
git add main.c test.c &&
|
|
|
|
git commit -m "add main and test file" &&
|
|
|
|
cat <<-\EOF >main.c &&
|
|
|
|
#include<stdio.h>
|
|
|
|
int stuff()
|
|
|
|
{
|
|
|
|
printf("Hello ");
|
|
|
|
printf("World\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
int main()
|
|
|
|
{
|
|
|
|
foo();
|
|
|
|
}
|
|
|
|
EOF
|
|
|
|
cat <<-\EOF >test.c &&
|
|
|
|
#include<stdio.h>
|
|
|
|
int bar()
|
|
|
|
{
|
|
|
|
printf("Hello World, but different\n");
|
|
|
|
}
|
|
|
|
|
|
|
|
int secure_foo(struct user *u)
|
|
|
|
{
|
|
|
|
foo(u);
|
|
|
|
if (!u->is_allowed_foo)
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
int another_function()
|
|
|
|
{
|
|
|
|
bar();
|
|
|
|
}
|
|
|
|
EOF
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames --color-moved=zebra --color | test_decode_color >actual &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/main.c b/main.c<RESET>
|
|
|
|
<BOLD>index 27a619c..7cf9336 100644<RESET>
|
|
|
|
<BOLD>--- a/main.c<RESET>
|
|
|
|
<BOLD>+++ b/main.c<RESET>
|
|
|
|
<CYAN>@@ -5,13 +5,6 @@<RESET> <RESET>printf("Hello ");<RESET>
|
|
|
|
printf("World\n");<RESET>
|
|
|
|
}<RESET>
|
|
|
|
<RESET>
|
|
|
|
<BRED>-int secure_foo(struct user *u)<RESET>
|
|
|
|
<BRED>-{<RESET>
|
|
|
|
<BLUE>-if (!u->is_allowed_foo)<RESET>
|
|
|
|
<BLUE>-return;<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<RED>-foo(u);<RESET>
|
|
|
|
<RED>-}<RESET>
|
|
|
|
<RED>-<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
int main()<RESET>
|
|
|
|
{<RESET>
|
|
|
|
foo();<RESET>
|
|
|
|
<BOLD>diff --git a/test.c b/test.c<RESET>
|
|
|
|
<BOLD>index 1dc1d85..2bedec9 100644<RESET>
|
|
|
|
<BOLD>--- a/test.c<RESET>
|
|
|
|
<BOLD>+++ b/test.c<RESET>
|
|
|
|
<CYAN>@@ -4,6 +4,13 @@<RESET> <RESET>int bar()<RESET>
|
|
|
|
printf("Hello World, but different\n");<RESET>
|
|
|
|
}<RESET>
|
|
|
|
<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>int secure_foo(struct user *u)<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>{<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<GREEN>+<RESET><GREEN>foo(u);<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
<BGREEN>+<RESET><BGREEN>if (!u->is_allowed_foo)<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>return;<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<GREEN>+<RESET><GREEN>}<RESET>
|
|
|
|
<GREEN>+<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
int another_function()<RESET>
|
|
|
|
{<RESET>
|
|
|
|
bar();<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
2017-07-01 04:53:08 +08:00
|
|
|
test_expect_success 'plain moved code, inside file' '
|
|
|
|
test_config color.diff.oldMoved "normal red" &&
|
|
|
|
test_config color.diff.newMoved "normal green" &&
|
|
|
|
test_config color.diff.oldMovedAlternative "blue" &&
|
|
|
|
test_config color.diff.newMovedAlternative "yellow" &&
|
|
|
|
# needs previous test as setup
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames --color-moved=plain --color | test_decode_color >actual &&
|
2017-07-01 04:53:08 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/main.c b/main.c<RESET>
|
|
|
|
<BOLD>index 27a619c..7cf9336 100644<RESET>
|
|
|
|
<BOLD>--- a/main.c<RESET>
|
|
|
|
<BOLD>+++ b/main.c<RESET>
|
|
|
|
<CYAN>@@ -5,13 +5,6 @@<RESET> <RESET>printf("Hello ");<RESET>
|
|
|
|
printf("World\n");<RESET>
|
|
|
|
}<RESET>
|
|
|
|
<RESET>
|
|
|
|
<BRED>-int secure_foo(struct user *u)<RESET>
|
|
|
|
<BRED>-{<RESET>
|
|
|
|
<BRED>-if (!u->is_allowed_foo)<RESET>
|
|
|
|
<BRED>-return;<RESET>
|
|
|
|
<BRED>-foo(u);<RESET>
|
|
|
|
<BRED>-}<RESET>
|
|
|
|
<BRED>-<RESET>
|
|
|
|
int main()<RESET>
|
|
|
|
{<RESET>
|
|
|
|
foo();<RESET>
|
|
|
|
<BOLD>diff --git a/test.c b/test.c<RESET>
|
|
|
|
<BOLD>index 1dc1d85..2bedec9 100644<RESET>
|
|
|
|
<BOLD>--- a/test.c<RESET>
|
|
|
|
<BOLD>+++ b/test.c<RESET>
|
|
|
|
<CYAN>@@ -4,6 +4,13 @@<RESET> <RESET>int bar()<RESET>
|
|
|
|
printf("Hello World, but different\n");<RESET>
|
|
|
|
}<RESET>
|
|
|
|
<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>int secure_foo(struct user *u)<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>{<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>foo(u);<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>if (!u->is_allowed_foo)<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>return;<RESET>
|
|
|
|
<BGREEN>+<RESET><BGREEN>}<RESET>
|
|
|
|
<BGREEN>+<RESET>
|
|
|
|
int another_function()<RESET>
|
|
|
|
{<RESET>
|
|
|
|
bar();<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
2017-07-01 04:53:09 +08:00
|
|
|
test_expect_success 'detect permutations inside moved code -- dimmed_zebra' '
|
|
|
|
git reset --hard &&
|
|
|
|
cat <<-\EOF >lines.txt &&
|
2017-08-16 09:27:39 +08:00
|
|
|
long line 1
|
|
|
|
long line 2
|
|
|
|
long line 3
|
2017-07-01 04:53:09 +08:00
|
|
|
line 4
|
|
|
|
line 5
|
|
|
|
line 6
|
|
|
|
line 7
|
|
|
|
line 8
|
|
|
|
line 9
|
|
|
|
line 10
|
|
|
|
line 11
|
|
|
|
line 12
|
|
|
|
line 13
|
2017-08-16 09:27:39 +08:00
|
|
|
long line 14
|
|
|
|
long line 15
|
|
|
|
long line 16
|
2017-07-01 04:53:09 +08:00
|
|
|
EOF
|
|
|
|
git add lines.txt &&
|
|
|
|
git commit -m "add poetry" &&
|
|
|
|
cat <<-\EOF >lines.txt &&
|
|
|
|
line 4
|
|
|
|
line 5
|
|
|
|
line 6
|
|
|
|
line 7
|
|
|
|
line 8
|
|
|
|
line 9
|
2017-08-16 09:27:39 +08:00
|
|
|
long line 1
|
|
|
|
long line 2
|
|
|
|
long line 3
|
|
|
|
long line 14
|
|
|
|
long line 15
|
|
|
|
long line 16
|
2017-07-01 04:53:09 +08:00
|
|
|
line 10
|
|
|
|
line 11
|
|
|
|
line 12
|
|
|
|
line 13
|
|
|
|
EOF
|
|
|
|
test_config color.diff.oldMoved "magenta" &&
|
|
|
|
test_config color.diff.newMoved "cyan" &&
|
|
|
|
test_config color.diff.oldMovedAlternative "blue" &&
|
|
|
|
test_config color.diff.newMovedAlternative "yellow" &&
|
|
|
|
test_config color.diff.oldMovedDimmed "normal magenta" &&
|
|
|
|
test_config color.diff.newMovedDimmed "normal cyan" &&
|
|
|
|
test_config color.diff.oldMovedAlternativeDimmed "normal blue" &&
|
|
|
|
test_config color.diff.newMovedAlternativeDimmed "normal yellow" &&
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames --color-moved=dimmed_zebra --color |
|
2017-08-16 09:27:39 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
2017-07-01 04:53:09 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,16 +1,16 @@<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<BMAGENTA>-long line 1<RESET>
|
|
|
|
<BMAGENTA>-long line 2<RESET>
|
|
|
|
<BMAGENTA>-long line 3<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
line 6<RESET>
|
|
|
|
line 7<RESET>
|
|
|
|
line 8<RESET>
|
|
|
|
line 9<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<BCYAN>+<RESET><BCYAN>long line 1<RESET>
|
|
|
|
<BCYAN>+<RESET><BCYAN>long line 2<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 3<RESET>
|
|
|
|
<YELLOW>+<RESET><YELLOW>long line 14<RESET>
|
|
|
|
<BYELLOW>+<RESET><BYELLOW>long line 15<RESET>
|
|
|
|
<BYELLOW>+<RESET><BYELLOW>long line 16<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
line 10<RESET>
|
|
|
|
line 11<RESET>
|
|
|
|
line 12<RESET>
|
|
|
|
line 13<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<BMAGENTA>-long line 14<RESET>
|
|
|
|
<BMAGENTA>-long line 15<RESET>
|
|
|
|
<BMAGENTA>-long line 16<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
EOF
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'cmd option assumes configured colored-moved' '
|
|
|
|
test_config color.diff.oldMoved "magenta" &&
|
|
|
|
test_config color.diff.newMoved "cyan" &&
|
|
|
|
test_config color.diff.oldMovedAlternative "blue" &&
|
|
|
|
test_config color.diff.newMovedAlternative "yellow" &&
|
|
|
|
test_config color.diff.oldMovedDimmed "normal magenta" &&
|
|
|
|
test_config color.diff.newMovedDimmed "normal cyan" &&
|
|
|
|
test_config color.diff.oldMovedAlternativeDimmed "normal blue" &&
|
|
|
|
test_config color.diff.newMovedAlternativeDimmed "normal yellow" &&
|
|
|
|
test_config diff.colorMoved zebra &&
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames --color-moved --color |
|
2017-08-16 09:27:39 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
2017-07-01 04:53:09 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,16 +1,16 @@<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<MAGENTA>-long line 1<RESET>
|
|
|
|
<MAGENTA>-long line 2<RESET>
|
|
|
|
<MAGENTA>-long line 3<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
line 6<RESET>
|
|
|
|
line 7<RESET>
|
|
|
|
line 8<RESET>
|
|
|
|
line 9<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<CYAN>+<RESET><CYAN>long line 1<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 2<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 3<RESET>
|
|
|
|
<YELLOW>+<RESET><YELLOW>long line 14<RESET>
|
|
|
|
<YELLOW>+<RESET><YELLOW>long line 15<RESET>
|
|
|
|
<YELLOW>+<RESET><YELLOW>long line 16<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
line 10<RESET>
|
|
|
|
line 11<RESET>
|
|
|
|
line 12<RESET>
|
|
|
|
line 13<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<MAGENTA>-long line 14<RESET>
|
|
|
|
<MAGENTA>-long line 15<RESET>
|
|
|
|
<MAGENTA>-long line 16<RESET>
|
2017-07-01 04:53:09 +08:00
|
|
|
EOF
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
test_expect_success 'no effect from --color-moved with --word-diff' '
|
|
|
|
cat <<-\EOF >text.txt &&
|
|
|
|
Lorem Ipsum is simply dummy text of the printing and typesetting industry.
|
|
|
|
EOF
|
|
|
|
git add text.txt &&
|
|
|
|
git commit -a -m "clean state" &&
|
|
|
|
cat <<-\EOF >text.txt &&
|
|
|
|
simply Lorem Ipsum dummy is text of the typesetting and printing industry.
|
|
|
|
EOF
|
|
|
|
git diff --color-moved --word-diff >actual &&
|
|
|
|
git diff --word-diff >expect &&
|
|
|
|
test_cmp expect actual
|
|
|
|
'
|
|
|
|
|
2017-10-20 04:24:03 +08:00
|
|
|
test_expect_success 'set up whitespace tests' '
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
git reset --hard &&
|
2017-10-20 04:24:03 +08:00
|
|
|
# Note that these lines have no leading or trailing whitespace.
|
|
|
|
cat <<-\EOF >lines.txt &&
|
|
|
|
line 1
|
|
|
|
line 2
|
|
|
|
line 3
|
|
|
|
line 4
|
2017-10-20 04:25:57 +08:00
|
|
|
line 5
|
2017-08-16 09:27:39 +08:00
|
|
|
long line 6
|
|
|
|
long line 7
|
2017-10-20 04:25:57 +08:00
|
|
|
long line 8
|
|
|
|
long line 9
|
2017-10-20 04:24:03 +08:00
|
|
|
EOF
|
|
|
|
git add lines.txt &&
|
|
|
|
git commit -m "add poetry" &&
|
|
|
|
git config color.diff.oldMoved "magenta" &&
|
|
|
|
git config color.diff.newMoved "cyan"
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success 'move detection ignoring whitespace ' '
|
|
|
|
q_to_tab <<-\EOF >lines.txt &&
|
|
|
|
Qlong line 6
|
|
|
|
Qlong line 7
|
2017-10-20 04:25:57 +08:00
|
|
|
Qlong line 8
|
|
|
|
Qchanged long line 9
|
2017-10-20 04:24:03 +08:00
|
|
|
line 1
|
|
|
|
line 2
|
|
|
|
line 3
|
|
|
|
line 4
|
2017-10-20 04:25:57 +08:00
|
|
|
line 5
|
2017-10-20 04:24:03 +08:00
|
|
|
EOF
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames --color-moved --color |
|
2017-08-16 09:27:39 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<GREEN>+<RESET> <GREEN>long line 6<RESET>
|
|
|
|
<GREEN>+<RESET> <GREEN>long line 7<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<GREEN>+<RESET> <GREEN>long line 8<RESET>
|
|
|
|
<GREEN>+<RESET> <GREEN>changed long line 9<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
line 5<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<RED>-long line 6<RESET>
|
|
|
|
<RED>-long line 7<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<RED>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
EOF
|
|
|
|
test_cmp expected actual &&
|
|
|
|
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --no-renames -w --color-moved --color |
|
2017-08-16 09:27:39 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<CYAN>+<RESET> <CYAN>long line 6<RESET>
|
|
|
|
<CYAN>+<RESET> <CYAN>long line 7<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<CYAN>+<RESET> <CYAN>long line 8<RESET>
|
|
|
|
<GREEN>+<RESET> <GREEN>changed long line 9<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
line 5<RESET>
|
2017-08-16 09:27:39 +08:00
|
|
|
<MAGENTA>-long line 6<RESET>
|
|
|
|
<MAGENTA>-long line 7<RESET>
|
2017-10-20 04:25:57 +08:00
|
|
|
<MAGENTA>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
EOF
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
2017-10-20 04:26:31 +08:00
|
|
|
test_expect_success 'move detection ignoring whitespace changes' '
|
|
|
|
git reset --hard &&
|
|
|
|
# Lines 6-8 have a space change, but 9 is new whitespace
|
|
|
|
q_to_tab <<-\EOF >lines.txt &&
|
|
|
|
longQline 6
|
|
|
|
longQline 7
|
|
|
|
longQline 8
|
|
|
|
long liQne 9
|
|
|
|
line 1
|
|
|
|
line 2
|
|
|
|
line 3
|
|
|
|
line 4
|
|
|
|
line 5
|
|
|
|
EOF
|
|
|
|
|
|
|
|
git diff HEAD --no-renames --color-moved --color |
|
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 6<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 7<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 8<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long li ne 9<RESET>
|
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
<RED>-long line 6<RESET>
|
|
|
|
<RED>-long line 7<RESET>
|
|
|
|
<RED>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
|
|
|
EOF
|
|
|
|
test_cmp expected actual &&
|
|
|
|
|
|
|
|
git diff HEAD --no-renames -b --color-moved --color |
|
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 6<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 7<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 8<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long li ne 9<RESET>
|
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
<MAGENTA>-long line 6<RESET>
|
|
|
|
<MAGENTA>-long line 7<RESET>
|
|
|
|
<MAGENTA>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
|
|
|
EOF
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
diff: fix whitespace-skipping with --color-moved
The code for handling whitespace with --color-moved
represents partial strings as a pair of pointers. There are
two possible conventions for the end pointer:
1. It points to the byte right after the end of the
string.
2. It points to the final byte of the string.
But we seem to use both conventions in the code:
a. we assign the initial pointers from the NUL-terminated
string using (1)
b. we eat trailing whitespace by checking the second
pointer for isspace(), which needs (2)
c. the next_byte() function checks for end-of-string with
"if (cp > endp)", which is (2)
d. in next_byte() we skip past internal whitespace with
"while (cp < end)", which is (1)
This creates fewer bugs than you might think, because there
are some subtle interactions. Because of (a) and (c), we
always return the NUL-terminator from next_byte(). But all
of the callers of next_byte() happen to handle that
gracefully.
Because of the mismatch between (d) and (c), next_byte()
could accidentally return a whitespace character right at
endp. But because of the interaction of (a) and (b), we fail
to actually chomp trailing whitespace, meaning our endp
_always_ points to a NUL, canceling out the problem.
But that does leave (b) as a real bug: when ignoring
whitespace only at the end-of-line, we don't correctly trim
it, and fail to match up lines.
We can fix the whole thing by moving consistently to one
convention. Since convention (1) is idiomatic in our code
base, we'll pick that one.
The existing "-w" and "-b" tests continue to pass, and a new
"--ignore-space-at-eol" shows off the breakage we're fixing.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-10-20 04:29:26 +08:00
|
|
|
test_expect_success 'move detection ignoring whitespace at eol' '
|
|
|
|
git reset --hard &&
|
|
|
|
# Lines 6-9 have new eol whitespace, but 9 also has it in the middle
|
|
|
|
q_to_tab <<-\EOF >lines.txt &&
|
|
|
|
long line 6Q
|
|
|
|
long line 7Q
|
|
|
|
long line 8Q
|
|
|
|
longQline 9Q
|
|
|
|
line 1
|
|
|
|
line 2
|
|
|
|
line 3
|
|
|
|
line 4
|
|
|
|
line 5
|
|
|
|
EOF
|
|
|
|
|
|
|
|
# avoid cluttering the output with complaints about our eol whitespace
|
|
|
|
test_config core.whitespace -blank-at-eol &&
|
|
|
|
|
|
|
|
git diff HEAD --no-renames --color-moved --color |
|
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 6 <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 7 <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 8 <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 9 <RESET>
|
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
<RED>-long line 6<RESET>
|
|
|
|
<RED>-long line 7<RESET>
|
|
|
|
<RED>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
|
|
|
EOF
|
|
|
|
test_cmp expected actual &&
|
|
|
|
|
|
|
|
git diff HEAD --no-renames --ignore-space-at-eol --color-moved --color |
|
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat <<-\EOF >expected &&
|
|
|
|
<BOLD>diff --git a/lines.txt b/lines.txt<RESET>
|
|
|
|
<BOLD>--- a/lines.txt<RESET>
|
|
|
|
<BOLD>+++ b/lines.txt<RESET>
|
|
|
|
<CYAN>@@ -1,9 +1,9 @@<RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 6 <RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 7 <RESET>
|
|
|
|
<CYAN>+<RESET><CYAN>long line 8 <RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>long line 9 <RESET>
|
|
|
|
line 1<RESET>
|
|
|
|
line 2<RESET>
|
|
|
|
line 3<RESET>
|
|
|
|
line 4<RESET>
|
|
|
|
line 5<RESET>
|
|
|
|
<MAGENTA>-long line 6<RESET>
|
|
|
|
<MAGENTA>-long line 7<RESET>
|
|
|
|
<MAGENTA>-long line 8<RESET>
|
|
|
|
<RED>-long line 9<RESET>
|
|
|
|
EOF
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
2017-10-20 04:24:03 +08:00
|
|
|
test_expect_success 'clean up whitespace-test colors' '
|
|
|
|
git config --unset color.diff.oldMoved &&
|
|
|
|
git config --unset color.diff.newMoved
|
|
|
|
'
|
|
|
|
|
2017-08-16 09:27:39 +08:00
|
|
|
test_expect_success '--color-moved block at end of diff output respects MIN_ALNUM_COUNT' '
|
2017-08-16 09:27:38 +08:00
|
|
|
git reset --hard &&
|
|
|
|
>bar &&
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
irrelevant_line
|
|
|
|
line1
|
|
|
|
EOF
|
|
|
|
git add foo bar &&
|
|
|
|
git commit -m x &&
|
|
|
|
|
|
|
|
cat <<-\EOF >bar &&
|
|
|
|
line1
|
|
|
|
EOF
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
irrelevant_line
|
|
|
|
EOF
|
|
|
|
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --color-moved=zebra --color --no-renames |
|
2017-08-16 09:27:38 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat >expected <<-\EOF &&
|
|
|
|
<BOLD>diff --git a/bar b/bar<RESET>
|
|
|
|
<BOLD>--- a/bar<RESET>
|
|
|
|
<BOLD>+++ b/bar<RESET>
|
|
|
|
<CYAN>@@ -0,0 +1 @@<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>line1<RESET>
|
|
|
|
<BOLD>diff --git a/foo b/foo<RESET>
|
|
|
|
<BOLD>--- a/foo<RESET>
|
|
|
|
<BOLD>+++ b/foo<RESET>
|
|
|
|
<CYAN>@@ -1,2 +1 @@<RESET>
|
|
|
|
irrelevant_line<RESET>
|
|
|
|
<RED>-line1<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
2017-08-16 09:27:39 +08:00
|
|
|
test_expect_success '--color-moved respects MIN_ALNUM_COUNT' '
|
|
|
|
git reset --hard &&
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
nineteen chars 456789
|
|
|
|
irrelevant_line
|
|
|
|
twenty chars 234567890
|
|
|
|
EOF
|
|
|
|
>bar &&
|
|
|
|
git add foo bar &&
|
|
|
|
git commit -m x &&
|
|
|
|
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
irrelevant_line
|
|
|
|
EOF
|
|
|
|
cat <<-\EOF >bar &&
|
|
|
|
twenty chars 234567890
|
|
|
|
nineteen chars 456789
|
|
|
|
EOF
|
|
|
|
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --color-moved=zebra --color --no-renames |
|
2017-08-16 09:27:39 +08:00
|
|
|
grep -v "index" |
|
|
|
|
test_decode_color >actual &&
|
|
|
|
cat >expected <<-\EOF &&
|
|
|
|
<BOLD>diff --git a/bar b/bar<RESET>
|
|
|
|
<BOLD>--- a/bar<RESET>
|
|
|
|
<BOLD>+++ b/bar<RESET>
|
|
|
|
<CYAN>@@ -0,0 +1,2 @@<RESET>
|
|
|
|
<BOLD;CYAN>+<RESET><BOLD;CYAN>twenty chars 234567890<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>nineteen chars 456789<RESET>
|
|
|
|
<BOLD>diff --git a/foo b/foo<RESET>
|
|
|
|
<BOLD>--- a/foo<RESET>
|
|
|
|
<BOLD>+++ b/foo<RESET>
|
|
|
|
<CYAN>@@ -1,3 +1 @@<RESET>
|
|
|
|
<RED>-nineteen chars 456789<RESET>
|
|
|
|
irrelevant_line<RESET>
|
|
|
|
<BOLD;MAGENTA>-twenty chars 234567890<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
|
|
|
test_expect_success '--color-moved treats adjacent blocks as separate for MIN_ALNUM_COUNT' '
|
|
|
|
git reset --hard &&
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
7charsA
|
|
|
|
irrelevant_line
|
|
|
|
7charsB
|
|
|
|
7charsC
|
|
|
|
EOF
|
|
|
|
>bar &&
|
|
|
|
git add foo bar &&
|
|
|
|
git commit -m x &&
|
|
|
|
|
|
|
|
cat <<-\EOF >foo &&
|
|
|
|
irrelevant_line
|
|
|
|
EOF
|
|
|
|
cat <<-\EOF >bar &&
|
|
|
|
7charsB
|
|
|
|
7charsC
|
|
|
|
7charsA
|
|
|
|
EOF
|
|
|
|
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff HEAD --color-moved=zebra --color --no-renames | grep -v "index" | test_decode_color >actual &&
|
2017-08-16 09:27:39 +08:00
|
|
|
cat >expected <<-\EOF &&
|
|
|
|
<BOLD>diff --git a/bar b/bar<RESET>
|
|
|
|
<BOLD>--- a/bar<RESET>
|
|
|
|
<BOLD>+++ b/bar<RESET>
|
|
|
|
<CYAN>@@ -0,0 +1,3 @@<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>7charsB<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>7charsC<RESET>
|
|
|
|
<GREEN>+<RESET><GREEN>7charsA<RESET>
|
|
|
|
<BOLD>diff --git a/foo b/foo<RESET>
|
|
|
|
<BOLD>--- a/foo<RESET>
|
|
|
|
<BOLD>+++ b/foo<RESET>
|
|
|
|
<CYAN>@@ -1,4 +1 @@<RESET>
|
|
|
|
<RED>-7charsA<RESET>
|
|
|
|
irrelevant_line<RESET>
|
|
|
|
<RED>-7charsB<RESET>
|
|
|
|
<RED>-7charsC<RESET>
|
|
|
|
EOF
|
|
|
|
|
|
|
|
test_cmp expected actual
|
|
|
|
'
|
|
|
|
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
test_expect_success 'move detection with submodules' '
|
|
|
|
test_create_repo bananas &&
|
|
|
|
echo ripe >bananas/recipe &&
|
|
|
|
git -C bananas add recipe &&
|
|
|
|
test_commit fruit &&
|
|
|
|
test_commit -C bananas recipe &&
|
|
|
|
git submodule add ./bananas &&
|
|
|
|
git add bananas &&
|
|
|
|
git commit -a -m "bananas are like a heavy library?" &&
|
|
|
|
echo foul >bananas/recipe &&
|
|
|
|
echo ripe >fruit.t &&
|
|
|
|
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff --submodule=diff --color-moved --color >actual &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
|
|
|
|
# no move detection as the moved line is across repository boundaries.
|
|
|
|
test_decode_color <actual >decoded_actual &&
|
|
|
|
! grep BGREEN decoded_actual &&
|
|
|
|
! grep BRED decoded_actual &&
|
|
|
|
|
|
|
|
# nor did we mess with it another way
|
2017-10-03 21:41:51 +08:00
|
|
|
git diff --submodule=diff --color | test_decode_color >expect &&
|
diff.c: color moved lines differently
When a patch consists mostly of moving blocks of code around, it can
be quite tedious to ensure that the blocks are moved verbatim, and not
undesirably modified in the move. To that end, color blocks that are
moved within the same patch differently. For example (OM, del, add,
and NM are different colors):
[OM] -void sensitive_stuff(void)
[OM] -{
[OM] - if (!is_authorized_user())
[OM] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OM] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NM] + sensitive_stuff(spanning,
[NM] + multiple,
[NM] + lines);
[NM] +}
However adjacent blocks may be problematic. For example, in this
potentially malicious patch, the swapping of blocks can be spotted:
[OM] -void sensitive_stuff(void)
[OM] -{
[OMA] - if (!is_authorized_user())
[OMA] - die("unauthorized");
[OM] - sensitive_stuff(spanning,
[OM] - multiple,
[OM] - lines);
[OMA] -}
void another_function()
{
[del] - printf("foo");
[add] + printf("bar");
}
[NM] +void sensitive_stuff(void)
[NM] +{
[NMA] + sensitive_stuff(spanning,
[NMA] + multiple,
[NMA] + lines);
[NM] + if (!is_authorized_user())
[NM] + die("unauthorized");
[NMA] +}
If the moved code is larger, it is easier to hide some permutation in the
code, which is why some alternative coloring is needed.
This patch implements the first mode:
* basic alternating 'Zebra' mode
This conveys all information needed to the user. Defer customization to
later patches.
First I implemented an alternative design, which would try to fingerprint
a line by its neighbors to detect if we are in a block or at the boundary.
This idea iss error prone as it inspected each line and its neighboring
lines to determine if the line was (a) moved and (b) if was deep inside
a hunk by having matching neighboring lines. This is unreliable as the
we can construct hunks which have equal neighbors that just exceed the
number of lines inspected. (Think of 'AXYZBXYZCXYZD..' with each letter
as a line, that is permutated to AXYZCXYZBXYZD..').
Instead this provides a dynamic programming greedy algorithm that finds
the largest moved hunk and then has several modes on highlighting bounds.
A note on the options '--submodule=diff' and '--color-words/--word-diff':
In the conversion to use emit_line in the prior patches both submodules
as well as word diff output carefully chose to call emit_line with sign=0.
All output with sign=0 is ignored for move detection purposes in this
patch, such that no weird looking output will be generated for these
cases. This leads to another thought: We could pass on '--color-moved' to
submodules such that they color up moved lines for themselves. If we'd do
so only line moves within a repository boundary are marked up.
It is useful to have moved lines colored, but there are annoying corner
cases, such as a single line moved, that is very common. For example
in a typical patch of C code, we have closing braces that end statement
blocks or functions.
While it is technically true that these lines are moved as they show up
elsewhere, it is harmful for the review as the reviewers attention is
drawn to such a minor side annoyance.
For now let's have a simple solution of hardcoding the number of
moved lines to be at least 3 before coloring them. Note, that the
length is applied across all blocks to find the 'lonely' blocks
that pollute new code, but do not interfere with a permutated
block where each permutation has less lines than 3.
Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-07-01 04:53:07 +08:00
|
|
|
test_cmp expect decoded_actual
|
|
|
|
'
|
|
|
|
|
2006-10-12 20:22:14 +08:00
|
|
|
test_done
|