Minor rewrite of ExecutableProviders

codemonstur · codemonstur · commit dc7cc4ebaad2 · 2024-01-30T21:54:48.000+01:00
diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 
     <groupId>com.github.codemonstur</groupId>
     <artifactId>embedded-redis</artifactId>
-    <version>1.3.0</version>
+    <version>1.4.0</version>
     <packaging>jar</packaging>
 
     <name>embedded-redis</name>
diff --git a/src/main/java/redis/embedded/RedisShardedCluster.java b/src/main/java/redis/embedded/RedisShardedCluster.java
@@ -13,7 +13,8 @@
 import java.util.stream.IntStream;
 
 public final class RedisShardedCluster implements Redis {
-    public static final String CLUSTER_IP = "127.0.0.1";
+
+    private static final String CLUSTER_IP = "127.0.0.1";
     private static final int MAX_NUMBER_OF_SLOTS_PER_CLUSTER = 16384;
     private static final Duration SLEEP_DURATION = Duration.ofMillis(300);
     private static final long SLEEP_DURATION_IN_MILLIS = SLEEP_DURATION.toMillis();
@@ -26,8 +27,7 @@ public final class RedisShardedCluster implements Redis {
     public RedisShardedCluster(
             final List<Redis> servers,
             final Map<Integer, Set<Integer>> replicasPortsByMainNodePort,
-            final Duration initializationTimeout
-    ) {
+            final Duration initializationTimeout) {
         this.servers.addAll(servers);
         this.replicasPortsByMainNodePort.putAll(replicasPortsByMainNodePort);
         this.initializationTimeout = initializationTimeout;
@@ -98,21 +98,21 @@ private void meetMainNodes(final Integer clusterMeetTarget) throws RedisClusterS
         // for every shard meet the main node (except the 1st shard) and add their slots manually
         final List<Integer> shardsMainNodePorts = new LinkedList<>(replicasPortsByMainNodePort.keySet());
         final int slotsPerShard = MAX_NUMBER_OF_SLOTS_PER_CLUSTER / shardsMainNodePorts.size();
-        for(int i = 0; i < shardsMainNodePorts.size(); i++) {
+        for (int i = 0; i < shardsMainNodePorts.size(); i++) {
             final Integer port = shardsMainNodePorts.get(i);
-            int startSlot = i * slotsPerShard;
-            int endSlot = i == shardsMainNodePorts.size() - 1
+            final int startSlot = i * slotsPerShard;
+            final int endSlot = i == shardsMainNodePorts.size() - 1
                           ? MAX_NUMBER_OF_SLOTS_PER_CLUSTER - 1
                           : startSlot + slotsPerShard - 1;
             try (final Jedis jedis = new Jedis(CLUSTER_IP, port)) {
-                if(!port.equals(clusterMeetTarget)){
+                if (!port.equals(clusterMeetTarget)) {
                     jedis.clusterMeet(CLUSTER_IP, clusterMeetTarget);
                 }
 
                 final String nodeId = jedis.clusterMyId();
                 mainNodeIdsByPort.put(port, nodeId);
                 jedis.clusterAddSlots(IntStream.range(startSlot, endSlot + 1).toArray());
-            } catch (Exception e) {
+            } catch (final Exception e) {
                 throw new RedisClusterSetupException("Failed creating main node instance at port: " + port, e);
             }
         }
diff --git a/src/main/java/redis/embedded/core/ExecutableProvider.java b/src/main/java/redis/embedded/core/ExecutableProvider.java
@@ -1,6 +1,8 @@
 package redis.embedded.core;
 
 import redis.embedded.model.OsArchitecture;
+import redis.embedded.util.IO;
+import redis.embedded.util.IOSupplier;
 
 import java.io.*;
 import java.net.HttpURLConnection;
@@ -14,8 +16,7 @@
 import static java.nio.file.StandardOpenOption.*;
 import static java.nio.file.attribute.PosixFilePermissions.fromString;
 import static redis.embedded.model.OsArchitecture.*;
-import static redis.embedded.util.IO.findBinaryInPath;
-import static redis.embedded.util.IO.writeResourceToExecutableFile;
+import static redis.embedded.util.IO.*;
 
 public interface ExecutableProvider {
 
@@ -26,16 +27,31 @@ public interface ExecutableProvider {
 
     File get() throws IOException;
 
-    static ExecutableProvider newEmbeddedRedisProvider() {
-        final Map<OsArchitecture, String> executables = newProvidedVersionsMap();
-        return () -> writeResourceToExecutableFile(executables.get(detectOSandArchitecture()));
+    static ExecutableProvider newJarResourceProvider() {
+        final Map<OsArchitecture, String> map = newProvidedVersionsMap();
+        return newJarResourceProvider(IO::newTempDirForBinary, map);
+    }
+
+    static ExecutableProvider newJarResourceProvider(final File tempDirectory) {
+        final Map<OsArchitecture, String> map = newProvidedVersionsMap();
+        return newJarResourceProvider(() -> tempDirectory, map);
+    }
+
+    static ExecutableProvider newJarResourceProvider(final Map<OsArchitecture, String> executables) {
+        return newJarResourceProvider(IO::newTempDirForBinary, executables);
+    }
+
+    static ExecutableProvider newJarResourceProvider(final IOSupplier<File> tempDirectory, final Map<OsArchitecture, String> executables) {
+        final OsArchitecture osArch = detectOSandArchitecture();
+        return () -> writeResourceToExecutableFile(tempDirectory.get(), executables.get(osArch));
     }
 
     static ExecutableProvider newFileThenJarResourceProvider(final Map<OsArchitecture, String> executables) {
         return () -> {
             final String executablePath = executables.get(detectOSandArchitecture());
             final File executable = new File(executablePath);
-            return executable.isFile() ? executable : writeResourceToExecutableFile(executablePath);
+            final File tempDir = newTempDirForBinary();
+            return executable.isFile() ? executable : writeResourceToExecutableFile(tempDir, executablePath);
         };
     }
 
@@ -53,10 +69,6 @@ static ExecutableProvider newSystemPropertyProvider(final String propertyName) {
         return () -> new File(System.getProperty(propertyName));
     }
 
-    static ExecutableProvider newJarResourceProvider(final Map<OsArchitecture, String> executables) {
-        return () -> writeResourceToExecutableFile(executables.get(detectOSandArchitecture()));
-    }
-
     static ExecutableProvider newExecutableInPath(final String executableName) throws FileNotFoundException {
         return findBinaryInPath(executableName)::toFile;
     }
diff --git a/src/main/java/redis/embedded/core/ExecutableProviderBuilder.java b/src/main/java/redis/embedded/core/ExecutableProviderBuilder.java
diff --git a/src/main/java/redis/embedded/core/PortProvider.java b/src/main/java/redis/embedded/core/PortProvider.java
@@ -7,7 +7,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 
 public interface PortProvider {
-    //Redis uses a cluster bus port as the first node port + 10000, so we need to make sure we use ports lower than
+    // Redis uses a cluster bus port as the first node port + 10000, so we need to make sure we use ports lower than
     // 55535 to ensure we always get a valid cluster bus port. We chose 50000 in order to have a safe margin.
     // Theoretically we could use the "cluster-port" as documented here:
     // https://redis.io/docs/reference/cluster-spec/#the-cluster-bus
@@ -21,7 +21,7 @@ static PortProvider newEphemeralPortProvider() {
             try (final ServerSocket socket = new ServerSocket(0)) {
                 socket.setReuseAddress(false);
                 return socket.getLocalPort();
-            } catch (IOException e) {
+            } catch (final IOException e) {
                 throw new IllegalArgumentException("Could not provide ephemeral port", e);
             }
         };
@@ -53,4 +53,5 @@ static PortProvider newSequencePortProvider(final int start) {
         final AtomicInteger currentPort = new AtomicInteger(start);
         return currentPort::getAndIncrement;
     }
+
 }
diff --git a/src/main/java/redis/embedded/core/RedisSentinelBuilder.java b/src/main/java/redis/embedded/core/RedisSentinelBuilder.java
@@ -11,9 +11,10 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static redis.embedded.Redis.DEFAULT_REDIS_PORT;
-import static redis.embedded.core.ExecutableProvider.newEmbeddedRedisProvider;
+import static redis.embedded.core.ExecutableProvider.newJarResourceProvider;
 
 public final class RedisSentinelBuilder {
+
     private static final String
         LINE_SEPARATOR = System.getProperty("line.separator"),
         CONF_FILENAME = "embedded-redis-sentinel",
@@ -24,7 +25,7 @@ public final class RedisSentinelBuilder {
         LINE_PORT = "port %d";
 
     private File executable;
-    private ExecutableProvider executableProvider = newEmbeddedRedisProvider();
+    private ExecutableProvider executableProvider = newJarResourceProvider();
     private String bind = "127.0.0.1";
     private Integer port = 26379;
     private int masterPort = DEFAULT_REDIS_PORT;
@@ -184,4 +185,5 @@ private List<String> buildCommandArgs() {
 
         return args;
     }
+
 }
diff --git a/src/main/java/redis/embedded/core/RedisServerBuilder.java b/src/main/java/redis/embedded/core/RedisServerBuilder.java
@@ -15,14 +15,14 @@
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static redis.embedded.Redis.DEFAULT_REDIS_PORT;
-import static redis.embedded.core.ExecutableProvider.newEmbeddedRedisProvider;
+import static redis.embedded.core.ExecutableProvider.newJarResourceProvider;
 
 public final class RedisServerBuilder {
 
     private static final String LINE_SEPARATOR = System.getProperty("line.separator");
 
     private File executable;
-    private ExecutableProvider provider = newEmbeddedRedisProvider();
+    private ExecutableProvider provider = newJarResourceProvider();
     private String bindAddress = "127.0.0.1";
     private int bindPort = DEFAULT_REDIS_PORT;
     private InetSocketAddress slaveOf;
@@ -97,7 +97,7 @@ public void reset() {
         this.executable = null;
         this.slaveOf = null;
         this.redisConfigBuilder = new StringBuilder();
-        this.provider = newEmbeddedRedisProvider();
+        this.provider = newJarResourceProvider();
         this.bindAddress = "127.0.0.1";
         this.bindPort = DEFAULT_REDIS_PORT;
         this.soutListener = null;
diff --git a/src/main/java/redis/embedded/core/RedisShardedClusterBuilder.java b/src/main/java/redis/embedded/core/RedisShardedClusterBuilder.java
@@ -12,6 +12,7 @@
 import static redis.embedded.core.PortProvider.*;
 
 public final class RedisShardedClusterBuilder {
+
     private static final Duration DEFAULT_INITIALIZATION_TIMEOUT = Duration.ofSeconds(20);
 
     private RedisServerBuilder serverBuilder = new RedisServerBuilder();
@@ -89,4 +90,5 @@ private RedisServer buildMainNode(final Shard shard) throws IOException {
         serverBuilder.setting("appendonly no");
         return serverBuilder.port(shard.mainNodePort).build();
     }
+
 }
diff --git a/src/main/java/redis/embedded/error/OsArchitectureNotFound.java b/src/main/java/redis/embedded/error/OsArchitectureNotFound.java
@@ -1,7 +1,9 @@
 package redis.embedded.error;
 
 public class OsArchitectureNotFound extends RuntimeException {
+
     public OsArchitectureNotFound(final Throwable cause) {
         super(cause);
     }
+
 }
diff --git a/src/main/java/redis/embedded/error/RedisClusterSetupException.java b/src/main/java/redis/embedded/error/RedisClusterSetupException.java
@@ -1,7 +1,9 @@
 package redis.embedded.error;
 
 public class RedisClusterSetupException extends Exception {
+
     public RedisClusterSetupException(final String message) { super(message); }
 
     public RedisClusterSetupException(final String message, final Throwable cause) { super(message, cause); }
+
 }
diff --git a/src/main/java/redis/embedded/error/UnknownOSName.java b/src/main/java/redis/embedded/error/UnknownOSName.java
@@ -1,7 +1,9 @@
 package redis.embedded.error;
 
 public class UnknownOSName extends RuntimeException {
+
     public UnknownOSName(final String name) {
         super("Unrecognized OS: " + name);
     }
+
 }
diff --git a/src/main/java/redis/embedded/model/OsArchitecture.java b/src/main/java/redis/embedded/model/OsArchitecture.java
@@ -10,6 +10,7 @@
 public class OsArchitecture {
     
     public static final OsArchitecture
+        WINDOWS_x86 = new OsArchitecture(WINDOWS, x86),
         WINDOWS_x86_64 = new OsArchitecture(WINDOWS, x86_64),
         UNIX_x86 = new OsArchitecture(UNIX, x86),
         UNIX_x86_64 = new OsArchitecture(UNIX, x86_64),
diff --git a/src/main/java/redis/embedded/model/ReplicationGroup.java b/src/main/java/redis/embedded/model/ReplicationGroup.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 public final class ReplicationGroup {
+
     public final String masterName;
     public final int masterPort;
     public final List<Integer> slavePorts = new LinkedList<>();
@@ -17,4 +18,5 @@ public ReplicationGroup(final String masterName, int slaveCount, final PortProvi
             this.slavePorts.add(provider.get());
         }
     }
+
 }
diff --git a/src/main/java/redis/embedded/model/Shard.java b/src/main/java/redis/embedded/model/Shard.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 public final class Shard {
+
     public final String name;
     public final int mainNodePort;
     public final List<Integer> replicaPorts = new LinkedList<>();
@@ -17,4 +18,5 @@ public Shard(final String name, int replicaCount, final PortProvider provider) {
             this.replicaPorts.add(provider.get());
         }
     }
+
 }
diff --git a/src/main/java/redis/embedded/util/CheckedRunnable.java b/src/main/java/redis/embedded/util/CheckedRunnable.java
@@ -1,5 +1,7 @@
 package redis.embedded.util;
 
 public interface CheckedRunnable {
+
     void run() throws Exception;
+
 }
diff --git a/src/main/java/redis/embedded/util/IO.java b/src/main/java/redis/embedded/util/IO.java
@@ -15,10 +15,13 @@
 
 public enum IO {;
 
-    public static File writeResourceToExecutableFile(final String resourcePath) throws IOException {
+    public static File newTempDirForBinary() throws IOException {
         final File tempDirectory = createDirectories(createTempDirectory("redis-")).toFile();
         tempDirectory.deleteOnExit();
+        return tempDirectory;
+    }
 
+    public static File writeResourceToExecutableFile(final File tempDirectory, final String resourcePath) throws IOException {
         final File executable = new File(tempDirectory, resourcePath);
         try (final InputStream in = IO.class.getResourceAsStream(resourcePath)) {
             if (in == null) throw new FileNotFoundException("Could not find Redis executable at " + resourcePath);
diff --git a/src/main/java/redis/embedded/util/IOSupplier.java b/src/main/java/redis/embedded/util/IOSupplier.java
@@ -0,0 +1,9 @@
+package redis.embedded.util;
+
+import java.io.IOException;
+
+public interface IOSupplier<T> {
+
+    T get() throws IOException;
+
+}
diff --git a/src/test/java/redis/embedded/RedisServerTest.java b/src/test/java/redis/embedded/RedisServerTest.java
diff --git a/src/test/java/redis/embedded/RedisShardedClusterTest.java b/src/test/java/redis/embedded/RedisShardedClusterTest.java

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@`
`12`	`12`	`import static redis.embedded.core.PortProvider.*;`
`13`	`13`
`14`	`14`	`public final class RedisShardedClusterBuilder {`
	`15`	`+`
`15`	`16`	`private static final Duration DEFAULT_INITIALIZATION_TIMEOUT = Duration.ofSeconds(20);`
`16`	`17`
`17`	`18`	`private RedisServerBuilder serverBuilder = new RedisServerBuilder();`
`@@ -89,4 +90,5 @@ private RedisServer buildMainNode(final Shard shard) throws IOException {`
`89`	`90`	`serverBuilder.setting("appendonly no");`
`90`	`91`	`return serverBuilder.port(shard.mainNodePort).build();`
`91`	`92`	`}`
	`93`	`+`
`92`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`package redis.embedded.error;`
`2`	`2`
`3`	`3`	`public class OsArchitectureNotFound extends RuntimeException {`
	`4`	`+`
`4`	`5`	`public OsArchitectureNotFound(final Throwable cause) {`
`5`	`6`	`super(cause);`
`6`	`7`	`}`
	`8`	`+`
`7`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,9 @@`
`1`	`1`	`package redis.embedded.error;`
`2`	`2`
`3`	`3`	`public class RedisClusterSetupException extends Exception {`
	`4`	`+`
`4`	`5`	`public RedisClusterSetupException(final String message) { super(message); }`
`5`	`6`
`6`	`7`	`public RedisClusterSetupException(final String message, final Throwable cause) { super(message, cause); }`
	`8`	`+`
`7`	`9`	`}`