101 -- Add KEYS command

Author: Mordil

Sources/RediStack/Commands/KeyCommands.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2020 RediStack project authors
+// Copyright (c) 2020-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -67,6 +67,12 @@ extension RedisCommand {
             return .init(milliseconds: try $0.map())
         }
     }
+
+    /// [KEYS](https://redis.io/commands/keys)
+    /// - Parameter pattern: The key pattern to search for matching keys that exist in Redis.
+    public static func keys(matching pattern: String) -> RedisCommand<[String]> {
+        return .init(keyword: "KEYS", arguments: [pattern.convertedToRESPValue()])
+    }
 
     /// [SCAN](https://redis.io/commands/scan)
     /// - Parameters:
@@ -115,6 +121,15 @@ extension RedisClient {
         return self.send(.expire(key, after: timeout))
     }
 
+    /// Searches the keys in the database that match the given pattern.
+    ///
+    /// See ``RedisCommand/keys(matching:)``
+    /// - Parameter pattern: The key pattern to search for matching keys that exist in Redis.
+    /// - Returns: A list of keys that matched the provided pattern.
+    public func listKeys(matching pattern: String) -> EventLoopFuture<[String]> {
+        return self.send(.keys(matching: pattern))
+    }
+
     /// Incrementally iterates over all keys in the currently selected database.
     ///
     /// See `RedisCommand.scan(startingFrom:matching:count:)`

Tests/RediStackIntegrationTests/Commands/KeyCommandsTests.swift

@@ -2,7 +2,7 @@
 //
 // This source file is part of the RediStack open source project
 //
-// Copyright (c) 2020 RediStack project authors
+// Copyright (c) 2020-2022 RediStack project authors
 // Licensed under Apache License v2.0
 //
 // See LICENSE.txt for license information
@@ -148,4 +148,14 @@ final class KeyCommandsTests: RediStackIntegrationTestCase {
         XCTAssertGreaterThanOrEqual(keys.count, 1)
         XCTAssertLessThanOrEqual(keys.count, 7)
     }
+
+    func test_keys() throws {
+        let range = Range(0...3)
+        try range.forEach {
+            try self.connection.set("\(#function)_\($0)", to: $0).wait()
+        }
+        let keys = try self.connection.listKeys(matching: "\(#function)*").wait()
+        XCTAssertEqual(keys.count, range.count)
+        XCTAssertTrue(keys.allSatisfy({ $0.contains(#function) }))
+    }
 }