Commit a7b5da0f authored by Sigurd M. Albrektsen's avatar Sigurd M. Albrektsen
Browse files

Moved cpp-code to sentiboard-cpp

parent 6f7cda90

.gitlab-ci.yml

deleted100644 → 0
+0 −50
Original line number Diff line number Diff line 
image: gcc-cpplint-cmake-gcov



build:

  stage: build

  script: 

    - make -C parsers tests -j 4

  artifacts:

    paths:

      - parsers/build/sentiboard_utils_test

  cache:

    paths:

      - parsers/build/



lint:

  stage: build

  script:

    - make -C parsers lint



test:

  stage: test

  script:

    - ./parsers/build/sentiboard_utils_test



coverage:

  stage: test

  script:

    - make -C parsers coverage

  coverage: '/lines[.: ]*\d+.\d+%/'

  artifacts:

    paths:

      - parsers/build_coverage/sentiboard_utils_test

      - parsers/coverage/

  cache:

    paths:

      - parsers/build_coverage/

      - parsers/coverage/



branch-coverage:

  stage: test

  script:

    - make -C parsers coverage

  coverage: '/branches[.: ]*\d+.\d+%/'

  artifacts:

    paths:

      - parsers/build_coverage/sentiboard_utils_test

      - parsers/coverage/

  cache:

    paths:

      - parsers/build_coverage/

      - parsers/coverage/

README.md

+0 −8
Original line number Diff line number Diff line 
Sentiboard Utils

================



Status

------



[![build status](https://kyb.guru/gitlab/enfo/sentiboard-utils/badges/master/pipeline.svg)](https://kyb.guru/gitlab/enfo/sentiboard-utils/commits/master)

 Lines: [![coverage report](https://kyb.guru/gitlab/enfo/sentiboard-utils/badges/master/coverage.svg?job=coverage)](https://kyb.guru/gitlab/enfo/sentiboard-utils/commits/master)

 Branches: [![coverage report](https://kyb.guru/gitlab/enfo/sentiboard-utils/badges/master/coverage.svg?job=branch-coverage)](https://kyb.guru/gitlab/enfo/sentiboard-utils/commits/master)





Usage

=====

parsers/CMakeLists.txt

deleted100644 → 0
+0 −83
Original line number Diff line number Diff line 
cmake_minimum_required (VERSION 3.1.0 FATAL_ERROR)

project (sentiboard-utils)



# The version number.

set (sentiboard_utils_VERSION_MAJOR 0)

set (sentiboard_utils_VERSION_MINOR 1)



set (SENTIBOARD_SRC_DIR "${CMAKE_SOURCE_DIR}/src")

set (SENTIBOARD_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/include")



include_directories(

  ${SENTIBOARD_INCLUDE_DIR}

)



set(SENTIBOARD_SRCS

  ${SENTIBOARD_SRC_DIR}/Reader.cpp

  ${SENTIBOARD_SRC_DIR}/Package.cpp

)



FILE(GLOB_RECURSE SENTIBOARD_HEADERS "include/*.h" "include/*.hpp)")





add_library(sentiboard_utils

  ${SENTIBOARD_SRCS}

  ${SENTIBOARD_HEADERS}

)



target_compile_features(sentiboard_utils PRIVATE cxx_auto_type cxx_range_for)





#  -- Set up test project --



set (TEST_TARGET "sentiboard_utils_test")



set (TEST_SRC_DIR "${CMAKE_SOURCE_DIR}/tests")

set (TEST_INCLUDE_DIR "${TEST_SRC_DIR}/include")



include_directories(

  ${TEST_INCLUDE_DIR}

)





# Select wether to use Catch c++ or doctest

option(USE_CATCH_TESTS "Use the Catch c++ test framework" True)





set(SENTIBOARD_TEST_HEADERS "${TEST_SRC_DIR}/include/framework/test_framework.hpp")

if(USE_CATCH_TESTS)

    add_definitions(-DUSE_CATCH)

    list(APPEND SENTIBOARD_TEST_HEADERS "${TEST_SRC_DIR}/include/framework/catch.hpp")

else()

    list(APPEND SENTIBOARD_TEST_HEADERS "${TEST_SRC_DIR}/include/framework/doctest.h")

endif()



set(SENTIBOARD_TEST_SRCS

  ${TEST_SRC_DIR}/testmain.cpp

  ${TEST_SRC_DIR}/sentiboard_reader_test.cpp

  ${TEST_SRC_DIR}/stim_parser_test.cpp

  ${TEST_SRC_DIR}/test_utils.cpp

)



add_executable(${TEST_TARGET}

  ${SENTIBOARD_TEST_SRCS}

  ${SENTIBOARD_TEST_HEADERS}

)





target_compile_features(${TEST_TARGET} PRIVATE cxx_auto_type cxx_nullptr)



target_link_libraries(${TEST_TARGET} sentiboard_utils)





#  -- Set up code coverage project --



set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake-modules)

if (CMAKE_BUILD_TYPE STREQUAL "Coverage")

    SET(CMAKE_CXX_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")

    SET(CMAKE_C_FLAGS "-g -O0 -fprofile-arcs -ftest-coverage")



    include(CodeCoverage)

    SETUP_TARGET_FOR_COVERAGE(test_coverage ${TEST_TARGET} ${PROJECT_SOURCE_DIR}/coverage)



endif() #CMAKE_BUILD_TYPE STREQUAL "Coverage"

parsers/Makefile

deleted100644 → 0
+0 −35
Original line number Diff line number Diff line 
CPPLINT_EXCLUDES = --exclude=tests/include/framework/* --filter=-readability/casting,-readability/check --repository=.



BIN_DIR = build

BIN_COV_DIR = build_coverage

TEST_TARGET = sentiboard_utils_test



.PHONY: all

all: tests



.PHONY: tests

tests :

	mkdir -p $(BIN_DIR)

	cd $(BIN_DIR) && cmake ..

	make -C $(BIN_DIR) -j 8



.PHONY: lint

lint:

	cpplint --recursive $(CPPLINT_EXCLUDES) src include tests simulator



.PHONY: coverage

coverage:

	mkdir -p $(BIN_COV_DIR)

	cd $(BIN_COV_DIR) && cmake -DCMAKE_BUILD_TYPE=Coverage ..

	make -C $(BIN_COV_DIR) -j8 test_coverage 



.PHONY: run

run: $(BIN_DIR)/$(TEST_TARGET)

	./$(BIN_DIR)/$(TEST_TARGET)



.PHONY: test

test: run



.PHONY: clean

clean:

	$(RM) -r build

parsers/cmake-modules/CodeCoverage.cmake

deleted100644 → 0
+0 −163
Original line number Diff line number Diff line 
#

# 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(NOT CMAKE_COMPILER_IS_GNUCXX)

    # Clang version 3.0.0 and greater now supports gcov as well.

    MESSAGE(WARNING "Compiler is not GNU gcc! Clang Version 3.0.0 and greater supports gcov as well, but older versions don't.")



    IF(NOT "${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")

        MESSAGE(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")

    ENDIF()

ENDIF() # NOT CMAKE_COMPILER_IS_GNUCXX



SET(CMAKE_CXX_FLAGS_COVERAGE

    "-Wunused-variable -g -O0 --coverage -fprofile-arcs -ftest-coverage"

    CACHE STRING "Flags used by the C++ compiler during coverage builds."

    FORCE )

SET(CMAKE_C_FLAGS_COVERAGE

    "-Wunused-variable -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

    # Setup target

    ADD_CUSTOM_TARGET(${_targetname}

        # Cleanup lcov

        ${LCOV_PATH} --directory . --zerocounters



        # Run tests

        COMMAND ${_testrunner} ${ARGV3}



        # Capturing lcov counters and generating report

        COMMAND ${LCOV_PATH} --rc lcov_branch_coverage=1 --directory . --capture --output-file ${_outputname}.info

        COMMAND ${LCOV_PATH} --rc lcov_branch_coverage=1 --remove ${_outputname}.info '${CMAKE_CURRENT_SOURCE_DIR}/tests/*' '/usr/*' --output-file ${_outputname}.info.cleaned

        COMMAND ${GENHTML_PATH} --rc lcov_branch_coverage=1 -o ${_outputname} ${_outputname}.info.cleaned

        COMMAND ${CMAKE_COMMAND} -E remove ${_outputname}.info ${_outputname}.info.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)

    find_package(PythonInterp)



    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/' -s -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