#include "../fixtures/fixture_log_observer.hpp" #include #include #include #include #include #include #include #include #include using namespace std::literals::string_literals; namespace { 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); } 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 = nullptr; bool locked = false; }; } //TEST(OfflineDatabase, NonexistentDirectory) { // using namespace mbgl; // // Log::setObserver(std::make_unique()); // // OfflineDatabase db("test/fixtures/404/offline.db"); // // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // EXPECT_FALSE(bool(res)); // }); // // auto observer = Log::removeObserver(); // EXPECT_EQ(1ul, dynamic_cast(observer.get())->count({ EventSeverity::Error, Event::Database, 14, "unable to open database file" })); //} TEST(OfflineDatabase, Create) { using namespace mbgl; createDir("test/fixtures/database"); deleteFile("test/fixtures/database/offline.db"); Log::setObserver(std::make_unique()); OfflineDatabase db("test/fixtures/database/offline.db"); EXPECT_FALSE(bool(db.get({ Resource::Unknown, "mapbox://test" }))); Log::removeObserver(); } TEST(OfflineDatabase, SchemaVersion) { using namespace mbgl; createDir("test/fixtures/database"); deleteFile("test/fixtures/database/offline.db"); std::string path("test/fixtures/database/offline.db"); { sqlite3* db = nullptr; sqlite3_open_v2(path.c_str(), &db, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, nullptr); sqlite3_exec(db, "PRAGMA user_version = 1", nullptr, nullptr, nullptr); sqlite3_close_v2(db); } Log::setObserver(std::make_unique()); OfflineDatabase db(path); auto observer = Log::removeObserver(); auto flo = dynamic_cast(observer.get()); EXPECT_EQ(1ul, flo->count({ EventSeverity::Warning, Event::Database, -1, "Removing existing incompatible offline database" })); } TEST(OfflineDatabase, Invalid) { using namespace mbgl; createDir("test/fixtures/database"); deleteFile("test/fixtures/database/invalid.db"); writeFile("test/fixtures/database/invalid.db", "this is an invalid file"); Log::setObserver(std::make_unique()); OfflineDatabase db("test/fixtures/database/invalid.db"); auto observer = Log::removeObserver(); auto flo = dynamic_cast(observer.get()); EXPECT_EQ(1ul, flo->count({ EventSeverity::Warning, Event::Database, -1, "Removing existing incompatible offline database" })); } //TEST(OfflineDatabase, 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"); // // OfflineDatabase db("test/fixtures/database/locked.db"); // // { // // First request should fail. // Log::setObserver(std::make_unique()); // // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // EXPECT_FALSE(bool(res)); // }); // // // Make sure that we got a few "database locked" errors // auto observer = Log::removeObserver(); // auto flo = dynamic_cast(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()); // // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // EXPECT_FALSE(bool(res)); // }); // // // Make sure that we got a no errors // Log::removeObserver(); // } //} // //TEST(OfflineDatabase, 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"); // // OfflineDatabase db("test/fixtures/database/locked.db"); // // { // // Adds a file (which should fail). // Log::setObserver(std::make_unique()); // // db.put({ Resource::Unknown, "mapbox://test" }, Response()); // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // EXPECT_FALSE(bool(res)); // }); // // auto observer = Log::removeObserver(); // auto flo = dynamic_cast(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()); // // Response response; // response.data = std::make_shared("Demo"); // db.put({ Resource::Unknown, "mapbox://test" }, response); // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // ASSERT_TRUE(bool(res)); // ASSERT_TRUE(res->data.get()); // EXPECT_EQ("Demo", *res->data); // }); // // // Make sure that we got a no errors // Log::removeObserver(); // } //} // //TEST(OfflineDatabase, DatabaseDeleted) { // using namespace mbgl; // // // Create a locked file. // createDir("test/fixtures/database"); // deleteFile("test/fixtures/database/locked.db"); // // OfflineDatabase db("test/fixtures/database/locked.db"); // // { // // Adds a file. // Log::setObserver(std::make_unique()); // // Response response; // response.data = std::make_shared("Demo"); // db.put({ Resource::Unknown, "mapbox://test" }, response); // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // ASSERT_TRUE(bool(res)); // 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()); // // Response response; // response.data = std::make_shared("Demo"); // db.put({ Resource::Unknown, "mapbox://test" }, response); // db.get({ Resource::Unknown, "mapbox://test" }, [] (optional res) { // ASSERT_TRUE(bool(res)); // ASSERT_TRUE(res->data.get()); // EXPECT_EQ("Demo", *res->data); // }); // // auto observer = Log::removeObserver(); // auto flo = dynamic_cast(observer.get()); // EXPECT_EQ(1ul, flo->count({ EventSeverity::Error, Event::Database, 8, "attempt to write a readonly database" })); // } //} TEST(OfflineDatabase, PutDoesNotStoreConnectionErrors) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Unknown, "http://example.com/" }; Response response; response.error = std::make_unique(Response::Error::Reason::Connection); db.put(resource, response); EXPECT_FALSE(bool(db.get(resource))); } TEST(OfflineDatabase, PutDoesNotStoreServerErrors) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Unknown, "http://example.com/" }; Response response; response.error = std::make_unique(Response::Error::Reason::Server); db.put(resource, response); EXPECT_FALSE(bool(db.get(resource))); } TEST(OfflineDatabase, PutResource) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Style, "http://example.com/" }; Response response; response.data = std::make_shared("first"); auto insertPutResult = db.put(resource, response); EXPECT_TRUE(insertPutResult.first); EXPECT_EQ(5, insertPutResult.second); auto insertGetResult = db.get(resource); EXPECT_EQ(nullptr, insertGetResult->error.get()); EXPECT_EQ("first", *insertGetResult->data); response.data = std::make_shared("second"); auto updatePutResult = db.put(resource, response); EXPECT_FALSE(updatePutResult.first); EXPECT_EQ(6, updatePutResult.second); auto updateGetResult = db.get(resource); EXPECT_EQ(nullptr, updateGetResult->error.get()); EXPECT_EQ("second", *updateGetResult->data); } TEST(OfflineDatabase, PutTile) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Tile, "http://example.com/" }; resource.tileData = Resource::TileData { "http://example.com/", 1, 0, 0, 0 }; Response response; response.data = std::make_shared("first"); auto insertPutResult = db.put(resource, response); EXPECT_TRUE(insertPutResult.first); EXPECT_EQ(5, insertPutResult.second); auto insertGetResult = db.get(resource); EXPECT_EQ(nullptr, insertGetResult->error.get()); EXPECT_EQ("first", *insertGetResult->data); response.data = std::make_shared("second"); auto updatePutResult = db.put(resource, response); EXPECT_FALSE(updatePutResult.first); EXPECT_EQ(6, updatePutResult.second); auto updateGetResult = db.get(resource); EXPECT_EQ(nullptr, updateGetResult->error.get()); EXPECT_EQ("second", *updateGetResult->data); } TEST(OfflineDatabase, PutResourceNoContent) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Style, "http://example.com/" }; Response response; response.noContent = true; db.put(resource, response); auto res = db.get(resource); EXPECT_EQ(nullptr, res->error); EXPECT_TRUE(res->noContent); EXPECT_FALSE(res->data.get()); } TEST(OfflineDatabase, PutTileNotFound) { using namespace mbgl; OfflineDatabase db(":memory:"); Resource resource { Resource::Tile, "http://example.com/" }; resource.tileData = Resource::TileData { "http://example.com/", 1, 0, 0, 0 }; Response response; response.noContent = true; db.put(resource, response); auto res = db.get(resource); EXPECT_EQ(nullptr, res->error); EXPECT_TRUE(res->noContent); EXPECT_FALSE(res->data.get()); } TEST(OfflineDatabase, CreateRegion) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "http://example.com/style", LatLngBounds::hull({1, 2}, {3, 4}), 5, 6, 2.0 }; OfflineRegionMetadata metadata {{ 1, 2, 3 }}; OfflineRegion region = db.createRegion(definition, metadata); EXPECT_EQ(definition.styleURL, region.getDefinition().styleURL); EXPECT_EQ(definition.bounds, region.getDefinition().bounds); EXPECT_EQ(definition.minZoom, region.getDefinition().minZoom); EXPECT_EQ(definition.maxZoom, region.getDefinition().maxZoom); EXPECT_EQ(definition.pixelRatio, region.getDefinition().pixelRatio); EXPECT_EQ(metadata, region.getMetadata()); } TEST(OfflineDatabase, ListRegions) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "http://example.com/style", LatLngBounds::hull({1, 2}, {3, 4}), 5, 6, 2.0 }; OfflineRegionMetadata metadata {{ 1, 2, 3 }}; OfflineRegion region = db.createRegion(definition, metadata); std::vector regions = db.listRegions(); ASSERT_EQ(1, regions.size()); EXPECT_EQ(region.getID(), regions.at(0).getID()); EXPECT_EQ(definition.styleURL, regions.at(0).getDefinition().styleURL); EXPECT_EQ(definition.bounds, regions.at(0).getDefinition().bounds); EXPECT_EQ(definition.minZoom, regions.at(0).getDefinition().minZoom); EXPECT_EQ(definition.maxZoom, regions.at(0).getDefinition().maxZoom); EXPECT_EQ(definition.pixelRatio, regions.at(0).getDefinition().pixelRatio); EXPECT_EQ(metadata, regions.at(0).getMetadata()); } TEST(OfflineDatabase, GetRegionDefinition) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "http://example.com/style", LatLngBounds::hull({1, 2}, {3, 4}), 5, 6, 2.0 }; OfflineRegionMetadata metadata {{ 1, 2, 3 }}; OfflineRegion region = db.createRegion(definition, metadata); OfflineRegionDefinition result = db.getRegionDefinition(region.getID()); EXPECT_EQ(definition.styleURL, result.styleURL); EXPECT_EQ(definition.bounds, result.bounds); EXPECT_EQ(definition.minZoom, result.minZoom); EXPECT_EQ(definition.maxZoom, result.maxZoom); EXPECT_EQ(definition.pixelRatio, result.pixelRatio); } TEST(OfflineDatabase, DeleteRegion) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "http://example.com/style", LatLngBounds::hull({1, 2}, {3, 4}), 5, 6, 2.0 }; OfflineRegionMetadata metadata {{ 1, 2, 3 }}; OfflineRegion region = db.createRegion(definition, metadata); Response response; response.noContent = true; db.putRegionResource(region.getID(), Resource::style("http://example.com/"), response); db.putRegionResource(region.getID(), Resource::tile("http://example.com/", 1.0, 0, 0, 0), response); db.deleteRegion(std::move(region)); ASSERT_EQ(0, db.listRegions().size()); } TEST(OfflineDatabase, CreateRegionInfiniteMaxZoom) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "", LatLngBounds::world(), 0, INFINITY, 1.0 }; OfflineRegionMetadata metadata; OfflineRegion region = db.createRegion(definition, metadata); EXPECT_EQ(0, region.getDefinition().minZoom); EXPECT_EQ(INFINITY, region.getDefinition().maxZoom); } TEST(OfflineDatabase, ConcurrentUse) { using namespace mbgl; createDir("test/fixtures/database"); deleteFile("test/fixtures/database/offline.db"); OfflineDatabase db1("test/fixtures/database/offline.db"); OfflineDatabase db2("test/fixtures/database/offline.db"); Resource resource { Resource::Style, "http://example.com/" }; Response response; response.noContent = true; std::thread thread1([&] { for (auto i = 0; i < 100; i++) { db1.put(resource, response); EXPECT_TRUE(bool(db1.get(resource))); } }); std::thread thread2([&] { for (auto i = 0; i < 100; i++) { db2.put(resource, response); EXPECT_TRUE(bool(db2.get(resource))); } }); thread1.join(); thread2.join(); } static std::shared_ptr randomString(size_t size) { auto result = std::make_shared(size, 0); std::mt19937 random; for (size_t i = 0; i < size; i++) { (*result)[i] = random(); } return result; } TEST(OfflineDatabase, PutReturnsSize) { using namespace mbgl; OfflineDatabase db(":memory:"); Response compressible; compressible.data = std::make_shared(1024, 0); EXPECT_EQ(17, db.put(Resource::style("http://example.com/compressible"), compressible).second); Response incompressible; incompressible.data = randomString(1024); EXPECT_EQ(1024, db.put(Resource::style("http://example.com/incompressible"), incompressible).second); Response noContent; noContent.noContent = true; EXPECT_EQ(0, db.put(Resource::style("http://example.com/noContent"), noContent).second); } TEST(OfflineDatabase, PutEvictsLeastRecentlyUsedResources) { using namespace mbgl; OfflineDatabase db(":memory:", 1024 * 25); Response response; response.data = randomString(1024); for (uint32_t i = 1; i <= 20; i++) { Resource resource = Resource::style("http://example.com/"s + util::toString(i)); db.put(resource, response); EXPECT_TRUE(bool(db.get(resource))) << i; } EXPECT_FALSE(bool(db.get(Resource::style("http://example.com/1")))); } TEST(OfflineDatabase, PutRegionResourceDoesNotEvict) { using namespace mbgl; OfflineDatabase db(":memory:", 1024 * 25); OfflineRegionDefinition definition { "", LatLngBounds::world(), 0, INFINITY, 1.0 }; OfflineRegion region = db.createRegion(definition, OfflineRegionMetadata()); Response response; response.data = randomString(1024); for (uint32_t i = 1; i <= 20; i++) { db.putRegionResource(region.getID(), Resource::style("http://example.com/"s + util::toString(i)), response); } EXPECT_TRUE(bool(db.get(Resource::style("http://example.com/1")))); EXPECT_TRUE(bool(db.get(Resource::style("http://example.com/20")))); } TEST(OfflineDatabase, PutFailsWhenEvictionInsuffices) { using namespace mbgl; Log::setObserver(std::make_unique()); OfflineDatabase db(":memory:", 1024 * 25); Response small; small.data = randomString(1024); for (uint32_t i = 1; i <= 10; i++) { db.put(Resource::style("http://example.com/"s + util::toString(i)), small); } Response big; big.data = randomString(1024 * 15); db.put(Resource::style("http://example.com/big"), big); EXPECT_FALSE(bool(db.get(Resource::style("http://example.com/big")))); auto observer = Log::removeObserver(); auto flo = dynamic_cast(observer.get()); EXPECT_EQ(1ul, flo->count({ EventSeverity::Warning, Event::Database, -1, "Unable to make space for entry" })); } TEST(OfflineDatabase, OfflineMapboxTileCount) { using namespace mbgl; OfflineDatabase db(":memory:"); OfflineRegionDefinition definition { "http://example.com/style", LatLngBounds::hull({1, 2}, {3, 4}), 5, 6, 2.0 }; OfflineRegionMetadata metadata; OfflineRegion region1 = db.createRegion(definition, metadata); OfflineRegion region2 = db.createRegion(definition, metadata); Resource nonMapboxTile = Resource::tile("http://example.com/", 1.0, 0, 0, 0); Resource mapboxTile1 = Resource::tile("mapbox://tiles/1", 1.0, 0, 0, 0); Resource mapboxTile2 = Resource::tile("mapbox://tiles/2", 1.0, 0, 0, 1); Response response; response.data = std::make_shared("data"); // Count is initially zero. EXPECT_EQ(0, db.getOfflineMapboxTileCount()); // Count stays the same after putting a non-tile resource. db.putRegionResource(region1.getID(), Resource::style("http://example.com/"), response); EXPECT_EQ(0, db.getOfflineMapboxTileCount()); // Count stays the same after putting a non-Mapbox tile. db.putRegionResource(region1.getID(), nonMapboxTile, response); EXPECT_EQ(0, db.getOfflineMapboxTileCount()); // Count increases after putting a Mapbox tile not used by another region. db.putRegionResource(region1.getID(), mapboxTile1, response); EXPECT_EQ(1, db.getOfflineMapboxTileCount()); // Count stays the same after putting a Mapbox tile used by another region. db.putRegionResource(region2.getID(), mapboxTile1, response); EXPECT_EQ(1, db.getOfflineMapboxTileCount()); // Count stays the same after putting a Mapbox tile used by the same region. db.putRegionResource(region2.getID(), mapboxTile1, response); EXPECT_EQ(1, db.getOfflineMapboxTileCount()); // Count stays the same after deleting a region when the tile is still used by another region. db.deleteRegion(std::move(region2)); EXPECT_EQ(1, db.getOfflineMapboxTileCount()); // Count stays the same after the putting a non-offline Mapbox tile. db.put(mapboxTile2, response); EXPECT_EQ(1, db.getOfflineMapboxTileCount()); // Count increases after putting a pre-existing, but non-offline Mapbox tile. db.putRegionResource(region1.getID(), mapboxTile2, response); EXPECT_EQ(2, db.getOfflineMapboxTileCount()); // Count decreases after deleting a region when the tiles are not used by other regions. db.deleteRegion(std::move(region1)); EXPECT_EQ(0, db.getOfflineMapboxTileCount()); }