Merge branch 'master' of https://github.com/blizzard4591/qt5-sqlcipher

Author: blizzard4591

CMakeLists.txt

@@ -1,15 +1,31 @@
 cmake_minimum_required(VERSION 3.0)
-project(qsqlcipher)
+project(libqt5sql5-sqlcipher)
 
 set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};${PROJECT_SOURCE_DIR}/cmake/")
-SET(CMAKE_PREFIX_PATH "D:/Qt/5.9.2/msvc2017_64/lib/cmake/")
+
+if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+	SET(CMAKE_PREFIX_PATH "C:/Qt/5.9.2/msvc2017_64/lib/cmake/")
+else()
+	SET(CMAKE_PREFIX_PATH "C:/Qtx86/5.9.2/msvc2015/lib/cmake/")
+endif()
 
 find_package(Qt5Sql REQUIRED)
-find_package(PkgConfig REQUIRED)
 
 if (NOT WIN32)
+	find_package(PkgConfig REQUIRED)
 	pkg_check_modules(SQLCIPHER REQUIRED sqlcipher)
 else()
+	if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+		set(_lib_suffix_win "x64")
+	else()
+		set(_lib_suffix_win "x86")
+	endif()
+
+	# Change this by hand if needed
+	set(Libsqlcipher_INCLUDE_DIRS "C:/CppProjects/sqlcipher/include")
+	# Change this by hand if needed
+	set(Libsqlcipher_LIBRARIES "optimized;C:/CppProjects/sqlcipher/compile/${_lib_suffix_win}/Release/sqlite3.lib;debug;C:/CppProjects/sqlcipher/compile/${_lib_suffix_win}/Debug/sqlite3.lib")
+
 	find_package(Libsqlcipher REQUIRED)
 endif()
 
@@ -19,9 +35,16 @@ set(CMAKE_AUTOMOC ON)
 # Arrange output paths so that the plugin is found in the default search path
 # relative to the test binary.
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/sqldrivers)
+if (NOT WIN32)
+	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/sqldrivers)
+else()
+	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG ${CMAKE_BINARY_DIR}/Debug/sqldrivers)
+	set(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE ${CMAKE_BINARY_DIR}/Release/sqldrivers)
+endif()
 
 option(QSQLCIPHER_STATIC "Build plugin as a static library" OFF)
+option(QSQLCIPHER_BUILD_TESTS "Build the test binary" ON)
+set(QSQLCIPHER_COPYTO_DIR "" CACHE PATH "If set, the build artifact of the library will be copied there")
 
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
@@ -83,27 +106,62 @@ add_library(qsqlcipher ${LIBTYPE}
     "${_PRIVATE_SOURCES_DIRECTORY}/qsql_sqlite.cpp"
 )
 
-if (WIN32)
-	# Change this by hand if needed
-	set(SQLCIPHER_INCLUDE_DIRS "D:/CppProjects/sqlcipher-original")
-endif()
-
 target_include_directories(qsqlcipher PRIVATE
     ${Qt5Sql_PRIVATE_INCLUDE_DIRS}
     ${SQLCIPHER_INCLUDE_DIRS} ${Libsqlcipher_INCLUDE_DIRS}
 )
 
-if (WIN32)
-	# Change this by hand if needed
-	set(SQLCIPHER_LIBRARIES "optimized;D:/CppProjects/sqlcipher-original-build/Retail/x64/sqlite3.lib;debug;D:/CppProjects/sqlcipher-original-build/Debug/x64/sqlite3.lib")
-endif()
-
 target_link_libraries(qsqlcipher
     Qt5::Sql
     ${SQLCIPHER_LIBRARIES} ${Libsqlcipher_LIBRARIES}
 )
 
-include(CTest)
-if(BUILD_TESTING)
+if (NOT ("${QSQLCIPHER_COPYTO_DIR}" STREQUAL ""))
+	add_custom_command(TARGET qsqlcipher POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_FILE:qsqlcipher> ${QSQLCIPHER_COPYTO_DIR}/$<TARGET_FILE_NAME:qsqlcipher>)
+endif()
+
+find_program(DPKG_PROGRAM dpkg DOC "dpkg program of Debian-based systems")
+if (NOT WIN32)
+	if (DPKG_PROGRAM)
+		if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+			INSTALL(TARGETS qsqlcipher DESTINATION lib/x86_64-linux-gnu/qt5/plugins/sqldrivers)
+		else()
+			INSTALL(TARGETS qsqlcipher DESTINATION lib/i386-linux-gnu/qt5/plugins/sqldrivers)
+		endif()
+	else()
+		message(WARNING "Packaging is not set up for this platform, either submit a ticket or change/add pathes yourself, if packaging is required.")
+		INSTALL(TARGETS qsqlcipher DESTINATION sqldrivers)
+	endif()
+else()
+	INSTALL(TARGETS qsqlcipher DESTINATION sqldrivers)
+endif()
+
+#include(CTest)
+if(QSQLCIPHER_BUILD_TESTS)
     add_subdirectory(${TEST_DIR})
 endif()
+
+# Packaging
+SET(CPACK_PACKAGE_NAME "libqt5sql5-sqlcipher")
+SET(CPACK_PACKAGE_CONTACT "[email protected]")
+
+SET(CPACK_PACKAGE_VERSION_MAJOR "0")
+SET(CPACK_PACKAGE_VERSION_MINOR "1")
+SET(CPACK_PACKAGE_VERSION_PATCH "1")
+SET(CPACK_PACKAGE_VERSION_REVISION "1")
+SET(CPACK_PACKAGE_VERSION "${CPACK_PACKAGE_VERSION_MAJOR}.${CPACK_PACKAGE_VERSION_MINOR}.${CPACK_PACKAGE_VERSION_PATCH}")
+
+if (DPKG_PROGRAM)
+	execute_process(COMMAND ${DPKG_PROGRAM} --print-architecture OUTPUT_VARIABLE CPACK_DEBIAN_PACKAGE_ARCHITECTURE OUTPUT_STRIP_TRAILING_WHITESPACE)
+	SET(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}_${CPACK_PACKAGE_VERSION}-${CPACK_PACKAGE_VERSION_REVISION}_${CPACK_DEBIAN_PACKAGE_ARCHITECTURE}")
+else (DPKG_PROGRAM)
+	SET(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}_${CPACK_PACKAGE_VERSION}-${CPACK_PACKAGE_VERSION_REVISION}_${CMAKE_SYSTEM_NAME}")
+	SET(CPACK_DEBIAN_PACKAGE_ARCHITECTURE "amd64")
+endif(DPKG_PROGRAM)
+
+SET(CPACK_DEBIAN_PACKAGE_DEPENDS "libqt5sql5, libsqlcipher0 (>= 3.4.1-1)")
+SET(DEBIAN_PACKAGE_BUILDS_DEPENDS "debhelper (>= 9), cmake (>= 3), qt5-qmake, qtbase5-dev, qtbase5-private-dev, qtbase5-dev-tools, qtmultimedia5-dev, gcc, g++")
+SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "A Qt5 wrapper for using SqlCipher as a QSqlDriver.")
+SET(CPACK_DEBIAN_PACKAGE_SECTION "libs")
+ 
+INCLUDE(CPack)

cmake/FindLibsqlcipher.cmake

@@ -4,7 +4,7 @@
 # This module finds the libsqlcipher header and library files. It
 # sets the following variables.
 #
-# Libsqlcipher_INCLUDE_DIR -  Include directory for Libsqlcipher header files.
+# Libsqlcipher_INCLUDE_DIRS -  Include directories for Libsqlcipher header files.
 # Libsqlcipher_LIBRARIES -	The name of the library to link against.
 #
 # Libsqlcipher_FOUND - Indicates whether Libsqlcipher has been found
@@ -15,7 +15,7 @@ if(PKG_CONFIG_FOUND)
 	pkg_check_modules(Libsqlcipher QUIET SQLCipher)
 endif()
 
-find_path(Libsqlcipher_INCLUDE_DIR sqlcipher/sqlite3.h
+find_path(Libsqlcipher_INCLUDE_DIRS sqlcipher/sqlite3.h
 	HINTS
 	$ENV{LIBSQLCIPHER_DIR}
 	PATH_SUFFIXES include/sqlcipher include
@@ -61,7 +61,6 @@ FIND_LIBRARY(Libsqlcipher_LIBRARIES
   /usr
 )
 
-set(Libsqlcipher_INCLUDE_DIRS ${Libsqlcipher_INCLUDE_DIR})
 find_package_handle_standard_args(Libsqlcipher FOUND_VAR Libsqlcipher_FOUND REQUIRED_VARS Libsqlcipher_LIBRARIES Libsqlcipher_INCLUDE_DIRS)
-mark_as_advanced(Libsqlcipher_INCLUDE_DIR)
+mark_as_advanced(Libsqlcipher_INCLUDE_DIRS)
 mark_as_advanced(Libsqlcipher_LIBRARIES)

test-shared/CMakeLists.txt

@@ -4,4 +4,4 @@ set(CMAKE_CXX_FLAGS "-std=c++14")
 add_executable(qsqlcipher-test main.cpp)
 target_link_libraries(qsqlcipher-test Qt5::Sql)
 
-add_test(NAME qsqlcipher-test COMMAND qsqlcipher-test)
+#add_test(NAME qsqlcipher-test COMMAND qsqlcipher-test)

test-shared/main.cpp

@@ -1,33 +1,31 @@
 #include <QCoreApplication>
-#include <QDebug>
 #include <QtSql>
 #include <QTemporaryDir>
 #include <iostream>
+#include <cstdlib>
 
-#ifndef QT_DEBUG
-#error Must be built in debug mode!
-#endif
+#define QSQLCIPHER_TEST_ASSERT(cond, message) if(!(cond)) { std::cerr << message << std::endl; exit(-1); }
 
 int main(int argc, char *argv[])
 {
 	QCoreApplication app(argc, argv);
 
 	for (const auto& driver : QSqlDatabase::drivers()) {
-		qDebug() << "Available QSqlDatabase driver: " << driver;
+		std::cout << "Available QSqlDatabase driver: " << driver.toStdString() << std::endl;
 	}
 
-	Q_ASSERT(QSqlDatabase::isDriverAvailable("QSQLITE")); // from Qt
-	Q_ASSERT(QSqlDatabase::isDriverAvailable("QSQLCIPHER")); // from our plugin
+	QSQLCIPHER_TEST_ASSERT(QSqlDatabase::isDriverAvailable("QSQLITE"), "QSQLITE driver is not available!"); // from Qt
+	QSQLCIPHER_TEST_ASSERT(QSqlDatabase::isDriverAvailable("QSQLCIPHER"), "QSQLCIPHER driver is not available!"); // from our plugin
 
 	QTemporaryDir tmp;
-	Q_ASSERT(tmp.isValid());
+	QSQLCIPHER_TEST_ASSERT(tmp.isValid(), "Could not get temp directory.");
 
 	auto withDB = [&](const char *driver, auto fn) {
 		QString path = QDir(tmp.path()).absoluteFilePath(QString(driver) + ".db");
 		{
 			QSqlDatabase db = QSqlDatabase::addDatabase(driver, "db");
 			db.setDatabaseName(path);
-			Q_ASSERT(db.open());
+			QSQLCIPHER_TEST_ASSERT(db.open(), "Could not open database!");
 			fn(db);
 		}
 		QSqlDatabase::removeDatabase("db");
@@ -46,27 +44,30 @@ int main(int argc, char *argv[])
 		// Check that we can read from the SQLite db
 		withDB("QSQLITE", [](auto db){
 			QSqlQuery q = db.exec("select bar from foo");
-			Q_ASSERT(q.next());
-			Q_ASSERT(q.value(0).toInt() == 42);
+			QSQLCIPHER_TEST_ASSERT(q.next(), "Expected a fetchable entry in Query object.");
+			QSQLCIPHER_TEST_ASSERT(q.value(0).toInt() == 42, "Database returned invalid value for row!");
 		});
 
 		std::cout << "Running Task 3..." << std::endl;
 		// Check that SQLite is not SQLCipher
 		withDB("QSQLITE", [](auto db){
 			QSqlQuery q = db.exec("select sqlcipher_export()");
 			QString errmsg = q.lastError().databaseText();
-			Q_ASSERT(errmsg.startsWith("no such function"));
+			QSQLCIPHER_TEST_ASSERT(errmsg.startsWith("no such function"), "Database did not respond with the expected error message.");
 		});
 	}
 
 	// QSQLCIPHER
 	{
+#if defined(_WIN32) || defined(_WIN64) || defined(_MSC_VER )
+		std::cout << "Hint: If you get an error in the following task like \"QSQLCIPHER driver not loaded\" then check if library dependencies (e.g. libeay32.dll) are in the same folder as the test executable." << std::endl;
+#endif
 		std::cout << "Running Task 4..." << std::endl;
 		// Check that SQLCipher is not SQLite
 		withDB("QSQLCIPHER", [](auto db){
 			QSqlQuery q = db.exec("select sqlcipher_export()");
 			QString errmsg = q.lastError().databaseText();
-			Q_ASSERT(errmsg.startsWith("wrong number of arguments"));
+			QSQLCIPHER_TEST_ASSERT(errmsg.startsWith("wrong number of arguments"), "Database did not respond with the expected error message.");
 		});
 
 		std::cout << "Running Task 5..." << std::endl;
@@ -84,16 +85,16 @@ int main(int argc, char *argv[])
 		// Check that we can't read from the SQLCipher db without the passphrase
 		withDB("QSQLCIPHER", [](auto db){
 			QSqlQuery q = db.exec("select bar from foo");
-			Q_ASSERT(!q.next());
+			QSQLCIPHER_TEST_ASSERT(!q.next(), "Query returned a fetchable row, this should not be the case.");
 		});
 
 		std::cout << "Running Task 7..." << std::endl;
 		// Check that we can read from the SQLCipher db with the passphrase
 		withDB("QSQLCIPHER", [](auto db){
 			db.exec("PRAGMA key = 'foobar';");
 			QSqlQuery q = db.exec("select bar from foo");
-			Q_ASSERT(q.next());
-			Q_ASSERT(q.value(0).toInt() == 42);
+			QSQLCIPHER_TEST_ASSERT(q.next(), "Expected a fetchable entry in Query object.");
+			QSQLCIPHER_TEST_ASSERT(q.value(0).toInt() == 42, "Database returned invalid value for row!");
 		});
 		std::cout << "Success! All tests completed." << std::endl;
 	}