Merge pull request #33 from kiwix/better_testing

Better testing (coverage)

Author: kelson42

.github/workflows/release.yml

@@ -12,7 +12,7 @@ on:
 jobs:
   publish:
 
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
 
     steps:
       - uses: actions/checkout@v2

lib/build.gradle

@@ -86,7 +86,7 @@ task downloadLibzimSoAndHeaderFiles(type: Download) {
             libzim_base_url + '/libzim_android-arm64.tar.gz',
             libzim_base_url + '/libzim_android-x86.tar.gz',
             libzim_base_url + '/libzim_android-x86_64.tar.gz',
-            libzim_base_url + '/libzim_linux-x86_64.tar.gz'
+            libzim_base_url + '/libzim_linux-x86_64-bionic.tar.gz'
     ])
     dest buildDir
     overwrite true
@@ -106,12 +106,12 @@ task unzipLibzim(type: Copy) {
     from tarTree(buildDir.path + "/libzim_android-x86_64.tar.gz")
     into buildDir
     // unzip linux x86_64
-    from tarTree(buildDir.path + "/libzim_linux-x86_64.tar.gz")
+    from tarTree(buildDir.path + "/libzim_linux-x86_64-bionic.tar.gz")
     into buildDir
 }
 
 task renameLibzimFolders() {
-    renameFolders(buildDir.path,"libzim_")
+    removeDateFromFolderName(buildDir.path,"libzim_")
 }
 
 task copyLibzimHeaderAndSoFiles(type: Copy) {
@@ -147,8 +147,8 @@ task copyLibzimHeaderAndSoFiles(type: Copy) {
 
     copy {
         // copying linux_x86_64 so file
-        project.ext.set("libzim_version", getFileFromFolder(buildDir.path + "/libzim_linux-x86_64/lib/x86_64-linux-gnu/"))
-        from buildDir.path + "/libzim_linux-x86_64/lib/x86_64-linux-gnu/" + libzim_version
+        project.ext.set("libzim_version", getFileFromFolder(buildDir.path + "/libzim_linux-x86_64-bionic/lib/x86_64-linux-gnu/"))
+        from buildDir.path + "/libzim_linux-x86_64-bionic/lib/x86_64-linux-gnu/" + libzim_version
         into buildDir.path
     }
 }
@@ -175,10 +175,10 @@ task downloadLibkiwixSoAndHeaderFiles(type: Download) {
 }
 
 task renameLibkiwixFolders() {
-    renameFolders(buildDir.path,"libkiwix_")
+    removeDateFromFolderName(buildDir.path,"libkiwix_")
 }
 
-static void renameFolders(String path, String startWith) {
+static void removeDateFromFolderName(String path, String startWith) {
     File directory = new File(path)
     if (directory.exists() && directory.isDirectory()) {
         Arrays.stream(directory.listFiles())
@@ -274,20 +274,20 @@ task testSourceJar(type: Jar) {
 
 task compileTestFile(type: JavaCompile) {
     dependsOn testSourceJar
-    source = file('src/test/test.java')
-    destinationDirectory = file('src/test/')
+    source = file('src/test')
+    destinationDirectory = file("$buildDir")
     classpath = files("src/test/junit-4.13.jar" , "src/test/hamcrest-core-1.4.jar", "build/libs/test-sources.jar")
 }
 
 task runTests(type: JavaExec) {
     workingDir("$projectDir/src/test/")
     dependsOn compileTestFile
-    classpath = files('src/test/', 'src/test/java/', 'src/test/junit-4.13.jar', 'src/test/hamcrest-core-1.3.jar')
+    classpath = files("$buildDir", 'src/test/java/', 'src/test/junit-4.13.jar', 'src/test/hamcrest-core-1.3.jar')
     main = 'org.junit.runner.JUnitCore'
     args = ['test']
     jvmArgs = [
             '-Djava.library.path=' + buildDir.path,
-            '-javaagent:jacoco-0.8.7/lib/jacocoagent.jar'
+            '-javaagent:jacoco-0.8.7/lib/jacocoagent.jar=destfile=../../build/jacoco/jacoco.exec'
     ]
 }
 
@@ -297,9 +297,9 @@ task createCodeCoverageReport(type: JavaExec) {
     classpath = files('src/test/', 'src/test/java/', 'src/test/junit-4.13.jar', 'src/test/hamcrest-core-1.3.jar', 'src/test/jacoco-0.8.7/lib/*')
     main = 'org.jacoco.cli.internal.Main'
     args = [
-            'report', 'jacoco.exec',
-            '--classfiles', 'java/org/kiwix/libkiwix/', '--classfiles', 'java/org/kiwix/libzim/',
-            '--html', '../../build/coverage-report', '--xml', 'coverage.xml'
+            'report', '../../build/jacoco/jacoco.exec',
+            '--classfiles', 'java/org/kiwix', '--classfiles', '../../build/org/kiwix',
+            '--html', '../../build/coverage-report', '--xml', '../../build/coverage.xml'
     ]
 }
 

lib/src/test/org/kiwix/test/libkiwix/TestBook.java

@@ -0,0 +1,40 @@
+
+package org.kiwix.test.libkiwix;
+
+import org.kiwix.libkiwix.Book;
+import org.kiwix.libkiwix.Illustration;
+import org.kiwix.test.libzim.TestArchive;
+
+public class TestBook
+{
+  private Book inner;
+  public TestBook() { inner = new Book(); }
+  public TestBook(Book _inner) { inner = _inner; }
+  public Book inner() { return inner; }
+
+  public void update(TestBook book) { inner.update(book.inner()); }
+  public void update(TestArchive archive) { inner.update(archive.inner()); }
+
+  public String getId() { return inner.getId(); }
+  public String getPath() { return inner.getPath(); }
+  public String getHumanReadableIdFromPath() { return inner.getHumanReadableIdFromPath(); }
+  public boolean isPathValid() { return inner.isPathValid(); }
+  public String getTitle() { return inner.getTitle(); }
+  public String getDescription() { return inner.getDescription(); }
+  public String getLanguage() { return inner.getLanguage(); }
+  public String getCreator() { return inner.getCreator(); }
+  public String getPublisher() { return inner.getPublisher(); }
+  public String getDate() { return inner.getDate(); }
+  public String getUrl() { return inner.getUrl(); }
+  public String getName() { return inner.getName(); }
+  public String getFlavour() { return inner.getFlavour(); }
+  public String getCategory() { return inner.getCategory(); }
+  public String getTags() { return inner.getTags(); }
+  public String getTagStr(String tagName) { return inner.getTagStr(tagName); }
+  public long getArticleCount() { return inner.getArticleCount(); }
+  public long getMediaCount() { return inner.getMediaCount(); }
+  public long getSize() { return inner.getSize(); }
+
+  public Illustration[] getIllustrations() { return inner.getIllustrations(); }
+  public Illustration getIllustration(int size) { return inner.getIllustration(size); }
+}

lib/src/test/org/kiwix/test/libkiwix/TestBookmark.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2022 Matthieu Gautier <mgautier@kymeria.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+package org.kiwix.test.libkiwix;
+
+import org.kiwix.libkiwix.Bookmark;
+
+public class TestBookmark
+{
+  private Bookmark inner;
+  public Bookmark inner() { return inner; }
+  public TestBookmark() { inner = new Bookmark(); }
+  public TestBookmark(Bookmark _inner) { inner = _inner; }
+
+  public void setBookId(String bookId) { inner.setBookId(bookId); }
+  public void setBookTitle(String bookTitle) { inner.setBookTitle(bookTitle); }
+  public void setUrl(String url) { inner.setUrl(url); }
+  public void setTitle(String title) { inner.setTitle(title); }
+  public void setLanguage(String language) { inner.setLanguage(language); }
+  public void setDate(String date) { inner.setDate(date); }
+
+  public String getBookId() { return inner.getBookId(); }
+  public String getBookTitle() { return inner.getBookTitle(); }
+  public String getUrl() { return inner.getUrl(); }
+  public String getTitle() { return inner.getTitle(); }
+  public String getLanguage() { return inner.getLanguage(); }
+  public String getDate() { return inner.getDate(); }
+}

lib/src/test/org/kiwix/test/libkiwix/TestLibrary.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (C) 2019-2020 Matthieu Gautier <mgautier@kymeria.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+package org.kiwix.test.libkiwix;
+
+import org.kiwix.libkiwix.Library;
+import org.kiwix.test.libzim.TestArchive;
+import org.kiwix.test.libkiwix.TestBookmark;
+import org.kiwix.libzim.Searcher;
+import org.kiwix.libkiwix.Filter;
+import org.kiwix.libkiwix.JNIKiwixException;
+import java.util.stream.Stream;
+
+public class TestLibrary
+{
+  private Library inner;
+  public Library inner() { return inner; }
+  public TestLibrary() { inner = new  Library(); }
+  public TestLibrary(Library _inner) { inner = _inner; }
+  public boolean addBook(TestBook book) throws JNIKiwixException { return inner.addBook(book.inner());  }
+
+  public TestBook getBookById(String id) { return new TestBook(inner.getBookById(id)); }
+
+  public TestArchive getArchiveById(String id) { return new TestArchive(inner.getArchiveById(id)); }
+  //public native Searcher getSearcherById(String id);
+  //public native Searcher getSearcherByIds(String ids[]);
+
+  public boolean removeBookById(String id) { return inner.removeBookById(id); }
+
+  public boolean writeToFile(String path) { return inner.writeToFile(path); }
+  public boolean writeBookmarksToFile(String path) { return inner.writeBookmarksToFile(path); }
+
+  public int getBookCount(boolean localBooks, boolean remoteBooks) { return inner.getBookCount(localBooks, remoteBooks); }
+
+  public String[] getBooksIds() { return inner.getBooksIds(); }
+  public String[] filter(Filter filter) { return inner.filter(filter); }
+
+  public String[] getBooksLanguages() { return inner.getBooksLanguages(); }
+  public String[] getBooksCategories() { return inner.getBooksCategories(); }
+  public String[] getBooksCreators() { return inner.getBooksCreators(); }
+  public String[] getBooksPublishers() { return inner.getBooksPublishers(); }
+
+  public void addBookmark(TestBookmark bookmark) { inner.addBookmark(bookmark.inner()); }
+  public boolean removeBookmark(String zimId, String url) { return inner.removeBookmark(zimId, url); }
+  public TestBookmark[] getBookmarks(boolean onlyValidBookmarks) { return Stream.of(inner.getBookmarks(onlyValidBookmarks)).map(b -> new TestBookmark(b)).toArray(TestBookmark[]::new); }
+}

lib/src/test/org/kiwix/test/libkiwix/TestManager.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) 2020 Matthieu Gautier <mgautier@kymeria.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+package org.kiwix.test.libkiwix;
+
+import org.kiwix.libkiwix.Manager;
+
+public class TestManager
+{
+  private Manager inner;
+
+  public TestManager(Manager _inner) { inner = _inner; }
+
+  public boolean readFile(String path) { return inner.readFile(path); }
+  public boolean readXml(String content, String libraryPath) { return inner.readXml(content, libraryPath); }
+  public boolean readOpds(String content, String urlHost) { return inner.readOpds(content, urlHost); }
+  public boolean readBookmarkFile(String path) { return inner.readBookmarkFile(path); }
+  public String addBookFromPath(String pathToOpen,
+                                String pathToSave,
+                                String url,
+                                boolean checkMetaData)
+  { return inner.addBookFromPath(pathToOpen, pathToSave, url, checkMetaData); }
+
+  public TestManager(TestLibrary library) {
+    inner = new Manager(library.inner());
+  }
+}

lib/src/test/org/kiwix/test/libkiwix/TestServer.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2019 Matthieu Gautier <mgautier@kymeria.fr>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU  General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+package org.kiwix.test.libkiwix;
+
+import org.kiwix.libkiwix.Library;
+import org.kiwix.libkiwix.Server;
+
+public class TestServer
+{
+  private Server inner;
+
+  public void setRoot(String root) { inner.setRoot(root); }
+  public void setAddress(String address) { inner.setAddress(address); }
+  public void setPort(int port) { inner.setPort(port); }
+  public void setNbThreads(int nbTreads) { inner.setNbThreads(nbTreads); }
+  public void setTaskbar(boolean withTaskBar, boolean witLibraryButton) { inner.setTaskbar(withTaskBar, witLibraryButton); }
+  public void setBlockExternalLinks(boolean blockExternalLinks) { inner.setBlockExternalLinks(blockExternalLinks); }
+  public boolean start() { return inner.start(); }
+  public void stop() { inner.stop(); }
+  public TestServer(TestLibrary library)
+  {
+    inner = new Server(library.inner());
+  }
+}