Fix determination of default branch for git config on push

This commit is contained in:
René Pfeuffer
2024-05-28 08:54:30 +02:00
parent e79ad2b1b8
commit ea4a148d86
4 changed files with 169 additions and 97 deletions

View File

@@ -0,0 +1,2 @@
- type: fixed
description: Default branch evaluation on git config initialization

View File

@@ -0,0 +1,3 @@
- type: fixed
description: Exception in SVN repositories due to incorrect git initialization (Backport from 2.47)

View File

@@ -29,11 +29,16 @@ import com.google.common.base.Strings;
import sonia.scm.EagerSingleton; import sonia.scm.EagerSingleton;
import sonia.scm.api.v2.resources.GitRepositoryConfigStoreProvider; import sonia.scm.api.v2.resources.GitRepositoryConfigStoreProvider;
import sonia.scm.plugin.Extension; import sonia.scm.plugin.Extension;
import sonia.scm.repository.api.RepositoryService;
import sonia.scm.repository.api.RepositoryServiceFactory;
import sonia.scm.store.ConfigurationStore; import sonia.scm.store.ConfigurationStore;
import javax.inject.Inject; import java.io.IOException;
import java.util.Comparator; import java.util.Comparator;
import java.util.List; import java.util.List;
import java.util.Optional;
import javax.inject.Inject;
@Extension @Extension
@EagerSingleton @EagerSingleton
@@ -41,28 +46,40 @@ public class GitRepositoryConfigInitializer {
private final GitRepositoryHandler repoHandler; private final GitRepositoryHandler repoHandler;
private final GitRepositoryConfigStoreProvider storeProvider; private final GitRepositoryConfigStoreProvider storeProvider;
private final RepositoryServiceFactory serviceFactory;
@Inject @Inject
public GitRepositoryConfigInitializer(GitRepositoryHandler repoHandler, GitRepositoryConfigStoreProvider storeProvider) { public GitRepositoryConfigInitializer(GitRepositoryHandler repoHandler, GitRepositoryConfigStoreProvider storeProvider, RepositoryServiceFactory serviceFactory) {
this.repoHandler = repoHandler; this.repoHandler = repoHandler;
this.storeProvider = storeProvider; this.storeProvider = storeProvider;
this.serviceFactory = serviceFactory;
} }
@Subscribe @Subscribe
public void initConfig(PostReceiveRepositoryHookEvent event) { public void initConfig(PostReceiveRepositoryHookEvent event) throws IOException {
if (GitRepositoryHandler.TYPE_NAME.equals(event.getRepository().getType())) {
ConfigurationStore<GitRepositoryConfig> store = storeProvider.get(event.getRepository()); ConfigurationStore<GitRepositoryConfig> store = storeProvider.get(event.getRepository());
GitRepositoryConfig repositoryConfig = store.get(); GitRepositoryConfig repositoryConfig = store.get();
if (repositoryConfig == null || Strings.isNullOrEmpty(repositoryConfig.getDefaultBranch())) { if (repositoryConfig == null || Strings.isNullOrEmpty(repositoryConfig.getDefaultBranch())) {
List<String> defaultBranchCandidates = event.getContext().getBranchProvider().getCreatedOrModified(); String defaultBranch;
try (RepositoryService service = serviceFactory.create(event.getRepository())) {
String defaultBranch = determineDefaultBranch(defaultBranchCandidates); List<Branch> branches = service.getBranchesCommand().getBranches().getBranches();
Optional<Branch> repoDefaultBranch = branches.stream().filter(Branch::isDefaultBranch).findFirst();
if (repoDefaultBranch.isPresent()) {
defaultBranch = repoDefaultBranch.get().getName();
} else {
defaultBranch = determineDefaultBranchFromPush(event);
}
}
GitRepositoryConfig gitRepositoryConfig = new GitRepositoryConfig(defaultBranch); GitRepositoryConfig gitRepositoryConfig = new GitRepositoryConfig(defaultBranch);
store.set(gitRepositoryConfig); store.set(gitRepositoryConfig);
} }
} }
}
private String determineDefaultBranch(List<String> defaultBranchCandidates) { private String determineDefaultBranchFromPush(PostReceiveRepositoryHookEvent event) {
List<String> defaultBranchCandidates = event.getContext().getBranchProvider().getCreatedOrModified();
String globalConfigDefaultBranch = repoHandler.getConfig().getDefaultBranch(); String globalConfigDefaultBranch = repoHandler.getConfig().getDefaultBranch();
if (defaultBranchCandidates.contains(globalConfigDefaultBranch)) { if (defaultBranchCandidates.contains(globalConfigDefaultBranch)) {
return globalConfigDefaultBranch; return globalConfigDefaultBranch;

View File

@@ -28,18 +28,24 @@ import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested; import org.junit.jupiter.api.Nested;
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.Answers;
import org.mockito.InjectMocks; import org.mockito.InjectMocks;
import org.mockito.Mock; import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension; import org.mockito.junit.jupiter.MockitoExtension;
import sonia.scm.api.v2.resources.GitRepositoryConfigStoreProvider; import sonia.scm.api.v2.resources.GitRepositoryConfigStoreProvider;
import sonia.scm.repository.api.BranchesCommandBuilder;
import sonia.scm.repository.api.HookBranchProvider; import sonia.scm.repository.api.HookBranchProvider;
import sonia.scm.repository.api.HookContext; import sonia.scm.repository.api.HookContext;
import sonia.scm.repository.api.RepositoryService;
import sonia.scm.repository.api.RepositoryServiceFactory;
import sonia.scm.store.ConfigurationStore; import sonia.scm.store.ConfigurationStore;
import java.io.IOException;
import java.util.List; import java.util.List;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.argThat; import static org.mockito.ArgumentMatchers.argThat;
import static org.mockito.Mockito.lenient;
import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.never; import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verify;
@@ -62,17 +68,46 @@ class GitRepositoryConfigInitializerTest {
@Mock @Mock
private PostReceiveRepositoryHookEvent event; private PostReceiveRepositoryHookEvent event;
@Mock
private RepositoryServiceFactory serviceFactory;
@Mock
private RepositoryService service;
@Mock(answer = Answers.RETURNS_DEEP_STUBS)
private BranchesCommandBuilder branchesCommand;
@Mock
private Branches branches;
@InjectMocks @InjectMocks
private GitRepositoryConfigInitializer initializer; private GitRepositoryConfigInitializer initializer;
@Test
void shouldSkipNonGitRepositories() throws IOException {
REPOSITORY.setType("svn");
initializer.initConfig(event);
verify(event, never()).getContext();
}
@BeforeEach @BeforeEach
void initMocks() { void initEvent() {
when(storeProvider.get(REPOSITORY)).thenReturn(configStore);
when(event.getRepository()).thenReturn(REPOSITORY); when(event.getRepository()).thenReturn(REPOSITORY);
} }
@Nested
class ForGitRepositories {
@BeforeEach
void initMocks() throws IOException {
when(storeProvider.get(REPOSITORY)).thenReturn(configStore);
REPOSITORY.setType("git");
lenient().when(serviceFactory.create(event.getRepository())).thenReturn(service);
lenient().when(service.getBranchesCommand()).thenReturn(branchesCommand);
lenient().when(branchesCommand.getBranches()).thenReturn(branches);
}
@Test @Test
void shouldDoNothingIfDefaultBranchAlreadySet() { void shouldDoNothingIfDefaultBranchAlreadySet() throws IOException {
when(configStore.get()).thenReturn(new GitRepositoryConfig("any")); when(configStore.get()).thenReturn(new GitRepositoryConfig("any"));
initializer.initConfig(event); initializer.initConfig(event);
@@ -87,11 +122,12 @@ class GitRepositoryConfigInitializerTest {
void initRepoHandler() { void initRepoHandler() {
GitConfig gitConfig = new GitConfig(); GitConfig gitConfig = new GitConfig();
gitConfig.setDefaultBranch("global_default"); gitConfig.setDefaultBranch("global_default");
when(repoHandler.getConfig()).thenReturn(gitConfig); lenient().when(repoHandler.getConfig()).thenReturn(gitConfig);
} }
@Test @Test
void shouldSetDefaultBranchIfNoGitConfigYet() { void shouldSetDefaultBranchFromPushIfNoGitConfigYet() throws IOException {
when(configStore.get()).thenReturn(null); when(configStore.get()).thenReturn(null);
initEvent(List.of("main")); initEvent(List.of("main"));
@@ -101,7 +137,7 @@ class GitRepositoryConfigInitializerTest {
} }
@Test @Test
void shouldDetermineAndApplyDefaultBranch_GlobalDefault() { void shouldDetermineAndApplyDefaultBranch_GlobalDefault() throws IOException {
initEvent(List.of("global_default", "main", "master")); initEvent(List.of("global_default", "main", "master"));
when(configStore.get()).thenReturn(new GitRepositoryConfig(null)); when(configStore.get()).thenReturn(new GitRepositoryConfig(null));
@@ -114,7 +150,7 @@ class GitRepositoryConfigInitializerTest {
} }
@Test @Test
void shouldDetermineAndApplyDefaultBranch_Main() { void shouldDetermineAndApplyDefaultBranch_Main() throws IOException {
initEvent(List.of("master", "main")); initEvent(List.of("master", "main"));
when(configStore.get()).thenReturn(new GitRepositoryConfig(null)); when(configStore.get()).thenReturn(new GitRepositoryConfig(null));
@@ -127,7 +163,7 @@ class GitRepositoryConfigInitializerTest {
} }
@Test @Test
void shouldDetermineAndApplyDefaultBranch_Master() { void shouldDetermineAndApplyDefaultBranch_Master() throws IOException {
initEvent(List.of("develop", "master")); initEvent(List.of("develop", "master"));
when(configStore.get()).thenReturn(new GitRepositoryConfig(null)); when(configStore.get()).thenReturn(new GitRepositoryConfig(null));
@@ -140,7 +176,21 @@ class GitRepositoryConfigInitializerTest {
} }
@Test @Test
void shouldDetermineAndApplyDefaultBranch_BestMatch() { void shouldDetermineAndApplyDefaultBranchFromRepository_Staging() throws IOException {
when(configStore.get()).thenReturn(null);
initEvent(List.of("master", "main"));
when(branches.getBranches()).thenReturn(List.of(new Branch("staging", "abc", true)));
initializer.initConfig(event);
verify(configStore).set(argThat(arg -> {
assertThat(arg.getDefaultBranch()).isEqualTo("staging");
return true;
}));
}
@Test
void shouldDetermineAndApplyDefaultBranch_BestMatch() throws IOException {
initEvent(List.of("test/123", "trillian", "dent")); initEvent(List.of("test/123", "trillian", "dent"));
when(configStore.get()).thenReturn(new GitRepositoryConfig(null)); when(configStore.get()).thenReturn(new GitRepositoryConfig(null));
@@ -153,7 +203,7 @@ class GitRepositoryConfigInitializerTest {
} }
@Test @Test
void shouldDetermineAndApplyDefaultBranch_AnyFallback() { void shouldDetermineAndApplyDefaultBranch_AnyFallback() throws IOException {
initEvent(List.of("test/123", "x/y/z")); initEvent(List.of("test/123", "x/y/z"));
when(configStore.get()).thenReturn(new GitRepositoryConfig(null)); when(configStore.get()).thenReturn(new GitRepositoryConfig(null));
@@ -168,10 +218,10 @@ class GitRepositoryConfigInitializerTest {
private void initEvent(List<String> branches) { private void initEvent(List<String> branches) {
HookContext hookContext = mock(HookContext.class); HookContext hookContext = mock(HookContext.class);
when(event.getContext()).thenReturn(hookContext); lenient().when(event.getContext()).thenReturn(hookContext);
HookBranchProvider branchProvider = mock(HookBranchProvider.class); HookBranchProvider branchProvider = mock(HookBranchProvider.class);
when(hookContext.getBranchProvider()).thenReturn(branchProvider); lenient().when(hookContext.getBranchProvider()).thenReturn(branchProvider);
when(branchProvider.getCreatedOrModified()).thenReturn(branches); lenient().when(branchProvider.getCreatedOrModified()).thenReturn(branches);
}
} }
} }