geode-gfsh/src/distributedTest/java/org/apache/geode/management/internal/cli/commands/ExportClusterConfigurationCommandDUnitTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.management.internal.cli.commands;

import static org.apache.geode.distributed.internal.DistributionConfig.GROUPS_NAME;
import static org.apache.geode.management.internal.i18n.CliStrings.EXPORT_SHARED_CONFIG;
import static org.assertj.core.api.Assertions.assertThat;

import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.HashSet;
import java.util.Properties;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;

import org.apache.commons.io.FileUtils;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;

import org.apache.geode.management.internal.configuration.ClusterConfig;
import org.apache.geode.management.internal.configuration.ConfigGroup;
import org.apache.geode.test.dunit.rules.ClusterStartupRule;
import org.apache.geode.test.dunit.rules.MemberVM;
import org.apache.geode.test.junit.rules.GfshCommandRule;

public class ExportClusterConfigurationCommandDUnitTest {
  @ClassRule
  public static ClusterStartupRule cluster = new ClusterStartupRule();

  @ClassRule
  public static GfshCommandRule gfsh = new GfshCommandRule();

  @ClassRule
  public static TemporaryFolder tempFolder = new TemporaryFolder();


  private static File xmlFile;
  private static MemberVM locator, server;

  @BeforeClass
  public static void beforeClass() throws Exception {
    xmlFile = tempFolder.newFile("my.xml");
    locator = cluster.startLocatorVM(0);
    Properties properties = new Properties();
    properties.setProperty(GROUPS_NAME, "groupB");
    server = cluster.startServerVM(1, properties, locator.getPort());
    gfsh.connectAndVerify(locator);
    gfsh.executeAndAssertThat("create region --name=regionA --type=REPLICATE").statusIsSuccess();
    gfsh.executeAndAssertThat("create region --name=regionB --type=REPLICATE --group=groupB")
        .statusIsSuccess();
  }

  @Test
  public void getClusterConfig() {
    gfsh.executeAndAssertThat(EXPORT_SHARED_CONFIG).statusIsSuccess()
        .containsOutput("<region name=\"regionA\"").containsOutput("cluster.xml")
        .doesNotContainOutput("<region name=\"regionB\"");
  }


  @Test
  public void getClusterConfigInGroup() {
    gfsh.executeAndAssertThat(EXPORT_SHARED_CONFIG + " --group=groupB")
        .containsOutput("<region name=\"regionB\"")
        .doesNotContainOutput("<region name=\"regionA\"");
  }

  @Test
  public void getClusterConfigWithFile() throws IOException {
    gfsh.executeAndAssertThat(EXPORT_SHARED_CONFIG + " --xml-file=" + xmlFile.getAbsolutePath())
        .statusIsSuccess().containsOutput("cluster.xml")
        .containsOutput("xml content exported to " + xmlFile.getAbsolutePath());

    assertThat(xmlFile).exists();
    String content = FileUtils.readFileToString(xmlFile, Charset.defaultCharset());
    assertThat(content).startsWith("<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>")
        .contains("<region name=\"regionA\"");
  }

  @Test
  public void testExportWithAbsolutePath() throws Exception {
    Path exportedZipPath =
        tempFolder.getRoot().toPath().resolve("exportedCC.zip").toAbsolutePath();

    testExportClusterConfig(exportedZipPath.toString());
  }

  @Test
  public void testExportWithRelativePath() throws Exception {
    testExportClusterConfig("mytemp/exportedCC.zip");
    FileUtils.deleteQuietly(new File("mytemp"));
  }

  @Test
  public void testExportWithOnlyFileName() throws Exception {
    testExportClusterConfig("exportedCC.zip");
    FileUtils.deleteQuietly(new File("exportedCC.zip"));
  }

  public void testExportClusterConfig(String zipFilePath) throws Exception {
    ConfigGroup cluster = new ConfigGroup("cluster").regions("regionA");
    ConfigGroup groupB = new ConfigGroup("groupB").regions("regionB");
    ClusterConfig expectedClusterConfig = new ClusterConfig(cluster, groupB);
    expectedClusterConfig.verify(locator);
    expectedClusterConfig.verify(server);

    String expectedFilePath = new File(zipFilePath).getAbsolutePath();
    gfsh.executeAndAssertThat("export cluster-configuration --zip-file-name=" + zipFilePath)
        .statusIsSuccess()
        .containsOutput("File saved to " + expectedFilePath);

    File exportedZip = new File(zipFilePath);
    assertThat(exportedZip).exists();

    Set<String> actualZipEnries =
        new ZipFile(exportedZip).stream().map(ZipEntry::getName).collect(Collectors.toSet());

    ConfigGroup exportedClusterGroup = cluster.configFiles("cluster.xml", "cluster.properties");
    ConfigGroup exportedGroupB = groupB.configFiles("groupB.xml", "groupB.properties");
    ClusterConfig expectedExportedClusterConfig =
        new ClusterConfig(exportedClusterGroup, exportedGroupB);

    Set<String> expectedZipEntries = new HashSet<>();
    for (ConfigGroup group : expectedExportedClusterConfig.getGroups()) {
      String groupDir = group.getName() + File.separator;

      for (String jarOrXmlOrPropFile : group.getAllFiles()) {
        expectedZipEntries.add(groupDir + jarOrXmlOrPropFile);
      }
    }

    assertThat(actualZipEnries).isEqualTo(expectedZipEntries);
  }

}