Restructure codebase and add unit tests

[marcransome]

Overview

To facilitate unit testing and integrate the cmocka unit testing framework a significant restructure of the existing project code is required. Given that the cmocka framework executes all tests for a given test target within the same process, getopt's reliance on global state is problematic, and it would be better replaced with the libpopt library which provides additional features such as option aliasing. Unit tests for FlogApi and FlogConfig opaque objects and related functions should be added¹ after integration of the unit test framework.

Improved error handling should be introduced in place of immediate exit() calls, and use of errno should be replaced with a defined error type.

Intended outcome

To increase unit test coverage, improve error handling, and automate the build and release process.

Tasks

• Add CTest and cmocka to build configuration and restructure codebase to support unit testing #72
• Improve error handling logic #110
• Automate build process with release workflow #136
• Add unit tests for FlogConfig opaque type and related functions #73
• Add unit tests for FlogCli opaque type and related functions #74
• Add unit tests for common helper functions (common.h) #247
• Add unit tests for helper functions (utils.h) #75
• Add unit tests to analysis workflow #76

Footnotes

1. Mocking objects with the cmocka unit test framework may require extra effort given the lack of support for the --wrap option in the macOS linker ld64. ↩