Added ChangesetTrailerExtractor

scm-webapp/src/test/java/sonia/scm/api/v2/resources/ChangesetTrailerExtractorTest.java

@@ -0,0 +1,142 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2020-present Cloudogu GmbH and Contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package sonia.scm.api.v2.resources;
+
+import com.google.common.collect.ImmutableList;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import sonia.scm.api.v2.resources.ChangesetTrailerExtractor.TrailerTypes;
+import sonia.scm.user.DisplayUser;
+import sonia.scm.user.User;
+import sonia.scm.user.UserDisplayManager;
+
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.Mockito.when;
+
+@ExtendWith(MockitoExtension.class)
+class ChangesetTrailerExtractorTest {
+
+  @Mock
+  private UserDisplayManager userDisplayManager;
+
+  private ChangesetTrailerExtractor extractor;
+
+  @BeforeEach
+  void initExtractor() {
+    TrailerTypes trailerTypes = new TrailerTypes();
+    extractor = new ChangesetTrailerExtractor(userDisplayManager, trailerTypes);
+  }
+
+  @Test
+  void shouldReturnEmptyMap() {
+    String commitMessage = "zaphod beetlebrox";
+
+    Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage);
+
+    assertThat(map).isInstanceOf(Map.class);
+    assertThat(map).isNotNull();
+    assertThat(map.keySet()).isEmpty();
+  }
+
+  @Test
+  void shouldReturnMapWithCoAuthors() {
+    DisplayUser displayUser = mockDisplayUser("Arthur Dent", "dent@hitchhiker.org");
+    String commitMessage = "zaphod beetlebrox\n\nCo-authored-by: Arthur Dent <dent@hitchhiker.org>";
+
+    PersonDto personDto = createPersonDto(displayUser);
+
+    Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage);
+
+    assertThat(map.keySet().iterator().next()).isEqualTo("Co-authored-by");
+    PersonDto person = map.values().iterator().next();
+    assertThat(person.getName()).isEqualTo(personDto.getName());
+    assertThat(person.getMail()).isEqualTo(personDto.getMail());
+  }
+
+  @Test
+  void shouldReturnMapWithReviewers() {
+    DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
+    String commitMessage = "zaphod beetlebrox\nReviewed-by: Tricia McMillan <trillian@hitchhiker.org>";
+
+    PersonDto personDto = createPersonDto(displayUser);
+
+    Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage);
+
+    assertThat(map.keySet().iterator().next()).isEqualTo("Reviewed-by");
+    PersonDto person = map.values().iterator().next();
+    assertThat(person.getName()).isEqualTo(personDto.getName());
+    assertThat(person.getMail()).isEqualTo(personDto.getMail());
+  }
+
+  @Test
+  void shouldReturnMapWithSigner() {
+    DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
+    String commitMessage = "zaphod beetlebrox\nSigned-off-by: Tricia McMillan <trillian@hitchhiker.org>";
+
+    PersonDto personDto = createPersonDto(displayUser);
+
+    Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage);
+
+    assertThat(map.keySet().iterator().next()).isEqualTo("Signed-off-by");
+    PersonDto person = map.values().iterator().next();
+    assertThat(person.getName()).isEqualTo(personDto.getName());
+    assertThat(person.getMail()).isEqualTo(personDto.getMail());
+  }
+
+  @Test
+  void shouldReturnMapWithCommitter() {
+    DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
+    String commitMessage = "zaphod beetlebrox\nCommitted-by: Tricia McMillan <trillian@hitchhiker.org>";
+
+    PersonDto personDto = createPersonDto(displayUser);
+
+    Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage);
+
+    assertThat(map.keySet().iterator().next()).isEqualTo("Committed-by");
+    PersonDto person = map.values().iterator().next();
+    assertThat(person.getName()).isEqualTo(personDto.getName());
+    assertThat(person.getMail()).isEqualTo(personDto.getMail());
+  }
+
+
+  private DisplayUser mockDisplayUser(String name, String mail) {
+    DisplayUser displayUser = DisplayUser.from(new User(name, name, mail));
+    when(userDisplayManager.autocomplete(mail)).thenReturn(ImmutableList.of(displayUser));
+    return displayUser;
+  }
+
+  private PersonDto createPersonDto(DisplayUser displayUser) {
+    PersonDto personDto = new PersonDto();
+    personDto.setName(displayUser.getDisplayName());
+    personDto.setMail(displayUser.getMail());
+    return personDto;
+  }
+
+}