Merge branch 'main' into memory-report-ci

Author: magnmaeh

.clang-tidy

@@ -1,214 +1,21 @@
 Checks: '
     clang-diagnostic-*,
-    boost-*,
     Google-*,
     clang-analyzer-*,
     modernize-*,
     performance-*,
     portability-*,
     readability-*,
-    cppcoreguidelines-*,
-    llvm-*,
     cert-*,
-    -clang-analyzer-core.CallAndMessage'
+    -readability-else-after-return,
+    -clang-analyzer-core.CallAndMessage,
+    -clang-analyzer-optin.performance.Padding,
+    -readability-magic-numbers,
+    -clang-analyzer-security.insecureAPI.DeprecatedOrUnsafeBufferHandling,
+    -readability-function-cognitive-complexity,
+    -modernize-macro-to-enum
+    '
 WarningsAsErrors: true
 HeaderFilterRegex: ''
 AnalyzeTemporaryDtors: false
 FormatStyle: none
-CheckOptions:
-  - key: cert-dcl16-c.NewSuffixes
-    value: 'L;LL;LU;LLU'
-  - key: cert-oop54-cpp.WarnOnlyIfThisHasSuspiciousField
-    value: '0'
-  - key: cppcoreguidelines-avoid-magic-numbers.IgnoredFloatingPointValues
-    value: '1.0;100.0;'
-  - key: cppcoreguidelines-avoid-magic-numbers.IgnoredIntegerValues
-    value: '1;2;3;4;'
-  - key: cppcoreguidelines-explicit-virtual-functions.FinalSpelling
-    value: final
-  - key: cppcoreguidelines-explicit-virtual-functions.IgnoreDestructors
-    value: '1'
-  - key: cppcoreguidelines-explicit-virtual-functions.OverrideSpelling
-    value: override
-  - key: cppcoreguidelines-macro-usage.AllowedRegexp
-    value: '^DEBUG_*'
-  - key: cppcoreguidelines-macro-usage.CheckCapsOnly
-    value: '0'
-  - key: cppcoreguidelines-macro-usage.IgnoreCommandLineMacros
-    value: '1'
-  - key: cppcoreguidelines-no-malloc.Allocations
-    value: '::malloc;::calloc'
-  - key: cppcoreguidelines-no-malloc.Deallocations
-    value: '::free'
-  - key: cppcoreguidelines-no-malloc.Reallocations
-    value: '::realloc'
-  - key: cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
-    value: '1'
-  - key: cppcoreguidelines-owning-memory.LegacyResourceConsumers
-    value: '::free;::realloc;::freopen;::fclose'
-  - key: cppcoreguidelines-owning-memory.LegacyResourceProducers
-    value: '::malloc;::aligned_alloc;::realloc;::calloc;::fopen;::freopen;::tmpfile'
-  - key: cppcoreguidelines-pro-bounds-constant-array-index.GslHeader
-    value: ''
-  - key: cppcoreguidelines-pro-bounds-constant-array-index.IncludeStyle
-    value: 'llvm'
-  - key: cppcoreguidelines-pro-type-member-init.IgnoreArrays
-    value: '0'
-  - key: cppcoreguidelines-pro-type-member-init.UseAssignment
-    value: '0'
-  - key: cppcoreguidelines-special-member-functions.AllowMissingMoveFunctions
-    value: '0'
-  - key: cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
-    value: '0'
-  - key: google-readability-braces-around-statements.ShortStatementLines
-    value: '1'
-  - key: google-readability-function-size.StatementThreshold
-    value: '800'
-  - key: google-readability-namespace-comments.ShortNamespaceLines
-    value: '10'
-  - key: google-readability-namespace-comments.SpacesBeforeComments
-    value: '2'
-  - key: llvm-namespace-comment.ShortNamespaceLines
-    value: '1'
-  - key: llvm-namespace-comment.SpacesBeforeComments
-    value: '1'
-  - key: modernize-loop-convert.MaxCopySize
-    value: '16'
-  - key: modernize-loop-convert.MinConfidence
-    value: reasonable
-  - key: modernize-loop-convert.NamingStyle
-    value: CamelCase
-  - key: modernize-make-shared.IgnoreMacros
-    value: '1'
-  - key: modernize-make-shared.IncludeStyle
-    value: 'llvm'
-  - key: modernize-make-shared.MakeSmartPtrFunction
-    value: 'std::make_shared'
-  - key: modernize-make-shared.MakeSmartPtrFunctionHeader
-    value: memory
-  - key: modernize-make-unique.IgnoreMacros
-    value: '1'
-  - key: modernize-make-unique.IncludeStyle
-    value: 'llvm'
-  - key: modernize-make-unique.MakeSmartPtrFunction
-    value: 'std::make_unique'
-  - key: modernize-make-unique.MakeSmartPtrFunctionHeader
-    value: memory
-  - key: modernize-pass-by-value.IncludeStyle
-    value: llvm
-  - key: modernize-pass-by-value.ValuesOnly
-    value: '0'
-  - key: modernize-raw-string-literal.ReplaceShorterLiterals
-    value: '0'
-  - key: modernize-replace-auto-ptr.IncludeStyle
-    value: llvm
-  - key: modernize-replace-random-shuffle.IncludeStyle
-    value: llvm
-  - key: modernize-use-auto.MinTypeNameLength
-    value: '5'
-  - key: modernize-use-auto.RemoveStars
-    value: '0'
-  - key: modernize-use-default-member-init.IgnoreMacros
-    value: '1'
-  - key: modernize-use-default-member-init.UseAssignment
-    value: '0'
-  - key: modernize-use-emplace.ContainersWithPushBack
-    value: '::std::vector;::std::list;::std::deque'
-  - key: modernize-use-emplace.SmartPointers
-    value: '::std::shared_ptr;::std::unique_ptr;::std::auto_ptr;::std::weak_ptr'
-  - key: modernize-use-emplace.TupleMakeFunctions
-    value: '::std::make_pair;::std::make_tuple'
-  - key: modernize-use-emplace.TupleTypes
-    value: '::std::pair;::std::tuple'
-  - key: modernize-use-equals-default.IgnoreMacros
-    value: '1'
-  - key: modernize-use-equals-delete.IgnoreMacros
-    value: '1'
-  - key: modernize-use-nodiscard.ReplacementString
-    value: '[[nodiscard]]'
-  - key: modernize-use-noexcept.ReplacementString
-    value: ''
-  - key: modernize-use-noexcept.UseNoexceptFalse
-    value: '1'
-  - key: modernize-use-nullptr.NullMacros
-    value: 'NULL'
-  - key: modernize-use-override.FinalSpelling
-    value: final
-  - key: modernize-use-override.IgnoreDestructors
-    value: '0'
-  - key: modernize-use-override.OverrideSpelling
-    value: override
-  - key: modernize-use-transparent-functors.SafeMode
-    value: '0'
-  - key: modernize-use-using.IgnoreMacros
-    value: '1'
-  - key: performance-faster-string-find.StringLikeClasses
-    value: 'std::basic_string'
-  - key: performance-for-range-copy.AllowedTypes
-    value: ''
-  - key: performance-for-range-copy.WarnOnAllAutoCopies
-    value: '0'
-  - key: performance-inefficient-string-concatenation.StrictMode
-    value: '0'
-  - key: performance-inefficient-vector-operation.VectorLikeClasses
-    value: '::std::vector'
-  - key: performance-move-const-arg.CheckTriviallyCopyableMove
-    value: '1'
-  - key: performance-move-constructor-init.IncludeStyle
-    value: llvm
-  - key: performance-type-promotion-in-math-fn.IncludeStyle
-    value: llvm
-  - key: performance-unnecessary-copy-initialization.AllowedTypes
-    value: ''
-  - key: performance-unnecessary-value-param.AllowedTypes
-    value: ''
-  - key: performance-unnecessary-value-param.IncludeStyle
-    value: llvm
-  - key: portability-simd-intrinsics.Std
-    value: ''
-  - key: portability-simd-intrinsics.Suggest
-    value: '0'
-  - key: readability-braces-around-statements.ShortStatementLines
-    value: '0'
-  - key: readability-function-size.BranchThreshold
-    value: '4294967295'
-  - key: readability-function-size.LineThreshold
-    value: '4294967295'
-  - key: readability-function-size.NestingThreshold
-    value: '4294967295'
-  - key: readability-function-size.ParameterThreshold
-    value: '4294967295'
-  - key: readability-function-size.StatementThreshold
-    value: '800'
-  - key: readability-function-size.VariableThreshold
-    value: '4294967295'
-  - key: readability-identifier-length.MinimumParameterNameLength
-    value: 2
-  - key: readability-identifier-naming.IgnoreFailedSplit
-    value: '0'
-  - key: readability-implicit-bool-conversion.AllowIntegerConditions
-    value: '0'
-  - key: readability-implicit-bool-conversion.AllowPointerConditions
-    value: '0'
-  - key: readability-inconsistent-declaration-parameter-name.IgnoreMacros
-    value: '1'
-  - key: readability-inconsistent-declaration-parameter-name.Strict
-    value: '0'
-  - key: readability-magic-numbers.IgnoredFloatingPointValues
-    value: '1.0;100.0;'
-  - key: readability-magic-numbers.IgnoredIntegerValues
-    value: '1;2;3;4;'
-  - key: readability-redundant-smartptr-get.IgnoreMacros
-    value: '1'
-  - key: readability-simplify-boolean-expr.ChainedConditionalAssignment
-    value: '0'
-  - key: readability-simplify-boolean-expr.ChainedConditionalReturn
-    value: '0'
-  - key: readability-simplify-subscript-expr.Types
-    value: '::std::basic_string;::std::basic_string_view;::std::vector;::std::array'
-  - key: readability-static-accessed-through-instance.NameSpecifierNestingThreshold
-    value: '3'
-  - key: readability-uppercase-literal-suffix.IgnoreMacros
-    value: '1'
-  - key: readability-uppercase-literal-suffix.NewSuffixes
-    value: ''

.github/actions/prepare-build-env/action.yml

@@ -0,0 +1,12 @@
+name: Set up build environment
+description: Set up Java and Gradle.
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 17
+    - name: Gradle Build Action
+      uses: gradle/gradle-build-action@v2.8.0

.github/workflows/ci.yml

@@ -21,8 +21,14 @@ jobs:
             submodules: recursive
       - name: Install deps
         run: sudo apt-get install lcov
+      - name: Setup java and gradle for compiling lfc
+        uses: ./.github/actions/prepare-build-env 
+      # Uncomment to SSH into the runner.
+      # - name: Setup upterm session
+      #   uses: lhotari/action-upterm@v1
       - name: Run tests
         run: |
+          source env.bash
           make format-check
           make test
           make coverage

.gitignore

@@ -6,4 +6,5 @@ cmake-build-debug
 cmake-build-release
 .idea
 include/reactor-uc/config.h
+!lfc/bin
 

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "external/Unity"]
 	path = external/Unity
 	url = https://github.com/ThrowTheSwitch/Unity.git
+[submodule "external/nanopb"]
+	path = external/nanopb
+	url = https://github.com/nanopb/nanopb.git

CHANGELOG

@@ -1,4 +1,6 @@
 # Changelog
+
+
 ## Sep 21
 - Adding PhysicalActions and also extend the Posix support (using pthread to allow testing with threads scheduling async events.)
 - 

CMakeLists.txt

@@ -2,7 +2,10 @@ cmake_minimum_required(VERSION 3.9)
 project(reactor-uc LANGUAGES C)
 
 # Command line options for the build
-set(BUILD_TESTS OFF CACHE BOOL "Build unit tests")
+set(BUILD_EXAMPLES OFF CACHE BOOL "Build examples")
+set(BUILD_TESTS OFF CACHE BOOL "Build all tests")
+set(BUILD_LF_TESTS OFF CACHE BOOL "Build lf tests")
+set(BUILD_UNIT_TESTS OFF CACHE BOOL "Build unit tests")
 set(TEST_COVERAGE OFF CACHE BOOL "Compute test coverage")
 set(ASAN OFF CACHE BOOL "Compile with AddressSanitizer")
 set(PLATFORM "POSIX" CACHE STRING "Platform to target")
@@ -25,47 +28,61 @@ endif()
 
 # Clang-tidy for static code analysis
 if(BUILD_TESTS)
+  set(BUILD_LF_TESTS ON)
+  set(BUILD_UNIT_TESTS ON)
   set(CMAKE_BUILD_TYPE "Debug")
   find_program(CLANG_TIDY clang-tidy)
   if (CLANG_TIDY)
-    set(CMAKE_C_CLANG_TIDY clang-tidy; --header-filter=include/\(.*\)\\.h; --warnings-as-errors)
+    set(CMAKE_C_CLANG_TIDY clang-tidy; --header-filter=include/\(.*\)\\.h; --warnings-as-errors=*;)
   else ()
     message(WARNING "Please install clang-tidy!")
   endif()
 endif()
 
-# TODO: Explicitly name all the sources.
-file(GLOB SOURCES "src/*.c")
-message(${SOURCES})
+# Add nanopb library manually
+set(NANOPB_PATH external/nanopb)
+add_library(nanopb ${NANOPB_PATH}/pb_common.c ${NANOPB_PATH}/pb_encode.c ${NANOPB_PATH}/pb_decode.c)
+set_target_properties(nanopb PROPERTIES C_CLANG_TIDY "") # Disable clang-tidy for this external lib.
+
+file(GLOB SOURCES "src/*.c" "external/proto/*.c")
 
 if (PLATFORM STREQUAL "POSIX")
   add_library(reactor-uc STATIC ${SOURCES})
-  target_compile_definitions(reactor-uc PUBLIC PLATFORM_POSIX)
   target_link_libraries(reactor-uc PRIVATE pthread)
+  if(BUILD_EXAMPLES)
+    add_subdirectory(examples/posix)
+  endif ()
 elseif (PLATFORM STREQUAL "ZEPHYR")
   zephyr_library_named(reactor-uc)
   zephyr_library_sources(${SOURCES})
   zephyr_library_link_libraries(kernel)
-  add_compile_definitions(PLATFORM_ZEPHYR)
 else ()
   message(FATAL_ERROR "No valid platform specified")
 endif ()
 
+add_compile_definitions("PLATFORM_${PLATFORM}")
+
+target_link_libraries(reactor-uc PRIVATE nanopb)
+target_compile_options(reactor-uc PRIVATE -Wall -Wextra -Werror)
 add_compile_options (-fdiagnostics-color=always)
-target_include_directories(reactor-uc PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
+target_include_directories(reactor-uc PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include ${CMAKE_CURRENT_LIST_DIR}/external)
 
 configure_file(
   ${CMAKE_CURRENT_SOURCE_DIR}/include/reactor-uc/config.h.in 
   ${CMAKE_CURRENT_SOURCE_DIR}/include/reactor-uc/config.h
 )
 
-if(BUILD_TESTS)
-  target_compile_options(reactor-uc PRIVATE -Wall -Wextra -pedantic -Werror)
+if(BUILD_UNIT_TESTS)
   set(UNITY_DIR ${CMAKE_CURRENT_LIST_DIR}/external/Unity)
   include(CTest)
   add_library(Unity STATIC ${UNITY_DIR}/src/unity.c)
   target_include_directories(Unity PUBLIC ${UNITY_DIR}/src)
   set_target_properties( Unity PROPERTIES C_CLANG_TIDY "") # Disable clang-tidy for this external lib.
-  add_subdirectory(test)
+  add_subdirectory(test/unit)
 endif()
 
+if(BUILD_LF_TEST)
+# TODO: Setup automatic code-gen and compiling of the LF tests as well.
+# Ideally we include code-coverage from the LF tests into the overall coverage.
+# Currently it is done from a stupid Makefile
+endif()