summaryrefslogtreecommitdiff
path: root/test/storage/database.cpp
blob: 19b46763b9bab7a8352b5a61cebeb42fd248e67c (plain)
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
#include "storage.hpp"
#include "../fixtures/fixture_log_observer.hpp"

#include "sqlite_cache_impl.hpp"
#include <mbgl/storage/resource.hpp>
#include <mbgl/storage/response.hpp>
#include <mbgl/util/io.hpp>

#include <sqlite3.h>

TEST_F(Storage, DatabaseDoesNotExist) {
    using namespace mbgl;

    Log::setObserver(std::make_unique<FixtureLogObserver>());

    SQLiteCache::Impl cache("test/fixtures/404/cache.db");

    cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
        EXPECT_EQ(nullptr, res.get());
    });

    auto observer = Log::removeObserver();
    EXPECT_EQ(1ul, dynamic_cast<FixtureLogObserver*>(observer.get())->count({ EventSeverity::Error, Event::Database, 14, "unable to open database file" }));
}

void createDir(const char* name) {
    const int ret = mkdir(name, 0755);
    if (ret == -1) {
        ASSERT_EQ(EEXIST, errno);
    } else {
        ASSERT_EQ(0, ret);
    }
}

void deleteFile(const char* name) {
    const int ret = unlink(name);
    if (ret == -1) {
        ASSERT_EQ(ENOENT, errno);
    } else {
        ASSERT_EQ(0, ret);
    }
}


void writeFile(const char* name, const std::string& data) {
    mbgl::util::write_file(name, data);
}


TEST_F(Storage, DatabaseCreate) {
    using namespace mbgl;

    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/cache.db");

    Log::setObserver(std::make_unique<FixtureLogObserver>());

    SQLiteCache::Impl cache("test/fixtures/database/cache.db");

    cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
        EXPECT_EQ(nullptr, res.get());
    });

    Log::removeObserver();
}

TEST_F(Storage, DatabaseVersion) {
    using namespace mbgl;

    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/cache.db");
    std::string path("test/fixtures/database/cache.db");

    Log::setObserver(std::make_unique<FixtureLogObserver>());

    {
        SQLiteCache::Impl cache(path);
        cache.put({ Resource::Unknown, "mapbox://test" }, Response());
    }

    sqlite3* db;
    sqlite3_open_v2(path.c_str(), &db, SQLITE_OPEN_READWRITE, nullptr);
    sqlite3_exec(db, "PRAGMA user_version = 999999", nullptr, nullptr, nullptr);
    sqlite3_close_v2(db);

    // Changing the version will force the database to get recreated
    // thus removing every pre-existing cache entry.
    {
        SQLiteCache::Impl cache(path);

        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });
    }

    Log::removeObserver();
}

class FileLock {
public:
    FileLock(const std::string& path) {
        const int err = sqlite3_open_v2(path.c_str(), &db, SQLITE_OPEN_CREATE | SQLITE_OPEN_READWRITE, nullptr);
        if (err != SQLITE_OK) {
            throw std::runtime_error("Could not open db");
        }
        lock();
    }

    void lock() {
        assert(!locked);
        const int err = sqlite3_exec(db, "begin exclusive transaction", nullptr, nullptr, nullptr);
        if (err != SQLITE_OK) {
            throw std::runtime_error("Could not lock db");
        }
        locked = true;
    }

    void unlock() {
        assert(locked);
        const int err = sqlite3_exec(db, "commit", nullptr, nullptr, nullptr);
        if (err != SQLITE_OK) {
            throw std::runtime_error("Could not unlock db");
        }
        locked = false;
    }

    ~FileLock() {
        if (locked) {
            unlock();
        }
    }

private:
    sqlite3* db;
    bool locked = false;
};

TEST_F(Storage, DatabaseLockedRead) {
    using namespace mbgl;

    // Create a locked file.
    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/locked.db");
    FileLock guard("test/fixtures/database/locked.db");

    SQLiteCache::Impl cache("test/fixtures/database/locked.db");

    {
        // First request should fail.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });

        // Make sure that we got a few "database locked" errors
        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(4ul, flo->count({ EventSeverity::Error, Event::Database, 5, "database is locked" }));
    }

    // Then, unlock the file and try again.
    guard.unlock();

    {
        // First, try getting a file (the cache value should not exist).
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });

        // Make sure that we got a no errors
        Log::removeObserver();
    }
}



TEST_F(Storage, DatabaseLockedWrite) {
    using namespace mbgl;

    // Create a locked file.
    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/locked.db");
    FileLock guard("test/fixtures/database/locked.db");

    SQLiteCache::Impl cache("test/fixtures/database/locked.db");

    {
        // Adds a file (which should fail).
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        cache.put({ Resource::Unknown, "mapbox://test" }, Response());
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });

        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(8ul, flo->count({ EventSeverity::Error, Event::Database, 5, "database is locked" }));
    }

    // Then, unlock the file and try again.
    guard.unlock();

    {
        // Then, set a file and obtain it again.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        Response response;
        response.data = std::make_shared<std::string>("Demo");
        cache.put({ Resource::Unknown, "mapbox://test" }, response);
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            ASSERT_NE(nullptr, res.get());
            ASSERT_TRUE(res->data.get());
            EXPECT_EQ("Demo", *res->data);
        });

        // Make sure that we got a no errors
        Log::removeObserver();
    }
}




TEST_F(Storage, DatabaseLockedRefresh) {
    using namespace mbgl;

    // Create a locked file.
    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/locked.db");

    SQLiteCache::Impl cache("test/fixtures/database/locked.db");

    // Then, lock the file and try again.
    FileLock guard("test/fixtures/database/locked.db");

    {
        // Adds a file.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        Response response;
        response.data = std::make_shared<std::string>("Demo");
        cache.put({ Resource::Unknown, "mapbox://test" }, response);
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });

        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(8ul, flo->count({ EventSeverity::Error, Event::Database, 5, "database is locked" }));
    }

    {
        // Then, try to refresh it.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        cache.refresh({ Resource::Unknown, "mapbox://test" }, {});
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            EXPECT_EQ(nullptr, res.get());
        });

        // Make sure that we got the right errors.
        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(8ul, flo->count({ EventSeverity::Error, Event::Database, 5, "database is locked" }));
    }
}



TEST_F(Storage, DatabaseDeleted) {
    using namespace mbgl;

    // Create a locked file.
    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/locked.db");

    SQLiteCache::Impl cache("test/fixtures/database/locked.db");

    {
        // Adds a file.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        Response response;
        response.data = std::make_shared<std::string>("Demo");
        cache.put({ Resource::Unknown, "mapbox://test" }, response);
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            ASSERT_NE(nullptr, res.get());
            ASSERT_TRUE(res->data.get());
            EXPECT_EQ("Demo", *res->data);
        });

        Log::removeObserver();
    }

    deleteFile("test/fixtures/database/locked.db");

    {
        // Adds a file.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        Response response;
        response.data = std::make_shared<std::string>("Demo");
        cache.put({ Resource::Unknown, "mapbox://test" }, response);
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            ASSERT_NE(nullptr, res.get());
            ASSERT_TRUE(res->data.get());
            EXPECT_EQ("Demo", *res->data);
        });

        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(1ul, flo->count({ EventSeverity::Error, Event::Database, 8, "attempt to write a readonly database" }));
    }
}



TEST_F(Storage, DatabaseInvalid) {
    using namespace mbgl;

    // Create a locked file.
    createDir("test/fixtures/database");
    deleteFile("test/fixtures/database/invalid.db");
    writeFile("test/fixtures/database/invalid.db", "this is an invalid file");

    SQLiteCache::Impl cache("test/fixtures/database/invalid.db");

    {
        // Adds a file.
        Log::setObserver(std::make_unique<FixtureLogObserver>());

        Response response;
        response.data = std::make_shared<std::string>("Demo");
        cache.put({ Resource::Unknown, "mapbox://test" }, response);
        cache.get({ Resource::Unknown, "mapbox://test" }, [] (std::unique_ptr<Response> res) {
            ASSERT_NE(nullptr, res.get());
            ASSERT_TRUE(res->data.get());
            EXPECT_EQ("Demo", *res->data);
        });

        auto observer = Log::removeObserver();
        auto flo = dynamic_cast<FixtureLogObserver*>(observer.get());
        EXPECT_EQ(1ul, flo->count({ EventSeverity::Warning, Event::Database, -1, "Trashing invalid database" }));
    }
}