This repository contains the Device Defender client library for interacting with the AWS IoT Device Defender Service. This library has no dependencies on any additional libraries other than the standard C library, and therefore, can be used with any MQTT client library. This library is distributed under the MIT Open Source License.
This library has gone through code quality checks including verification that no function has a GNU Complexity score over 8.
The Device Defender client library exposes build configuration macros that are
required for building the library. A list of all the configurations and their
default values are defined in
defender_config_defaults.h.
To provide custom values for the configuration macros, a config file named
defender_config.h
can be provided by the application to the library.
By default, a defender_config.h
config file is required to build the library.
To disable this requirement and build the library with default configuration
values, provide DEFENDER_DO_NOT_USE_CUSTOM_CONFIG
as a compile time
preprocessor macro.
Thus, the Device Defender client library can be built by either:
- Defining a
defender_config.h
file in the application, and adding it to the include directories list of the library.
OR
- Defining the
DEFENDER_DO_NOT_USE_CUSTOM_CONFIG
preprocessor macro for the library build.
The defenderFilePaths.cmake file contains the information of all source files and the header include paths required to build the Device Defender client library.
As mentioned in the previous section, either a custom config file
(i.e. defender_config.h
) or DEFENDER_DO_NOT_USE_CUSTOM_CONFIG
macro needs to
be provided to build the Device Defender client library.
For a CMake example of building the Device Defender client library with the
defenderFilePaths.cmake
file, refer to the coverity_analysis
library target
in test/CMakeLists.txt file.
- For running unit tests:
- C90 compiler like gcc.
- CMake 3.13.0 or later.
- Ruby 2.0.0 or later is additionally required for the CMock test framework (that we use).
- For running the coverage target, gcov and lcov are additionally required.
-
Go to the root directory of this repository.
-
Run the cmake command:
cmake -S test -B build -DBUILD_CLONE_SUBMODULES=ON
. -
Run this command to build the library and unit tests:
make -C build all
. -
The generated test executables will be present in
build/bin/tests
folder. -
Run
cd build && ctest
to execute all tests and view the test run summary.