1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
@testable import Basics
import SPMTestSupport
import tsan_utils
import XCTest
final class SQLiteBackedCacheTests: XCTestCase {
func testHappyCase() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer { XCTAssertNoThrow(try cache.close()) }
let mockData = try makeMockData(fileSystem: localFileSystem, rootPath: tmpPath)
try mockData.forEach { key, value in
_ = try cache.put(key: key, value: value)
}
try mockData.forEach { key, _ in
let result = try cache.get(key: key)
XCTAssertEqual(mockData[key], result)
}
let key = mockData.first!.key
_ = try cache.put(key: key, value: "foobar", replace: false)
XCTAssertEqual(mockData[key], try cache.get(key: key))
_ = try cache.put(key: key, value: "foobar", replace: true)
XCTAssertEqual("foobar", try cache.get(key: key))
try cache.remove(key: key)
XCTAssertNil(try cache.get(key: key))
guard case .path(let cachePath) = cache.location else {
return XCTFail("invalid location \(cache.location)")
}
XCTAssertTrue(cache.fileSystem.exists(cachePath), "expected file to be written")
}
}
func testFileDeleted() throws {
#if os(Windows)
try XCTSkipIf(true, "open file cannot be deleted on Windows")
#endif
try XCTSkipIf(is_tsan_enabled())
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer { XCTAssertNoThrow(try cache.close()) }
let mockData = try makeMockData(fileSystem: localFileSystem, rootPath: tmpPath)
try mockData.forEach { key, value in
_ = try cache.put(key: key, value: value)
}
try mockData.forEach { key, _ in
let result = try cache.get(key: key)
XCTAssertEqual(mockData[key], result)
}
guard case .path(let cachePath) = cache.location else {
return XCTFail("invalid location \(cache.location)")
}
XCTAssertTrue(cache.fileSystem.exists(cachePath), "expected file to exist at \(cachePath)")
try cache.fileSystem.removeFileTree(cachePath)
let key = mockData.first!.key
do {
let result = try cache.get(key: key)
XCTAssertNil(result)
}
do {
XCTAssertNoThrow(try cache.put(key: key, value: mockData[key]!))
let result = try cache.get(key: key)
XCTAssertEqual(mockData[key], result)
}
XCTAssertTrue(cache.fileSystem.exists(cachePath), "expected file to exist at \(cachePath)")
}
}
func testFileCorrupt() throws {
try XCTSkipIf(is_tsan_enabled())
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer { XCTAssertNoThrow(try cache.close()) }
let mockData = try makeMockData(fileSystem: localFileSystem, rootPath: tmpPath)
try mockData.forEach { key, value in
_ = try cache.put(key: key, value: value)
}
try mockData.forEach { key, _ in
let result = try cache.get(key: key)
XCTAssertEqual(mockData[key], result)
}
guard case .path(let cachePath) = cache.location else {
return XCTFail("invalid location \(cache.location)")
}
try cache.close()
XCTAssertTrue(cache.fileSystem.exists(cachePath), "expected file to exist at \(path)")
try cache.fileSystem.writeFileContents(cachePath, string: "blah")
XCTAssertThrowsError(try cache.get(key: mockData.first!.key), "expected error") { error in
XCTAssert("\(error)".contains("is not a database"), "Expected file is not a database error")
}
XCTAssertThrowsError(try cache.put(key: mockData.first!.key, value: mockData.first!.value), "expected error") { error in
XCTAssert("\(error)".contains("is not a database"), "Expected file is not a database error")
}
}
}
func testMaxSizeNotHandled() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
var configuration = SQLiteBackedCacheConfiguration()
configuration.maxSizeInBytes = 1024 * 3
configuration.truncateWhenFull = false
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path, configuration: configuration)
defer { XCTAssertNoThrow(try cache.close()) }
func create() throws {
let mockData = try makeMockData(fileSystem: localFileSystem, rootPath: tmpPath, count: 500)
try mockData.forEach { key, value in
_ = try cache.put(key: key, value: value)
}
}
XCTAssertThrowsError(try create(), "expected error") { error in
XCTAssertEqual(error as? SQLite.Errors, .databaseFull, "Expected 'databaseFull' error")
}
}
}
func testMaxSizeHandled() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
var configuration = SQLiteBackedCacheConfiguration()
configuration.maxSizeInBytes = 1024 * 3
configuration.truncateWhenFull = true
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path, configuration: configuration)
defer { XCTAssertNoThrow(try cache.close()) }
var keys = [String]()
let mockData = try makeMockData(fileSystem: localFileSystem, rootPath: tmpPath, count: 500)
try mockData.forEach { key, value in
_ = try cache.put(key: key, value: value)
keys.append(key)
}
do {
let result = try cache.get(key: mockData.first!.key)
XCTAssertNil(result)
}
do {
let result = try cache.get(key: keys.last!)
XCTAssertEqual(mockData[keys.last!], result)
}
}
}
}
private func makeMockData(fileSystem: FileSystem, rootPath: AbsolutePath, count: Int = Int.random(in: 50 ..< 100)) throws -> [String: String] {
var data = [String: String]()
let value = UUID().uuidString
for index in 0 ..< count {
data["\(index)"] = "\(index) \(value)"
}
return data
}
|