123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337 |
- /*
- * Copyright (C) 2009, Google Inc. and others
- *
- * This program and the accompanying materials are made available under the
- * terms of the Eclipse Distribution License v. 1.0 which is available at
- * https://www.eclipse.org/org/documents/edl-v10.php.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- */
-
- package org.eclipse.jgit.revwalk;
-
- import static org.junit.Assert.assertEquals;
- import static org.junit.Assert.assertFalse;
- import static org.junit.Assert.assertNotNull;
- import static org.junit.Assert.assertNull;
- import static org.junit.Assert.assertTrue;
-
- import java.io.IOException;
- import java.util.List;
-
- import org.eclipse.jgit.junit.RepositoryTestCase;
- import org.eclipse.jgit.lib.Constants;
- import org.eclipse.jgit.lib.ObjectId;
- import org.junit.Test;
-
- public class FooterLineTest extends RepositoryTestCase {
- @Test
- public void testNoFooters_EmptyBody() throws IOException {
- final RevCommit commit = parse("");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_NewlineOnlyBody1() throws IOException {
- final RevCommit commit = parse("\n");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_NewlineOnlyBody5() throws IOException {
- final RevCommit commit = parse("\n\n\n\n\n");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_OneLineBodyNoLF() throws IOException {
- final RevCommit commit = parse("this is a commit");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_OneLineBodyWithLF() throws IOException {
- final RevCommit commit = parse("this is a commit\n");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_ShortBodyNoLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testNoFooters_ShortBodyWithLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n");
- final List<FooterLine> footers = commit.getFooterLines();
- assertNotNull(footers);
- assertEquals(0, footers.size());
- }
-
- @Test
- public void testSignedOffBy_OneUserNoLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Signed-off-by: A. U. Thor <a@example.com>");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("A. U. Thor <a@example.com>", f.getValue());
- assertEquals("a@example.com", f.getEmailAddress());
- }
-
- @Test
- public void testSignedOffBy_OneUserWithLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Signed-off-by: A. U. Thor <a@example.com>\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("A. U. Thor <a@example.com>", f.getValue());
- assertEquals("a@example.com", f.getEmailAddress());
- }
-
- @Test
- public void testSignedOffBy_IgnoreWhitespace() throws IOException {
- // We only ignore leading whitespace on the value, trailing
- // is assumed part of the value.
- //
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Signed-off-by: A. U. Thor <a@example.com> \n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("A. U. Thor <a@example.com> ", f.getValue());
- assertEquals("a@example.com", f.getEmailAddress());
- }
-
- @Test
- public void testEmptyValueNoLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Signed-off-by:");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("", f.getValue());
- assertNull(f.getEmailAddress());
- }
-
- @Test
- public void testEmptyValueWithLF() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Signed-off-by:\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("", f.getValue());
- assertNull(f.getEmailAddress());
- }
-
- @Test
- public void testShortKey() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "K:V\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("K", f.getKey());
- assertEquals("V", f.getValue());
- assertNull(f.getEmailAddress());
- }
-
- @Test
- public void testNonDelimtedEmail() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Acked-by: re@example.com\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Acked-by", f.getKey());
- assertEquals("re@example.com", f.getValue());
- assertEquals("re@example.com", f.getEmailAddress());
- }
-
- @Test
- public void testNotEmail() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n" + "\n"
- + "Acked-by: Main Tain Er\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- f = footers.get(0);
- assertEquals("Acked-by", f.getKey());
- assertEquals("Main Tain Er", f.getValue());
- assertNull(f.getEmailAddress());
- }
-
- @Test
- public void testSignedOffBy_ManyUsers() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n"
- + "Not-A-Footer-Line: this line must not be read as a footer\n"
- + "\n" // paragraph break, now footers appear in final block
- + "Signed-off-by: A. U. Thor <a@example.com>\n"
- + "CC: <some.mailing.list@example.com>\n"
- + "Acked-by: Some Reviewer <sr@example.com>\n"
- + "Signed-off-by: Main Tain Er <mte@example.com>\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(4, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("A. U. Thor <a@example.com>", f.getValue());
- assertEquals("a@example.com", f.getEmailAddress());
-
- f = footers.get(1);
- assertEquals("CC", f.getKey());
- assertEquals("<some.mailing.list@example.com>", f.getValue());
- assertEquals("some.mailing.list@example.com", f.getEmailAddress());
-
- f = footers.get(2);
- assertEquals("Acked-by", f.getKey());
- assertEquals("Some Reviewer <sr@example.com>", f.getValue());
- assertEquals("sr@example.com", f.getEmailAddress());
-
- f = footers.get(3);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("Main Tain Er <mte@example.com>", f.getValue());
- assertEquals("mte@example.com", f.getEmailAddress());
- }
-
- @Test
- public void testSignedOffBy_SkipNonFooter() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n"
- + "Not-A-Footer-Line: this line must not be read as a footer\n"
- + "\n" // paragraph break, now footers appear in final block
- + "Signed-off-by: A. U. Thor <a@example.com>\n"
- + "CC: <some.mailing.list@example.com>\n"
- + "not really a footer line but we'll skip it anyway\n"
- + "Acked-by: Some Reviewer <sr@example.com>\n"
- + "Signed-off-by: Main Tain Er <mte@example.com>\n");
- final List<FooterLine> footers = commit.getFooterLines();
- FooterLine f;
-
- assertNotNull(footers);
- assertEquals(4, footers.size());
-
- f = footers.get(0);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("A. U. Thor <a@example.com>", f.getValue());
-
- f = footers.get(1);
- assertEquals("CC", f.getKey());
- assertEquals("<some.mailing.list@example.com>", f.getValue());
-
- f = footers.get(2);
- assertEquals("Acked-by", f.getKey());
- assertEquals("Some Reviewer <sr@example.com>", f.getValue());
-
- f = footers.get(3);
- assertEquals("Signed-off-by", f.getKey());
- assertEquals("Main Tain Er <mte@example.com>", f.getValue());
- }
-
- @Test
- public void testFilterFootersIgnoreCase() throws IOException {
- final RevCommit commit = parse("subject\n\nbody of commit\n"
- + "Not-A-Footer-Line: this line must not be read as a footer\n"
- + "\n" // paragraph break, now footers appear in final block
- + "Signed-Off-By: A. U. Thor <a@example.com>\n"
- + "CC: <some.mailing.list@example.com>\n"
- + "Acked-by: Some Reviewer <sr@example.com>\n"
- + "signed-off-by: Main Tain Er <mte@example.com>\n");
- final List<String> footers = commit.getFooterLines("signed-off-by");
-
- assertNotNull(footers);
- assertEquals(2, footers.size());
-
- assertEquals("A. U. Thor <a@example.com>", footers.get(0));
- assertEquals("Main Tain Er <mte@example.com>", footers.get(1));
- }
-
- @Test
- public void testMatchesBugId() throws IOException {
- final RevCommit commit = parse("this is a commit subject for test\n"
- + "\n" // paragraph break, now footers appear in final block
- + "Simple-Bug-Id: 42\n");
- final List<FooterLine> footers = commit.getFooterLines();
-
- assertNotNull(footers);
- assertEquals(1, footers.size());
-
- final FooterLine line = footers.get(0);
- assertNotNull(line);
- assertEquals("Simple-Bug-Id", line.getKey());
- assertEquals("42", line.getValue());
-
- final FooterKey bugid = new FooterKey("Simple-Bug-Id");
- assertTrue("matches Simple-Bug-Id", line.matches(bugid));
- assertFalse("not Signed-off-by", line.matches(FooterKey.SIGNED_OFF_BY));
- assertFalse("not CC", line.matches(FooterKey.CC));
- }
-
- private RevCommit parse(String msg) throws IOException {
- final StringBuilder buf = new StringBuilder();
- buf.append("tree " + ObjectId.zeroId().name() + "\n");
- buf.append("author A. U. Thor <a@example.com> 1 +0000\n");
- buf.append("committer A. U. Thor <a@example.com> 1 +0000\n");
- buf.append("\n");
- buf.append(msg);
-
- try (RevWalk walk = new RevWalk(db)) {
- RevCommit c = new RevCommit(ObjectId.zeroId());
- c.parseCanonical(walk, Constants.encode(buf.toString()));
- return c;
- }
- }
- }
|