Merge branch 'add-unit-tests'

Author: legerch

CMakeLists.txt

@@ -32,7 +32,7 @@ set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
 
 # Define project options
-# Example: option(QBAR_BUILD_TESTS "Use to enable/disable build of unit-tests." ON)
+option(QBAR_BUILD_TESTS "Use to enable/disable build of unit-tests." ON)
 
 # Manage global compiler options
 ## For MSVC: force to read source code as UTF-8 file (already default behaviour on GCC/Clang)

README.md

@@ -15,6 +15,7 @@
   - [2.2. Dependencies](#22-dependencies)
 - [3. How to build](#3-how-to-build)
   - [3.1. CMake Usage](#31-cmake-usage)
+  - [3.2. CMake options](#32-cmake-options)
 - [4. How to use](#4-how-to-use)
   - [4.1. Usage](#41-usage)
   - [4.2. Library version](#42-library-version)
@@ -79,6 +80,11 @@ add_subdirectory(qbarcode) # Or if library is put in a folder "dependencies" : a
 target_link_libraries(${PROJECT_NAME} PRIVATE qbarcode)
 ```
 
+## 3.2. CMake options
+
+This library provide some **CMake** build options:
+- `QBAR_BUILD_TESTS` (default: `ON`): Use to enable/disable unit-tests build
+
 # 4. How to use
 ## 4.1. Usage
 

tests/CMakeLists.txt

@@ -0,0 +1,92 @@
+# CMakeLists file based on project template repository: https://github.com/legerch/projects-template
+## Template file version: 2025-07-24 
+
+cmake_minimum_required(VERSION 3.20)
+
+# Set project properties
+set(PROJECT_NAME qbarcode-tests)
+
+# Set project configuration
+## Generic properties
+project(${PROJECT_NAME} LANGUAGES CXX)
+
+## Qt specific properties
+set(CMAKE_AUTOUIC ON)
+set(CMAKE_AUTOMOC ON)
+set(CMAKE_AUTORCC ON)
+
+# Define project options
+# Example: option(QBAR_TESTS_ENABLE_FEAT1 "Use to enable/disable feature1 for tests." ON)
+
+# Set needed packages
+## Qt packages
+set(PROJECT_QT_PACKAGES
+    Core
+    Test
+)
+
+find_package(QT NAMES Qt6 Qt5 COMPONENTS ${PROJECT_QT_PACKAGES} REQUIRED)
+find_package(Qt${QT_VERSION_MAJOR} COMPONENTS ${PROJECT_QT_PACKAGES} REQUIRED)
+
+list(TRANSFORM PROJECT_QT_PACKAGES PREPEND "Qt${QT_VERSION_MAJOR}::")
+
+## Other library packages
+### Example: find_package(nlohmann_json 3.11.3 REQUIRED)
+find_package(GTest 1.11.0 REQUIRED)
+
+# Defines useful path variables for easier CMake configuration
+set(PROJECT_DIR_TESTS_EXTERNAL_RSC  "${CMAKE_CURRENT_SOURCE_DIR}/external-ressources/")
+
+# Manage library files
+## Set tests compilation definitions
+set(PROJECT_DEFS_PRIV
+    QBAR_TESTS_DIR_EXTERNAL_RSC="${PROJECT_DIR_TESTS_EXTERNAL_RSC}"
+)
+
+## Set library linking
+### Linking dirs
+set(PROJECT_LINKING_DIR
+
+)
+
+### Linking libs
+set(PROJECT_LINKING_LIB
+    ${PROJECT_QT_PACKAGES}
+    GTest::gtest_main
+
+    qbarcode
+)
+
+## Set tests files
+set(FILES_HEADERS
+    helpers/testsutils.h
+)
+
+set(FILES_SOURCES
+    helpers/testsutils.cpp
+
+    payloads_tests.cpp
+    qrcode_tests.cpp
+)
+
+# Add files to the test application
+set(PROJECT_FILES ${FILES_HEADERS} ${FILES_SOURCES})
+add_executable(${PROJECT_NAME} ${PROJECT_FILES})
+
+# Link needed libraries
+target_link_directories(${PROJECT_NAME} PUBLIC ${PROJECT_LINKING_DIR})
+target_link_libraries(${PROJECT_NAME} LINK_PUBLIC ${PROJECT_LINKING_LIB})
+
+# Specify compiler options
+target_compile_options(${PROJECT_NAME} PRIVATE
+    $<$<CXX_COMPILER_ID:GNU>:-Wall -Wextra -Werror=return-type -Wshadow -Wlogical-op -Wduplicated-cond -Wduplicated-branches>
+    $<$<CXX_COMPILER_ID:Clang>:-Wall -Wextra -Werror=return-type -Wshadow -Wlogical-op -Wduplicated-cond -Wduplicated-branches>
+    $<$<CXX_COMPILER_ID:MSVC>:/W3 /wd4251>
+)
+
+# Compile needed definitions
+## Application tests related
+target_compile_definitions(${PROJECT_NAME} PRIVATE ${PROJECT_DEFS_PRIV})
+
+# Specify include directories
+set(CMAKE_INCLUDE_CURRENT_DIR ON)

tests/external-ressources/qrcodes/qr_wifi_high.png

@@ -0,0 +1,56 @@
+#include "testsutils.h"
+
+
+
+/*****************************/
+/* Macro definitions         */
+/*****************************/
+#if !defined(QBAR_TESTS_DIR_EXTERNAL_RSC)
+#error "Macro 'QBAR_TESTS_DIR_EXTERNAL_RSC' is not defined, please set up !"
+#endif
+
+/*****************************/
+/* Start namespace           */
+/*****************************/
+
+/*****************************/
+/* Constants defintitions    */
+/*****************************/
+
+/*****************************/
+/* Functions implementations */
+/*****************************/
+
+QFileInfo TestsUtils::getPathRsc(const QString &filename)
+{
+    return QFileInfo(QBAR_TESTS_DIR_EXTERNAL_RSC + filename);
+}
+
+QFileInfo TestsUtils::getPathRscCustom(const QFileInfo &fileInfo, const QString &customName)
+{
+    const QString path = fileInfo.absolutePath();
+    const QString suffix = fileInfo.suffix();
+
+    const QString newFile = QString("%1/%2.%3").arg(path, customName, suffix);
+    return QFileInfo(newFile);
+}
+
+qbar::PayloadQrWifi TestsUtils::createPayloadWifi(IdWifiSec idSec, const QString &ssid, const QString &passwd, bool isHidden)
+{
+    qbar::PayloadQrWifi payload;
+
+    payload.setSecurityType(idSec);
+    payload.setSsid(ssid);
+    payload.setPassword(passwd);
+    payload.setIsHidden(isHidden);
+
+    return payload;
+}
+
+/*****************************/
+/* End namespace             */
+/*****************************/
+
+/*****************************/
+/* End file                  */
+/*****************************/

tests/external-ressources/qrcodes/qr_wifi_high_margin-L10-R10-T0-B0.png

@@ -0,0 +1,19 @@
+#ifndef QBAR_TESTS_HELPERS_TESTSUTILS_H
+#define QBAR_TESTS_HELPERS_TESTSUTILS_H
+
+#include "qbarcode/payloads/payloadqrwifi.h"
+
+#include <QFileInfo>
+
+using IdWifiSec = qbar::PayloadQrWifi::SecurityType;
+
+class TestsUtils
+{
+public:
+    static QFileInfo getPathRsc(const QString &filename);
+    static QFileInfo getPathRscCustom(const QFileInfo &fileInfo, const QString &customName);
+
+    static qbar::PayloadQrWifi createPayloadWifi(IdWifiSec idSec, const QString &ssid, const QString &passwd, bool isHidden);
+};
+
+#endif // QBAR_TESTS_HELPERS_TESTSUTILS_H