Skip to content

Commit

Permalink
Release v2.0.9
Browse files Browse the repository at this point in the history
  • Loading branch information
arobenko committed Feb 13, 2025
2 parents 06fa3f5 + 3909879 commit dc9dc26
Show file tree
Hide file tree
Showing 28 changed files with 2,136 additions and 27 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/actions_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ on:

env:
COMMS_TAG: v5.3
CC_MQTTSN_TAG: v3.0.1
CC_MQTT311_TAG: v3.0.1
CC_MQTTSN_TAG: v3.0.2
CC_MQTT311_TAG: v3.0.2
WIN_BOOST_VERSION: "1.87.0"
WIN_BOOST_DIR: "C:/local/boost_1_87_0"

Expand Down
5 changes: 3 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@ option (CC_MQTTSN_CLIENT_APPS "Build and install client applications" ${CC_MQTTS
option (CC_MQTTSN_GATEWAY_LIB "Build and install MQTT-SN gateway library" ON)
option (CC_MQTTSN_GATEWAY_LIB_FORCE_PIC "Force Position Independent Code (PIC) when compiling gateway library" OFF)
option (CC_MQTTSN_GATEWAY_APPS "Build and install gateway applications" ${CC_MQTTSN_GATEWAY_LIB})
option (CC_MQTTSN_AFL_FUZZ "Build and install AFL++ fuzzing application(s)" OFF)
option (CC_MQTTSN_BUILD_UNIT_TESTS "Build unittests." OFF)
option (CC_MQTTSN_UNIT_TEST_WITH_VALGRIND "Disable valgrind in unittests." OFF)
option (CC_MQTTSN_UNIT_TEST_WITH_VALGRIND "Run unittests with valgrind." OFF)
option (CC_MQTTSN_USE_CCACHE "Use ccache on unix system" OFF)
option (CC_MQTTSN_WITH_SANITIZERS "Build with sanitizers" OFF)

Expand All @@ -18,7 +19,6 @@ option (BUILD_SHARED_LIBS "Build as shared libraries" OFF)

# Extra variables
# CC_MQTTSN_CUSTOM_CLIENT_CONFIG_FILES - List of custom client configuration files
# CC_MQTTSN_DEFAULT_CLIENT_CONFIG_FILE - Custom congiruation of the default client.

##########################################################################

Expand All @@ -33,6 +33,7 @@ if (("${CMAKE_VERSION}" VERSION_GREATER_EQUAL "3.30") AND
endif ()

find_package(LibComms REQUIRED)
find_package(cc_mqttsn REQUIRED)

include (${PROJECT_SOURCE_DIR}/cmake/Compile.cmake)
cc_mqttsn_compile ()
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,16 @@ necessary components of the [CommsChampion Ecosystem](https://commschamp.github.
Detailed instructions on how to build sources of **this** particular repository can be
found in [doc/BUILD.md](doc/BUILD.md) file.

# How to Fuzz Test
The provided MQTT-SN client library as well as its dependencies from the
[CommsChampion Ecosystem](https://commschamp.github.io/) have been designed with
reliability in mind and to be able to safely handle malformed data as well as
withstand unexpected behaviour from a gateway. In order to
verify the library's reliability it is highly recommended to perform
[AFL++](https://github.com/AFLplusplus/AFLplusplus) based fuzz testing.
The detailed instruction on how to fuzz test the
library can be found in [doc/client_fuzz_test.md](doc/client_fuzz_test.md) file.

# Branching Model
This repository will follow the
[Successful Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/).
Expand Down
3 changes: 2 additions & 1 deletion client/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
add_subdirectory (lib)
add_subdirectory (app)
add_subdirectory (app)
add_subdirectory (afl_fuzz)
Loading

0 comments on commit dc9dc26

Please # to comment.