namespace for IPRefresher instead of class

error messages in gui.

.gitlab-ci.yml

@@ -1,17 +1,49 @@
 image: luki42/dynuiprefresher_build:latest
 
 stages:
+  - cmake
   - build
+  - build_package
+  - test
 
+cache:
+  paths:
+    - build/
+    - src/
+    - inc/
+    - tests/
+    - postinst
+
+cmake:
+  stage: cmake
+  script:
+    - cmake -S . -B build
 
 build:
   stage: build
   script:
-    - cmake -S . -B build
     - cd build
     - make
-    - make package
   artifacts:
     paths:
       - "build/bin/*"
+
+
+build_package:
+  stage: build_package
+  script:
+    - cd build
+    - make package
+  artifacts:
+    paths:
       - "build/packages/*"
+
+test:
+  stage: test
+  script:
+    - cd build
+    - make test
+    - make build-xml
+  artifacts:
+    reports:
+      junit: build/report.xml

CMakeLists.txt

@@ -1,22 +1,111 @@
+# @author Lukas Heiligenbrunner
+# main CMake file
+#
+# Build lib dependencies:
+## libcurl (with sources)
+## libconfig (with sources)
+#
+# for documenation build doxygen needs to be installed.
+# for test build gtest needs to be installed.
+
 cmake_minimum_required(VERSION 3.13)
 project(iprefresher DESCRIPTION "Dynu ip refresher")
+SET(PROJECT_VERSION 1.3.3)
 
-set(CMAKE_CXX_STANDARD 17)
+# CONFIGURATION
+SET(CMAKE_BUILD_TYPE Release) # manually SET build type (Release / Debug)
+SET(LIB_METHOD STATIC) #SHARED / STATIC
 
-set(CMAKE_BUILD_TYPE Release) # manually set build type (Release / Debug)
+option(BUILD_DOC "Build documentation" ON) # additional dependency for Doxygen
-set(LIB_METHOD STATIC) #SHARED / STATIC
+option(PACKAGING "Allow Packaging to <exe>, <deb> or <rpm>" ON) # additional dependencies for RPMbuild,dpkg  or NSIS
-set(PROJECT_VERSION 1.3.1)
+option(TESTS "Build Tests" ON) # additional dependencies for GTEST - to build tests
-option(BUILD_DOC "Build documentation" ON)
+option(GUI "Build GUI elements" ON) # additional dependencies to QT libraries needed
+set(WinBuild false)
+
+# helper variables
+SET(CMAKE_CXX_STANDARD 17)
+string(TIMESTAMP TIMESTAMP_NOW "%d.%m.%Y")
+
+SET(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+# setup winbuild compilers
+if (${WinBuild})
+    set(LIBSUFFIX .dll)
+    set(SUFFIX .exe)
+
+    set(CMAKE_SYSTEM_NAME WindowsStore)
+    set(CMAKE_SYSTEM_VERSION 10.0)
+    set(TOOLCHAIN_PREFIX x86_64-w64-mingw32) # x64 build toolchain
+    #set(TOOLCHAIN_PREFIX i686-w64-mingw32)
+
+    # cross compilers to use for C and C++
+    set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc)
+    set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++)
+    set(CMAKE_RC_COMPILER ${TOOLCHAIN_PREFIX}-windres)
+
+    # target environment on the build host system
+    set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX})
+
+
+    # modify default behavior of FIND_XXX() commands to
+    # search for headers/libs in the target environment and
+    # search for programs in the build host environment
+    set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
+    set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+    set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+    set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
+
+    set(CMAKE_CXX_STANDARD_LIBRARIES "${CMAKE_CSS_STANDARD_LIBRARIES}")
+    set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS}")
+    # currently libs are dynamically linked eg. dlls have to be copied to same folder
+    # todo link dynamically.
+    # maybe so: set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -static-libgcc -static-libstdc++ -static")
+    # or set(CMAKE_CXX_STANDARD_LIBRARIES -lcurl -lpthread -static-libgcc -static-libstdc++ -lcrypto -lssl -lws2_32 -static -DCURL_STATICLIB)
+    # or add_definitions(-DCURL_STATICLIB)
+
+    # windows config path is same as executable
+    set(CONFIG_PATH "./iprefresher.cfg")
+else ()
+    set(LIBSUFFIX .so)
+    set(SUFFIX "")
+
+    # set /etc/ config path
+    set(CONFIG_PATH "/etc/iprefresher.cfg")
+endif ()
 
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 # config libs
 message(STATUS "Config of Libraries")
 # libcurl
+if (${WinBuild})
+    SET(CMAKE_FIND_LIBRARY_SUFFIXES ".lib" ".dll")
+    # configure libcurl
+    FIND_PATH(CURL_INCLUDE_DIRS curl/curl.h /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/include/) # search for libconfig include headers
+    FIND_LIBRARY(CURL_LIBRARIES NAMES libcurl.dll.a HINTS /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib) # search for actual lib
+
+    message(STATUS "Using CURL include dir(s): ${CURL_INCLUDE_DIRS}")
+    message(STATUS "Using CURL lib(s): ${CURL_LIBRARIES}")
+    message(STATUS "")
+
+    include_directories(${CURL_INCLUDE_DIRS} inc)
+
+    # configure libconfig
+    FIND_PATH(LIBCONFIG++_INCLUDE_DIRS libconfig.h++ /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/include/) # search for libconfig include headers
+    FIND_LIBRARY(LIBCONFIG++_LIBRARIES NAMES libconfig++.dll.a HINTS /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib) # search for actual lib
+
+    message(STATUS "Using LIBCONFIG++ include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
+    message(STATUS "Using LIBCONFIG++ lib(s): ${LIBCONFIG++_LIBRARIES}")
+
+    include_directories(${LIBCONFIG++_INCLUDE_DIRS} inc)
+
+    if (${GUI})
+        set(CMAKE_PREFIX_PATH "/usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/lib/cmake")
+    endif ()
+else ()
     find_package(CURL REQUIRED)
-if (CURL_FOUND)
+    if (CURL_INCLUDE_DIRS AND CURL_LIBRARIES)
         message(STATUS "Found CURL version: ${CURL_VERSION_STRING}")
         message(STATUS "Using CURL include dir(s): ${CURL_INCLUDE_DIRS}")
         message(STATUS "Using CURL lib(s): ${CURL_LIBRARIES}")
@@ -25,69 +114,161 @@ else ()
     endif ()
     include_directories(${CURL_INCLUDE_DIR} inc)
 
+    message("")
     # libconfig
-FIND_PATH(LIBCONFIG_INCLUDE_DIR libconfig.h++ /usr/include /usr/local/include) # search for libconfig include headers
+    FIND_PATH(LIBCONFIG++_INCLUDE_DIRS
-FIND_LIBRARY(CONFIG++_LIBRARY NAMES config++ PATH /usr/lib /usr/local/lib) # search for actual lib
+            NAMES libconfig.h++
+            PATHS /usr/include /usr/local/include) # search for libconfig include headers
+    FIND_LIBRARY(LIBCONFIG++_LIBRARIES
+            NAMES config++
+            PATHS /usr/lib /usr/local/lib) # search for actual lib
 
-IF (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
+    if (LIBCONFIG++_INCLUDE_DIRS AND LIBCONFIG++_LIBRARIES)
-    MESSAGE(STATUS "Found Config++: ${CONFIG++_LIBRARY}")
+        message(STATUS "Fount libconfig!")
-ELSE (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
+        message(STATUS "Using libconfig include dir(s): ${LIBCONFIG++_INCLUDE_DIRS}")
-    IF (NOT LIBCONFIG_INCLUDE_DIR)
+        message(STATUS "Using libconfig lib(s): ${LIBCONFIG++_LIBRARIES}")
-        MESSAGE(FATAL_ERROR "Could not find LibConfig++ header file! Try to install 'libconfig-devel'")
+    else ()
-    ENDIF (NOT LIBCONFIG_INCLUDE_DIR)
+        message(FATAL_ERROR "Could not find LIBCONFIG")
+    endif ()
 
-    IF (NOT CONFIG++_LIBRARY)
+    include_directories(${LIBCONFIG_INCLUDE_DIRS})
-        MESSAGE(FATAL_ERROR "Could not find LibConfig++ library file! Try to install 'libconfig'")
+endif ()
-    ENDIF (NOT CONFIG++_LIBRARY)
-ENDIF (CONFIG++_LIBRARY AND LIBCONFIG_INCLUDE_DIR)
 
-include_directories(${LIBCONFIG_INCLUDE_DIR})
+if (${GUI})
+    set(CMAKE_AUTOMOC ON)
+    set(CMAKE_INCLUDE_CURRENT_DIR ON)
+
+    find_package(Qt5Widgets REQUIRED)
+    find_package(Qt5PrintSupport REQUIRED)
+    find_package(Qt5Sql REQUIRED)
+endif ()
 
 message("")
 
+#read sample config
+FILE(READ ${CMAKE_SOURCE_DIR}/config/iprefresher.cfg SAMPLECONFIG)
 #add version header
 FILE(WRITE ${CMAKE_SOURCE_DIR}/inc/Version.h
-        "\#pragma once\nclass Version {\npublic:\n  static const std::string VERSION;\n};\n\nstd::string const Version::VERSION = \"${PROJECT_VERSION}\";"
+        "/**
+ * Version header to store Version, Config dir and a Sample config
+ * Do not edit this file manually, it is generated by the cmake script!
+ *
+ * @author Lukas Heiligenbrunner
+ * @date ${TIMESTAMP_NOW}
+ */
+
+#pragma once
+
+#include <string>
+
+namespace Version {
+  const std::string VERSION = \"${PROJECT_VERSION}\";
+  const std::string ConfigDir = \"${CONFIG_PATH}\";
+  const std::string SAMPLECONFIG = R\"(${SAMPLECONFIG})\";
+}"
         )
 
 add_library(api ${LIB_METHOD}
         src/api/API.cpp
-
         src/api/TelegramAPI.cpp
-
         src/api/DynuAPI.cpp
+        src/api/IPAPI.cpp)
 
-        src/api/IPAPI.cpp
+add_library(dynuiprefresher ${LIB_METHOD}
-        )
+        src/IPRefresher.cpp
-
+        src/Config.cpp
-add_library(logger ${LIB_METHOD}
+        src/IpHelper.cpp
         src/FileLogger.cpp
         src/Logger.cpp
         )
 
-
+add_executable(iprefresher src/main.cpp)
-set(SOURCE
-        src/main.cpp
-        src/IPRefresher.cpp
-        src/Config.cpp)
-
-add_executable(iprefresher ${SOURCE})
 
 # LINK generated LIBS #
-target_link_libraries(iprefresher api logger ${CURL_LIBRARIES} config++)
+target_link_libraries(iprefresher dynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
 
-# INSTALL to SYSTEM #
+if (${GUI})
-set(CMAKE_INSTALL_PREFIX "/")
+    set(QT5_LIBRARIES Qt5::Widgets Qt5::PrintSupport Qt5::Sql)
+
+    set(UI_SOURCES
+            src/gui/mainwindow.ui
+            )
+
+    #
+    # Generate necessary headers from .ui files. (qmake lets `uic` do this job.)
+    # hint from [Cross-platform Qt5 project using cmake](http://stackoverflow.com/questions/21174586/cross-platform-qt5-project-using-cmake)
+    #
+    qt5_wrap_ui(UI_GENERATED_HEADERS ${UI_SOURCES})
+
+    add_executable(iprefresher-gui
+            src/maingui.cpp
+            src/gui/MainWindow.cpp
+            src/gui/MainWindow.h ${UI_GENERATED_HEADERS})
+
+    # LINK generated LIBS #
+    target_link_libraries(iprefresher-gui -lpthread dynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES} ${QT5_LIBRARIES})
+endif ()
+
+# setting install targets
+IF (NOT ${WinBuild})
+    # INSTALL to Linux SYSTEM #
+
+    # install binaries
     install(TARGETS iprefresher DESTINATION usr/bin)
+    # install systemd service and enable it
     install(FILES service/iprefresher.service DESTINATION lib/systemd/system)
-install(FILES config/iprefresher.cfg DESTINATION etc)
+ELSE ()
+    # INSTALL to Windows SYSTEM #
 
+    # install binary to current folder
+    set_target_properties(iprefresher PROPERTIES SUFFIX ".exe")
+    install(TARGETS iprefresher DESTINATION .)
 
-IF (UNIX)
+    # install .dll dependencies
+    # todo check if files exist...
+    install(FILES /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libcurl-4.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libssh2-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libstdc++-6.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libgcc_s_seh-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libcrypto-1_1-x64.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libssl-1_1-x64.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libwinpthread-1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/zlib1.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libidn2-0.dll
+            /usr/${TOOLCHAIN_PREFIX}/sys-root/mingw/bin/libconfig++-11.dll
+            DESTINATION .)
+ENDIF ()
+
+if (${PACKAGING})
+    # General Packaging options:
     message(STATUS "config of Package build")
+
+    set(CPACK_PACKAGE_NAME "DynuIpRefresher")
+    SET(CPACK_PACKAGE_DESCRIPTION "IPrefresher to refresh Dynu ip address and notify user via Telegram")
+    SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "IPrefresher to refresh Dynu ip address and notify user via Telegram")
+    SET(CPACK_PACKAGE_VENDOR "Lukas Heilgienbrunner")
+    SET(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
+    SET(CPACK_SOURCE_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${PROJECT_VERSION}")
+    SET(CPACK_PACKAGE_CONTACT "Lukas Heiligenbrunner <lukas.heiligenbrunner@gmail.com>")
+
+    SET(CMAKE_INSTALL_PREFIX "/")
+
+    IF (NOT ${WinBuild})
+        # generate post script for checking if configuration already exists
+        FILE(WRITE ${CMAKE_SOURCE_DIR}/postinst
+                "#!/bin/bash
+# Post installation script for linux packages
+# do not edit this file manually, it is generated by the cmake script
+if [ ! -f ${CONFIG_PATH} ]; then
+    cat > ${CONFIG_PATH} <<- EOM
+${SAMPLECONFIG}EOM
+fi\n"
+                )
+
+
         SET(CPACK_DEB_COMPONENT_INSTALL 1)
         SET(CPACK_OUTPUT_FILE_PREFIX packages)
-    set(CPACK_PACKAGING_INSTALL_PREFIX "/") # no prefix for package structure
+        SET(CPACK_PACKAGING_INSTALL_PREFIX "/") # no prefix for package structure
 
         FIND_PROGRAM(RPMBUILD_EXECUTABLE rpmbuild)
         FIND_PROGRAM(DEB_EXECUTABLE dpkg)
@@ -97,8 +278,10 @@ IF (UNIX)
         #check if rpm build is possible
         if (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
             message(STATUS "found rpm build executeable --> able to build rpm")
-        set(CPACK_GENERATOR "${CPACK_GENERATOR};RPM")
+            SET(CPACK_GENERATOR "${CPACK_GENERATOR};RPM")
-        set(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/lib/systemd/system" "/lib/systemd" "/lib" "/usr/local/bin" "/usr/local") # --> needed to not override existing folders
+            SET(CPACK_RPM_POST_INSTALL_SCRIPT_FILE "${CMAKE_CURRENT_SOURCE_DIR}/postinst")
+            SET(CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION "/lib/systemd/system" "/lib/systemd" "/lib" "/usr/local/bin" "/usr/local") # --> needed to not override existing folders
+            set(CPACK_RPM_PACKAGE_REQUIRES "libcurl,libconfig")
         else (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
             message(STATUS "not found rpm build tools --> not building rpm")
         endif (NOT ${RPMBUILD_EXECUTABLE} STREQUAL "RPMBUILD_EXECUTABLE-NOTFOUND")
@@ -106,7 +289,9 @@ IF (UNIX)
         #check if deb build is possible
         if (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
             message(STATUS "found deb build tools --> able to build deb")
-        set(CPACK_GENERATOR "${CPACK_GENERATOR};DEB")
+            SET(CPACK_GENERATOR "${CPACK_GENERATOR};DEB") # add deb generator
+            set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/postinst") # set post inst file
+            set(CPACK_DEBIAN_PACKAGE_DEPENDS "libcurl4,libconfig++9v5") # add debian dependencies
         else (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
             message(STATUS "not found  deb build tools --> not building deb")
         endif (NOT ${DEB_EXECUTABLE} STREQUAL "DEB_EXECUTABLE-NOTFOUND")
@@ -115,32 +300,34 @@ IF (UNIX)
         SET(CPACK_CMAKE_GENERATOR "Unix Makefiles")
         SET(CPACK_SOURCE_GENERATOR "TGZ;TBZ2")
 
-    SET(CPACK_PACKAGE_DESCRIPTION "IPrefresher to refresh Dynu ip address and notify user via Telegram")
-    SET(CPACK_PACKAGE_DESCRIPTION_SUMMARY "IPrefresher to refresh Dynu ip address and notify user via Telegram")
-    SET(CPACK_PACKAGE_VENDOR "Lukas Heilgienbrunner")
-    SET(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}")
-    SET(CPACK_SOURCE_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-${PROJECT_VERSION}")
-    SET(CPACK_PACKAGE_CONTACT "Lukas Heiligenbrunner <lukas.heiligenbrunner@gmail.com>")
         SET(CPACK_PACKAGE_SECTION "games")
-    set(CPACK_PACKAGE_DEPENDS "libcurl (>= 7.0.0-1), libconfig (>= 1.5.0)")
+    ELSE ()
+        # Pack a NSIS intaller
+        set(CPACK_GENERATOR NSIS)
+        message(STATUS "Using NSIS Package build.")
+
+        set(CPACK_NSIS_testcomp_INSTALL_DIRECTORY /)
+        set(CPACK_PACKAGE_INSTALL_DIRECTORY "DynuIpRefresher")
+        SET(CPACK_NSIS_MODIFY_PATH ON)
+    ENDIF ()
 
     INCLUDE(CPack)
 
-    add_custom_target(build-linux-packages
+    add_custom_target(build-packages
             "${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target package
             DEPENDS ${PROJECT_NAME}
-            COMMENT "Installing ${PROJECT_NAME}")
+            COMMENT "Packing ${PROJECT_NAME}")
     message("")
-ENDIF (UNIX)
+ENDIF ()
 
 # check if Doxygen is installed
 if (BUILD_DOC)
     message(STATUS "config of DOxygen build")
     find_package(Doxygen)
     if (DOXYGEN_FOUND)
-        # set input and output files
+        # SET input and output files
-        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
+        SET(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile.in)
-        set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+        SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
         # request to configure the file
         configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
@@ -157,3 +344,42 @@ if (BUILD_DOC)
     endif (DOXYGEN_FOUND)
     message("")
 endif (BUILD_DOC)
+
+# Test Cases
+if (TESTS)
+    include(GoogleTest)
+
+    mark_as_advanced(
+            BUILD_GMOCK BUILD_GTEST BUILD_SHARED_LIBS
+            gmock_build_tests gtest_build_samples gtest_build_tests
+            gtest_disable_pthreads gtest_force_shared_crt gtest_hide_internal_symbols
+    )
+
+    enable_testing()
+
+    macro(package_add_test TESTNAME)
+        # create an exectuable in which the tests will be stored
+        add_executable(${TESTNAME} ${ARGN})
+        # link the Google test infrastructure, mocking library, and a default main fuction to
+        target_link_libraries(${TESTNAME} gtest gtest_main -lpthread -lm dynuiprefresher api ${CURL_LIBRARIES} ${LIBCONFIG++_LIBRARIES})
+        # see https://cmake.org/cmake/help/v3.10/module/GoogleTest.html for more options to pass to it
+        gtest_discover_tests(${TESTNAME}
+                WORKING_DIRECTORY ${PROJECT_DIR}
+                EXTRA_ARGS --gtest_output=xml:report.xml -VV
+                PROPERTIES VS_DEBUGGER_WORKING_DIRECTORY "${PROJECT_DIR}"
+                )
+        set_target_properties(${TESTNAME} PROPERTIES FOLDER tests)
+    endmacro()
+
+    package_add_test(test1 tests/UnitTest.cpp ${SOURCE})
+
+    add_custom_target(build-test
+            "${CMAKE_COMMAND}" --build "${CMAKE_BINARY_DIR}" --target test
+            DEPENDS ${PROJECT_NAME}
+            COMMENT "Packing ${PROJECT_NAME}")
+
+    add_custom_target(build-xml
+            "bin/test1" --gtest_output="xml:report.xml"
+            DEPENDS ${PROJECT_NAME}
+            COMMENT "Packing ${PROJECT_NAME}")
+ENDIF ()

README.md

@@ -1,3 +1,4 @@
+[![pipeline status](http://gitlab.heili.eu/lukas/dynuiprefresher/badges/master/pipeline.svg)](http://gitlab.heili.eu/lukas/dynuiprefresher/-/commits/master)
 # DynuIPRefresher
 A lightweight C++ application to setup a service for refreshing a dynamic IP to the Dynu servers. 
 Dynu.com is a free DDns service and provides an API.
@@ -11,6 +12,9 @@ But you can still compile the code my your own (see build section).
 There is a configuration file `/etc/iprefresher.cfg` where you have to specify the DYNU API key (get it from their homepage), the domainid and your domain.
 Furthermore, you can optionally specify a Telegram API key and a Chat ID if you want to be notfied when your local ip changes.
 
+To enable and start the service: 
+`systemctl enable iprefresher.service` and `systemctl start iprefresher.service`
+
 
 ## Build
 ## Basic Build
@@ -68,4 +72,16 @@ cd into downloaded files and Generate makefiles:
 
 
 ### Windows cross build
-TODO!
+Set Winbuild flag in CMakeList.txt.
+
+Dependencies:
+* MinGW Compiler
+* MinGW-libcurl
+* MinGW-libconfig++
+
+Optional dependencies
+* NSIS Pack tool (for creating installer)
+* doxygen (for generating html doc)
+
+Some addition configuration of lib paths may be needed in CMakeList.txt. 
+`make package` will pack it into a NSIS installer for Windows. 

inc/Config.h

@@ -1,6 +1,9 @@
-//
+/**
-// Created by lukas on 11.02.20.
+ * A static class to manage the configuration file, read/write parameters to it.
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 11.02.2020
+ */
 
 #pragma once
 
@@ -8,15 +11,76 @@
 
 class Config {
 public:
-    static std::string dynuapikey;
+    /**
+    * read configuration out of config file
+    *
+    * @return success of config read
+    */
+    static bool readConfig();
 
-    static std::string domainid; //id of the dynu domain
+    /**
-    static std::string domainname;
+     * validate config file
+     *
+     * @return validity of config file
+     */
+    static bool validateConfig();
 
-    static std::string telegramApiKey;
+    /**
-    static std::string chatId;
+     * check if telegram credentials in config are set
+     * @return is supported?
+     */
+    static bool isTelegramSupported();
+
+    /** Getters **/
+
+    /**
+     * encapsulated getter for DynuApiKey
+     * @return api key
+     */
+    static const std::string &getDynuapikey();
+
+    /**
+     * encapsulated getter for DomainId
+     * @return DomainId
+     */
+    static const std::string &getDomainid();
+
+    /**
+     * encapsulated getter for Domainname
+     * @return Domainname
+     */
+    static const std::string &getDomainname();
+
+    /**
+     * encapsulated getter for TelegramApiKey
+     * @return TelegramApiKey
+     */
+    static const std::string &getTelegramApiKey();
+
+    /**
+     * encapsulated getter for ChatId
+     * @return ChatId
+     */
+    static const std::string &getChatId();
 
-    static bool readCredentials();
 
 private:
+    /**
+     * private constructor --> don't allow instance of this class
+     */
+    Config();
+
+    /**
+     * helper variable for managing telegram Support
+     */
+    static bool telegramSupport;
+
+    /**
+     * helper variables for storing keys and ids
+     */
+    static std::string dynuapikey;
+    static std::string domainid; //id of the dynu domain
+    static std::string domainname;
+    static std::string telegramApiKey;
+    static std::string chatId;
 };

inc/FileLogger.h

@@ -1,6 +1,9 @@
-//
+/**
-// Created by lukas on 05.05.19.
+ * Read and write current ip to a temp file to remember last ip until restart
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 05.05.2019
+ */
 
 #pragma once
 

inc/IPRefresher.h

@@ -1,25 +1,33 @@
-//
+/**
-// Created by lukas on 02.08.19.
+ * IPrefresher library
-//
+ * - start checking ip once
+ * - or in loop mode
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 06.04.2019
+ */
 
 #pragma once
 
-class IPRefresher {
+namespace IPRefresher {
-public:
+    /**
+     * Status return-codes for startUpService
+     */
+    namespace Status_Code {
+        const int SUCCESS = 1;
+        const int ERROR = -1;
+        const int ERROR_NO_INTERNET = -2;
+        const int NOREFRESH = 0;
+    }
+
     /**
      * refresh ip address on Dynu server
      */
-    void checkIPAdress(bool force);
+    bool checkIPAdress(bool force);
-
-    /**
-     * default constructor
-     */
-    IPRefresher();
 
     /**
      * start the service in loop mode
      * every 5 minutes the ip is checked an refreshed (needed for .service)
-     * @param loop true->loopmode on
      */
-    explicit IPRefresher(bool loop);
+    void startUpService(int interval = 300);
-};
+}

inc/IpHelper.h

@@ -0,0 +1,22 @@
+/**
+ * A helper class for general IP String actions
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 07.05.2020
+ */
+
+#pragma once
+
+#include <string>
+
+class IpHelper {
+public:
+    /**
+     * check if ip is valid
+     * @param ip ip address to test
+     * @return validity
+     */
+    static bool isIpValid(std::string ip);
+
+private:
+};

inc/Logger.h

@@ -1,6 +1,10 @@
-//
+/**
-// Created by lukas on 26.10.19.
+ * Fancy console log output format
-//
+ * todo log level support
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 26.10.2019
+ */
 
 #pragma once
 
@@ -8,13 +12,38 @@
 
 class Logger {
 public:
+    /**
+     * a debug message
+     * @param message message
+     */
     static void debug(std::string message);
+
+    /**
+     * a default message
+     * @param message message
+     */
     static void message(std::string message);
+
+    /**
+     * a warning message
+     * @param message message
+     */
     static void warning(std::string message);
+
+    /**
+     * a error message
+     * @param message message
+     */
     static void error(std::string message);
 
+    /**
+     * a log message with manual level set
+     * @param message message
+     * @param level loglevel (1-4) or predefined labels
+     */
     static void log(const std::string &message, int level);
 
+
     static const int Debug = 4;
     static const int Message = 3;
     static const int Warning = 2;

inc/api/API.h

@@ -1,12 +1,17 @@
-//
+/**
-// Created by lukas on 06.04.19.
+ * API class
-//
+ * - manages all curl download stuff
+ * - easy POST/GET requests
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 06.04.2019
+ */
 
 #pragma once
 
+#include "Hashmap.h"
 
 #include <string>
-#include "Hashmap.h"
 
 class API {
 public:
@@ -25,7 +30,10 @@ public:
      * @param headers header fields
      * @return return string of server
      */
-    std::string request(std::string myurl, bool post, Hashmap<std::string, std::string> &map, std::vector<std::string> &headers);
+    std::string request(std::string myurl,
+                        bool post,
+                        Hashmap<std::string, std::string> &map,
+                        std::vector<std::string> &headers);
 
 private:
     static size_t write_data(void *buffer, size_t size, size_t buffersize, FILE *stream);

inc/api/DynuAPI.h

@@ -1,6 +1,9 @@
-//
+/**
-// Created by lukas on 18.06.19.
+ * Dynu API - Refresh the IP
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 18.06.2019
+ */
 
 #pragma once
 
@@ -13,7 +16,7 @@ public:
      * @param ip new ip
      * @return request status
      */
-    int refreshIp(std::string ip);
+    bool refreshIp(std::string ip);
 
     /**
      * init Telegram api with apikey and chatid
@@ -22,9 +25,20 @@ public:
      * @param domainName domainname to refresh
      */
     void init(const std::string &dynuApiKey, const std::string &domainId, const std::string &domainName);
-private:
-    std::string dynuapikey; // Dynu API key
 
-    std::string domainid; //id of the dynu domain
+private:
+    /**
+     * Dynu API Key
+     */
+    std::string dynuapikey;
+
+    /**
+     * Dynu Domain ID
+     */
+    std::string domainid;
+
+    /**
+     * Domain name eg. "mydomain.dynu.net"
+     */
     std::string domainname;
 };

inc/api/Hashmap.h

@@ -1,6 +1,9 @@
-//
+/**
-// Created by lukas on 07.04.19.
+ * A Hashmap class for easier Key-Value maps
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 07.04.2019
+ */
 
 #pragma once
 

inc/api/IPAPI.h

@@ -1,12 +1,16 @@
-//
+/**
-// Created by lukas on 18.06.19.
+ * IPAPI for getting global ip of current network
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 18.06.2019
+ */
 
 #pragma once
 
-#include <string>
 #include "API.h"
 
+#include <string>
+
 class IPAPI : API {
 public:
     /**

inc/api/TelegramAPI.h

@@ -1,12 +1,15 @@
-//
+/**
-// Created by lukas on 08.05.19.
+ * Telegram API for sending message to specific chat
-//
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 08.05.2019
+ */
 
 #pragma once
 
+#include "API.h"
 
 #include <string>
-#include "API.h"
 
 class TelegramAPI : API {
 public:

src/Config.cpp

@@ -1,12 +1,11 @@
-//
+#include "Config.h"
-// Created by lukas on 11.02.20.
+#include "Logger.h"
-//
+#include "Version.h"
 
-#include <Config.h>
 #include <iostream>
 #include <cstring>
-
+#include <fstream>
-#include "libconfig.h++"
+#include <libconfig.h++>
 
 std::string Config::dynuapikey;
 std::string Config::domainid; //id of the dynu domain
@@ -15,14 +14,25 @@ std::string Config::domainname;
 std::string Config::telegramApiKey;
 std::string Config::chatId;
 
-bool Config::readCredentials() {
+bool Config::telegramSupport;
+
+bool Config::readConfig() {
     libconfig::Config cfg;
     try {
-        cfg.readFile("/etc/iprefresher.cfg");
+        cfg.readFile(Version::ConfigDir.c_str());
     }
     catch (const libconfig::FileIOException &fioex) {
         std::cout << "I/O error while reading config file." << std::endl << "creating new config file!" << std::endl;
-        cfg.writeFile("/etc/iprefresher.cfg");
+
+        std::ofstream myfile;
+        myfile.open(Version::ConfigDir);
+        if (myfile.is_open()) {
+            myfile << Version::SAMPLECONFIG;
+            myfile.close();
+        } else {
+            Logger::error("error creating file");
+        }
+
         return false;
     }
     catch (const libconfig::ParseException &pex) {
@@ -31,7 +41,6 @@ bool Config::readCredentials() {
         return false;
     }
 
-    // Get the store name.
     try {
         // needed parameters
         dynuapikey = (std::string) cfg.lookup("dynuapikey");
@@ -40,13 +49,92 @@ bool Config::readCredentials() {
         // optional parameters
         telegramApiKey = (std::string) cfg.lookup("telegramApiKey");
         chatId = (std::string) cfg.lookup("chatId");
+        telegramSupport = true;
     }
     catch (const libconfig::SettingNotFoundException &nfex) {
         // triggered if setting is missing in config
         if (!(std::strcmp("telegramApiKey", nfex.getPath()) == 0 || std::strcmp("chatId", nfex.getPath()) == 0)) {
             std::cerr << "No '" << nfex.getPath() << "' setting in configuration file." << std::endl;
+        } else {
+            Logger::message("no Telegram support - fields in config not set");
+            telegramSupport = false;
         }
     }
     // check if needed values aren't empty
     return !(Config::dynuapikey.empty() || Config::domainid.empty() || Config::domainname.empty());
 }
+
+bool Config::validateConfig() {
+    libconfig::Config cfg;
+    try {
+        Logger::message("reading config file");
+        cfg.readFile(Version::ConfigDir.c_str());
+    }
+    catch (const libconfig::FileIOException &fioex) {
+        Logger::warning("config file doesn't exist or permission denied!");
+        return false;
+    }
+    catch (const libconfig::ParseException &pex) {
+        std::cerr << "Parse error at " << pex.getFile() << ":" << pex.getLine()
+                  << " - " << pex.getError() << std::endl;
+        return false;
+    }
+    Logger::message("Syntax and Permission is OK");
+
+    try {
+        // needed parameters
+        if (((std::string) cfg.lookup("dynuapikey")).empty()) {
+            Logger::warning("required parameter \"dynuapikey\" seems to be empty.");
+            return false;
+        }
+        if (((std::string) cfg.lookup("domainid")).empty()) {
+            Logger::warning("required parameter \"domainid\" seems to be empty.");
+            return false;
+        }
+        if (((std::string) cfg.lookup("domainname")).empty()) {
+            Logger::warning("required parameter \"domainname\" seems to be empty.");
+            return false;
+        }
+        // optional parameters
+        cfg.lookup("telegramApiKey");
+        cfg.lookup("chatId");
+        telegramSupport = true;
+    }
+    catch (const libconfig::SettingNotFoundException &nfex) {
+        // triggered if setting is missing in config
+        if (!(std::strcmp("telegramApiKey", nfex.getPath()) == 0 || std::strcmp("chatId", nfex.getPath()) == 0)) {
+            std::cerr << "No '" << nfex.getPath() << "' setting in configuration file." << std::endl;
+            return false;
+        } else {
+            Logger::message("no Telegram support - fields in config not set");
+            telegramSupport = false;
+        }
+    }
+    return true;
+}
+
+bool Config::isTelegramSupported() {
+    return telegramSupport;
+}
+
+const std::string &Config::getDynuapikey() {
+    return dynuapikey;
+}
+
+const std::string &Config::getDomainid() {
+    return domainid;
+}
+
+const std::string &Config::getDomainname() {
+    return domainname;
+}
+
+const std::string &Config::getTelegramApiKey() {
+    return telegramApiKey;
+}
+
+const std::string &Config::getChatId() {
+    return chatId;
+}
+
+Config::Config() = default;

src/FileLogger.cpp

@@ -1,12 +1,9 @@
-//
+#include "FileLogger.h"
-// Created by lukas on 05.05.19.
+#include "IpHelper.h"
-//
 
 #include <fstream>
 #include <iostream>
 
-#include "FileLogger.h"
-
 void FileLogger::safeip(std::string ip) {
     std::ofstream out;
     out.open("ip.txt", std::ios::out);
@@ -24,5 +21,9 @@ std::string FileLogger::readip() {
 
     in >> ip;
 
+    // when received ip has no . return 0.0.0.0
+    if (!IpHelper::isIpValid(ip))
+        return "0.0.0.0";
+    else
         return ip;
 }

src/IPRefresher.cpp

@@ -1,22 +1,19 @@
-//
+#include "IPRefresher.h"
-// Created by lukas on 02.08.19.
+#include "FileLogger.h"
-//
+#include "api/IPAPI.h"
-
+#include "api/DynuAPI.h"
-#include <string>
+#include "api/TelegramAPI.h"
-
+#include "Config.h"
-#include <FileLogger.h>
+#include "Version.h"
-#include <api/IPAPI.h>
+#include "IpHelper.h"
-#include <api/DynuAPI.h>
-#include <api/TelegramAPI.h>
 
 #include <chrono>
 #include <thread>
 #include <Logger.h>
 
-#include <IPRefresher.h>
+using namespace IPRefresher;
-#include <Config.h>
 
-void IPRefresher::checkIPAdress(bool force) {
+bool IPRefresher::checkIPAdress(bool force) {
     FileLogger logger;
 
     IPAPI ipapi;
@@ -25,44 +22,52 @@ void IPRefresher::checkIPAdress(bool force) {
     if (ip.empty()) {
         //no internet connection (or other error)
         Logger::warning("no internet connection");
+        return Status_Code::ERROR_NO_INTERNET;
+    } else if (!IpHelper::isIpValid(ip)) {
+        // error when ip doesn't contain a :
+        Logger::warning("an error occured when getting the global ip");
+        return Status_Code::ERROR;
     } else {
         std::string oldip = logger.readip();
 
         if (oldip == ip && !force) {
             Logger::message("no change -- ip: " + ip);
+            return Status_Code::NOREFRESH;
         } else {
             Logger::message("ip changed! -- from :" + oldip + "to: " + ip);
 
             DynuAPI dynu;
-            dynu.init(Config::dynuapikey, Config::domainid, Config::domainname);
+            dynu.init(Config::getDynuapikey(), Config::getDomainid(), Config::getDomainname());
+            // actual refresh of IP in api - here
+            bool result = dynu.refreshIp(ip);
 
-            if (dynu.refreshIp(ip)) {
+            if (result && Config::isTelegramSupported()) {
                 TelegramAPI tele;
-                tele.init(Config::telegramApiKey, Config::chatId);
+                tele.init(Config::getTelegramApiKey(), Config::getChatId());
                 tele.sendMessage(oldip + " moved to " + ip);
-            } else {
+            } else if (!result) {
                 //error
                 Logger::error("failed to write ip to dynu api!");
+                return Status_Code::ERROR;
             }
 
             logger.safeip(ip);
+            return result ? Status_Code::SUCCESS : Status_Code::ERROR;
         }
     }
 }
 
-IPRefresher::IPRefresher() = default;
+void IPRefresher::startUpService(int interval) {
-
-IPRefresher::IPRefresher(bool loop) {
-    if (loop) {
     Logger::message("startup of service");
-        if (Config::readCredentials()) {
+    Logger::message("Version: " + Version::VERSION);
+    if (Config::readConfig()) {
         while (true) {
             Logger::message("starting check");
             checkIPAdress(false);
-                std::this_thread::sleep_for(std::chrono::milliseconds(300000));
+            std::this_thread::sleep_for(std::chrono::milliseconds(interval * 1000));
         }
     } else {
         std::cout << "incorrect credentials!" << std::endl;
     }
-    }
+
 }

src/IpHelper.cpp

@@ -0,0 +1,7 @@
+#include "IpHelper.h"
+
+#include <climits>
+
+bool IpHelper::isIpValid(std::string ip) {
+    return (ip.find('.') != ULONG_MAX);
+}

src/Logger.cpp

@@ -1,12 +1,8 @@
-//
+#include "Logger.h"
-// Created by lukas on 26.10.19.
-//
 
 #include <sstream>
 #include <iostream>
 
-#include "Logger.h"
-
 void Logger::debug(const std::string message) {
     log(message, Logger::Debug);
 }
@@ -39,6 +35,9 @@ void Logger::log(const std::string &message, int level) {
         case Error:
             out << "ERROR";
             break;
+        default:
+            out << "UNDEFINED";
+            break;
     }
     out << "] ";
     out << message;

src/api/API.cpp

@@ -1,16 +1,8 @@
-//
-// Created by lukas on 06.04.19.
-//
-
 #include "api/API.h"
-#include "api/Hashmap.h"
 
-#include <string>
-#include <iostream>
 #include <sstream>
 #include <curl/curl.h>
 
-
 std::string API::request(std::string myurl) {
     Hashmap<std::string, std::string> map;
     std::vector<std::string> str;

src/api/DynuAPI.cpp

@@ -1,10 +1,6 @@
-//
-// Created by lukas on 18.06.19.
-//
-
 #include "api/DynuAPI.h"
 
-int DynuAPI::refreshIp(std:: string ip) {
+bool DynuAPI::refreshIp(std::string ip) {
     Hashmap<std::string, std::string> args;
     args.add("name", domainname);
     args.add("ipv4Address", ip);
@@ -16,11 +12,7 @@ int DynuAPI::refreshIp(std:: string ip) {
 
     const std::string dynurepl = request("https://api.dynu.com/v2/dns/" + domainid, true, args, headers);
 
-    if (dynurepl != "{\"statusCode\":200}") {
+    return (dynurepl == "{\"statusCode\":200}");
-        return -1;
-    } else {
-        return 1;
-    }
 }
 
 void DynuAPI::init(const std::string &dynuApiKey, const std::string &domainId, const std::string &domainName) {

src/api/IPAPI.cpp

@@ -1,7 +1,3 @@
-//
-// Created by lukas on 18.06.19.
-//
-
 #include "api/IPAPI.h"
 
 std::string IPAPI::getGlobalIp() {

src/api/TelegramAPI.cpp

@@ -1,10 +1,7 @@
-//
-// Created by lukas on 08.05.19.
-//
-
 #include "api/TelegramAPI.h"
+#include "Logger.h"
 
-#include <Logger.h>
+#include <climits>
 
 int TelegramAPI::sendMessage(const std::string &text) {
     Hashmap<std::string, std::string> args;
@@ -15,7 +12,6 @@ int TelegramAPI::sendMessage(const std::string& text) {
 
     std::string reply = request("https://api.telegram.org/bot" + apikey + "/sendmessage", false, args, headers);
 
-    unsigned const long ULONG_MAX = -1;
     if (reply.find("\"error_code\"") != ULONG_MAX) {
         Logger::error("failed to refresh the ip (Dynu API)");
         return -1;

src/gui/MainWindow.cpp

@@ -0,0 +1,84 @@
+#include "MainWindow.h"
+#include "ui_mainwindow.h"
+
+#include "api/IPAPI.h"
+#include "IPRefresher.h"
+#include "Config.h"
+#include "Logger.h"
+
+#include <thread>
+
+MainWindow::MainWindow() : QMainWindow(), ui(new Ui::MainWindow) {
+    ui->setupUi(this);
+
+    // needs to be defined with new -- would be termintated after this constructor.
+    new std::thread([this]() {
+        IPAPI ipapi;
+        std::string ip = ipapi.getGlobalIp();
+        Logger::message("Current global IP: " + ip);
+        std::string msg = "Your current global IP: " + ip;
+        this->ui->labelCurrentIP->setText(msg.c_str());
+    });
+
+    // set config info label and initial check if config is valid
+    ui->labelConfig->setText(Config::validateConfig() ? "Config is: OK" : "Config is: NOT OK");
+
+    connect(ui->buttonCheckConfig, SIGNAL(clicked()), this, SLOT(checkConfigBtn()));
+    connect(ui->buttonRefreshIP, SIGNAL(clicked()), this, SLOT(refreshIPBtn()));
+
+    connect(this, SIGNAL(appendLogField(QString)), ui->textLog, SLOT(appendPlainText(QString)));
+}
+
+MainWindow::~MainWindow() {
+    // todo check if disconnects are really necessary
+    disconnect(ui->buttonCheckConfig);
+    disconnect(ui->buttonRefreshIP);
+    delete ui;
+}
+
+void MainWindow::checkConfigBtn() {
+    Logger::message("checking config!");
+    appendLogField("checking config!");
+
+    if (Config::validateConfig()) {
+        Logger::message("Config file is OK");
+        appendLogField("Config file is OK");
+        ui->labelConfig->setText("Config is: OK");
+    } else {
+        Logger::error("There are errors in config file!");
+        appendLogField("There are errors in config file!");
+    }
+    appendLogField("");
+}
+
+void MainWindow::refreshIPBtn() {
+    Logger::message("start refreshing Dynu IP.");
+    appendLogField("");
+    appendLogField("start refreshing Dynu IP.");
+    new std::thread([this]() {
+        if (Config::readConfig()) {
+            int code = IPRefresher::checkIPAdress(false);
+            switch (code) {
+                case IPRefresher::Status_Code::SUCCESS:
+                    appendLogField("successfully refreshed IP!");
+                    break;
+                case IPRefresher::Status_Code::NOREFRESH:
+                    appendLogField("IP is already correct.");
+                    break;
+                case IPRefresher::Status_Code::ERROR_NO_INTERNET:
+                    appendLogField("Error: No Internet connection");
+                    break;
+                case IPRefresher::Status_Code::ERROR:
+                    appendLogField("An error occured while refreshing.");
+                    break;
+                default:
+                    appendLogField("An unknown error code occured");
+            }
+        } else {
+            std::cout << "incorrect credentials!" << std::endl;
+        }
+
+        Logger::message("Finished refreshing Dynu IP.");
+        this->appendLogField("Finished refreshing Dynu IP.");
+    });
+}

src/gui/MainWindow.h

@@ -0,0 +1,50 @@
+/**
+ * Main GUI controller - User IO handlings
+ *
+ * @author Lukas Heiligenbrunner
+ * @date 09.05.2020
+ */
+
+#pragma once
+
+#include <QtWidgets/QMainWindow>
+
+namespace Ui {
+    class MainWindow;
+}
+
+class MainWindow : public QMainWindow {
+Q_OBJECT
+
+public:
+    /**
+     * constructor with basic initializations
+     */
+    explicit MainWindow();
+
+    /**
+     * destruct all gui elements
+     */
+    ~MainWindow();
+
+private:
+    Ui::MainWindow *ui;
+private slots:
+    /**
+     * executed click handler for config button
+     */
+    void checkConfigBtn();
+
+    /**
+     * executed click handler for refresh btn
+     */
+    void refreshIPBtn();
+
+signals:
+    /**
+     * append a String line to the Log field
+     *
+     * @param QString string to be appended
+     */
+    void appendLogField(QString);
+};

src/gui/mainwindow.ui

@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>823</width>
+    <height>618</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>MainWindow</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <widget class="QPushButton" name="buttonRefreshIP">
+    <property name="geometry">
+     <rect>
+      <x>290</x>
+      <y>300</y>
+      <width>91</width>
+      <height>33</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Refresh IP</string>
+    </property>
+   </widget>
+   <widget class="QLabel" name="labelCurrentIP">
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>60</y>
+      <width>301</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Your current global IP:</string>
+    </property>
+   </widget>
+   <widget class="QPlainTextEdit" name="textLog">
+    <property name="enabled">
+     <bool>false</bool>
+    </property>
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>410</y>
+      <width>691</width>
+      <height>191</height>
+     </rect>
+    </property>
+    <property name="cursor" stdset="0">
+     <cursorShape>IBeamCursor</cursorShape>
+    </property>
+   </widget>
+   <widget class="QLabel" name="label_2">
+    <property name="geometry">
+     <rect>
+      <x>40</x>
+      <y>380</y>
+      <width>64</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Log:</string>
+    </property>
+   </widget>
+   <widget class="QPushButton" name="buttonCheckConfig">
+    <property name="geometry">
+     <rect>
+      <x>270</x>
+      <y>140</y>
+      <width>91</width>
+      <height>33</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Check Config</string>
+    </property>
+   </widget>
+   <widget class="QLabel" name="labelConfig">
+    <property name="geometry">
+     <rect>
+      <x>270</x>
+      <y>180</y>
+      <width>141</width>
+      <height>17</height>
+     </rect>
+    </property>
+    <property name="text">
+     <string>Config is: undefined</string>
+    </property>
+   </widget>
+  </widget>
+  <widget class="QStatusBar" name="statusbar"/>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

src/main.cpp

@@ -1,12 +1,8 @@
-//
+#include "Version.h"
-// Created by lukas on 18.06.19.
+#include "IPRefresher.h"
-//
+#include "Logger.h"
-
+#include "Config.h"
-#include <iostream>
+#include "api/IPAPI.h"
-#include <IPRefresher.h>
-#include <Version.h>
-#include <Logger.h>
-#include <Config.h>
 
 /**
  * application entry point
@@ -19,27 +15,37 @@ int main(int argc, char *argv[]) {
                       << "[-v] [--version] print the software version" << std::endl
                       << "[-f] [--force] force refresh of ip" << std::endl
                       << "[-l] [--loop] infinite loop to refresh ip every five minutes" << std::endl
+                      << "[-c] [--checkconfig] validate configuration" << std::endl
+                      << "[-ip] [--currentip] get current global ip" << std::endl
                       << "[no argument] normal ip check and refresh" << std::endl;
         } else if (firstarg == "-v" || firstarg == "--version") {
             std::cout << "Version " << Version::VERSION << std::endl;
         } else if (firstarg == "-f" || firstarg == "--force") {
-            IPRefresher ipr;
+            if (Config::readConfig()) {
-            if (Config::readCredentials()) {
+                IPRefresher::checkIPAdress(true);
-                ipr.checkIPAdress(true);
             } else {
                 std::cout << "incorrect credentials!" << std::endl;
             }
 
         } else if (firstarg == "-l" || firstarg == "--loop") {
-            IPRefresher(true);
+            IPRefresher::startUpService(true);
+        } else if (firstarg == "-c" || firstarg == "--checkconfig") {
+            if (Config::validateConfig()) {
+                Logger::message("Config file is OK");
+            } else {
+                Logger::error("There are errors in config file!");
+                return -1;
+            }
+        } else if (firstarg == "-ip" || firstarg == "--currentip") {
+            IPAPI ipapi;
+            std::cout << "Current global IP: " << ipapi.getGlobalIp() << std::endl;
         } else {
             Logger::message("wrong arguments!  -h for help");
         }
     } else {
-        IPRefresher ipr;
         Logger::message("starting check");
-        if (Config::readCredentials()) {
+        if (Config::readConfig()) {
-            ipr.checkIPAdress(false);
+            IPRefresher::checkIPAdress(false);
         } else {
             std::cout << "incorrect credentials!" << std::endl;
         }

src/maingui.cpp

@@ -0,0 +1,14 @@
+#include <QApplication>
+#include "gui/MainWindow.h"
+
+/**
+ * application entry point
+ */
+int main(int argc, char *argv[]) {
+    QApplication a(argc, argv);
+    MainWindow w;
+    w.setWindowTitle("startUpService");
+    w.show();
+
+    return QApplication::exec();
+}

tests/UnitTest.cpp

@@ -0,0 +1,30 @@
+//
+// Created by lukas on 06.05.20.
+//
+
+#include <FileLogger.h>
+#include <api/IPAPI.h>
+#include <climits>
+#include "gtest/gtest.h"
+
+/**
+ * Test if default ip is 0.0.0.0 when last ip file doesn't exist.
+ */
+TEST(ReadIp, testzeroIpIfNotExists) {
+    FileLogger logger;
+    std::string oldip = logger.readip();
+    ASSERT_EQ(oldip, "0.0.0.0");
+}
+/**
+ * Test if default ip is 0.0.0.0 when last ip file doesn't exist.
+ */
+TEST(IPAPI, testIpAPIcheckIPSyntax) {
+    IPAPI ipapi;
+    std::string ip = ipapi.getGlobalIp();
+    if (ip.find('.') == ULONG_MAX) {
+        // error when ip doesn't contain a .
+        ASSERT_TRUE(false);
+    } else {
+        ASSERT_TRUE(true);
+    }
+}