Java: rename CreateClient to createClient (#1828)

* Java: rename CreateClient to createClient Signed-off-by: Andrew Carbonetto <[email protected]> --------- Signed-off-by: Andrew Carbonetto <[email protected]> Co-authored-by: Andrew Carbonetto <[email protected]>
valkey-io · Jul 6, 2024 · ebdd8b5 · ebdd8b5
1 parent 95172c7
commit ebdd8b5
Show file tree

Hide file tree

Showing 19 changed files with 89 additions and 90 deletions.
diff --git a/java/benchmarks/src/main/java/glide/benchmarks/clients/glide/GlideAsyncClient.java b/java/benchmarks/src/main/java/glide/benchmarks/clients/glide/GlideAsyncClient.java
@@ -33,7 +33,7 @@ public void connectToRedis(ConnectionSettings connectionSettings) {
                             .useTLS(connectionSettings.useSsl)
                             .build();
             try {
-                redisClient = RedisClusterClient.CreateClient(config).get(10, SECONDS);
+                redisClient = RedisClusterClient.createClient(config).get(10, SECONDS);
             } catch (InterruptedException | ExecutionException | TimeoutException e) {
                 throw new RuntimeException(e);
             }
@@ -50,7 +50,7 @@ public void connectToRedis(ConnectionSettings connectionSettings) {
                             .build();
 
             try {
-                redisClient = RedisClient.CreateClient(config).get(10, SECONDS);
+                redisClient = RedisClient.createClient(config).get(10, SECONDS);
             } catch (InterruptedException | ExecutionException | TimeoutException e) {
                 throw new RuntimeException(e);
             }

diff --git a/java/client/src/main/java/glide/api/BaseClient.java b/java/client/src/main/java/glide/api/BaseClient.java
@@ -341,7 +341,7 @@ protected static class ClientBuilder {
      * @param <T> Client type.
      * @return a Future to connect and return a RedisClient.
      */
-    protected static <T extends BaseClient> CompletableFuture<T> CreateClient(
+    protected static <T extends BaseClient> CompletableFuture<T> createClient(
             @NonNull BaseClientConfiguration config, Function<ClientBuilder, T> constructor) {
         try {
             ThreadPoolResource threadPoolResource = config.getThreadPoolResource();

diff --git a/java/client/src/main/java/glide/api/RedisClient.java b/java/client/src/main/java/glide/api/RedisClient.java
@@ -65,7 +65,7 @@
 import org.apache.commons.lang3.ArrayUtils;
 
 /**
- * Async (non-blocking) client for Redis in Standalone mode. Use {@link #CreateClient} to request a
+ * Async (non-blocking) client for Redis in Standalone mode. Use {@link #createClient} to request a
  * client to Redis.
  */
 public class RedisClient extends BaseClient
@@ -76,7 +76,7 @@ public class RedisClient extends BaseClient
                 TransactionsCommands {
 
     /**
-     * A constructor. Use {@link #CreateClient} to get a client. Made protected to simplify testing.
+     * A constructor. Use {@link #createClient} to get a client. Made protected to simplify testing.
      */
     protected RedisClient(ClientBuilder builder) {
         super(builder);
@@ -88,9 +88,9 @@ protected RedisClient(ClientBuilder builder) {
      * @param config Redis client Configuration.
      * @return A Future to connect and return a RedisClient.
      */
-    public static CompletableFuture<RedisClient> CreateClient(
+    public static CompletableFuture<RedisClient> createClient(
             @NonNull RedisClientConfiguration config) {
-        return CreateClient(config, RedisClient::new);
+        return createClient(config, RedisClient::new);
     }
 
     @Override

diff --git a/java/client/src/main/java/glide/api/RedisClusterClient.java b/java/client/src/main/java/glide/api/RedisClusterClient.java
@@ -75,7 +75,7 @@
 import response.ResponseOuterClass.Response;
 
 /**
- * Async (non-blocking) client for Redis in Cluster mode. Use {@link #CreateClient} to request a
+ * Async (non-blocking) client for Redis in Cluster mode. Use {@link #createClient} to request a
  * client to Redis.
  */
 public class RedisClusterClient extends BaseClient
@@ -86,7 +86,7 @@ public class RedisClusterClient extends BaseClient
                 TransactionsClusterCommands,
                 PubSubClusterCommands {
 
-    /** A private constructor. Use {@link #CreateClient} to get a client. */
+    /** A private constructor. Use {@link #createClient} to get a client. */
     RedisClusterClient(ClientBuilder builder) {
         super(builder);
     }
@@ -97,9 +97,9 @@ public class RedisClusterClient extends BaseClient
      * @param config Redis cluster client Configuration.
      * @return A Future to connect and return a RedisClusterClient.
      */
-    public static CompletableFuture<RedisClusterClient> CreateClient(
+    public static CompletableFuture<RedisClusterClient> createClient(
             @NonNull RedisClusterClientConfiguration config) {
-        return CreateClient(config, RedisClusterClient::new);
+        return createClient(config, RedisClusterClient::new);
     }
 
     @Override

diff --git a/java/client/src/test/java/glide/api/RedisClientCreateTest.java b/java/client/src/test/java/glide/api/RedisClientCreateTest.java
@@ -3,9 +3,9 @@
 
 import static glide.api.BaseClient.buildChannelHandler;
 import static glide.api.BaseClient.buildMessageHandler;
-import static glide.api.RedisClient.CreateClient;
 import static glide.api.RedisClient.buildCommandManager;
 import static glide.api.RedisClient.buildConnectionManager;
+import static glide.api.RedisClient.createClient;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.any;
@@ -53,7 +53,7 @@ public void init() {
         mockedClient.when(() -> buildConnectionManager(channelHandler)).thenReturn(connectionManager);
         mockedClient.when(() -> buildCommandManager(channelHandler)).thenReturn(commandManager);
         mockedClient.when(() -> buildMessageHandler(any())).thenReturn(messageHandler);
-        mockedClient.when(() -> CreateClient(any(), any())).thenCallRealMethod();
+        mockedClient.when(() -> createClient(any(), any())).thenCallRealMethod();
 
         var threadPoolResource = ThreadPoolResourceAllocator.getOrCreate(() -> null);
         if (threadPoolResource != null) {
@@ -78,7 +78,7 @@ public void createClient_with_default_config_successfully_returns_RedisClient()
         when(connectionManager.connectToRedis(eq(config))).thenReturn(connectToRedisFuture);
 
         // exercise
-        CompletableFuture<RedisClient> result = CreateClient(config);
+        CompletableFuture<RedisClient> result = createClient(config);
         RedisClient client = result.get();
 
         // verify
@@ -98,7 +98,7 @@ public void createClient_with_custom_config_successfully_returns_RedisClient() {
         when(connectionManager.connectToRedis(eq(config))).thenReturn(connectToRedisFuture);
 
         // exercise
-        CompletableFuture<RedisClient> result = CreateClient(config);
+        CompletableFuture<RedisClient> result = createClient(config);
         RedisClient client = result.get();
 
         // verify
@@ -119,7 +119,7 @@ public void createClient_error_on_connection_throws_ExecutionException() {
         when(connectionManager.connectToRedis(eq(config))).thenReturn(connectToRedisFuture);
 
         // exercise
-        CompletableFuture<RedisClient> result = CreateClient(config);
+        CompletableFuture<RedisClient> result = createClient(config);
 
         ExecutionException executionException = assertThrows(ExecutionException.class, result::get);
 

diff --git a/java/examples/build.gradle b/java/examples/build.gradle
@@ -11,8 +11,7 @@ repositories {
 }
 
 dependencies {
-    implementation group: 'software.amazon.glide', name: 'glide-for-redis', version: '0.4.3', classifier: osdetector.classifier
-
+    implementation project(':client')
     implementation 'redis.clients:jedis:4.4.3'
     implementation 'io.lettuce:lettuce-core:6.2.6.RELEASE'
     implementation 'commons-cli:commons-cli:1.5.0'

diff --git a/java/examples/src/main/java/glide/examples/ExamplesApp.java b/java/examples/src/main/java/glide/examples/ExamplesApp.java
@@ -25,7 +25,7 @@ private static void runGlideExamples() {
                         .build();
 
         try {
-            RedisClient client = RedisClient.CreateClient(config).get();
+            RedisClient client = RedisClient.createClient(config).get();
 
             System.out.println("PING: " + client.ping().get());
             System.out.println("PING(found you): " + client.ping("found you").get());

diff --git a/java/integTest/src/test/java/glide/ConnectionTests.java b/java/integTest/src/test/java/glide/ConnectionTests.java
@@ -15,7 +15,7 @@ public class ConnectionTests {
     @SneakyThrows
     public void basic_client() {
         var regularClient =
-                RedisClient.CreateClient(
+                RedisClient.createClient(
                                 RedisClientConfiguration.builder()
                                         .address(
                                                 NodeAddress.builder().port(TestConfiguration.STANDALONE_PORTS[0]).build())
@@ -28,7 +28,7 @@ public void basic_client() {
     @SneakyThrows
     public void cluster_client() {
         var regularClient =
-                RedisClient.CreateClient(
+                RedisClient.createClient(
                                 RedisClientConfiguration.builder()
                                         .address(NodeAddress.builder().port(TestConfiguration.CLUSTER_PORTS[0]).build())
                                         .build())

diff --git a/java/integTest/src/test/java/glide/CustomThreadPoolResourceTest.java b/java/integTest/src/test/java/glide/CustomThreadPoolResourceTest.java
@@ -32,7 +32,7 @@ public void standalone_client_with_custom_threadPoolResource() {
         }
 
         var regularClient =
-                RedisClient.CreateClient(
+                RedisClient.createClient(
                                 RedisClientConfiguration.builder()
                                         .address(
                                                 NodeAddress.builder().port(TestConfiguration.STANDALONE_PORTS[0]).build())

diff --git a/java/integTest/src/test/java/glide/ErrorHandlingTests.java b/java/integTest/src/test/java/glide/ErrorHandlingTests.java
@@ -26,7 +26,7 @@ public void basic_client_tries_to_connect_to_wrong_address() {
                 assertThrows(
                         ExecutionException.class,
                         () ->
-                                RedisClient.CreateClient(
+                                RedisClient.createClient(
                                                 RedisClientConfiguration.builder()
                                                         .address(NodeAddress.builder().port(getFreePort()).build())
                                                         .build())
@@ -40,7 +40,7 @@ public void basic_client_tries_to_connect_to_wrong_address() {
     @SneakyThrows
     public void basic_client_tries_wrong_command() {
         try (var regularClient =
-                RedisClient.CreateClient(
+                RedisClient.createClient(
                                 RedisClientConfiguration.builder()
                                         .address(
                                                 NodeAddress.builder().port(TestConfiguration.STANDALONE_PORTS[0]).build())
@@ -60,7 +60,7 @@ public void basic_client_tries_wrong_command() {
     @SneakyThrows
     public void basic_client_tries_wrong_command_arguments() {
         try (var regularClient =
-                RedisClient.CreateClient(
+                RedisClient.createClient(
                                 RedisClientConfiguration.builder()
                                         .address(
                                                 NodeAddress.builder().port(TestConfiguration.STANDALONE_PORTS[0]).build())

diff --git a/java/integTest/src/test/java/glide/PubSubTests.java b/java/integTest/src/test/java/glide/PubSubTests.java
@@ -79,7 +79,7 @@ private <M extends ChannelMode> BaseClient createClientWithSubscriptions(
             if (callback.isPresent()) {
                 subConfigBuilder.callback(callback.get(), context.get());
             }
-            return RedisClient.CreateClient(
+            return RedisClient.createClient(
                             commonClientConfig()
                                     .requestTimeout(5000)
                                     .subscriptionConfiguration(subConfigBuilder.build())
@@ -94,7 +94,7 @@ private <M extends ChannelMode> BaseClient createClientWithSubscriptions(
                 subConfigBuilder.callback(callback.get(), context.get());
             }
 
-            return RedisClusterClient.CreateClient(
+            return RedisClusterClient.createClient(
                             commonClusterClientConfig()
                                     .requestTimeout(5000)
                                     .subscriptionConfiguration(subConfigBuilder.build())
@@ -112,9 +112,9 @@ private <M extends ChannelMode> BaseClient createClientWithSubscriptions(
     @SneakyThrows
     private BaseClient createClient(boolean standalone) {
         if (standalone) {
-            return RedisClient.CreateClient(commonClientConfig().build()).get();
+            return RedisClient.createClient(commonClientConfig().build()).get();
         }
-        return RedisClusterClient.CreateClient(commonClusterClientConfig().build()).get();
+        return RedisClusterClient.createClient(commonClusterClientConfig().build()).get();
     }
 
     /**

diff --git a/java/integTest/src/test/java/glide/SharedClientTests.java b/java/integTest/src/test/java/glide/SharedClientTests.java
@@ -36,9 +36,9 @@ public class SharedClientTests {
     @BeforeAll
     @SneakyThrows
     public static void init() {
-        standaloneClient = RedisClient.CreateClient(commonClientConfig().build()).get();
+        standaloneClient = RedisClient.createClient(commonClientConfig().build()).get();
         clusterClient =
-                RedisClusterClient.CreateClient(commonClusterClientConfig().requestTimeout(10000).build())
+                RedisClusterClient.createClient(commonClusterClientConfig().requestTimeout(10000).build())
                         .get();
 
         clients = List.of(Arguments.of(standaloneClient), Arguments.of(clusterClient));