Files
Nathan Harris ea6f427993 Add type-safe representation of Redis keys
Motivation:

Inspired by Swift by Sundell's article on type-safe identifers, the goal of this commit is to have the compiler
assist in preventing incorrect Redis key values from being used in API calls.

See https://www.swiftbysundell.com/articles/type-safe-identifiers-in-swift/ for the inspiration.

Modifications:

- Add new `RedisKey` struct that wraps around a single `String` value that conforms to several expected protocols
  (Hashable, Comparable, Codable, etc.)
- Change all command APIs to require `RedisKey` rather than plain strings

Result:

When encountering an API requiring a RedisKey, it should be much more apparant at the use site what form a value should take.
2019-12-27 21:38:35 -08:00

115 lines
4.0 KiB
Swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the RediStack open source project
//
// Copyright (c) 2019 RediStack project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of RediStack project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
@testable import RediStack
import RediStackTestUtils
import XCTest
final class BasicCommandsTests: RediStackIntegrationTestCase {
func test_select() {
XCTAssertNoThrow(try connection.select(database: 3).wait())
}
func test_delete() throws {
let keys = [ #function + "1", #function + "2", #function + "3" ].map(RedisKey.init(_:))
try connection.set(keys[0], to: "value").wait()
try connection.set(keys[1], to: "value").wait()
try connection.set(keys[2], to: "value").wait()
let first = try connection.delete([keys[0]]).wait()
XCTAssertEqual(first, 1)
let second = try connection.delete([keys[0]]).wait()
XCTAssertEqual(second, 0)
let third = try connection.delete(keys[1], keys[2]).wait()
XCTAssertEqual(third, 2)
}
func test_expire() throws {
try connection.set(#function, to: "value").wait()
XCTAssertNotNil(try connection.get(#function).wait())
XCTAssertTrue(try connection.expire(#function, after: .nanoseconds(1)).wait())
XCTAssertNil(try connection.get(#function).wait())
try connection.set(#function, to: "new value").wait()
XCTAssertNotNil(try connection.get(#function).wait())
XCTAssertTrue(try connection.expire(#function, after: .seconds(10)).wait())
XCTAssertNotNil(try connection.get(#function).wait())
}
func test_ping() throws {
let first = try connection.ping().wait()
XCTAssertEqual(first, "PONG")
let second = try connection.ping(with: "My message").wait()
XCTAssertEqual(second, "My message")
}
func test_echo() throws {
let response = try connection.echo("FIZZ_BUZZ").wait()
XCTAssertEqual(response, "FIZZ_BUZZ")
}
func test_swapDatabase() throws {
try connection.set("first", to: "3").wait()
var first = try connection.get("first").wait()
XCTAssertEqual(first, "3")
try connection.select(database: 1).wait()
var second = try connection.get("first").wait()
XCTAssertEqual(second, nil)
try connection.set("second", to: "100").wait()
second = try connection.get("second").wait()
XCTAssertEqual(second, "100")
let success = try connection.swapDatabase(0, with: 1).wait()
XCTAssertEqual(success, true)
second = try connection.get("first").wait()
XCTAssertEqual(second, "3")
try connection.select(database: 0).wait()
first = try connection.get("second").wait()
XCTAssertEqual(first, "100")
}
func test_scan() throws {
var dataset: [RedisKey] = .init(repeating: "", count: 10)
for index in 1...15 {
let key = RedisKey("key\(index)\(index % 2 == 0 ? "_even" : "_odd")")
dataset.append(key)
_ = try connection.set(key, to: "\(index)").wait()
}
var (cursor, keys) = try connection.scan(count: 5).wait()
XCTAssertGreaterThanOrEqual(cursor, 0)
XCTAssertGreaterThanOrEqual(keys.count, 5)
(_, keys) = try connection.scan(startingFrom: cursor, count: 8).wait()
XCTAssertGreaterThanOrEqual(keys.count, 8)
(cursor, keys) = try connection.scan(matching: "*_odd").wait()
XCTAssertGreaterThanOrEqual(cursor, 0)
XCTAssertGreaterThanOrEqual(keys.count, 1)
XCTAssertLessThanOrEqual(keys.count, 7)
(cursor, keys) = try connection.scan(matching: "*_even*").wait()
XCTAssertGreaterThanOrEqual(cursor, 0)
XCTAssertGreaterThanOrEqual(keys.count, 1)
XCTAssertLessThanOrEqual(keys.count, 7)
}
}