Rename var names and add a test

apache · Apr 3, 2020 · e2d7c4b · e2d7c4b
1 parent fa97765
commit e2d7c4b
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 18 deletions.
diff --git a/conf/broker.conf b/conf/broker.conf
@@ -473,7 +473,8 @@ httpMaxRequestSize=-1
 
 # Metadata service uri that bookkeeper is used for loading corresponding metadata driver
 # and resolving its metadata service location.
-bookkeeperServiceUri=
+# For example: zk+hierarchical://localhost:2181/ledgers
+bookkeeperMetadataServiceUri=
 
 # Authentication plugin to use when connecting to bookies
 bookkeeperClientAuthenticationPlugin=

diff --git a/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java b/pulsar-broker-common/src/main/java/org/apache/pulsar/broker/ServiceConfiguration.java
@@ -810,7 +810,7 @@ public class ServiceConfiguration implements PulsarConfiguration {
         doc = "Metadata service uri that bookkeeper is used for loading corresponding metadata driver"
             + " and resolving its metadata service location"
     )
-    private String bookkeeperServiceUri;
+    private String bookkeeperMetadataServiceUri;
     @FieldContext(
         category = CATEGORY_STORAGE_BK,
         doc = "Authentication plugin to use when connecting to bookies"

diff --git a/pulsar-broker/src/main/java/org/apache/pulsar/broker/BookKeeperClientFactoryImpl.java b/pulsar-broker/src/main/java/org/apache/pulsar/broker/BookKeeperClientFactoryImpl.java
@@ -106,8 +106,8 @@ ClientConfiguration createBkClientConfiguration(ServiceConfiguration conf) {
         bkConf.setNettyMaxFrameSizeBytes(conf.getMaxMessageSize() + Commands.MESSAGE_SIZE_FRAME_PADDING);
         bkConf.setDiskWeightBasedPlacementEnabled(conf.isBookkeeperDiskWeightBasedPlacementEnabled());
 
-        if (StringUtils.isNotBlank(conf.getBookkeeperServiceUri())) {
-            bkConf.setMetadataServiceUri(conf.getBookkeeperServiceUri());
+        if (StringUtils.isNotBlank(conf.getBookkeeperMetadataServiceUri())) {
+            bkConf.setMetadataServiceUri(conf.getBookkeeperMetadataServiceUri());
         } else {
             String metadataServiceUri = PulsarService.bookieMetadataServiceUri(conf);
             bkConf.setMetadataServiceUri(metadataServiceUri);

diff --git a/pulsar-broker/src/main/java/org/apache/pulsar/broker/PulsarService.java b/pulsar-broker/src/main/java/org/apache/pulsar/broker/PulsarService.java
@@ -733,8 +733,8 @@ public InternalConfigurationData getInternalConfigurationData() {
 
         String metadataServiceUri = getMetadataServiceUri();
 
-        if (StringUtils.isNotBlank(config.getBookkeeperServiceUri())) {
-            metadataServiceUri = this.getConfiguration().getBookkeeperServiceUri();
+        if (StringUtils.isNotBlank(config.getBookkeeperMetadataServiceUri())) {
+            metadataServiceUri = this.getConfiguration().getBookkeeperMetadataServiceUri();
         }
 
         return new InternalConfigurationData(
@@ -1205,7 +1205,7 @@ private void startWorkerService(AuthenticationService authenticationService,
                 dlogURI = WorkerUtils.initializeDlogNamespace(internalConf);
             } catch (IOException ioe) {
                 LOG.error("Failed to initialize dlog namespace with zookeeper {} at at metadata service uri {} for storing function packages",
-                    internalConf.getZookeeperServers(), internalConf.getMetadataServiceUri(), ioe);
+                    internalConf.getZookeeperServers(), internalConf.getBookkeeperMetadataServiceUri(), ioe);
                 throw ioe;
             }
             LOG.info("Function worker service setup completed");

diff --git a/pulsar-broker/src/test/java/org/apache/pulsar/broker/BookKeeperClientFactoryImplTest.java b/pulsar-broker/src/test/java/org/apache/pulsar/broker/BookKeeperClientFactoryImplTest.java
@@ -28,10 +28,12 @@
 import static org.testng.Assert.assertFalse;
 import static org.testng.Assert.assertNull;
 import static org.testng.Assert.assertTrue;
+import static org.testng.Assert.fail;
 
 import java.util.concurrent.atomic.AtomicReference;
 import org.apache.bookkeeper.conf.ClientConfiguration;
 import org.apache.bookkeeper.net.CachedDNSToSwitchMapping;
+import org.apache.commons.configuration.ConfigurationException;
 import org.apache.pulsar.zookeeper.ZkBookieRackAffinityMapping;
 import org.apache.pulsar.zookeeper.ZooKeeperCache;
 import org.apache.zookeeper.ZooKeeper;
@@ -170,4 +172,21 @@ public void testSetExplicitLacInterval() {
         assertEquals(factory.createBkClientConfiguration(conf).getExplictLacInterval(), 5);
     }
 
+    @Test
+    public void testSetMetadataServiceUri() {
+        BookKeeperClientFactoryImpl factory = new BookKeeperClientFactoryImpl();
+        ServiceConfiguration conf = new ServiceConfiguration();
+        conf.setZookeeperServers("localhost:2181");
+        try {
+            String defaultUri = "zk+null://localhost:2181/ledgers";
+            assertEquals(factory.createBkClientConfiguration(conf).getMetadataServiceUri(), defaultUri);
+            String expectedUri = "zk+hierarchical://localhost:2181/chroot/ledgers";
+            conf.setBookkeeperMetadataServiceUri(expectedUri);
+            assertEquals(factory.createBkClientConfiguration(conf).getMetadataServiceUri(), expectedUri);
+        } catch (ConfigurationException e) {
+            e.printStackTrace();
+            fail("Get metadata service uri should be successful", e);
+        }
+    }
+
 }
diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/conf/InternalConfigurationData.java b/pulsar-common/src/main/java/org/apache/pulsar/common/conf/InternalConfigurationData.java
@@ -28,19 +28,19 @@ public class InternalConfigurationData {
 
     private String zookeeperServers;
     private String configurationStoreServers;
-    private String metadataServiceUri;
+    private String bookkeeperMetadataServiceUri;
     private String stateStorageServiceUrl;
 
     public InternalConfigurationData() {
     }
 
     public InternalConfigurationData(String zookeeperServers,
                                      String configurationStoreServers,
-                                     String metadataServiceUri,
+                                     String bookkeeperMetadataServiceUri,
                                      String stateStorageServiceUrl) {
         this.zookeeperServers = zookeeperServers;
         this.configurationStoreServers = configurationStoreServers;
-        this.metadataServiceUri = metadataServiceUri;
+        this.bookkeeperMetadataServiceUri = bookkeeperMetadataServiceUri;
         this.stateStorageServiceUrl = stateStorageServiceUrl;
     }
 
@@ -52,8 +52,8 @@ public String getConfigurationStoreServers() {
         return configurationStoreServers;
     }
 
-    public String getMetadataServiceUri() {
-        return metadataServiceUri;
+    public String getBookkeeperMetadataServiceUri() {
+        return bookkeeperMetadataServiceUri;
     }
 
     public String getStateStorageServiceUrl() {
@@ -68,21 +68,21 @@ public boolean equals(Object obj) {
         InternalConfigurationData other = (InternalConfigurationData) obj;
         return Objects.equals(zookeeperServers, other.zookeeperServers)
             && Objects.equals(configurationStoreServers, other.configurationStoreServers)
-            && Objects.equals(metadataServiceUri, other.metadataServiceUri)
+            && Objects.equals(bookkeeperMetadataServiceUri, other.bookkeeperMetadataServiceUri)
             && Objects.equals(stateStorageServiceUrl, other.stateStorageServiceUrl);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(zookeeperServers, configurationStoreServers, metadataServiceUri, stateStorageServiceUrl);
+        return Objects.hash(zookeeperServers, configurationStoreServers, bookkeeperMetadataServiceUri, stateStorageServiceUrl);
     }
 
     @Override
     public String toString() {
         return MoreObjects.toStringHelper(this)
             .add("zookeeperServers", zookeeperServers)
             .add("configurationStoreServers", configurationStoreServers)
-            .add("metadataServiceUri", metadataServiceUri)
+            .add("bookkeeperMetadataServiceUri", bookkeeperMetadataServiceUri)
             .add("stateStorageServiceUrl", stateStorageServiceUrl)
             .toString();
     }

diff --git a/pulsar-functions/worker/src/main/java/org/apache/pulsar/functions/worker/Worker.java b/pulsar-functions/worker/src/main/java/org/apache/pulsar/functions/worker/Worker.java
@@ -146,7 +146,7 @@ private static URI initialize(WorkerConfig workerConfig)
             return WorkerUtils.initializeDlogNamespace(internalConf);
         } catch (IOException ioe) {
             log.error("Failed to initialize dlog namespace with zookeeper {} at metadata service uri {} for storing function packages",
-                internalConf.getZookeeperServers(), internalConf.getMetadataServiceUri(), ioe);
+                internalConf.getZookeeperServers(), internalConf.getBookkeeperMetadataServiceUri(), ioe);
             throw ioe;
         }
     }

diff --git a/pulsar-functions/worker/src/main/java/org/apache/pulsar/functions/worker/WorkerUtils.java b/pulsar-functions/worker/src/main/java/org/apache/pulsar/functions/worker/WorkerUtils.java
@@ -149,7 +149,7 @@ public static DistributedLogConfiguration getDlogConf(WorkerConfig workerConfig)
 
     public static URI initializeDlogNamespace(InternalConfigurationData internalConf) throws IOException {
         String zookeeperServers = internalConf.getZookeeperServers();
-        URI metadataServiceUri = URI.create(internalConf.getMetadataServiceUri());
+        URI metadataServiceUri = URI.create(internalConf.getBookkeeperMetadataServiceUri());
         String ledgersStoreServers = metadataServiceUri.getAuthority().replace(";", ",");
         String ledgersRootPath = metadataServiceUri.getPath();
         BKDLConfig dlConfig = new BKDLConfig(ledgersStoreServers, ledgersRootPath);

diff --git a/site2/docs/reference-configuration.md b/site2/docs/reference-configuration.md
@@ -168,7 +168,7 @@ Pulsar brokers are responsible for handling incoming messages from producers, di
 |brokerClientAuthenticationParameters|||
 |athenzDomainNames| Supported Athenz provider domain names(comma separated) for authentication  ||
 |exposePreciseBacklogInPrometheus| Enable expose the precise backlog stats, set false to use published counter and consumed counter to calculate, this would be more efficient but may be inaccurate. |false|
-|bookkeeperServiceUri|  Metadata service uri that bookkeeper is used for loading corresponding metadata driver and resolving its metadata service location ||
+|bookkeeperMetadataServiceUri| Metadata service uri that bookkeeper is used for loading corresponding metadata driver and resolving its metadata service location. For example: zk+hierarchical://localhost:2181/ledgers ||
 |bookkeeperClientAuthenticationPlugin|  Authentication plugin to use when connecting to bookies ||
 |bookkeeperClientAuthenticationParametersName|  BookKeeper auth plugin implementatation specifics parameters name and values  ||
 |bookkeeperClientAuthenticationParameters|||