Build unit tests using Unity instead of CMock

.github/workflows/ci.yml

@@ -11,14 +11,13 @@ jobs:
     steps:
       - name: Clone This Repo
         uses: actions/checkout@v2
-      - name: Checkout CMock submodule
-        run: git submodule update --checkout --init --recursive test/unit-test/CMock
       - name: Build
         run: |
           sudo apt-get install -y lcov
           cmake -S test -B build/ \
           -G "Unix Makefiles" \
           -DCMAKE_BUILD_TYPE=Debug \
+          -DBUILD_CLONE_SUBMODULES=ON \
           -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror -DNDEBUG'
           make -C build/ all
       - name: Test

.gitmodules

@@ -1,6 +1,6 @@
-[submodule "test/unit-test/CMock"]
-	path = test/unit-test/CMock
-	url = https://github.com/ThrowTheSwitch/CMock
+[submodule "test/unit-test/Unity"]
+	path = test/unit-test/Unity
+	url = https://github.com/ThrowTheSwitch/Unity
 	update = none
 [submodule "test/cbmc/aws-templates-for-cbmc-proofs"]
 	path = test/cbmc/aws-templates-for-cbmc-proofs

README.md

@@ -73,29 +73,29 @@ doxygen docs/doxygen/config.doxyfile
 
 ## Building unit tests
 
-### Checkout CMock Submodule
+### Checkout Unity Submodule
 By default, the submodules in this repository are configured with `update=none` in [.gitmodules](.gitmodules) to avoid increasing clone time and disk space usage of other repositories (like [amazon-freertos](https://github.com/aws/amazon-freertos) that submodule this repository.
 
-To build unit tests, the submodule dependency of CMock is required. Use the following command to clone the submodule:
+To build unit tests, the submodule dependency of Unity is required. Use the following command to clone the submodule:
 ```
-git submodule update --checkout --init --recursive --test/unit-test/CMock
+git submodule update --checkout --init --recursive --test/unit-test/Unity
 ```
 
 ### Platform Prerequisites
 
 - 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).
+    - Ruby 2.0.0 or later is additionally required for the Unity test framework (that we use).
 - For running the coverage target, gcov is additionally required.
 
 ### Steps to build Unit Tests
 
-1. Go to the root directory of this repository. (Make sure that the **CMock** submodule is cloned as described [above](#checkout-cmock-submodule).)
+1. Go to the root directory of this repository. (Make sure that the **Unity** submodule is cloned as described [above](#checkout-unity-submodule).)
 
 1. Create build directory: `mkdir build && cd build`
 
-1. Run *cmake* while inside build directory: `cmake -S ../test `
+1. Run *cmake* while inside build directory: `cmake -S ../test`
 
 1. Run this command to build the library and unit tests: `make all`
 

test/CMakeLists.txt

@@ -19,12 +19,12 @@ endif()
 get_filename_component(__MODULE_ROOT_DIR "${CMAKE_CURRENT_LIST_DIR}/.." ABSOLUTE)
 set( MODULE_ROOT_DIR ${__MODULE_ROOT_DIR} CACHE INTERNAL "coreJSON source root." )
 set( UNIT_TEST_DIR ${MODULE_ROOT_DIR}/test/unit-test CACHE INTERNAL "coreJSON unit test directory." )
-set( CMOCK_DIR ${UNIT_TEST_DIR}/CMock CACHE INTERNAL "CMock library source directory." )
+set( UNITY_DIR ${UNIT_TEST_DIR}/Unity CACHE INTERNAL "Unity library source directory." )
 
 # Configure options to always show in CMake GUI.
 option( BUILD_CLONE_SUBMODULES
         "Set this to ON to automatically clone any required Git submodules. When OFF, submodules must be manually cloned."
-        ON )
+        OFF )
 
 # Set output directories.
 set( CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin )
@@ -43,17 +43,17 @@ target_include_directories( coverity_analysis PUBLIC ${JSON_INCLUDE_PUBLIC_DIRS}
 
 #  ====================================  Test Configuration ========================================
 
-# Include CMock build configuration.
-include( unit-test/cmock_build.cmake )
+# Include Unity build configuration.
+include( unit-test/unity_build.cmake )
 
-# Check if the CMock source directory exists, and if not present, clone the submodule
+# Check if the Unity source directory exists, and if not present, clone the submodule
 # if BUILD_CLONE_SUBMODULES configuration is enabled.
-if( NOT EXISTS ${CMOCK_DIR}/src )
-    # Attempt to clone CMock.
+if( NOT EXISTS ${UNITY_DIR}/src )
+    # Attempt to clone Unity.
     if( ${BUILD_CLONE_SUBMODULES} )
-        clone_cmock()
+        clone_unity()
     else()
-        message( FATAL_ERROR "The required submodule CMock does not exist. Either clone it manually, or set BUILD_CLONE_SUBMODULES to 1 to automatically clone it during build." )
+        message( FATAL_ERROR "The required submodule Unity does not exist. Either clone it manually, or set BUILD_CLONE_SUBMODULES to 1 to automatically clone it during build." )
     endif()
 endif()
 
@@ -63,11 +63,11 @@ endif()
 # defining test targets with add_test()
 enable_testing()
 
-# Add build targets for CMock and Unit, required for unit testing.
-add_cmock_targets()
+# Add build targets for Unity and Unit, required for unit testing.
+add_unity_targets()
 
-# Add function to enable CMock based tests and coverage.
-include( ${MODULE_ROOT_DIR}/tools/cmock/create_test.cmake )
+# Add function to enable Unity based tests and coverage.
+include( ${MODULE_ROOT_DIR}/tools/unity/create_test.cmake )
 
 # Include build configuration for unit tests.
 add_subdirectory( unit-test )
@@ -76,8 +76,8 @@ add_subdirectory( unit-test )
 
 # Add a target for running coverage on tests.
 add_custom_target( coverage
-    COMMAND ${CMAKE_COMMAND} -DCMOCK_DIR=${CMOCK_DIR}
-    -P ${MODULE_ROOT_DIR}/tools/cmock/coverage.cmake
-    DEPENDS cmock unity core_json_utest
+    COMMAND ${CMAKE_COMMAND} -DUNITY_DIR=${UNITY_DIR}
+    -P ${MODULE_ROOT_DIR}/tools/unity/coverage.cmake
+    DEPENDS unity core_json_utest
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}
 )

test/unit-test/CMakeLists.txt

@@ -29,7 +29,6 @@ set(real_name "${project_name}_real")
 create_real_library(${real_name}
                     "${real_source_files}"
                     "${real_include_directories}"
-                    "${mock_name}"
         )
 
 list(APPEND utest_link_list

test/unit-test/unity_build.cmake

@@ -0,0 +1,38 @@
+# Macro utility to clone the Unity submodule.
+macro( clone_unity )
+        find_package( Git REQUIRED )
+        message( "Cloning submodule Unity." )
+        execute_process( COMMAND rm -rf ${UNITY_DIR}
+                         COMMAND ${GIT_EXECUTABLE} submodule update --checkout --init --recursive ${UNITY_DIR}
+                        WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
+                        RESULT_VARIABLE UNITY_CLONE_RESULT )
+
+        if( NOT ${UNITY_CLONE_RESULT} STREQUAL "0" )
+                message( FATAL_ERROR "Failed to clone Unity submodule." )
+        endif()
+endmacro()
+
+# Macro utility to add library targets for Unity and Unity to build configuration.
+macro( add_unity_targets )
+        # Build Configuration for Unity and Unity libraries.
+        list( APPEND UNITY_INCLUDE_DIRS
+                "${UNITY_DIR}/src/"
+                "${UNITY_DIR}/extras/fixture/src"
+                "${UNITY_DIR}/extras/memory/src"
+        )
+
+        add_library( unity STATIC
+                "${UNITY_DIR}/src/unity.c"
+                "${UNITY_DIR}/extras/fixture/src/unity_fixture.c"
+                "${UNITY_DIR}/extras/memory/src/unity_memory.c"
+        )
+
+        set_target_properties( unity PROPERTIES
+                ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib
+                POSITION_INDEPENDENT_CODE ON
+        )
+
+        target_include_directories( unity PUBLIC
+                ${UNITY_INCLUDE_DIRS}
+        )
+endmacro()