Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OPDS name mapper #830

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

OPDS name mapper #830

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
cc849b3
[New] Use a macro to define catalog's entries in test.
mgautierfr Oct 18, 2022
96fb423
Make the opds_dumper respect the provided nameMapper used in the server.
mgautierfr Oct 5, 2022
24472e0
fixup! Make the opds_dumper respect the provided nameMapper used in t…
mgautierfr Oct 18, 2022
85f58b8
Introduce a ServerConfiguration object.
mgautierfr Oct 6, 2022
5896691
fixup! Introduce a ServerConfiguration object.
mgautierfr Oct 12, 2022
0bd5a5e
Do not store raw pointer to Library.
mgautierfr Oct 6, 2022
4842fa0
fixup! Do not store raw pointer to Library.
mgautierfr Oct 12, 2022
3d75f24
Do not store raw pointer to NameMapper.
mgautierfr Oct 7, 2022
92c0e14
Make internalServer use m_root from configuration instead of using it…
mgautierfr Oct 7, 2022
422e71a
Make InternalServer use the NameMapper of the configuration.
mgautierfr Oct 7, 2022
3e54e56
[NEW] Make InternalServer inherite Server::Configuration.
mgautierfr Oct 12, 2022
6815a4c
Make the OPDSDumper use the ServerConfiguration.
mgautierfr Oct 7, 2022
37ccfb5
Make `fullEntryXML` use the configuration to get the bookName.
mgautierfr Oct 7, 2022
7d83127
Change the default NameMappe to use a `HumanReadableNameMapper`
mgautierfr Oct 7, 2022
1fcc2ad
Add a `Server::isRunning` to know if the server is running or not.
mgautierfr Oct 7, 2022
d112470
Make `kiwix::Server` a simple wrapper around `kiwix::InternalServer`.
mgautierfr Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 50 additions & 50 deletions test/library.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "gtest/gtest.h"
#include <string>

#include "testing_tools.h"

const char * sampleOpdsStream = R"(
<feed xmlns="http://www.w3.org/2005/Atom"
Expand Down Expand Up @@ -236,14 +237,14 @@ namespace

TEST(LibraryOpdsImportTest, allInOne)
{
auto lib = std::make_shared<kiwix::Library>();
kiwix::Manager manager(lib);
kiwix::Library lib;
kiwix::Manager manager{NotOwned<kiwix::Library>(lib)};
manager.readOpds(sampleOpdsStream, "library-opds-import.unittests.dev");

EXPECT_EQ(10U, lib->getBookCount(true, true));
EXPECT_EQ(10U, lib.getBookCount(true, true));

{
const kiwix::Book& book1 = lib->getBookById("0c45160e-f917-760a-9159-dfe3c53cdcdd");
const kiwix::Book& book1 = lib.getBookById("0c45160e-f917-760a-9159-dfe3c53cdcdd");

EXPECT_EQ(book1.getTitle(), "Encyclopédie de la Tunisie");
EXPECT_EQ(book1.getName(), "wikipedia_fr_tunisie_novid_2018-10");
Expand All @@ -268,7 +269,7 @@ TEST(LibraryOpdsImportTest, allInOne)
}

{
const kiwix::Book& book2 = lib->getBookById("0189d9be-2fd0-b4b6-7300-20fab0b5cdc8");
const kiwix::Book& book2 = lib.getBookById("0189d9be-2fd0-b4b6-7300-20fab0b5cdc8");
EXPECT_EQ(book2.getTitle(), "TED talks - Business");
EXPECT_EQ(book2.getName(), "");
EXPECT_EQ(book2.getFlavour(), "");
Expand Down Expand Up @@ -298,11 +299,10 @@ class LibraryTest : public ::testing::Test {
typedef std::vector<std::string> TitleCollection;

explicit LibraryTest()
: lib(std::make_shared<kiwix::Library>())
{}

void SetUp() override {
kiwix::Manager manager(lib);
kiwix::Manager manager{NotOwned<kiwix::Library>(lib)};
manager.readOpds(sampleOpdsStream, "foo.urlHost");
manager.readXml(sampleLibraryXML, false, "./test/library.xml", true);
}
Expand All @@ -316,25 +316,25 @@ class LibraryTest : public ::testing::Test {
TitleCollection ids2Titles(const BookIdCollection& ids) {
TitleCollection titles;
for ( const auto& bookId : ids ) {
titles.push_back(lib->getBookById(bookId).getTitle());
titles.push_back(lib.getBookById(bookId).getTitle());
}
std::sort(titles.begin(), titles.end());
return titles;
}

std::shared_ptr<kiwix::Library> lib;
kiwix::Library lib;
};

TEST_F(LibraryTest, getBookMarksTest)
{
auto bookId1 = lib->getBooksIds()[0];
auto bookId2 = lib->getBooksIds()[1];
auto bookId1 = lib.getBooksIds()[0];
auto bookId2 = lib.getBooksIds()[1];

lib->addBookmark(createBookmark(bookId1));
lib->addBookmark(createBookmark("invalid-bookmark-id"));
lib->addBookmark(createBookmark(bookId2));
auto onlyValidBookmarks = lib->getBookmarks();
auto allBookmarks = lib->getBookmarks(false);
lib.addBookmark(createBookmark(bookId1));
lib.addBookmark(createBookmark("invalid-bookmark-id"));
lib.addBookmark(createBookmark(bookId2));
auto onlyValidBookmarks = lib.getBookmarks();
auto allBookmarks = lib.getBookmarks(false);

EXPECT_EQ(onlyValidBookmarks[0].getBookId(), bookId1);
EXPECT_EQ(onlyValidBookmarks[1].getBookId(), bookId2);
Expand All @@ -346,11 +346,11 @@ TEST_F(LibraryTest, getBookMarksTest)

TEST_F(LibraryTest, sanityCheck)
{
EXPECT_EQ(lib->getBookCount(true, true), 12U);
EXPECT_EQ(lib->getBooksLanguages(),
EXPECT_EQ(lib.getBookCount(true, true), 12U);
EXPECT_EQ(lib.getBooksLanguages(),
std::vector<std::string>({"deu", "eng", "fra"})
);
EXPECT_EQ(lib->getBooksCreators(), std::vector<std::string>({
EXPECT_EQ(lib.getBooksCreators(), std::vector<std::string>({
"Islam Stack Exchange",
"Movies & TV Stack Exchange",
"Mythology & Folklore Stack Exchange",
Expand All @@ -361,7 +361,7 @@ TEST_F(LibraryTest, sanityCheck)
"Wikipedia",
"Wikiquote"
}));
EXPECT_EQ(lib->getBooksPublishers(), std::vector<std::string>({
EXPECT_EQ(lib.getBooksPublishers(), std::vector<std::string>({
"",
"Kiwix",
"Kiwix & Some Enthusiasts",
Expand All @@ -371,22 +371,22 @@ TEST_F(LibraryTest, sanityCheck)

TEST_F(LibraryTest, categoryHandling)
{
EXPECT_EQ("", lib->getBookById("0c45160e-f917-760a-9159-dfe3c53cdcdd").getCategory());
EXPECT_EQ("category_defined_via_tags_only", lib->getBookById("0d0bcd57-d3f6-cb22-44cc-a723ccb4e1b2").getCategory());
EXPECT_EQ("category_defined_via_category_element_only", lib->getBookById("0ea1cde6-441d-6c58-f2c7-21c2838e659f").getCategory());
EXPECT_EQ("category_element_overrides_tags", lib->getBookById("1123e574-6eef-6d54-28fc-13e4caeae474").getCategory());
EXPECT_EQ("category_element_overrides_tags", lib->getBookById("14829621-c490-c376-0792-9de558b57efa").getCategory());
EXPECT_EQ("", lib.getBookById("0c45160e-f917-760a-9159-dfe3c53cdcdd").getCategory());
EXPECT_EQ("category_defined_via_tags_only", lib.getBookById("0d0bcd57-d3f6-cb22-44cc-a723ccb4e1b2").getCategory());
EXPECT_EQ("category_defined_via_category_element_only", lib.getBookById("0ea1cde6-441d-6c58-f2c7-21c2838e659f").getCategory());
EXPECT_EQ("category_element_overrides_tags", lib.getBookById("1123e574-6eef-6d54-28fc-13e4caeae474").getCategory());
EXPECT_EQ("category_element_overrides_tags", lib.getBookById("14829621-c490-c376-0792-9de558b57efa").getCategory());
}

TEST_F(LibraryTest, emptyFilter)
{
const auto bookIds = lib->filter(kiwix::Filter());
EXPECT_EQ(bookIds, lib->getBooksIds());
const auto bookIds = lib.filter(kiwix::Filter());
EXPECT_EQ(bookIds, lib.getBooksIds());
}

#define EXPECT_FILTER_RESULTS(f, ...) \
EXPECT_EQ( \
ids2Titles(lib->filter(f)), \
ids2Titles(lib.filter(f)), \
TitleCollection({ __VA_ARGS__ }) \
)

Expand Down Expand Up @@ -736,51 +736,51 @@ TEST_F(LibraryTest, filterByMultipleCriteria)

TEST_F(LibraryTest, getBookByPath)
{
kiwix::Book book = lib->getBookById(lib->getBooksIds()[0]);
kiwix::Book book = lib.getBookById(lib.getBooksIds()[0]);
#ifdef _WIN32
auto path = "C:\\some\\abs\\path.zim";
#else
auto path = "/some/abs/path.zim";
#endif
book.setPath(path);
lib->addBook(book);
EXPECT_EQ(lib->getBookByPath(path).getId(), book.getId());
EXPECT_THROW(lib->getBookByPath("non/existant/path.zim"), std::out_of_range);
lib.addBook(book);
EXPECT_EQ(lib.getBookByPath(path).getId(), book.getId());
EXPECT_THROW(lib.getBookByPath("non/existant/path.zim"), std::out_of_range);
}

TEST_F(LibraryTest, removeBookByIdRemovesTheBook)
{
const auto initialBookCount = lib->getBookCount(true, true);
const auto initialBookCount = lib.getBookCount(true, true);
ASSERT_GT(initialBookCount, 0U);
EXPECT_NO_THROW(lib->getBookById("raycharles"));
lib->removeBookById("raycharles");
EXPECT_EQ(initialBookCount - 1, lib->getBookCount(true, true));
EXPECT_THROW(lib->getBookById("raycharles"), std::out_of_range);
EXPECT_NO_THROW(lib.getBookById("raycharles"));
lib.removeBookById("raycharles");
EXPECT_EQ(initialBookCount - 1, lib.getBookCount(true, true));
EXPECT_THROW(lib.getBookById("raycharles"), std::out_of_range);
};

TEST_F(LibraryTest, removeBookByIdDropsTheReader)
{
EXPECT_NE(nullptr, lib->getArchiveById("raycharles"));
lib->removeBookById("raycharles");
EXPECT_THROW(lib->getArchiveById("raycharles"), std::out_of_range);
EXPECT_NE(nullptr, lib.getArchiveById("raycharles"));
lib.removeBookById("raycharles");
EXPECT_THROW(lib.getArchiveById("raycharles"), std::out_of_range);
};

TEST_F(LibraryTest, removeBookByIdUpdatesTheSearchDB)
{
kiwix::Filter f;
f.local(true).valid(true).query(R"(title:"ray charles")", false);

EXPECT_NO_THROW(lib->getBookById("raycharles"));
EXPECT_EQ(1U, lib->filter(f).size());
EXPECT_NO_THROW(lib.getBookById("raycharles"));
EXPECT_EQ(1U, lib.filter(f).size());

lib->removeBookById("raycharles");
lib.removeBookById("raycharles");

EXPECT_THROW(lib->getBookById("raycharles"), std::out_of_range);
EXPECT_EQ(0U, lib->filter(f).size());
EXPECT_THROW(lib.getBookById("raycharles"), std::out_of_range);
EXPECT_EQ(0U, lib.filter(f).size());

// make sure that Library::filter() doesn't add an empty book with
// an id surviving in the search DB
EXPECT_THROW(lib->getBookById("raycharles"), std::out_of_range);
EXPECT_THROW(lib.getBookById("raycharles"), std::out_of_range);
};

TEST_F(LibraryTest, removeBooksNotUpdatedSince)
Expand All @@ -800,12 +800,12 @@ TEST_F(LibraryTest, removeBooksNotUpdatedSince)
"Wikiquote"
);

const uint64_t rev = lib->getRevision();
for ( const auto& id : lib->filter(kiwix::Filter().query("exchange")) ) {
lib->addBook(lib->getBookByIdThreadSafe(id));
const uint64_t rev = lib.getRevision();
for ( const auto& id : lib.filter(kiwix::Filter().query("exchange")) ) {
lib.addBook(lib.getBookByIdThreadSafe(id));
}

EXPECT_EQ(9u, lib->removeBooksNotUpdatedSince(rev));
EXPECT_EQ(9u, lib.removeBooksNotUpdatedSince(rev));

EXPECT_FILTER_RESULTS(kiwix::Filter(),
"Islam Stack Exchange",
Expand Down
28 changes: 15 additions & 13 deletions test/manager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@
#include <iostream>
#include <fstream>

#include "testing_tools.h"

TEST(ManagerTest, addBookFromPathAndGetIdTest)
{
auto lib = std::make_shared<kiwix::Library>();
kiwix::Manager manager = kiwix::Manager(lib);
kiwix::Library lib;
kiwix::Manager manager = kiwix::Manager(NotOwned<kiwix::Library>(lib));

auto bookId = manager.addBookFromPathAndGetId("./test/example.zim");
ASSERT_NE(bookId, "");
kiwix::Book book = lib->getBookById(bookId);
kiwix::Book book = lib.getBookById(bookId);
EXPECT_EQ(book.getPath(), kiwix::computeAbsolutePath("", "./test/example.zim"));

const std::string pathToSave = "./pathToSave";
const std::string url = "url";
bookId = manager.addBookFromPathAndGetId("./test/example.zim", pathToSave, url, true);
book = lib->getBookById(bookId);
book = lib.getBookById(bookId);
auto savedPath = kiwix::computeAbsolutePath(kiwix::removeLastPathElement(manager.writableLibraryPath), pathToSave);
EXPECT_EQ(book.getPath(), savedPath);
EXPECT_EQ(book.getUrl(), url);
Expand Down Expand Up @@ -48,11 +50,11 @@ const char sampleLibraryXML[] = R"(

TEST(ManagerTest, readXml)
{
auto lib = std::make_shared<kiwix::Library>();
kiwix::Manager manager = kiwix::Manager(lib);
kiwix::Library lib;
kiwix::Manager manager = kiwix::Manager(NotOwned<kiwix::Library>(lib));

EXPECT_EQ(true, manager.readXml(sampleLibraryXML, true, "/data/lib.xml", true));
kiwix::Book book = lib->getBookById("0d0bcd57-d3f6-cb22-44cc-a723ccb4e1b2");
kiwix::Book book = lib.getBookById("0d0bcd57-d3f6-cb22-44cc-a723ccb4e1b2");
EXPECT_EQ("/data/zimfiles/unittest.zim", book.getPath());
EXPECT_EQ("https://example.com/zimfiles/unittest.zim", book.getUrl());
EXPECT_EQ("Unit Test", book.getTitle());
Expand All @@ -70,24 +72,24 @@ TEST(ManagerTest, readXml)

TEST(Manager, reload)
{
auto lib = std::make_shared<kiwix::Library>();
kiwix::Manager manager(lib);
kiwix::Library lib;
kiwix::Manager manager = kiwix::Manager(NotOwned<kiwix::Library>(lib));

manager.reload({ "./test/library.xml" });
EXPECT_EQ(lib->getBooksIds(), (kiwix::Library::BookIdCollection{
EXPECT_EQ(lib.getBooksIds(), (kiwix::Library::BookIdCollection{
"charlesray",
"raycharles",
"raycharles_uncategorized"
}));

lib->removeBookById("raycharles");
EXPECT_EQ(lib->getBooksIds(), (kiwix::Library::BookIdCollection{
lib.removeBookById("raycharles");
EXPECT_EQ(lib.getBooksIds(), (kiwix::Library::BookIdCollection{
"charlesray",
"raycharles_uncategorized"
}));

manager.reload({ "./test/library.xml" });
EXPECT_EQ(lib->getBooksIds(), kiwix::Library::BookIdCollection({
EXPECT_EQ(lib.getBooksIds(), kiwix::Library::BookIdCollection({
"charlesray",
"raycharles",
"raycharles_uncategorized"
Expand Down
Loading