src/test/java/com/googlesource/gerrit/plugins/replication/FanoutReplicationConfigTest.java

// 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;

import static com.google.common.io.RecursiveDeleteOption.ALLOW_INSECURE;
import static com.google.common.truth.Truth.assertThat;

import com.google.common.io.MoreFiles;
import com.googlesource.gerrit.plugins.replication.ReplicationConfig.FilterType;
import java.io.IOException;
import java.util.List;
import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.storage.file.FileBasedConfig;
import org.eclipse.jgit.util.FS;
import org.junit.Before;
import org.junit.Test;

public class FanoutReplicationConfigTest extends AbstractConfigTest {

  public FanoutReplicationConfigTest() throws IOException {
    super();
  }

  String remoteName1 = "foo";
  String remoteUrl1 = "ssh://git@git.somewhere.com/${name}";
  String remoteName2 = "bar";
  String remoteUrl2 = "ssh://git@git.elsewhere.com/${name}";

  @Before
  public void setupTests() {
    FileBasedConfig config = newReplicationConfig();
    try {
      config.save();
    } catch (IOException e) {
      throw new RuntimeException(e);
    }
  }

  @Test
  public void shouldSkipRemoteConfigFromReplicationConfig() throws Exception {
    String remoteName = "foo";
    String remoteUrl = "ssh://git@git.somewhere.com/${name}";

    FileBasedConfig config = newReplicationConfig();
    config.setString("remote", remoteName, "url", remoteUrl);
    config.save();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(1);

    assertThatIsDestination(destinations.get(0), remoteName2, remoteUrl2);
  }

  @Test
  public void shouldLoadDestinationsFromMultipleFiles() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(2);

    assertThatContainsDestination(destinations, remoteName1, remoteUrl1);
    assertThatContainsDestination(destinations, remoteName2, remoteUrl2);
  }

  @Test
  public void shouldIgnoreDestinationsFromSubdirectories() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config = newRemoteConfig("subdirectory/" + remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(1);

    assertThatIsDestination(destinations.get(0), remoteName1, remoteUrl1);
  }

  @Test
  public void shouldIgnoreNonConfigFiles() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config =
        new FileBasedConfig(
            sitePaths.etc_dir.resolve("replication/" + remoteName2 + ".yaml").toFile(),
            FS.DETECTED);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(1);

    assertThatIsDestination(destinations.get(0), remoteName1, remoteUrl1);
  }

  @Test(expected = ConfigInvalidException.class)
  public void shouldThrowConfigInvalidExceptionWhenUrlIsMissingName() throws Exception {
    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", "ssh://git@git.elsewhere.com/name");
    config.save();

    newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
  }

  @Test
  public void shouldIgnoreEmptyConfigFile() throws Exception {
    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(0);
  }

  @Test
  public void shouldIgnoreConfigWhenMoreThanOneRemoteInASingleFile() throws Exception {
    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.setString("remote", remoteName2, "url", remoteUrl2);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(0);
  }

  @Test
  public void shouldIgnoreConfigRemoteSection() throws Exception {
    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("replication", null, "url", remoteUrl1);
    config.save();

    DestinationsCollection destinationsCollections =
        newDestinationsCollections(new FanoutReplicationConfig(sitePaths, pluginDataPath));
    List<Destination> destinations = destinationsCollections.getAll(FilterType.ALL);
    assertThat(destinations).hasSize(0);
  }

  @Test
  public void shouldReturnSameVersionWhenNoChanges() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    FanoutReplicationConfig objectUnderTest =
        new FanoutReplicationConfig(sitePaths, pluginDataPath);

    String version = objectUnderTest.getVersion();

    objectUnderTest = new FanoutReplicationConfig(sitePaths, pluginDataPath);

    assertThat(objectUnderTest.getVersion()).isEqualTo(version);
  }

  @Test
  public void shouldReturnNewVersionWhenConfigFileAdded() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    FanoutReplicationConfig objectUnderTest =
        new FanoutReplicationConfig(sitePaths, pluginDataPath);

    String version = objectUnderTest.getVersion();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    assertThat(objectUnderTest.getVersion()).isNotEqualTo(version);
  }

  @Test
  public void shouldReturnNewVersionWhenConfigFileIsModified() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    FanoutReplicationConfig objectUnderTest =
        new FanoutReplicationConfig(sitePaths, pluginDataPath);

    String version = objectUnderTest.getVersion();

    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    assertThat(objectUnderTest.getVersion()).isNotEqualTo(version);
  }

  @Test
  public void shouldReturnNewVersionWhenConfigFileRemoved() throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    FanoutReplicationConfig objectUnderTest =
        new FanoutReplicationConfig(sitePaths, pluginDataPath);

    String version = objectUnderTest.getVersion();
    assertThat(
            sitePaths.etc_dir.resolve("replication/" + remoteName2 + ".config").toFile().delete())
        .isTrue();

    assertThat(objectUnderTest.getVersion()).isNotEqualTo(version);
  }

  @Test
  public void shouldReturnReplicationConfigVersionWhenReplicationConfigDirectoryRemoved()
      throws Exception {

    FileBasedConfig config = newRemoteConfig(remoteName1);
    config.setString("remote", null, "url", remoteUrl1);
    config.save();

    config = newRemoteConfig(remoteName2);
    config.setString("remote", null, "url", remoteUrl2);
    config.save();

    FanoutReplicationConfig objectUnderTest =
        new FanoutReplicationConfig(sitePaths, pluginDataPath);

    String replicationConfigVersion =
        new ReplicationFileBasedConfig(sitePaths, pluginDataPath).getVersion();

    MoreFiles.deleteRecursively(sitePaths.etc_dir.resolve("replication"), ALLOW_INSECURE);

    assertThat(objectUnderTest.getVersion()).isEqualTo(replicationConfigVersion);
  }

  protected FileBasedConfig newRemoteConfig(String configFileName) {
    return new FileBasedConfig(
        sitePaths.etc_dir.resolve("replication/" + configFileName + ".config").toFile(),
        FS.DETECTED);
  }
}