Merge a2ee277 into 89b1bd6

ugnelis · Apr 23, 2018 · 8df12f1 · 8df12f1
2 parents 89b1bd6 + a2ee277
commit 8df12f1
Show file tree

Hide file tree

Showing 9 changed files with 285 additions and 36 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -4,25 +4,37 @@ language: cpp
 os:
   - linux
 
+before_install:
+  - |
+    if [ "${TRAVIS_OS_NAME}" = "linux" ]; then
+      pip install --user cpp-coveralls
+    fi
+
 install:
   - |
     if [ "${TRAVIS_OS_NAME}" = "linux" ]; then
       lsb_release -a
       sudo apt-add-repository -y ppa:ubuntu-toolchain-r/test
       sudo apt-add-repository -y ppa:beineri/opt-qt562-trusty
       sudo apt-get -qq update
-      sudo apt-get -qq install g++-4.8 libc6-i386 qt56tools qt56svg qt56script
+      sudo apt-get -qq install g++-4.8 libc6-i386 qt56tools qt56svg qt56script lcov
       export CXX="g++-4.8"
       export CC="gcc-4.8"
     fi
 
 script:
+  # Setup environment.
   - |
     if [ "${TRAVIS_OS_NAME}" = "linux" ]; then
       QTDIR="/opt/qt56"
       PATH="$QTDIR/bin:$PATH"
       qt56-env.sh
     fi
+  # Build.
   - mkdir build && cd build
-  - cmake ..
+  - cmake -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=ON ..
   - make
+  - CTEST_OUTPUT_ON_FAILURE=1 make test
+
+after_success:
+  - coveralls --root .. --build-root . -e tests/ -E .+/moc_.* -E .+/qrc_.* -E .+/qxt.* -E .+/ui_.* > coveralls.log
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -8,9 +8,26 @@ set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_LIBDIR})
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR})
 
-# This is used for code coverage.
-if (CMAKE_CXX_COMPILER_ID MATCHES GNU)
-    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fprofile-arcs -ftest-coverage")
+# Threading support doesn't exist for some cross compile targets.
+find_package(Thread QUIET)
+
+if (CMAKE_THREAD_LIBS_INIT)
+    set(gtest_disable_pthreads OFF)
+else ()
+    message(STATUS "Disabling pthread in Google Test.")
+    set(gtest_disable_pthreads ON)
+endif ()
+
+# Coverage.
+option(COVERAGE "Generate coverage data" OFF)
+if (COVERAGE)
+    if (CMAKE_COMPILER_IS_GNUCXX)
+        include(cmake/coverage.cmake)
+        setup_target_for_coverage(project_coverage unit_tests coverage)
+
+        set(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
+        set(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
+    endif ()
 endif ()
 
 # Add source folder.
@@ -24,4 +41,4 @@ fetch_googletest(
 )
 
 enable_testing()
-add_subdirectory(test)
+add_subdirectory(tests)
diff --git a/README.md b/README.md
@@ -1,15 +1,15 @@
-# instant-translator [![Build Status](https://travis-ci.org/ugnelis/instant-translator.svg?branch=master)](https://travis-ci.org/ugnelis/instant-translator)
-Translate words and sentences instantly. Program uses various translator APIs.
+# instant-translator [![Build Status](https://travis-ci.org/ugnelis/instant-translator.svg?branch=master)](https://travis-ci.org/ugnelis/instant-translator) [![Coverage Status](https://coveralls.io/repos/github/ugnelis/instant-translator/badge.svg?branch=master)](https://coveralls.io/github/ugnelis/instant-translator?branch=master)
+Translate words and sentences instantly. Program uses APIs of various translators.
 
 ## What Does the App Solve?
 ### Context
-I am a in the country whose language I know only the basics.
+Currently, I live in the country whose language I only know the basics.
 
 ### Problem
-Most things are in local language. It was necessary to quickly search words or sentences quickly, not only on the WEB pages but also in various dekstop applications.
+Most of the things are in local language. So, it is necessary to adapt quickly by searching for the meanings of the words or the sentences in various applications (WEB based, desktop based).
 
 ### Solution to the Problem
-I have made a desktop application that can translate both web pages and dekstop-based applications and translate that text into the program by clicking on the desired button.
+Desktop application that is able to translate the content of web pages and dekstop-based applications in the app by clicking on the desired button.
 
 ## Screenshot
 ![Screenshot](screenshot.png)

diff --git a/cmake/coverage.cmake b/cmake/coverage.cmake
@@ -0,0 +1,197 @@
+# Copyright (c) 2012 - 2015, Lars Bilke
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+#    may be used to endorse or promote products derived from this software without
+#    specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+#
+#
+# 2012-01-31, Lars Bilke
+# - Enable Code Coverage
+#
+# 2013-09-17, Joakim Söderberg
+# - Added support for Clang.
+# - Some additional usage instructions.
+#
+# USAGE:
+
+# 0. (Mac only) If you use Xcode 5.1 make sure to patch geninfo as described here:
+#      http://stackoverflow.com/a/22404544/80480
+#
+# 1. Copy this file into your cmake modules path.
+#
+# 2. Add the following line to your CMakeLists.txt:
+#      INCLUDE(CodeCoverage)
+#
+# 3. Set compiler flags to turn off optimization and enable coverage:
+#    SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
+#	 SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")
+#
+# 3. Use the function SETUP_TARGET_FOR_COVERAGE to create a custom make target
+#    which runs your test executable and produces a lcov code coverage report:
+#    Example:
+#	 SETUP_TARGET_FOR_COVERAGE(
+#				my_coverage_target  # Name for custom target.
+#				test_driver         # Name of the test driver executable that runs the tests.
+#									# NOTE! This should always have a ZERO as exit code
+#									# otherwise the coverage generation will not complete.
+#				coverage            # Name of output directory.
+#				)
+#
+# 4. Build a Debug build:
+#	 cmake -DCMAKE_BUILD_TYPE=Debug ..
+#	 make
+#	 make my_coverage_target
+#
+#
+
+# Check prereqs
+FIND_PROGRAM(GCOV_PATH gcov)
+FIND_PROGRAM(LCOV_PATH lcov)
+FIND_PROGRAM(GENHTML_PATH genhtml)
+FIND_PROGRAM(GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/tests)
+
+IF (NOT GCOV_PATH)
+    MESSAGE(FATAL_ERROR "gcov not found! Aborting...")
+ENDIF () # NOT GCOV_PATH
+
+IF ("${CMAKE_CXX_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
+    IF ("${CMAKE_CXX_COMPILER_VERSION}" VERSION_LESS 3)
+        MESSAGE(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...")
+    ENDIF ()
+ELSEIF (NOT CMAKE_COMPILER_IS_GNUCXX)
+    MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
+ENDIF () # CHECK VALID COMPILER
+
+SET(CMAKE_CXX_FLAGS_COVERAGE
+        "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
+        CACHE STRING "Flags used by the C++ compiler during coverage builds."
+        FORCE)
+SET(CMAKE_C_FLAGS_COVERAGE
+        "-g -O0 --coverage -fprofile-arcs -ftest-coverage"
+        CACHE STRING "Flags used by the C compiler during coverage builds."
+        FORCE)
+SET(CMAKE_EXE_LINKER_FLAGS_COVERAGE
+        ""
+        CACHE STRING "Flags used for linking binaries during coverage builds."
+        FORCE)
+SET(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
+        ""
+        CACHE STRING "Flags used by the shared libraries linker during coverage builds."
+        FORCE)
+MARK_AS_ADVANCED(
+        CMAKE_CXX_FLAGS_COVERAGE
+        CMAKE_C_FLAGS_COVERAGE
+        CMAKE_EXE_LINKER_FLAGS_COVERAGE
+        CMAKE_SHARED_LINKER_FLAGS_COVERAGE)
+
+IF (NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "Coverage"))
+    MESSAGE(WARNING "Code coverage results with an optimized (non-Debug) build may be misleading")
+ENDIF () # NOT CMAKE_BUILD_TYPE STREQUAL "Debug"
+
+
+# Param _targetname     The name of new the custom make target
+# Param _testrunner     The name of the target which runs the tests.
+#						MUST return ZERO always, even on errors.
+#						If not, no coverage report will be created!
+# Param _outputname     lcov output is generated as _outputname.info
+#                       HTML report is generated in _outputname/index.html
+# Optional fourth parameter is passed as arguments to _testrunner
+#   Pass them in list form, e.g.: "-j;2" for -j 2
+FUNCTION(SETUP_TARGET_FOR_COVERAGE _targetname _testrunner _outputname)
+
+    IF (NOT LCOV_PATH)
+        MESSAGE(FATAL_ERROR "lcov not found! Aborting...")
+    ENDIF () # NOT LCOV_PATH
+
+    IF (NOT GENHTML_PATH)
+        MESSAGE(FATAL_ERROR "genhtml not found! Aborting...")
+    ENDIF () # NOT GENHTML_PATH
+
+    SET(coverage_info "${CMAKE_BINARY_DIR}/${_outputname}.info")
+    SET(coverage_cleaned "${coverage_info}.cleaned")
+
+    SEPARATE_ARGUMENTS(test_command UNIX_COMMAND "${_testrunner}")
+
+    # Setup target
+    ADD_CUSTOM_TARGET(${_targetname}
+
+            # Cleanup lcov
+            ${LCOV_PATH} --directory . --zerocounters
+
+            # Run tests
+            COMMAND ${test_command} ${ARGV3}
+
+            # Capturing lcov counters and generating report
+            COMMAND ${LCOV_PATH} --directory . --capture --output-file ${coverage_info}
+            COMMAND ${LCOV_PATH} --remove ${coverage_info} 'tests/*' '/usr/*' --output-file ${coverage_cleaned}
+            COMMAND ${GENHTML_PATH} -o ${_outputname} ${coverage_cleaned}
+            COMMAND ${CMAKE_COMMAND} -E remove ${coverage_info} ${coverage_cleaned}
+
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
+            )
+
+    # Show info where to find the report
+    ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
+            COMMAND ;
+            COMMENT "Open ./${_outputname}/index.html in your browser to view the coverage report."
+            )
+
+ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE
+
+# Param _targetname     The name of new the custom make target
+# Param _testrunner     The name of the target which runs the tests
+# Param _outputname     cobertura output is generated as _outputname.xml
+# Optional fourth parameter is passed as arguments to _testrunner
+#   Pass them in list form, e.g.: "-j;2" for -j 2
+FUNCTION(SETUP_TARGET_FOR_COVERAGE_COBERTURA _targetname _testrunner _outputname)
+
+    IF (NOT PYTHON_EXECUTABLE)
+        MESSAGE(FATAL_ERROR "Python not found! Aborting...")
+    ENDIF () # NOT PYTHON_EXECUTABLE
+
+    IF (NOT GCOVR_PATH)
+        MESSAGE(FATAL_ERROR "gcovr not found! Aborting...")
+    ENDIF () # NOT GCOVR_PATH
+
+    ADD_CUSTOM_TARGET(${_targetname}
+
+            # Run tests
+            ${_testrunner} ${ARGV3}
+
+            # Running gcovr
+            COMMAND ${GCOVR_PATH} -x -r ${CMAKE_SOURCE_DIR} -e '${CMAKE_SOURCE_DIR}/tests/' -o ${_outputname}.xml
+            WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
+            COMMENT "Running gcovr to produce Cobertura code coverage report."
+            )
+
+    # Show info where to find the report
+    ADD_CUSTOM_COMMAND(TARGET ${_targetname} POST_BUILD
+            COMMAND ;
+            COMMENT "Cobertura code coverage report saved in ${_outputname}.xml."
+            )
+
+ENDFUNCTION() # SETUP_TARGET_FOR_COVERAGE_COBERTURA
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
diff --git a/test/add_test.cpp b/test/add_test.cpp
diff --git a/test/main.cpp b/test/main.cpp
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -0,0 +1,40 @@
+
+# Find the Qt libraries.
+find_package(Qt5Widgets REQUIRED)
+find_package(Qt5Network REQUIRED)
+find_package(Qt5Concurrent REQUIRED)
+
+# Qt5 libraries.
+set(QT5_LIBRARIES
+        Qt5::Widgets
+        Qt5::Network
+        Qt5::Concurrent)
+
+# UI files.
+qt5_wrap_ui(UI_HEADERS ${PROJECT_SOURCE_DIR}/src/mainwindow.ui)
+
+set(RESOURCE_FILES
+        ${PROJECT_SOURCE_DIR}/src/resources.qrc)
+
+qt5_add_resources(RESOURCE_FILES_ADDED ${RESOURCE_FILES})
+
+# Include source directory.
+include_directories("${PROJECT_SOURCE_DIR}/src")
+
+# Source files.
+set(SOURCE_FILES
+        language_test.cpp
+        ${PROJECT_SOURCE_DIR}/src/utils/language.cpp
+        ${PROJECT_SOURCE_DIR}/src/utils/language.h)
+
+# Tell CMake to create the executable.
+add_executable(unit_tests ${SOURCE_FILES} ${RESOURCE_FILES_ADDED} ${UI_HEADERS})
+
+# Use the Widgets module from Qt5.
+target_link_libraries(unit_tests ${QT5_LIBRARIES} gtest_main)
+
+# Add tests.
+add_test(
+        NAME unit_tests
+        COMMAND ${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}/unit_tests
+)
diff --git a/tests/language_test.cpp b/tests/language_test.cpp
@@ -0,0 +1,8 @@
+#include <gtest/gtest.h>
+#include "utils/language.h"
+
+TEST(Language, getCode)
+{
+    Language language;
+    ASSERT_EQ("lt", language.getCode("Lithuanian"));
+}