[PATCH v2] sequencer: require trailing NL in footers
- From
- Jonathan Tan <jonathantanmy@google.com>
- Date
- Apr 25, 2017, 23:57 UTC
- Message-ID
- <20170425235741.32546-1-jonathantanmy@google.com>
- In-Reply-To
- <20170425190651.8910-1-jonathantanmy@google.com>
In commit 967dfd4 ("sequencer: use trailer's trailer layout", 2016-11-29), sequencer was taught to use the same mechanism as interpret-trailers to determine the nature of the trailer of a commit message (referred to as the "footer" in sequencer.c). However, the requirement that a footer end in a newline character was inadvertently removed. Restore that requirement.
While writing this commit, I noticed that if the "ignore_footer" parameter in "has_conforming_footer" is greater than the distance between the trailer start and sb->len, "has_conforming_footer" will return an unexpected result. This does not occur in practice, because "ignore_footer" is either zero or the return value of an invocation to "ignore_non_trailer", which only skips empty lines and comment lines. This commit contains a comment explaining this in the function's documentation.
Reported-by: Brian Norris <computersforpeace@gmail.com> Signed-off-by: Jonathan Tan <jonathantanmy@google.com> ---
jrnieder pointed out the existence of commit-tree to me, which I have used to write the test below.
Changes from v1: - added test - used one of sbeller's documentation suggestions
sequencer.c | 11 +++++++++++ t/t3511-cherry-pick-x.sh | 14 ++++++++++++++ 2 files changed, 25 insertions(+)
diff --git a/sequencer.c b/sequencer.c index 77afecaeb..500a76260 100644 --- a/sequencer.c +++ b/sequencer.c @@ -151,6 +151,12 @@ static const char *get_todo_path(const struct replay_opts *opts) * Returns 1 for conforming footer * Returns 2 when sob exists within conforming footer * Returns 3 when sob exists within conforming footer as last entry + * + * A footer that does not end in a newline is considered non-conforming. + * + * ignore_footer, if not zero, should be the return value of an invocation to + * ignore_non_trailer(). See the documentation of that function for more + * information. */ static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob, int ignore_footer) @@ -159,6 +165,11 @@ static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob, int i; int found_sob = 0, found_sob_last = 0; + if (sb->len <= ignore_footer) + return 0; + if (sb->buf[sb->len - ignore_footer - 1] != '\n') + return 0; + trailer_info_get(&info, sb->buf); if (info.trailer_start == info.trailer_end) diff --git a/t/t3511-cherry-pick-x.sh b/t/t3511-cherry-pick-x.sh index bf0a5c988..6f518020b 100755 --- a/t/t3511-cherry-pick-x.sh +++ b/t/t3511-cherry-pick-x.sh @@ -208,6 +208,20 @@ test_expect_success 'cherry-pick -x -s adds sob even when trailing sob exists fo test_cmp expect actual ' +test_expect_success 'cherry-pick -x handles commits with no NL at end of message' ' + pristine_detach initial && + sha1=$(printf "title\n\nSigned-off-by: a" | git commit-tree -p initial mesg-with-footer^{tree}) && + git cherry-pick -x $sha1 && + cat <<-EOF >expect && + title + + Signed-off-by: a + (cherry picked from commit $sha1) + EOF + git log -1 --pretty=format:%B >actual && + test_cmp expect actual +' + test_expect_success 'cherry-pick -x treats "(cherry picked from..." line as part of footer' ' pristine_detach initial && sha1=$(git rev-parse mesg-with-cherry-footer^0) &&
-- 2.13.0.rc0.306.g87b477812d-goog