Merge pull request #25 from Mordil/remove-driver

Remove `RedisDriver`
swift-server · Mar 28, 2019 · 152eb30 · 152eb30
2 parents ba6bf6d + db4a156
commit 152eb30
Show file tree

Hide file tree

Showing 13 changed files with 72 additions and 175 deletions.
diff --git a/Sources/NIORedis/Extensions/NIO/ClientBootstrap.swift b/Sources/NIORedis/Extensions/NIO/ClientBootstrap.swift
@@ -2,22 +2,22 @@ import Foundation
 import NIO
 
 extension ClientBootstrap {
-    /// Makes a new `ClientBootstrap` instance with a standard Redis `Channel` pipeline for sending and receiving
-    /// messages in Redis Serialization Protocol (RESP) format.
+    /// Makes a new `ClientBootstrap` instance with a default Redis `Channel` pipeline
+    /// for sending and receiving messages in Redis Serialization Protocol (RESP) format.
     ///
-    /// See `RESPEncoder`, `RESPDecoder`, and `RedisCommadHandler`.
+    /// See `RESPEncoder`, `RESPDecoder`, and `RedisCommadHandler`
     /// - Parameter using: The `EventLoopGroup` to build the `ClientBootstrap` on.
-    /// - Returns: A `ClientBootstrap` with the standard configuration of a `Channel` pipeline for RESP messages.
-    public static func makeForRedis(using group: EventLoopGroup) -> ClientBootstrap {
+    /// - Returns: A `ClientBootstrap` with the default configuration of a `Channel` pipeline for RESP messages.
+    public static func makeRedisDefault(using group: EventLoopGroup) -> ClientBootstrap {
         return ClientBootstrap(group: group)
-            .channelOption(ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR), value: 1)
-            .channelInitializer { channel in
-                let handlers: [ChannelHandler] = [
-                    MessageToByteHandler(RESPEncoder()),
-                    ByteToMessageHandler(RESPDecoder()),
-                    RedisCommandHandler()
-                ]
-                return .andAllSucceed(handlers.map { channel.pipeline.addHandler($0) }, on: group.next())
-            }
+            .channelOption(
+                ChannelOptions.socket(SocketOptionLevel(SOL_SOCKET), SO_REUSEADDR),
+                value: 1
+            )
+            .channelInitializer { $0.pipeline.addHandlers([
+                MessageToByteHandler(RESPEncoder()),
+                ByteToMessageHandler(RESPDecoder()),
+                RedisCommandHandler()
+            ])}
     }
 }
diff --git a/Sources/NIORedis/RedisClient.swift b/Sources/NIORedis/RedisClient.swift
@@ -138,3 +138,31 @@ public final class RedisConnection: RedisClient {
         return promise.futureResult
     }
 }
+
+extension RedisConnection {
+    /// Makes a client connection to a Redis instance.
+    /// - Parameters:
+    ///     - socket: The `SocketAddress` information of the Redis instance to connect to.
+    ///     - password: The optional password to authorize the client with.
+    ///     - eventLoopGroup: The `EventLoopGroup` to build the connection on.
+    ///     - logger: The `Logger` instance to log with.
+    /// - Returns: A `RedisClient` instance representing this new connection.
+    public static func connect(
+        to socket: SocketAddress,
+        with password: String? = nil,
+        on eventLoopGroup: EventLoopGroup,
+        logger: Logger = Logger(label: "NIORedis.RedisClient")
+    ) -> EventLoopFuture<RedisConnection> {
+        let bootstrap = ClientBootstrap.makeRedisDefault(using: eventLoopGroup)
+
+        return bootstrap.connect(to: socket)
+            .map { return RedisConnection(channel: $0, logger: logger) }
+            .flatMap { client in
+                guard let pw = password else {
+                    return eventLoopGroup.next().makeSucceededFuture(client)
+                }
+                return client.authorize(with: pw)
+                    .map { _ in return client }
+            }
+    }
+}
diff --git a/Sources/NIORedis/RedisDriver.swift b/Sources/NIORedis/RedisDriver.swift
diff --git a/Tests/NIORedisTests/Commands/BasicCommandsTests.swift b/Tests/NIORedisTests/Commands/BasicCommandsTests.swift
@@ -2,22 +2,19 @@
 import XCTest
 
 final class BasicCommandsTests: XCTestCase {
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
         } catch {
             XCTFail("Failed to create RedisConnection!")
         }
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/Commands/HashCommandsTests.swift b/Tests/NIORedisTests/Commands/HashCommandsTests.swift
@@ -2,22 +2,19 @@
 import XCTest
 
 final class HashCommandsTests: XCTestCase {
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
         } catch {
             XCTFail("Failed to create RedisConnection!")
         }
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/Commands/ListCommandsTests.swift b/Tests/NIORedisTests/Commands/ListCommandsTests.swift
@@ -2,22 +2,19 @@
 import XCTest
 
 final class ListCommandsTests: XCTestCase {
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
         } catch {
             XCTFail("Failed to create RedisConnection!")
         }
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/Commands/SetCommandsTests.swift b/Tests/NIORedisTests/Commands/SetCommandsTests.swift
@@ -2,22 +2,19 @@
 import XCTest
 
 final class SetCommandsTests: XCTestCase {
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
         } catch {
             XCTFail("Failed to create RedisConnection!")
         }
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/Commands/SortedSetCommandsTests.swift b/Tests/NIORedisTests/Commands/SortedSetCommandsTests.swift
@@ -4,15 +4,13 @@ import XCTest
 final class SortedSetCommandsTests: XCTestCase {
     private static let testKey = "SortedSetCommandsTests"
 
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
+
     private var key: String { return SortedSetCommandsTests.testKey }
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
 
             var dataset: [(RESPValueConvertible, Double)] = []
             for index in 1...10 {
@@ -27,7 +25,7 @@ final class SortedSetCommandsTests: XCTestCase {
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/Commands/StringCommandsTests.swift b/Tests/NIORedisTests/Commands/StringCommandsTests.swift
@@ -4,22 +4,19 @@ import XCTest
 final class StringCommandsTests: XCTestCase {
     private static let testKey = "SortedSetCommandsTests"
 
-    private let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-    deinit { try? redis.terminate() }
-
     private var connection: RedisConnection!
 
     override func setUp() {
         do {
-            connection = try redis.makeConnection().wait()
+            connection = try RedisConnection.connect().wait()
         } catch {
             XCTFail("Failed to create RedisConnection!")
         }
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
+        try? connection.close().wait()
         connection = nil
     }
 

diff --git a/Tests/NIORedisTests/RedisDriverTests.swift b/Tests/NIORedisTests/RedisDriverTests.swift
diff --git a/Tests/NIORedisTests/RedisPipelineTests.swift b/Tests/NIORedisTests/RedisPipelineTests.swift
@@ -2,24 +2,20 @@
 import XCTest
 
 final class RedisPipelineTests: XCTestCase {
-    private var redis: RedisDriver!
     private var connection: RedisConnection!
 
     override func setUp() {
-        let redis = RedisDriver(ownershipModel: .internal(threadCount: 1))
-
-        guard let connection = try? redis.makeConnection().wait() else {
-            return XCTFail("Failed to create connection!")
+        do {
+            connection = try RedisConnection.connect().wait()
+        } catch {
+            XCTFail("Failed to create RedisConnection!")
         }
-
-        self.redis = redis
-        self.connection = connection
     }
 
     override func tearDown() {
         _ = try? connection.send(command: "FLUSHALL").wait()
-        connection.close()
-        try? redis.terminate()
+        try? connection.close().wait()
+        connection = nil
     }
 
     func test_enqueue() throws {

diff --git a/Tests/NIORedisTests/Utilities/RedisConnection.swift b/Tests/NIORedisTests/Utilities/RedisConnection.swift
@@ -0,0 +1,11 @@
+
+@testable import NIORedis
+import Foundation
+
+extension RedisConnection {
+    static func connect(
+        on elg: EventLoopGroup = MultiThreadedEventLoopGroup(numberOfThreads: 1)
+    ) throws -> EventLoopFuture<RedisConnection> {
+        return RedisConnection.connect(to: try .init(ipAddress: "127.0.0.1", port: 6379), on: elg)
+    }
+}
diff --git a/Tests/NIORedisTests/XCTestManifests.swift b/Tests/NIORedisTests/XCTestManifests.swift
@@ -3,7 +3,6 @@ import XCTest
 #if !os(macOS)
 public func allTests() -> [XCTestCaseEntry] {
     return [
-        testCase(RedisDriverTests.allTests),
         testCase(RESPDecoderTests.allTests),
         testCase(RESPDecoderParsingTests.allTests),
         testCase(RESPDecoderByteToMessageDecoderTests.allTests),