Merge pull request #6086 from pan-/gatt-client-unit-tests

BLE: Gatt client unit tests

Author: cmonr

.travis.yml

@@ -20,6 +20,15 @@ cache:
     - $HOME/.cache/apt
     - $HOME/gcc-arm-none-eabi-6-2017-q2-update
 
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - gcc-6
+      - g++-6
+      - cmake
+
 before_install:
   - bash -c "$STATUS" pending "Local $NAME testing is in progress"
   # Make sure pipefail
@@ -134,6 +143,25 @@ matrix:
           fi
         - bash -c "$STATUS" success "$STATUSM"
 
+    - env:
+        - NAME=ble-host-tests
+        - BLE_HOST_TESTS=$PWD/features/FEATURE_BLE/tests
+      install:
+        # Install dependencies
+        - sudo apt-get install cmake
+        # Print versions we use
+        - gcc --version
+        - cmake --version
+      script:
+        # Compile the tests
+        - mkdir $BLE_HOST_TESTS/build
+        - cd $BLE_HOST_TESTS/build && CC=gcc-6 CXX=g++-6 cmake .. -G "Unix Makefiles"
+        - ls $BLE_HOST_TESTS
+        - ls $BLE_HOST_TESTS/build
+        - cd $BLE_HOST_TESTS/build && make 
+        # Run ble host tests
+        - $BLE_HOST_TESTS/build/gatt-client-tests
+
     - env:
         - NAME=littlefs
         - LITTLEFS=features/filesystem/littlefs

features/FEATURE_BLE/tests/CMakeLists.txt

@@ -0,0 +1,89 @@
+cmake_minimum_required(VERSION 2.8.11)
+
+# Make PROJECT_SOURCE_DIR, PROJECT_BINARY_DIR, and PROJECT_NAME available.
+set(PROJECT_NAME ble-tests)
+project(${PROJECT_NAME})
+
+set(CMAKE_CXX_STANDARD 14)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+################################
+# GTEST
+################################
+
+# Download and unpack googletest at configure time
+configure_file(CMakeLists.txt.in googletest-download/CMakeLists.txt)
+execute_process(COMMAND ${CMAKE_COMMAND} -G "${CMAKE_GENERATOR}" .
+  RESULT_VARIABLE result
+  WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/googletest-download )
+if(result)
+  message(FATAL_ERROR "CMake step for googletest failed: ${result}")
+endif()
+execute_process(COMMAND ${CMAKE_COMMAND} --build .
+  RESULT_VARIABLE result
+  WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/googletest-download )
+if(result)
+  message(FATAL_ERROR "Build step for googletest failed: ${result}")
+endif()
+
+# Prevent overriding the parent project's compiler/linker
+# settings on Windows
+set(gtest_force_shared_crt ON CACHE BOOL "" FORCE)
+
+# Add googletest directly to our build. This defines
+# the gtest and gtest_main targets.
+add_subdirectory(${CMAKE_BINARY_DIR}/googletest-src
+                 ${CMAKE_BINARY_DIR}/googletest-build
+                 EXCLUDE_FROM_ALL)
+
+# The gtest/gtest_main targets carry header search path
+# dependencies automatically when using CMake 2.8.11 or
+# later. Otherwise we have to add them here ourselves.
+if (CMAKE_VERSION VERSION_LESS 2.8.11)
+  include_directories(BEFORE SYSTEM
+    "${gtest_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}/include")
+else()
+  target_include_directories(gmock_main SYSTEM BEFORE INTERFACE
+    "${gtest_SOURCE_DIR}/include" "${gmock_SOURCE_DIR}/include")
+endif()
+
+
+################################
+# Testing
+################################
+
+enable_testing()
+
+###############################
+# GattClient test
+###############################
+
+add_executable(gatt-client-tests 
+  mbed_os_stub/mbed_assert.c
+  generic/GattClient/mock/MockCallbacks.cpp
+  generic/GattClient/mock/MockPalGattClient.cpp 
+  generic/GattClient/util/Equality.cpp 
+  generic/GattClient/TestCharacteristicDesctiptorDiscovery.cpp
+  generic/GattClient/TestDiscoverAllServices.cpp
+  generic/GattClient/TestNoCb.cpp
+  generic/GattClient/TestRead.cpp
+  generic/GattClient/TestServerEvent.cpp
+  generic/GattClient/TestWrite.cpp
+  ${PROJECT_SOURCE_DIR}/../source/generic/GenericGattClient.cpp
+)
+
+target_include_directories(gatt-client-tests PRIVATE 
+  "${PROJECT_SOURCE_DIR}/.." 
+  "${PROJECT_SOURCE_DIR}/../../.." 
+  "${PROJECT_SOURCE_DIR}/generic/GattClient"
+)
+
+# Standard linking to gtest stuff.
+target_link_libraries(gatt-client-tests gmock_main)
+
+# This is so you can do 'make gatt-client-tests' to see all your tests run, instead of
+# manually running the executable runUnitTests to see those specific tests.
+add_test(NAME AllUnitTests COMMAND gatt-client-tests)
+
+

features/FEATURE_BLE/tests/CMakeLists.txt.in

@@ -0,0 +1,15 @@
+cmake_minimum_required(VERSION 2.8.11)
+
+project(googletest-download NONE)
+
+include(ExternalProject)
+ExternalProject_Add(googletest
+  GIT_REPOSITORY    https://github.com/google/googletest.git
+  GIT_TAG           master
+  SOURCE_DIR        "${CMAKE_BINARY_DIR}/googletest-src"
+  BINARY_DIR        "${CMAKE_BINARY_DIR}/googletest-build"
+  CONFIGURE_COMMAND ""
+  BUILD_COMMAND     ""
+  INSTALL_COMMAND   ""
+  TEST_COMMAND      ""
+)

features/FEATURE_BLE/tests/README.md

@@ -0,0 +1,35 @@
+# mbed BLE host tests
+
+This folder contains tests for mbed BLE that can be run on an x86 host.
+
+## Getting started
+
+Run the following instructions to build the tests:
+
+```
+cd features/FEATURE_BLE/tests
+mkdir build
+cd build
+cmake ..
+make
+```
+
+The various tests applications are present at the root of the test folder;
+execute them to run the tests. As an examples gatt client related tests can be
+run with:
+
+```
+./gatt-client-tests
+```
+
+## Requirements
+
+These tests requires cmake on the host and a compliant C++14 compiler.
+
+## Resources
+
+These tests use extensively google test (gtest) and google mock. Please refer to
+the documentation of each products to get more insight:
+* gtest: https://github.com/google/googletest/tree/master/googletest/docs
+* gmock: https://github.com/google/googletest/tree/master/googlemock/docs
+