| // Copyright (C) 2020 The Android Open Source Project |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| package com.googlesource.gerrit.plugins.replication.pull; |
| |
| import static com.google.common.truth.Truth.assertThat; |
| import static java.nio.file.Files.createTempDirectory; |
| import static org.mockito.ArgumentMatchers.anyBoolean; |
| import static org.mockito.Mockito.any; |
| import static org.mockito.Mockito.anyInt; |
| import static org.mockito.Mockito.anyString; |
| import static org.mockito.Mockito.eq; |
| import static org.mockito.Mockito.lenient; |
| import static org.mockito.Mockito.never; |
| import static org.mockito.Mockito.times; |
| import static org.mockito.Mockito.verify; |
| import static org.mockito.Mockito.verifyZeroInteractions; |
| import static org.mockito.Mockito.when; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Lists; |
| import com.google.gerrit.entities.Project; |
| import com.google.gerrit.extensions.api.changes.NotifyHandling; |
| import com.google.gerrit.extensions.common.AccountInfo; |
| import com.google.gerrit.extensions.events.GitReferenceUpdatedListener; |
| import com.google.gerrit.extensions.events.GitReferenceUpdatedListener.Event; |
| import com.google.gerrit.extensions.events.ProjectDeletedListener; |
| import com.google.gerrit.extensions.registration.DynamicItem; |
| import com.google.gerrit.metrics.DisabledMetricMaker; |
| import com.google.gerrit.server.config.SitePaths; |
| import com.google.gerrit.server.events.EventDispatcher; |
| import com.google.gerrit.server.git.WorkQueue; |
| import com.google.inject.Provider; |
| import com.googlesource.gerrit.plugins.replication.ReplicationConfig; |
| import com.googlesource.gerrit.plugins.replication.ReplicationFileBasedConfig; |
| import com.googlesource.gerrit.plugins.replication.pull.api.data.RevisionData; |
| import com.googlesource.gerrit.plugins.replication.pull.api.exception.RefUpdateException; |
| import com.googlesource.gerrit.plugins.replication.pull.client.FetchApiClient; |
| import com.googlesource.gerrit.plugins.replication.pull.client.FetchRestApiClient; |
| import com.googlesource.gerrit.plugins.replication.pull.client.HttpResult; |
| import com.googlesource.gerrit.plugins.replication.pull.filter.ExcludedRefsFilter; |
| import java.io.IOException; |
| import java.nio.file.Path; |
| import java.util.Arrays; |
| import java.util.List; |
| import java.util.Optional; |
| import org.apache.http.client.ClientProtocolException; |
| import org.eclipse.jgit.errors.LargeObjectException; |
| import org.eclipse.jgit.lib.ObjectId; |
| import org.eclipse.jgit.storage.file.FileBasedConfig; |
| import org.eclipse.jgit.util.FS; |
| import org.junit.Before; |
| import org.junit.Test; |
| import org.junit.runner.RunWith; |
| import org.mockito.ArgumentCaptor; |
| import org.mockito.Captor; |
| import org.mockito.Mock; |
| import org.mockito.junit.MockitoJUnitRunner; |
| |
| @RunWith(MockitoJUnitRunner.class) |
| public class ReplicationQueueTest { |
| private static int CONNECTION_TIMEOUT = 1000000; |
| |
| @Mock private WorkQueue wq; |
| @Mock private Source source; |
| @Mock private SourcesCollection sourceCollection; |
| @Mock private Provider<SourcesCollection> rd; |
| @Mock private DynamicItem<EventDispatcher> dis; |
| @Mock ReplicationStateListeners sl; |
| @Mock FetchRestApiClient fetchRestApiClient; |
| @Mock FetchApiClient.Factory fetchClientFactory; |
| @Mock AccountInfo accountInfo; |
| @Mock RevisionReader revReader; |
| @Mock RevisionData revisionData; |
| @Mock HttpResult successfulHttpResult; |
| @Mock HttpResult fetchHttpResult; |
| @Mock RevisionData revisionDataWithParents; |
| List<ObjectId> revisionDataParentObjectIds; |
| @Mock HttpResult httpResult; |
| ApplyObjectMetrics applyObjectMetrics; |
| FetchReplicationMetrics fetchMetrics; |
| |
| @Captor ArgumentCaptor<String> stringCaptor; |
| @Captor ArgumentCaptor<Project.NameKey> projectNameKeyCaptor; |
| @Captor ArgumentCaptor<List<RevisionData>> revisionsDataCaptor; |
| |
| private ExcludedRefsFilter refsFilter; |
| private ReplicationQueue objectUnderTest; |
| private SitePaths sitePaths; |
| private Path pluginDataPath; |
| |
| @Before |
| public void setup() throws IOException, LargeObjectException { |
| Path sitePath = createTempPath("site"); |
| sitePaths = new SitePaths(sitePath); |
| Path pluginDataPath = createTempPath("data"); |
| ReplicationConfig replicationConfig = new ReplicationFileBasedConfig(sitePaths, pluginDataPath); |
| refsFilter = new ExcludedRefsFilter(replicationConfig); |
| when(source.getConnectionTimeout()).thenReturn(CONNECTION_TIMEOUT); |
| when(source.wouldFetchProject(any())).thenReturn(true); |
| when(source.wouldFetchRef(anyString())).thenReturn(true); |
| ImmutableList<String> apis = ImmutableList.of("http://localhost:18080"); |
| when(source.getApis()).thenReturn(apis); |
| when(sourceCollection.getAll()).thenReturn(Lists.newArrayList(source)); |
| when(rd.get()).thenReturn(sourceCollection); |
| lenient() |
| .when(revReader.read(any(), any(), anyString(), eq(0))) |
| .thenReturn(Optional.of(revisionData)); |
| lenient().when(revReader.read(any(), anyString(), eq(0))).thenReturn(Optional.of(revisionData)); |
| lenient() |
| .when(revReader.read(any(), any(), anyString(), eq(Integer.MAX_VALUE))) |
| .thenReturn(Optional.of(revisionDataWithParents)); |
| lenient() |
| .when(revReader.read(any(), anyString(), eq(Integer.MAX_VALUE))) |
| .thenReturn(Optional.of(revisionDataWithParents)); |
| revisionDataParentObjectIds = |
| Arrays.asList( |
| ObjectId.fromString("9f8d52853089a3cf00c02ff7bd0817bd4353a95a"), |
| ObjectId.fromString("b5d7bcf1d1c5b0f0726d10a16c8315f06f900bfb")); |
| when(revisionDataWithParents.getParentObjetIds()).thenReturn(revisionDataParentObjectIds); |
| |
| when(fetchClientFactory.create(any())).thenReturn(fetchRestApiClient); |
| lenient() |
| .when(fetchRestApiClient.callSendObject(any(), anyString(), anyBoolean(), any(), any())) |
| .thenReturn(httpResult); |
| lenient() |
| .when(fetchRestApiClient.callSendObjects(any(), anyString(), any(), any())) |
| .thenReturn(httpResult); |
| when(fetchRestApiClient.callFetch(any(), anyString(), any())).thenReturn(fetchHttpResult); |
| when(fetchRestApiClient.initProject(any(), any())).thenReturn(successfulHttpResult); |
| when(successfulHttpResult.isSuccessful()).thenReturn(true); |
| when(httpResult.isSuccessful()).thenReturn(true); |
| when(fetchHttpResult.isSuccessful()).thenReturn(true); |
| when(httpResult.isProjectMissing(any())).thenReturn(false); |
| |
| applyObjectMetrics = new ApplyObjectMetrics("pull-replication", new DisabledMetricMaker()); |
| fetchMetrics = new FetchReplicationMetrics("pull-replication", new DisabledMetricMaker()); |
| |
| objectUnderTest = |
| new ReplicationQueue( |
| wq, |
| rd, |
| dis, |
| sl, |
| fetchClientFactory, |
| refsFilter, |
| () -> revReader, |
| applyObjectMetrics, |
| fetchMetrics); |
| } |
| |
| @Test |
| public void shouldCallSendObjectWhenMetaRef() throws ClientProtocolException, IOException { |
| Event event = new TestEvent("refs/changes/01/1/meta"); |
| objectUnderTest.start(); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).callSendObjects(any(), anyString(), any(), any()); |
| } |
| |
| @Test |
| public void shouldCallInitProjectWhenProjectIsMissing() throws IOException { |
| Event event = new TestEvent("refs/changes/01/1/meta"); |
| when(httpResult.isSuccessful()).thenReturn(false); |
| when(httpResult.isProjectMissing(any())).thenReturn(true); |
| when(source.isCreateMissingRepositories()).thenReturn(true); |
| |
| objectUnderTest.start(); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).initProject(any(), any()); |
| } |
| |
| @Test |
| public void shouldNotCallInitProjectWhenReplicateNewRepositoriesNotSet() throws IOException { |
| Event event = new TestEvent("refs/changes/01/1/meta"); |
| when(httpResult.isSuccessful()).thenReturn(false); |
| when(httpResult.isProjectMissing(any())).thenReturn(true); |
| when(source.isCreateMissingRepositories()).thenReturn(false); |
| |
| objectUnderTest.start(); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient, never()).initProject(any(), any()); |
| } |
| |
| @Test |
| public void shouldCallSendObjectWhenPatchSetRef() throws ClientProtocolException, IOException { |
| Event event = new TestEvent("refs/changes/01/1/1"); |
| objectUnderTest.start(); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).callSendObjects(any(), anyString(), any(), any()); |
| } |
| |
| @Test |
| public void shouldFallbackToCallFetchWhenIOException() |
| throws ClientProtocolException, IOException, LargeObjectException, RefUpdateException { |
| Event event = new TestEvent("refs/changes/01/1/meta"); |
| objectUnderTest.start(); |
| |
| when(revReader.read(any(), any(), anyString(), anyInt())).thenThrow(IOException.class); |
| |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).callFetch(any(), anyString(), any()); |
| } |
| |
| @Test |
| public void shouldFallbackToCallFetchWhenLargeRef() |
| throws ClientProtocolException, IOException, LargeObjectException, RefUpdateException { |
| Event event = new TestEvent("refs/changes/01/1/1"); |
| objectUnderTest.start(); |
| |
| when(revReader.read(any(), any(), anyString(), anyInt())).thenReturn(Optional.empty()); |
| |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).callFetch(any(), anyString(), any()); |
| } |
| |
| @Test |
| public void shouldFallbackToCallFetchWhenParentObjectIsMissing() |
| throws ClientProtocolException, IOException { |
| Event event = new TestEvent("refs/changes/01/1/1"); |
| objectUnderTest.start(); |
| |
| when(httpResult.isSuccessful()).thenReturn(false); |
| when(httpResult.isParentObjectMissing()).thenReturn(true); |
| when(fetchRestApiClient.callSendObjects(any(), anyString(), any(), any())) |
| .thenReturn(httpResult); |
| |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient).callFetch(any(), anyString(), any()); |
| } |
| |
| @Test |
| public void shouldFallbackToApplyAllParentObjectsWhenParentObjectIsMissingOnMetaRef() |
| throws ClientProtocolException, IOException { |
| Event event = new TestEvent("refs/changes/01/1/meta"); |
| objectUnderTest.start(); |
| |
| when(httpResult.isSuccessful()).thenReturn(false, true); |
| when(httpResult.isParentObjectMissing()).thenReturn(true, false); |
| when(fetchRestApiClient.callSendObjects(any(), anyString(), any(), any())) |
| .thenReturn(httpResult); |
| |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verify(fetchRestApiClient, times(2)) |
| .callSendObjects(any(), anyString(), revisionsDataCaptor.capture(), any()); |
| List<List<RevisionData>> revisionsDataValues = revisionsDataCaptor.getAllValues(); |
| assertThat(revisionsDataValues).hasSize(2); |
| |
| List<RevisionData> firstRevisionsValues = revisionsDataValues.get(0); |
| assertThat(firstRevisionsValues).hasSize(1); |
| assertThat(firstRevisionsValues).contains(revisionData); |
| |
| List<RevisionData> secondRevisionsValues = revisionsDataValues.get(1); |
| assertThat(secondRevisionsValues).hasSize(1 + revisionDataParentObjectIds.size()); |
| } |
| |
| @Test |
| public void shouldSkipEventWhenMultiSiteVersionRef() throws IOException { |
| FileBasedConfig fileConfig = |
| new FileBasedConfig(sitePaths.etc_dir.resolve("replication.config").toFile(), FS.DETECTED); |
| fileConfig.setString("replication", null, "excludeRefs", "refs/multi-site/version"); |
| fileConfig.save(); |
| ReplicationConfig replicationConfig = new ReplicationFileBasedConfig(sitePaths, pluginDataPath); |
| refsFilter = new ExcludedRefsFilter(replicationConfig); |
| |
| objectUnderTest = |
| new ReplicationQueue( |
| wq, |
| rd, |
| dis, |
| sl, |
| fetchClientFactory, |
| refsFilter, |
| () -> revReader, |
| applyObjectMetrics, |
| fetchMetrics); |
| Event event = new TestEvent("refs/multi-site/version"); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verifyZeroInteractions(wq, rd, dis, sl, fetchClientFactory, accountInfo); |
| } |
| |
| @Test |
| public void shouldSkipEventWhenStarredChangesRef() { |
| Event event = new TestEvent("refs/starred-changes/41/2941/1000000"); |
| objectUnderTest.onGitReferenceUpdated(event); |
| |
| verifyZeroInteractions(wq, rd, dis, sl, fetchClientFactory, accountInfo); |
| } |
| |
| @Test |
| public void shouldCallDeleteWhenReplicateProjectDeletionsTrue() throws IOException { |
| when(source.wouldDeleteProject(any())).thenReturn(true); |
| |
| String projectName = "testProject"; |
| FakeProjectDeletedEvent event = new FakeProjectDeletedEvent(projectName); |
| |
| objectUnderTest.start(); |
| objectUnderTest.onProjectDeleted(event); |
| |
| verify(source, times(1)) |
| .scheduleDeleteProject(stringCaptor.capture(), projectNameKeyCaptor.capture()); |
| assertThat(stringCaptor.getValue()).isEqualTo(source.getApis().get(0)); |
| assertThat(projectNameKeyCaptor.getValue()).isEqualTo(Project.NameKey.parse(projectName)); |
| } |
| |
| @Test |
| public void shouldNotCallDeleteWhenProjectNotToDelete() throws IOException { |
| when(source.wouldDeleteProject(any())).thenReturn(false); |
| |
| FakeProjectDeletedEvent event = new FakeProjectDeletedEvent("testProject"); |
| |
| objectUnderTest.start(); |
| objectUnderTest.onProjectDeleted(event); |
| |
| verify(source, never()).scheduleDeleteProject(any(), any()); |
| } |
| |
| @Test |
| public void shouldScheduleUpdateHeadWhenWouldFetchProject() throws IOException { |
| when(source.wouldFetchProject(any())).thenReturn(true); |
| |
| String projectName = "aProject"; |
| String newHEAD = "newHEAD"; |
| |
| objectUnderTest.start(); |
| objectUnderTest.onHeadUpdated(new FakeHeadUpdateEvent("oldHead", newHEAD, projectName)); |
| verify(source, times(1)) |
| .scheduleUpdateHead(any(), projectNameKeyCaptor.capture(), stringCaptor.capture()); |
| |
| assertThat(stringCaptor.getValue()).isEqualTo(newHEAD); |
| assertThat(projectNameKeyCaptor.getValue()).isEqualTo(Project.NameKey.parse(projectName)); |
| } |
| |
| @Test |
| public void shouldNotScheduleUpdateHeadWhenNotWouldFetchProject() throws IOException { |
| when(source.wouldFetchProject(any())).thenReturn(false); |
| |
| String projectName = "aProject"; |
| String newHEAD = "newHEAD"; |
| |
| objectUnderTest.start(); |
| objectUnderTest.onHeadUpdated(new FakeHeadUpdateEvent("oldHead", newHEAD, projectName)); |
| verify(source, never()).scheduleUpdateHead(any(), any(), any()); |
| } |
| |
| protected static Path createTempPath(String prefix) throws IOException { |
| return createTempDirectory(prefix); |
| } |
| |
| private class TestEvent implements GitReferenceUpdatedListener.Event { |
| private String refName; |
| private String projectName; |
| private ObjectId newObjectId; |
| |
| public TestEvent(String refName) { |
| this(refName, "defaultProject", ObjectId.zeroId()); |
| } |
| |
| public TestEvent(String refName, String projectName, ObjectId newObjectId) { |
| this.refName = refName; |
| this.projectName = projectName; |
| this.newObjectId = newObjectId; |
| } |
| |
| @Override |
| public String getRefName() { |
| return refName; |
| } |
| |
| @Override |
| public String getProjectName() { |
| return projectName; |
| } |
| |
| @Override |
| public NotifyHandling getNotify() { |
| return null; |
| } |
| |
| @Override |
| public String getOldObjectId() { |
| return ObjectId.zeroId().getName(); |
| } |
| |
| @Override |
| public String getNewObjectId() { |
| return newObjectId.getName(); |
| } |
| |
| @Override |
| public boolean isCreate() { |
| return false; |
| } |
| |
| @Override |
| public boolean isDelete() { |
| return false; |
| } |
| |
| @Override |
| public boolean isNonFastForward() { |
| return false; |
| } |
| |
| @Override |
| public AccountInfo getUpdater() { |
| return null; |
| } |
| } |
| |
| private class FakeProjectDeletedEvent implements ProjectDeletedListener.Event { |
| private String projectName; |
| |
| public FakeProjectDeletedEvent(String projectName) { |
| this.projectName = projectName; |
| } |
| |
| @Override |
| public NotifyHandling getNotify() { |
| return null; |
| } |
| |
| @Override |
| public String getProjectName() { |
| return projectName; |
| } |
| } |
| } |