solr/solrj/src/test/org/apache/solr/client/ref_guide_examples/ZkConfigFilesTest.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.solr.client.ref_guide_examples;

import java.io.File;
import java.nio.file.Paths;
import java.util.List;

import org.apache.solr.cloud.SolrCloudTestCase;
import org.apache.solr.common.cloud.SolrZkClient;
import org.apache.solr.common.cloud.ZkConfigManager;
import org.apache.solr.util.ExternalPaths;
import org.junit.After;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

/**
 * Examples showing how to manipulate configsets in ZK.
 *
 * Snippets surrounded by "tag" and "end" comments are extracted and used in the Solr Reference Guide.
 */
public class ZkConfigFilesTest extends SolrCloudTestCase {

  private static final int ZK_TIMEOUT_MILLIS = 10000;

  @BeforeClass
  public static void setUpCluster() throws Exception {
    configureCluster(1)
        .configure();
  }

  @Before
  public void clearConfigsBefore() throws Exception {
    clearConfigs();
  }

  @After
  public void clearConfigsAfter() throws Exception {
    clearConfigs();
  }

  private void clearConfigs() throws Exception {
    ZkConfigManager manager = new ZkConfigManager(cluster.getZkClient());
    List<String> configs = manager.listConfigs();
    for (String config : configs) {
      manager.deleteConfigDir(config);
    }
  }

  @Test
  public void testCanUploadConfigToZk() throws Exception {
    final String zkConnectionString = cluster.getZkClient().getZkServerAddress();
    final String localConfigSetDirectory = new File(ExternalPaths.TECHPRODUCTS_CONFIGSET).getAbsolutePath();

    assertConfigsContainOnly();

    // tag::zk-configset-upload[]
    try (SolrZkClient zkClient = new SolrZkClient(zkConnectionString, ZK_TIMEOUT_MILLIS)) {
      ZkConfigManager manager = new ZkConfigManager(zkClient);
      manager.uploadConfigDir(Paths.get(localConfigSetDirectory), "nameForConfigset");
    }
    // end::zk-configset-upload[]

    assertConfigsContainOnly("nameForConfigset");
  }

  private void assertConfigsContainOnly(String... expectedConfigs) throws Exception {
    final int expectedSize = expectedConfigs.length;

    ZkConfigManager manager = new ZkConfigManager(cluster.getZkClient());
    List<String> actualConfigs = manager.listConfigs();

    assertEquals(expectedSize, actualConfigs.size());
    for (String expectedConfig : expectedConfigs) {
      assertTrue("Expected ZK to contain " + expectedConfig + ", but it didn't.  Actual configs: ", actualConfigs.contains(expectedConfig));
    }
  }
}