feat: support cmock_config.yml in cmock_generate_mock

README.md

@@ -166,3 +166,27 @@ void test_something_logs(void) {
 The `_Expect` call records the expected argument. CMock verifies the
 actual argument matches at call time using string comparison, and
 `Mocklogger_Verify` confirms the expected number of calls were made.
+
+## Configuring CMock
+
+Pass a config file as the third argument to `cmock_generate_mock`:
+
+```cmake
+cmock_generate_mock(test_mymodule "${CMAKE_SOURCE_DIR}/ctdd/logger.h"
+                    "cmock_config.yml")
+```
+
+The file is loaded by the CMock Ruby generator with `-o`. A typical
+`tests/cmock_config.yml` enables plugins:
+
+```yaml
+:cmock:
+  :plugins:
+    - :ignore
+    - :ignore_arg
+    - :return_thru_ptr
+```
+
+Use `:ignore` to skip certain mocks, `:ignore_arg` to stop checking
+particular parameters, or `:return_thru_ptr` to have CMock write
+through pointer return values automatically.

tests/CMakeLists.txt

@@ -5,9 +5,11 @@ set(MOCK_GEN_DIR "${CMAKE_CURRENT_BINARY_DIR}/mocks")
 file(MAKE_DIRECTORY "${MOCK_GEN_DIR}")
 
 # Generate a CMock mock from a header and attach it to a target.
-# Usage: cmock_generate_mock(<target> <absolute-path-to-header>)
+# Usage: cmock_generate_mock(<target> <absolute-path-to-header> [config.yml])
 # CMock names generated files Mock<Name>.h/.c (capital M, no separator)
+# If a config file is given it is passed to the Ruby generator with `-o`.
 function(cmock_generate_mock target header)
+    cmake_parse_arguments(ARG "" "" "CONFIG" ${ARGN})
     if (NOT RUBY_EXECUTABLE)
         message(FATAL_ERROR "Ruby is required for CMock generation")
     endif()
@@ -15,12 +17,17 @@ function(cmock_generate_mock target header)
     get_filename_component(header_dir "${header}" DIRECTORY)
     set(mock_src "${MOCK_GEN_DIR}/Mock${name}.c")
     set(mock_hdr "${MOCK_GEN_DIR}/Mock${name}.h")
+    if (ARG_CONFIG)
+        set(CMOCK_CONFIG_FLAG "-o${ARG_CONFIG}")
+        set(CMOCK_CONFIG_DEPENDS "${ARG_CONFIG}")
+    endif()
     add_custom_command(
         OUTPUT  "${mock_src}" "${mock_hdr}"
         COMMAND "${RUBY_EXECUTABLE}" "${CMOCK_SCRIPT}"
+                ${CMOCK_CONFIG_FLAG}
                 "--mock_path=${MOCK_GEN_DIR}"
                 "${header}"
-        DEPENDS "${header}"
+        DEPENDS "${header}" ${CMOCK_CONFIG_DEPENDS}
         COMMENT "CMock: generating Mock${name}"
         VERBATIM
     )