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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2021-2025 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
//
//===----------------------------------------------------------------------===//
import Foundation
@testable import Basics
import _InternalTestSupport
import tsan_utils
import Testing
struct SQLiteBackedCacheTests {
@Test
func happyCase() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer {
#expect(throws: Never.self) {
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)
#expect(mockData[key] == result)
}
let key = mockData.first!.key
_ = try cache.put(key: key, value: "foobar", replace: false)
#expect(try cache.get(key: key) == mockData[key], "Actual is not as expected")
_ = try cache.put(key: key, value: "foobar", replace: true)
#expect(try cache.get(key: key) == "foobar", "Actual is not as expected")
try cache.remove(key: key)
#expect(try cache.get(key: key) == nil, "Actual is not as expected")
guard case .path(let cachePath) = cache.location else {
Issue.record("invalid location \(cache.location)")
return
}
#expect(cache.fileSystem.exists(cachePath), "expected file to be written")
}
}
@Test(
.disabled(if: (ProcessInfo.hostOperatingSystem == .windows), "open file cannot be deleted on Windows"),
.disabled(if: is_tsan_enabled(), "Disabling as tsan is enabled")
)
func fileDeleted() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer {
#expect(throws: Never.self) {
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)
#expect(mockData[key] == result)
}
guard case .path(let cachePath) = cache.location else {
Issue.record("invalid location \(cache.location)")
return
}
#expect(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)
#expect(result == nil)
}
do {
#expect(throws: Never.self) {
try cache.put(key: key, value: mockData[key]!)
}
let result = try cache.get(key: key)
#expect(mockData[key] == result)
}
#expect(cache.fileSystem.exists(cachePath), "expected file to exist at \(cachePath)")
}
}
@Test(
.disabled(if: is_tsan_enabled(), "Disabling as tsan is enabled")
)
func fileCorrupt() throws {
try testWithTemporaryDirectory { tmpPath in
let path = tmpPath.appending("test.db")
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
defer {
#expect(throws: Never.self) {
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)
#expect(mockData[key] == result)
}
guard case .path(let cachePath) = cache.location else {
Issue.record("invalid location \(cache.location)")
return
}
try cache.close()
#expect(cache.fileSystem.exists(cachePath), "expected file to exist at \(path)")
try cache.fileSystem.writeFileContents(cachePath, string: "blah")
#expect {
try cache.get(key: mockData.first!.key)
} throws: { error in
return "\(error)".contains("is not a database")
}
#expect {
try cache.put(key: mockData.first!.key, value: mockData.first!.value)
} throws: { error in
return "\(error)".contains("is not a database")
}
}
}
@Test
func maxSizeNotHandled() 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 {
#expect(throws: Never.self) {
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)
}
}
#expect {
try create()
} throws: { error in
let error = try #require(error as? SQLite.Errors)
return error == .databaseFull
}
}
}
@Test
func maxSizeHandled() 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 {
#expect(throws: Never.self) {
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)
#expect(result == nil)
}
do {
let result = try cache.get(key: keys.last!)
#expect(mockData[keys.last!] == result)
}
}
}
@Test
func initialFileCreation() throws {
try testWithTemporaryDirectory { tmpPath in
let paths = [
tmpPath.appending("foo", "test.db"),
// Ensure it works recursively.
tmpPath.appending("bar", "baz", "test.db"),
]
for path in paths {
let cache = SQLiteBackedCache<String>(tableName: "SQLiteBackedCacheTest", path: path)
// Put an entry to ensure the file is created.
#expect(throws: Never.self) {
try cache.put(key: "foo", value: "bar")
}
#expect(throws: Never.self) {
try cache.close()
}
#expect(localFileSystem.exists(path), "expected file to be created at \(path)")
}
}
}
}
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
}
|
