adjust ChangesetTrailerExtractor so that we don't check if user already exists

This commit is contained in:
Eduard Heimbuch
2020-05-28 09:50:16 +02:00
committed by René Pfeuffer
parent bb1126befc
commit e451bb618e
5 changed files with 99 additions and 72 deletions

View File

@@ -32,7 +32,7 @@ import lombok.NoArgsConstructor;
import lombok.Setter; import lombok.Setter;
import java.time.Instant; import java.time.Instant;
import java.util.Map; import java.util.List;
@Getter @Getter
@Setter @Setter
@@ -59,7 +59,7 @@ public class ChangesetDto extends HalRepresentation {
*/ */
private String description; private String description;
private Map<String, PersonDto> trailerPersons; private List<TrailerPersonDto> trailerPersons;
public ChangesetDto(Links links, Embedded embedded) { public ChangesetDto(Links links, Embedded embedded) {
super(links, embedded); super(links, embedded);

View File

@@ -0,0 +1,36 @@
/*
* 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 lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
@Getter
@Setter
@NoArgsConstructor
public class TrailerPersonDto extends PersonDto {
private String trailerType;
}

View File

@@ -26,27 +26,24 @@ package sonia.scm.api.v2.resources;
import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableList;
import sonia.scm.repository.ChangesetTrailerTypes; import sonia.scm.repository.ChangesetTrailerTypes;
import sonia.scm.user.DisplayUser;
import sonia.scm.user.UserDisplayManager;
import javax.inject.Inject; import javax.inject.Inject;
import java.util.*; import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
import java.util.regex.Pattern; import java.util.regex.Pattern;
public class ChangesetTrailerExtractor { public class ChangesetTrailerExtractor {
private final UserDisplayManager userDisplayManager;
private final ChangesetTrailerTypes changesetTrailerTypes; private final ChangesetTrailerTypes changesetTrailerTypes;
@Inject @Inject
public ChangesetTrailerExtractor(UserDisplayManager userDisplayManager, ChangesetTrailerTypes changesetTrailerTypes) { public ChangesetTrailerExtractor(ChangesetTrailerTypes changesetTrailerTypes) {
this.userDisplayManager = userDisplayManager;
this.changesetTrailerTypes = changesetTrailerTypes; this.changesetTrailerTypes = changesetTrailerTypes;
} }
Map<String, PersonDto> extractTrailersFromCommitMessage(String commitMessage) { List<TrailerPersonDto> extractTrailersFromCommitMessage(String commitMessage) {
List<TrailerPersonDto> persons = new ArrayList<>();
HashMap<String, PersonDto> persons = new HashMap<>();
try (Scanner scanner = new Scanner(commitMessage)) { try (Scanner scanner = new Scanner(commitMessage)) {
scanner.useDelimiter(Pattern.compile("[\\n;]")); scanner.useDelimiter(Pattern.compile("[\\n;]"));
@@ -55,30 +52,29 @@ public class ChangesetTrailerExtractor {
for (String trailerType : changesetTrailerTypes.getTrailerTypes()) { for (String trailerType : changesetTrailerTypes.getTrailerTypes()) {
if (line.contains(trailerType)) { if (line.contains(trailerType)) {
String mail = line.split("<|>")[1]; TrailerPersonDto personDto = createPersonDtoFromUser(line);
persons.put(trailerType, createPersonDtoFromUser(mail)); personDto.setTrailerType(trailerType);
persons.add(personDto);
} }
} }
/* if (line.contains("Co-authored-by")) {
persons.put("Co-authored-by", createPersonDtoFromUser(mail));
}
if (line.contains("Reviewed-by")) {
persons.put("Reviewed-by", createPersonDtoFromUser(mail));
}*/
} }
} }
return persons; return persons;
} }
private PersonDto createPersonDtoFromUser(String mail) { private TrailerPersonDto createPersonDtoFromUser(String line) {
DisplayUser displayUser = userDisplayManager.autocomplete(mail).iterator().next(); TrailerPersonDto personDto = new TrailerPersonDto();
PersonDto personDto = new PersonDto();
personDto.setName(displayUser.getDisplayName()); String[] splittedTrailer = line.split("[:<>]");
personDto.setMail(displayUser.getMail());
if (splittedTrailer.length > 1) {
personDto.setName(splittedTrailer[1].trim());
if (splittedTrailer.length > 2) {
personDto.setMail(splittedTrailer[2]);
}
}
return personDto; return personDto;
} }

View File

@@ -27,6 +27,7 @@ package sonia.scm.api.v2.resources;
import com.google.inject.AbstractModule; import com.google.inject.AbstractModule;
import com.google.inject.servlet.ServletScopes; import com.google.inject.servlet.ServletScopes;
import org.mapstruct.factory.Mappers; import org.mapstruct.factory.Mappers;
import sonia.scm.repository.ChangesetTrailerTypes;
import sonia.scm.web.api.RepositoryToHalMapper; import sonia.scm.web.api.RepositoryToHalMapper;
public class MapperModule extends AbstractModule { public class MapperModule extends AbstractModule {
@@ -77,6 +78,7 @@ public class MapperModule extends AbstractModule {
bind(MeDtoFactory.class); bind(MeDtoFactory.class);
bind(UIPluginDtoMapper.class); bind(UIPluginDtoMapper.class);
bind(UIPluginDtoCollectionMapper.class); bind(UIPluginDtoCollectionMapper.class);
bind(ChangesetTrailerTypes.class).to(ChangesetTrailerExtractor.TrailerTypes.class);
bind(ScmPathInfoStore.class).in(ServletScopes.REQUEST); bind(ScmPathInfoStore.class).in(ServletScopes.REQUEST);

View File

@@ -24,111 +24,104 @@
package sonia.scm.api.v2.resources; package sonia.scm.api.v2.resources;
import com.google.common.collect.ImmutableList;
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith; import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension; import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.api.v2.resources.ChangesetTrailerExtractor.TrailerTypes; import sonia.scm.api.v2.resources.ChangesetTrailerExtractor.TrailerTypes;
import sonia.scm.user.DisplayUser; import sonia.scm.user.DisplayUser;
import sonia.scm.user.User; import sonia.scm.user.User;
import sonia.scm.user.UserDisplayManager;
import java.util.Map; import java.util.List;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.when;
@ExtendWith(MockitoExtension.class) @ExtendWith(MockitoExtension.class)
class ChangesetTrailerExtractorTest { class ChangesetTrailerExtractorTest {
@Mock
private UserDisplayManager userDisplayManager;
private ChangesetTrailerExtractor extractor; private ChangesetTrailerExtractor extractor;
@BeforeEach @BeforeEach
void initExtractor() { void initExtractor() {
TrailerTypes trailerTypes = new TrailerTypes(); TrailerTypes trailerTypes = new TrailerTypes();
extractor = new ChangesetTrailerExtractor(userDisplayManager, trailerTypes); extractor = new ChangesetTrailerExtractor(trailerTypes);
} }
@Test @Test
void shouldReturnEmptyMap() { void shouldReturnEmptyList() {
String commitMessage = "zaphod beetlebrox"; String commitMessage = "zaphod beetlebrox";
Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage); List<TrailerPersonDto> trailerPersons = extractor.extractTrailersFromCommitMessage(commitMessage);
assertThat(map).isInstanceOf(Map.class); assertThat(trailerPersons).isNotNull();
assertThat(map).isNotNull(); assertThat(trailerPersons).isEmpty();
assertThat(map.keySet()).isEmpty();
} }
@Test @Test
void shouldReturnMapWithCoAuthors() { void shouldReturnTrailerPersonsWithCoAuthors() {
DisplayUser displayUser = mockDisplayUser("Arthur Dent", "dent@hitchhiker.org"); DisplayUser displayUser = createDisplayUser("Arthur Dent", "dent@hitchhiker.org");
String commitMessage = "zaphod beetlebrox\n\nCo-authored-by: Arthur Dent <dent@hitchhiker.org>"; String commitMessage = "zaphod beetlebrox\n\nCo-authored-by: Arthur Dent <dent@hitchhiker.org>";
PersonDto personDto = createPersonDto(displayUser); PersonDto personDto = createPersonDto(displayUser);
Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage); List<TrailerPersonDto> trailerPersons = extractor.extractTrailersFromCommitMessage(commitMessage);
assertThat(map.keySet().iterator().next()).isEqualTo("Co-authored-by"); TrailerPersonDto trailerPersonDto = trailerPersons.get(0);
PersonDto person = map.values().iterator().next(); assertThat(trailerPersonDto.getTrailerType()).isEqualTo("Co-authored-by");
assertThat(person.getName()).isEqualTo(personDto.getName()); assertThat(trailerPersonDto.getName()).isEqualTo(personDto.getName());
assertThat(person.getMail()).isEqualTo(personDto.getMail()); assertThat(trailerPersonDto.getMail()).isEqualTo(personDto.getMail());
} }
@Test @Test
void shouldReturnMapWithReviewers() { void shouldReturnTrailerPersonsWithReviewers() {
DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org"); DisplayUser displayUser = createDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
String commitMessage = "zaphod beetlebrox\nReviewed-by: Tricia McMillan <trillian@hitchhiker.org>"; String commitMessage = "zaphod beetlebrox\nReviewed-by: Tricia McMillan <trillian@hitchhiker.org>";
PersonDto personDto = createPersonDto(displayUser); PersonDto personDto = createPersonDto(displayUser);
Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage); List<TrailerPersonDto> trailerPersons = extractor.extractTrailersFromCommitMessage(commitMessage);
assertThat(map.keySet().iterator().next()).isEqualTo("Reviewed-by"); TrailerPersonDto trailerPersonDto = trailerPersons.get(0);
PersonDto person = map.values().iterator().next();
assertThat(person.getName()).isEqualTo(personDto.getName()); assertThat(trailerPersonDto.getTrailerType()).isEqualTo("Reviewed-by");
assertThat(person.getMail()).isEqualTo(personDto.getMail()); assertThat(trailerPersonDto.getName()).isEqualTo(personDto.getName());
assertThat(trailerPersonDto.getMail()).isEqualTo(personDto.getMail());
} }
@Test @Test
void shouldReturnMapWithSigner() { void shouldReturnTrailerPersonsWithSigner() {
DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org"); DisplayUser displayUser = createDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
String commitMessage = "zaphod beetlebrox\nSigned-off-by: Tricia McMillan <trillian@hitchhiker.org>"; String commitMessage = "zaphod beetlebrox\nSigned-off-by: Tricia McMillan <trillian@hitchhiker.org>";
PersonDto personDto = createPersonDto(displayUser); PersonDto personDto = createPersonDto(displayUser);
Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage); List<TrailerPersonDto> trailerPersons = extractor.extractTrailersFromCommitMessage(commitMessage);
assertThat(map.keySet().iterator().next()).isEqualTo("Signed-off-by"); TrailerPersonDto trailerPersonDto = trailerPersons.get(0);
PersonDto person = map.values().iterator().next();
assertThat(person.getName()).isEqualTo(personDto.getName()); assertThat(trailerPersonDto.getTrailerType()).isEqualTo("Signed-off-by");
assertThat(person.getMail()).isEqualTo(personDto.getMail()); assertThat(trailerPersonDto.getName()).isEqualTo(personDto.getName());
assertThat(trailerPersonDto.getMail()).isEqualTo(personDto.getMail());
} }
@Test @Test
void shouldReturnMapWithCommitter() { void shouldReturnTrailerPersonsWithCommitter() {
DisplayUser displayUser = mockDisplayUser("Tricia McMillan", "trillian@hitchhiker.org"); DisplayUser displayUser = createDisplayUser("Tricia McMillan", "trillian@hitchhiker.org");
String commitMessage = "zaphod beetlebrox\nCommitted-by: Tricia McMillan <trillian@hitchhiker.org>"; String commitMessage = "zaphod beetlebrox\nCommitted-by: Tricia McMillan <trillian@hitchhiker.org>";
PersonDto personDto = createPersonDto(displayUser); PersonDto personDto = createPersonDto(displayUser);
Map<String, PersonDto> map = extractor.extractTrailersFromCommitMessage(commitMessage); List<TrailerPersonDto> trailerPersons = extractor.extractTrailersFromCommitMessage(commitMessage);
assertThat(map.keySet().iterator().next()).isEqualTo("Committed-by"); TrailerPersonDto trailerPersonDto = trailerPersons.get(0);
PersonDto person = map.values().iterator().next();
assertThat(person.getName()).isEqualTo(personDto.getName()); assertThat(trailerPersonDto.getTrailerType()).isEqualTo("Committed-by");
assertThat(person.getMail()).isEqualTo(personDto.getMail()); assertThat(trailerPersonDto.getName()).isEqualTo(personDto.getName());
assertThat(trailerPersonDto.getMail()).isEqualTo(personDto.getMail());
} }
private DisplayUser createDisplayUser(String name, String mail) {
private DisplayUser mockDisplayUser(String name, String mail) {
DisplayUser displayUser = DisplayUser.from(new User(name, name, mail)); DisplayUser displayUser = DisplayUser.from(new User(name, name, mail));
when(userDisplayManager.autocomplete(mail)).thenReturn(ImmutableList.of(displayUser));
return displayUser; return displayUser;
} }