| project(netconf-cli LANGUAGES CXX) |
| cmake_minimum_required(VERSION 3.0) |
| set(CMAKE_CXX_STANDARD 17) |
| set(CMAKE_CXX_STANDARD_REQUIRED ON) |
| set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) |
| |
| include(GNUInstallDirs) |
| |
| # Set a default build type if none was specified. This was shamelessly stolen |
| # from VTK's cmake setup because these guys produce both CMake and a project that |
| # manipulates this variable, and the web is full of posts where people say that |
| # it is apparently evil to just set the build type in a way an earlier version of |
| # this patch did. Oh, and the location of this check/update matters, apparently. |
| # |
| # Yes, this is just plain crazy. |
| if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) |
| message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.") |
| set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose the type of build." FORCE) |
| # Set the possible values of build type for cmake-gui |
| set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo") |
| endif() |
| |
| # -Werror is not a default for sanity reasons (one cannot know what warnings a future compiler |
| # might bring along), but it's a default in debug mode. The idea is that developers should care |
| # about a warning-free build, and that this is easier than messing with yet another configure option. |
| set(CMAKE_CXX_FLAGS_DEBUG "-Werror ${CMAKE_CXX_FLAGS_DEBUG}") |
| |
| # I don't want to duplicate the compiler's optimizations |
| set(CMAKE_CXX_FLAGS "-O2 ${CMAKE_CXX_FLAGS}") |
| |
| # Build warnings are useful tools (and this project should be warning-free anyway), enable them on all |
| # configurations. They are warnings, not errors. |
| set(CMAKE_CXX_FLAGS "-Wall -Wextra -pedantic -Woverloaded-virtual -Wimplicit-fallthrough ${CMAKE_CXX_FLAGS}") |
| |
| if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU") |
| set(CMAKE_CXX_FLAGS "-Wsuggest-override ${CMAKE_CXX_FLAGS}") |
| endif() |
| |
| set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/") |
| |
| add_custom_target(git-version-cmake-ide |
| cmake/ProjectGitVersion.cmake |
| cmake/ProjectGitVersionRunner.cmake |
| ) |
| include(cmake/ProjectGitVersion.cmake) |
| prepare_git_version(NETCONF_CLI_VERSION "0.0") |
| |
| find_package(Doxygen) |
| option(WITH_DOCS "Create and install internal documentation (needs Doxygen)" ${DOXYGEN_FOUND}) |
| |
| find_package(docopt REQUIRED) |
| find_package(Boost REQUIRED) |
| find_library(REPLXX_LIBRARY NAMES replxx replxx-d REQUIRED) |
| find_path(REPLXX_PATH replxx.hxx) |
| if("${REPLXX_PATH}" STREQUAL REPLXX_PATH-NOTFOUND) |
| message(FATAL_ERROR "Cannot find the \"replxx.hxx\" include file for the replxx library.") |
| endif() |
| |
| find_package(PkgConfig) |
| pkg_check_modules(LIBYANG REQUIRED libyang-cpp>=1.0.130 IMPORTED_TARGET libyang) |
| pkg_check_modules(SYSREPO REQUIRED libSysrepo-cpp>=0.7.9 IMPORTED_TARGET libsysrepo) |
| pkg_check_modules(LIBNETCONF2 REQUIRED libnetconf2>=0.12.64 IMPORTED_TARGET libnetconf2) |
| |
| # we don't need filename tracking, and we prefer to use header-only Boost |
| add_definitions(-DBOOST_SPIRIT_X3_NO_FILESYSTEM) |
| |
| include_directories(${CMAKE_CURRENT_SOURCE_DIR}/src/) |
| |
| add_library(ast_values STATIC |
| src/ast_values.cpp |
| ) |
| target_link_libraries(ast_values PUBLIC Boost::boost) |
| |
| add_library(path STATIC |
| src/ast_path.cpp |
| ) |
| target_link_libraries(path PUBLIC ast_values Boost::boost) |
| |
| add_library(leaf_data_type STATIC |
| src/leaf_data_type.cpp |
| ) |
| target_link_libraries(leaf_data_type ast_values) |
| |
| add_library(utils STATIC |
| src/utils.cpp |
| ) |
| target_link_libraries(utils path ast_values) |
| |
| add_library(schemas STATIC |
| src/static_schema.cpp |
| src/schema.cpp |
| ) |
| target_link_libraries(schemas PUBLIC path leaf_data_type Boost::boost) |
| |
| add_library(datastoreaccess STATIC |
| src/datastore_access.cpp |
| src/data_query.cpp |
| ) |
| target_link_libraries(datastoreaccess PUBLIC Boost::boost) |
| |
| add_library(sysrepoaccess STATIC |
| src/sysrepo_access.cpp |
| ) |
| |
| target_link_libraries(sysrepoaccess PUBLIC datastoreaccess ast_values PRIVATE PkgConfig::SYSREPO) |
| |
| add_library(netconfaccess STATIC |
| src/netconf-client.cpp |
| src/netconf_access.cpp |
| ) |
| |
| target_link_libraries(netconfaccess PUBLIC datastoreaccess yangschema ast_values utils PkgConfig::LIBNETCONF2 PRIVATE PkgConfig::LIBYANG) |
| |
| add_library(yangaccess STATIC |
| src/yang_access.cpp |
| ) |
| |
| target_link_libraries(yangaccess PUBLIC datastoreaccess yangschema PRIVATE PkgConfig::LIBYANG) |
| |
| add_library(yangschema STATIC |
| src/yang_schema.cpp |
| src/libyang_utils.cpp |
| ) |
| target_link_libraries(yangschema PUBLIC schemas utils PRIVATE PkgConfig::LIBYANG) |
| |
| add_library(parser STATIC |
| src/parser.cpp |
| src/ast_commands.cpp |
| src/parser_context.cpp |
| src/interpreter.cpp |
| src/ast_handlers.cpp |
| src/completion.cpp |
| ) |
| target_link_libraries(parser schemas utils ast_values) |
| |
| add_library(proxydatastore STATIC |
| src/proxy_datastore.cpp |
| ) |
| target_link_libraries(proxydatastore PUBLIC datastoreaccess yangaccess) |
| |
| # Links libraries, that aren't specific to a datastore type |
| function(cli_link_required cli_target) |
| target_include_directories(${cli_target} PRIVATE ${REPLXX_PATH}) |
| target_link_libraries(${cli_target} proxydatastore yangschema docopt parser ${REPLXX_LIBRARY}) |
| add_dependencies(${cli_target} target-NETCONF_CLI_VERSION) |
| target_include_directories(${cli_target} PRIVATE ${PROJECT_BINARY_DIR}) |
| endfunction() |
| |
| add_executable(sysrepo-cli |
| src/cli.cpp |
| ) |
| target_compile_definitions(sysrepo-cli PRIVATE SYSREPO_CLI) |
| target_link_libraries(sysrepo-cli sysrepoaccess) |
| cli_link_required(sysrepo-cli) |
| |
| add_executable(yang-cli |
| src/cli.cpp |
| ) |
| target_compile_definitions(yang-cli PRIVATE YANG_CLI) |
| cli_link_required(yang-cli) |
| target_link_libraries(yang-cli yangaccess) |
| if(CMAKE_CXX_FLAGS MATCHES "-stdlib=libc\\+\\+" AND CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9.0) |
| target_link_libraries(yang-cli c++experimental) |
| elseif(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_LESS 9.1) |
| target_link_libraries(yang-cli stdc++fs) |
| endif() |
| |
| |
| |
| include(CTest) |
| if(BUILD_TESTING) |
| find_package(trompeloeil 33 REQUIRED) |
| find_package(doctest 2.3.1 REQUIRED) |
| |
| add_library(DoctestIntegration STATIC |
| tests/doctest_integration.cpp |
| tests/trompeloeil_doctest.hpp |
| tests/wait-a-bit-longer.cpp |
| ) |
| target_include_directories(DoctestIntegration PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/tests/ ${CMAKE_CURRENT_SOURCE_DIR}/src/) |
| target_link_libraries(DoctestIntegration doctest::doctest trompeloeil) |
| target_compile_definitions(DoctestIntegration PUBLIC DOCTEST_CONFIG_SUPER_FAST_ASSERTS) |
| |
| add_library(sysreposubscription STATIC |
| tests/mock/sysrepo_subscription.cpp |
| ) |
| target_link_libraries(sysreposubscription PUBLIC datastoreaccess PRIVATE PkgConfig::SYSREPO) |
| |
| if (NOT SYSREPOCTL_EXECUTABLE) |
| find_program(SYSREPOCTL_EXECUTABLE sysrepoctl) |
| endif() |
| if (NOT SYSREPOCTL_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find sysrepoctl, set SYSREPOCTL_EXECUTABLE manually.") |
| endif() |
| |
| if (NOT SYSREPOCFG_EXECUTABLE) |
| find_program(SYSREPOCFG_EXECUTABLE sysrepocfg) |
| endif() |
| if (NOT SYSREPOCFG_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find sysrepocfg, set SYSREPOCFG_EXECUTABLE manually.") |
| endif() |
| |
| if (NOT SYSREPOD_EXECUTABLE) |
| find_program(SYSREPOD_EXECUTABLE sysrepod) |
| endif() |
| if (NOT SYSREPOD_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find sysrepod, set SYSREPOD_EXECUTABLE manually.") |
| endif() |
| |
| if (NOT SYSREPO_PLUGIND_EXECUTABLE) |
| find_program(SYSREPO_PLUGIND_EXECUTABLE sysrepo-plugind) |
| endif() |
| if (NOT SYSREPO_PLUGIND_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find sysrepo-plugind, set SYSREPO_EXECUTABLE manually.") |
| endif() |
| |
| if (NOT NETOPEER2_EXECUTABLE) |
| find_program(NETOPEER2_EXECUTABLE netopeer2-server) |
| endif() |
| if (NOT NETOPEER2_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find netopeer2-server, set NETOPEER2_EXECUTABLE manually.") |
| endif() |
| |
| if (NOT FAKEROOT_EXECUTABLE) |
| find_program(FAKEROOT_EXECUTABLE fakeroot) |
| endif() |
| if (NOT FAKEROOT_EXECUTABLE) |
| message(FATAL_ERROR "Unable to find fakeroot, set FAKEROOT_EXECUTABLE manually.") |
| endif() |
| |
| set(NETOPEER_SOCKET_PATH "${CMAKE_CURRENT_BINARY_DIR}/netopeer2-server.sock") |
| configure_file(${CMAKE_CURRENT_SOURCE_DIR}/tests/start_daemons.sh.in ${CMAKE_CURRENT_BINARY_DIR}/start_daemons.sh @ONLY) |
| configure_file(${CMAKE_CURRENT_SOURCE_DIR}/tests/netopeer_vars.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/netopeer_vars.hpp @ONLY) |
| configure_file(${CMAKE_CURRENT_SOURCE_DIR}/tests/yang_access_test_vars.hpp.in ${CMAKE_CURRENT_BINARY_DIR}/yang_access_test_vars.hpp @ONLY) |
| |
| function(setup_datastore_tests) |
| add_test(NAME setup_netopeer COMMAND ${SYSREPOCFG_EXECUTABLE} ietf-netconf-server -i ${CMAKE_CURRENT_SOURCE_DIR}/tests/netopeer-test-config.xml --datastore=startup --format=xml) |
| add_test(NAME start_daemons COMMAND ${FAKEROOT_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/start_daemons.sh) |
| add_test(NAME example-schema_init |
| COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/sysrepoctl-manage-module.sh ${SYSREPOCTL_EXECUTABLE} ${SYSREPOCFG_EXECUTABLE} install ${CMAKE_CURRENT_SOURCE_DIR}/tests/example-schema.yang ) |
| add_test(NAME example-schema_cleanup |
| COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/sysrepoctl-manage-module.sh ${SYSREPOCTL_EXECUTABLE} ${SYSREPOCFG_EXECUTABLE} uninstall ${CMAKE_CURRENT_SOURCE_DIR}/tests/example-schema.yang ) |
| add_test(NAME kill_daemons COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/kill_daemons.sh) |
| set_tests_properties(example-schema_init PROPERTIES FIXTURES_REQUIRED netopeer_running FIXTURES_SETUP example-schema_setup) |
| set_tests_properties(example-schema_cleanup PROPERTIES FIXTURES_CLEANUP example-schema_setup) |
| set_tests_properties(setup_netopeer start_daemons kill_daemons example-schema_init example-schema_cleanup PROPERTIES RESOURCE_LOCK sysrepo) |
| set_tests_properties(setup_netopeer PROPERTIES FIXTURES_SETUP netopeer_configured) |
| set_tests_properties(start_daemons PROPERTIES FIXTURES_REQUIRED netopeer_configured FIXTURES_SETUP netopeer_running) |
| set_property(TEST kill_daemons APPEND PROPERTY DEPENDS example-schema_cleanup) |
| set_property(TEST kill_daemons APPEND PROPERTY FIXTURES_CLEANUP netopeer_running) |
| endfunction() |
| |
| function(cli_test name) |
| if (${ARGC} GREATER 1) # this is how CMake does optional arguments |
| add_executable(test_${name} |
| tests/${ARGV1} |
| ) |
| else() |
| add_executable(test_${name} |
| tests/${name}.cpp |
| ) |
| endif() |
| target_link_libraries(test_${name} DoctestIntegration parser datastoreaccess) |
| if(NOT CMAKE_CROSSCOMPILING) |
| add_test(test_${name} test_${name}) |
| endif() |
| target_include_directories(test_${name} PRIVATE ${CMAKE_CURRENT_BINARY_DIR}) |
| endfunction() |
| |
| function(datastore_test_impl name model backend) |
| set(TESTNAME test_${name}_${backend}) |
| cli_test(${name}_${backend} ${name}.cpp) |
| set_tests_properties(${TESTNAME} PROPERTIES FIXTURES_REQUIRED ${model}_setup RESOURCE_LOCK sysrepo) |
| set_property(TEST ${TESTNAME} APPEND PROPERTY FIXTURES_REQUIRED netopeer_running) |
| target_include_directories(${TESTNAME} PRIVATE ${PROJECT_SOURCE_DIR}/tests/mock) |
| if (${backend} STREQUAL "sysrepo") |
| target_link_libraries(${TESTNAME} sysrepoaccess) |
| elseif (${backend} STREQUAL "netconf") |
| target_link_libraries(${TESTNAME} netconfaccess) |
| elseif (${backend} STREQUAL "yang") |
| target_link_libraries(${TESTNAME} yangaccess) |
| else() |
| message(FATAL_ERROR "Unknown backend ${backend}") |
| endif() |
| target_link_libraries(${TESTNAME} yangschema sysreposubscription proxydatastore PkgConfig::SYSREPO) |
| |
| target_compile_definitions(${TESTNAME} PRIVATE ${backend}_BACKEND) |
| endfunction() |
| |
| function(datastore_test name model) |
| datastore_test_impl(${name} ${model} sysrepo) |
| datastore_test_impl(${name} ${model} netconf) |
| datastore_test_impl(${name} ${model} yang) |
| endfunction() |
| |
| cli_test(cd) |
| cli_test(ls) |
| cli_test(presence_containers) |
| cli_test(leaf_editing) |
| target_link_libraries(test_leaf_editing leaf_data_type) |
| cli_test(yang) |
| target_link_libraries(test_yang yangschema) |
| cli_test(utils) |
| cli_test(path_completion) |
| cli_test(command_completion) |
| cli_test(set_value_completion) |
| target_link_libraries(test_set_value_completion leaf_data_type) |
| cli_test(list_manipulation) |
| cli_test(interpreter) |
| target_link_libraries(test_interpreter proxydatastore) |
| cli_test(path_utils) |
| target_link_libraries(test_path_utils path) |
| cli_test(keyvalue_completion) |
| |
| setup_datastore_tests() |
| datastore_test(datastore_access example-schema) |
| datastore_test(data_query example-schema) |
| endif() |
| |
| option(WITH_PYTHON_BINDINGS "Create and install Python3 bindings for accessing datastores" OFF) |
| if(WITH_PYTHON_BINDINGS) |
| set(PYBIND11_CPP_STANDARD -std=c++17) |
| find_package(pybind11 REQUIRED) |
| pybind11_add_module(netconf_cli_py src/python_netconf.cpp) |
| target_link_libraries(netconf_cli_py PUBLIC netconfaccess) |
| |
| if(BUILD_TESTING) |
| configure_file(${CMAKE_CURRENT_SOURCE_DIR}/tests/python_netconfaccess.py |
| ${CMAKE_CURRENT_BINARY_DIR}/tests_python_netconfaccess.py @ONLY) |
| add_test(NAME test_netconf_cli_py COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/tests_python_netconfaccess.py) |
| set_tests_properties(test_netconf_cli_py PROPERTIES RESOURCE_LOCK sysrepo) |
| set_property(TEST test_netconf_cli_py APPEND PROPERTY FIXTURES_REQUIRED netopeer_running) |
| set_property(TEST test_netconf_cli_py APPEND PROPERTY FIXTURES_REQUIRED example-schema_setup) |
| |
| set(sanitizer_active OFF) |
| # FIXME: this just sucks. The detection is very unreliable (one could use something like |
| # -fsanitize=address,undefined and we are screwed), and especially clang's query for preload |
| # is obviously unportable because we hardcode host's architecture. |
| # This is super-ugly. Perhaps it would be better just to outright disable everything, but hey, |
| # I need to test this on my laptop where I'm using ASAN by default, and it kinda-almost-works |
| # there with just one patch to libyang :). |
| if (${CMAKE_CXX_FLAGS} MATCHES "-fsanitize=address") |
| set(sanitizer_active ON) |
| set(gcc_sanitizer_preload libasan.so) |
| set(clang_sanitizer_preload libclang_rt.asan-x86_64.so) |
| endif() |
| |
| if (sanitizer_active) |
| if (CMAKE_CXX_COMPILER_ID STREQUAL "Clang") |
| execute_process(COMMAND ${CMAKE_CXX_COMPILER} -print-file-name=${clang_sanitizer_preload} |
| OUTPUT_VARIABLE LIBxSAN_FULL_PATH OUTPUT_STRIP_TRAILING_WHITESPACE) |
| elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU") |
| execute_process(COMMAND ${CMAKE_CXX_COMPILER} -print-file-name=${gcc_sanitizer_preload} |
| OUTPUT_VARIABLE LIBxSAN_FULL_PATH OUTPUT_STRIP_TRAILING_WHITESPACE) |
| else() |
| message(ERROR "Cannot determine correct sanitizer library for LD_PRELOAD") |
| endif() |
| set_property(TEST test_netconf_cli_py APPEND PROPERTY ENVIRONMENT |
| LD_PRELOAD=${LIBxSAN_FULL_PATH} |
| ASAN_OPTIONS=detect_leaks=0 # they look harmless, but they are annoying |
| ) |
| endif() |
| endif() |
| endif() |
| |
| if(WITH_DOCS) |
| set(doxyfile_in ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in) |
| set(doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile) |
| configure_file(${doxyfile_in} ${doxyfile} @ONLY) |
| add_custom_target(doc |
| COMMAND ${DOXYGEN_EXECUTABLE} ${doxyfile} |
| WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} |
| COMMENT "Generating API documentation with Doxygen" |
| VERBATIM |
| SOURCES ${doxyfile_in} |
| ) |
| endif() |
| |
| install(TARGETS |
| sysrepo-cli |
| RUNTIME DESTINATION ${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_BINDIR}/) |