From 9f75ce3d8f2666ea82913a88d7068f28893b23a8 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 29 Oct 2020 12:48:28 +0000 Subject: [PATCH 1/2] ref-filter: handle CRLF at end-of-line more gracefully The ref-filter code does not correctly handle commit or tag messages that use CRLF as the line terminator. Such messages can be created with the `--cleanup=verbatim` option of `git commit` and `git tag`, or by using `git commit-tree` directly. The function `find_subpos` in ref-filter.c looks for two consecutive LFs to find the end of the subject line, a sequence which is absent in messages using CRLF. This results in the whole message being parsed as the subject line (`%(contents:subject)`), and the body of the message (`%(contents:body)`) being empty. Moreover, in `copy_subject`, which wants to return the subject as a single line, '\n' is replaced by space, but '\r' is untouched. This impacts the output of `git branch`, `git tag` and `git for-each-ref`. This behaviour is a regression for `git branch --verbose`, which bisects down to 949af0684c (branch: use ref-filter printing APIs, 2017-01-10). Adjust the ref-filter code to be more lenient by hardening the logic in `copy_subject` and `find_subpos` to correctly parse messages containing CRLF. Add a new test script, 't3920-crlf-messages.sh', to test the behaviour of commands using either the ref-filter or the pretty APIs with messages using CRLF line endings. The function `test_crlf_subject_body_and_contents` can be used to test that the `--format` option of `branch`, `tag`, `for-each-ref`, `log` and `show` correctly displays the subject, body and raw content of commit and tag messages using CRLF. Test the output of `branch`, `tag` and `for-each-ref` with such commits. Helped-by: Junio C Hamano Helped-by: Eric Sunshine Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano --- ref-filter.c | 34 +++++++----- t/t3920-crlf-messages.sh | 108 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 129 insertions(+), 13 deletions(-) create mode 100755 t/t3920-crlf-messages.sh diff --git a/ref-filter.c b/ref-filter.c index c62f6b4822..6476686fea 100644 --- a/ref-filter.c +++ b/ref-filter.c @@ -1097,14 +1097,19 @@ static const char *copy_email(const char *buf, struct used_atom *atom) static char *copy_subject(const char *buf, unsigned long len) { - char *r = xmemdupz(buf, len); + struct strbuf sb = STRBUF_INIT; int i; - for (i = 0; i < len; i++) - if (r[i] == '\n') - r[i] = ' '; + for (i = 0; i < len; i++) { + if (buf[i] == '\r' && i + 1 < len && buf[i + 1] == '\n') + continue; /* ignore CR in CRLF */ - return r; + if (buf[i] == '\n') + strbuf_addch(&sb, ' '); + else + strbuf_addch(&sb, buf[i]); + } + return strbuf_detach(&sb, NULL); } static void grab_date(const char *buf, struct atom_value *v, const char *atomname) @@ -1228,20 +1233,23 @@ static void find_subpos(const char *buf, /* subject is first non-empty line */ *sub = buf; - /* subject goes to first empty line */ - while (buf < *sig && *buf && *buf != '\n') { - eol = strchrnul(buf, '\n'); - if (*eol) - eol++; - buf = eol; + /* subject goes to first empty line before signature begins */ + if ((eol = strstr(*sub, "\n\n"))) { + eol = eol < *sig ? eol : *sig; + /* check if message uses CRLF */ + } else if (! (eol = strstr(*sub, "\r\n\r\n"))) { + /* treat whole message as subject */ + eol = strrchr(*sub, '\0'); } + buf = eol; *sublen = buf - *sub; /* drop trailing newline, if present */ - if (*sublen && (*sub)[*sublen - 1] == '\n') + while (*sublen && ((*sub)[*sublen - 1] == '\n' || + (*sub)[*sublen - 1] == '\r')) *sublen -= 1; /* skip any empty lines */ - while (*buf == '\n') + while (*buf == '\n' || *buf == '\r') buf++; *body = buf; *bodylen = strlen(buf); diff --git a/t/t3920-crlf-messages.sh b/t/t3920-crlf-messages.sh new file mode 100755 index 0000000000..3f0ce02c3f --- /dev/null +++ b/t/t3920-crlf-messages.sh @@ -0,0 +1,108 @@ +#!/bin/sh + +test_description='Test ref-filter and pretty APIs for commit and tag messages using CRLF' +. ./test-lib.sh + +LIB_CRLF_BRANCHES="" + +create_crlf_ref () { + branch="$1" && + cat >.crlf-orig-$branch.txt && + cat .crlf-orig-$branch.txt | append_cr >.crlf-message-$branch.txt && + grep 'Subject' .crlf-orig-$branch.txt | tr '\n' ' ' | sed 's/[ ]*$//' | tr -d '\n' >.crlf-subject-$branch.txt && + grep 'Body' .crlf-message-$branch.txt >.crlf-body-$branch.txt || true && + LIB_CRLF_BRANCHES="${LIB_CRLF_BRANCHES} ${branch}" && + test_tick && + hash=$(git commit-tree HEAD^{tree} -p HEAD -F .crlf-message-${branch}.txt) && + git branch ${branch} ${hash} && + git tag tag-${branch} ${branch} -F .crlf-message-${branch}.txt --cleanup=verbatim +} + +create_crlf_refs () { + create_crlf_ref crlf <<-\EOF && + Subject first line + + Body first line + Body second line + EOF + create_crlf_ref crlf-empty-lines-after-subject <<-\EOF && + Subject first line + + + Body first line + Body second line + EOF + create_crlf_ref crlf-two-line-subject <<-\EOF && + Subject first line + Subject second line + + Body first line + Body second line + EOF + create_crlf_ref crlf-two-line-subject-no-body <<-\EOF && + Subject first line + Subject second line + EOF + create_crlf_ref crlf-two-line-subject-no-body-trailing-newline <<-\EOF + Subject first line + Subject second line + + EOF +} + +test_crlf_subject_body_and_contents() { + command_and_args="$@" && + command=$1 && + if test ${command} = "branch" || test ${command} = "for-each-ref" || test ${command} = "tag" + then + atoms="(contents:subject) (contents:body) (contents)" + elif test ${command} = "log" || test ${command} = "show" + then + atoms="s b B" + fi && + files="subject body message" && + while test -n "${atoms}" + do + set ${atoms} && atom=$1 && shift && atoms="$*" && + set ${files} && file=$1 && shift && files="$*" && + test_expect_success "${command}: --format='%${atom}' works with messages using CRLF" " + rm -f expect && + for ref in ${LIB_CRLF_BRANCHES} + do + cat .crlf-${file}-\"\${ref}\".txt >>expect && + printf \"\n\" >>expect + done && + git $command_and_args --format=\"%${atom}\" >actual && + test_cmp expect actual + " + done +} + + +test_expect_success 'Setup refs with commit and tag messages using CRLF' ' + test_commit inital && + create_crlf_refs +' + +test_expect_success 'branch: --verbose works with messages using CRLF' ' + rm -f expect && + for branch in $LIB_CRLF_BRANCHES + do + printf " " >>expect && + cat .crlf-subject-${branch}.txt >>expect && + printf "\n" >>expect + done && + git branch -v >tmp && + # Remove first two columns, and the line for the currently checked out branch + current=$(git branch --show-current) && + grep -v $current actual && + test_cmp expect actual +' + +test_crlf_subject_body_and_contents branch --list crlf* + +test_crlf_subject_body_and_contents tag --list tag-crlf* + +test_crlf_subject_body_and_contents for-each-ref refs/heads/crlf* + +test_done From e2f89586fa6d22bfb176e2f679584464fa1a282d Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Thu, 29 Oct 2020 12:48:29 +0000 Subject: [PATCH 2/2] log, show: add tests for messages containing CRLF A previous commit adjusted the code in ref-filter.c so that messages containing CRLF are now correctly parsed and displayed. Add tests to also check that `git log` and `git show` correctly handle such messages, to prevent futur regressions if these commands are refactored to use the ref-filter API. Signed-off-by: Philippe Blain Signed-off-by: Junio C Hamano --- t/t3920-crlf-messages.sh | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/t/t3920-crlf-messages.sh b/t/t3920-crlf-messages.sh index 3f0ce02c3f..70ddce3a2e 100755 --- a/t/t3920-crlf-messages.sh +++ b/t/t3920-crlf-messages.sh @@ -105,4 +105,22 @@ test_crlf_subject_body_and_contents tag --list tag-crlf* test_crlf_subject_body_and_contents for-each-ref refs/heads/crlf* +test_expect_success 'log: --oneline works with messages using CRLF' ' + for branch in $LIB_CRLF_BRANCHES + do + cat .crlf-subject-${branch}.txt >expect && + printf "\n" >>expect && + git log --oneline -1 ${branch} >tmp-branch && + git log --oneline -1 tag-${branch} >tmp-tag && + cut -d" " -f2- actual-branch && + cut -d" " -f2- actual-tag && + test_cmp expect actual-branch && + test_cmp expect actual-tag || return 1 + done +' + +test_crlf_subject_body_and_contents log --all --reverse --grep Subject + +test_crlf_subject_body_and_contents show $LIB_CRLF_BRANCHES + test_done