Add clang-format for code style enforcement

- Add .clang-format configuration matching existing code style
- Add CI workflow to check formatting on push/PR
- Add make format and make format-check targets
- Update DEVELOPMENT.md with clang-format requirements
- Add missing stdint.h include in binary.h
- Format all C++ source files

Author: fcostaoliveira

.clang-format

@@ -0,0 +1,63 @@
+# clang-format configuration for memtier_benchmark
+# Based on analysis of existing code style
+
+BasedOnStyle: LLVM
+
+# Indentation
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+ContinuationIndentWidth: 4
+AccessModifierOffset: -4
+
+# Brace style: opening brace on new line for functions, same line for control structures
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterClass: true
+  AfterControlStatement: Never
+  AfterEnum: true
+  AfterFunction: true
+  AfterNamespace: true
+  AfterStruct: true
+  AfterUnion: true
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+
+# Constructor initializer lists - colon on same line, break after colon
+BreakConstructorInitializers: AfterColon
+ConstructorInitializerIndentWidth: 8
+PackConstructorInitializers: NextLine
+
+# Line width
+ColumnLimit: 120
+
+# Pointer/reference alignment - space before * (Right alignment)
+PointerAlignment: Right
+ReferenceAlignment: Right
+
+# Spaces
+SpaceAfterCStyleCast: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpacesInAngles: Never
+SpacesInParentheses: false
+
+# IMPORTANT: Do not sort includes - breaks build due to header dependencies
+IncludeBlocks: Preserve
+SortIncludes: Never
+
+# Short statements
+AllowShortBlocksOnASingleLine: Empty
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: WithoutElse
+AllowShortLoopsOnASingleLine: false
+
+# Other
+AlignTrailingComments: true
+AlwaysBreakAfterReturnType: None
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 2
+SpaceBeforeCpp11BracedList: false
+Cpp11BracedListStyle: true
+

.github/workflows/code-style.yml

@@ -0,0 +1,39 @@
+name: Code Style
+
+on: [push, pull_request]
+
+jobs:
+  cpp-format-check:
+    name: C++ Format Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install clang-format
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y clang-format
+
+      - name: Check C++ formatting
+        run: |
+          # Find all C++ source files
+          CPP_FILES=$(find . -name "*.cpp" -o -name "*.h" | grep -v deps/ | grep -v autom4te.cache/ | sort)
+
+          # Check formatting (dry-run)
+          FAILED=0
+          for file in $CPP_FILES; do
+            if ! clang-format --dry-run --Werror "$file" 2>/dev/null; then
+              echo "::error file=$file::File needs formatting: $file"
+              FAILED=1
+            fi
+          done
+
+          if [ $FAILED -eq 1 ]; then
+            echo ""
+            echo "Some files need formatting. Run locally:"
+            echo "  make format"
+            exit 1
+          fi
+
+          echo "All C++ files are properly formatted!"
+

DEVELOPMENT.md

@@ -17,13 +17,15 @@ The following tools are required:
 * pkg-config
 * GNU make
 * GCC C++ compiler
+* clang-format (for code formatting)
 
 ### CentOS/Red Hat Linux 7 or newer
 
 Use the following to install prerequisites:
 ```
 $ sudo yum install autoconf automake make gcc-c++ \
-    zlib-devel libmemcached-devel libevent-devel openssl-devel
+    zlib-devel libmemcached-devel libevent-devel openssl-devel \
+    clang-tools-extra
 ```
 
 ### Ubuntu/Debian
@@ -32,15 +34,15 @@ Use the following to install prerequisites:
 
 ```
 $ sudo apt-get install build-essential autoconf automake \
-    libevent-dev pkg-config zlib1g-dev libssl-dev
+    libevent-dev pkg-config zlib1g-dev libssl-dev clang-format
 ```
 
 ### macOS
 
 To build natively on macOS, use Homebrew to install the required dependencies:
 
 ```
-$ brew install autoconf automake libtool libevent pkg-config [email protected]
+$ brew install autoconf automake libtool libevent pkg-config [email protected] clang-format
 ```
 
 When running `./configure`, if it fails to find libssl it may be necessary to
@@ -74,6 +76,22 @@ $ ./configure CXXFLAGS="-g -O0 -Wall"
 
 This disables optimizations (`-O0`), making it easier to step through code in a debugger, but should not be used for performance testing or production.
 
+### Code Style
+
+This project uses `clang-format` for consistent C++ code formatting. The style configuration is defined in `.clang-format`.
+
+To format all C++ files:
+```
+$ make format
+```
+
+To check formatting without modifying files:
+```
+$ make format-check
+```
+
+CI will automatically check that all C++ files are properly formatted on every push and pull request.
+
 ## Testing
 
 The project includes a basic set of integration tests.

JSON_handler.cpp

@@ -22,7 +22,7 @@
 
 #include <stdlib.h>
 #include <string.h>
-#include <cmath>  // For std::isnan
+#include <cmath> // For std::isnan
 #include "JSON_handler.h"
 
 
@@ -32,7 +32,7 @@
  * Opens the file named jsonfilename and sets the first nesting as NESTED_GENERAL
  * In case of failure to create the file, will state the error perror
  */
-json_handler::json_handler(const char * jsonfilename) : m_json_file(NULL)
+json_handler::json_handler(const char *jsonfilename) : m_json_file(NULL)
 {
     // Try to open a file and add the first level
     m_json_file = fopen(jsonfilename, "w");
@@ -41,7 +41,7 @@ json_handler::json_handler(const char * jsonfilename) : m_json_file(NULL)
     }
     // opening the JSON
     fprintf(stderr, "Json file %s created...\n", jsonfilename);
-    fprintf(m_json_file,"{");
+    fprintf(m_json_file, "{");
     m_nest_closer_types.push_back(NESTED_GENERAL);
     beutify();
 }
@@ -53,9 +53,10 @@ json_handler::json_handler(const char * jsonfilename) : m_json_file(NULL)
  */
 json_handler::~json_handler()
 {
-    if (m_json_file){
+    if (m_json_file) {
         // close nesting...
-        while (close_nesting());
+        while (close_nesting())
+            ;
         fclose(m_json_file);
         fprintf(stderr, "Json file closed.\n");
     }
@@ -66,7 +67,7 @@ json_handler::~json_handler()
  * based on the format defined
  * basically uses fprintf with the same parameters.
  */
-void json_handler::write_obj(const char * objectname, const char * format, ...)
+void json_handler::write_obj(const char *objectname, const char *format, ...)
 {
     fprintf(m_json_file, "\"%s\": ", objectname);
     va_list argptr;
@@ -76,7 +77,7 @@ void json_handler::write_obj(const char * objectname, const char * format, ...)
         // Use a temporary va_list to check the string argument without advancing the original
         va_list tmp_argptr;
         va_copy(tmp_argptr, argptr);
-        const char *str_arg = va_arg(tmp_argptr, const char*);
+        const char *str_arg = va_arg(tmp_argptr, const char *);
         va_end(tmp_argptr);
 
         if (str_arg == nullptr) {
@@ -99,8 +100,7 @@ void json_handler::write_obj(const char * objectname, const char * format, ...)
         } else {
             vfprintf(m_json_file, format, argptr);
         }
-    }
-    else {
+    } else {
         // For other format specifiers, proceed as usual
         vfprintf(m_json_file, format, argptr);
     }
@@ -114,10 +114,10 @@ void json_handler::write_obj(const char * objectname, const char * format, ...)
  * in case objectname == NULL it will not add the title and just start nesting
  * The type defines the kind of charecters that will be used
  */
-void json_handler::open_nesting(const char * objectname,eJSON_NESTED_TYPE type /*= NESTED_GENERAL*/)
+void json_handler::open_nesting(const char *objectname, eJSON_NESTED_TYPE type /*= NESTED_GENERAL*/)
 {
-    const char * nestStart = (type == NESTED_GENERAL) ? "{" : "[";
-    if (objectname != NULL){
+    const char *nestStart = (type == NESTED_GENERAL) ? "{" : "[";
+    if (objectname != NULL) {
         fprintf(m_json_file, "\"%s\":", objectname);
     }
     fprintf(m_json_file, "%s", nestStart);
@@ -134,17 +134,15 @@ void json_handler::open_nesting(const char * objectname,eJSON_NESTED_TYPE type /
 int json_handler::close_nesting()
 {
     int nest_level = m_nest_closer_types.size();
-    if (nest_level > 0)
-    {
+    if (nest_level > 0) {
         eJSON_NESTED_TYPE type = m_nest_closer_types.back();
         m_nest_closer_types.pop_back();
         // as we assume that the last value is always a ',' or '\n' we need to remove it first
         fseek(m_json_file, -1, SEEK_CUR);
-        const char * nestEnd = (type == NESTED_GENERAL) ? "}" : "]";
+        const char *nestEnd = (type == NESTED_GENERAL) ? "}" : "]";
         fprintf(m_json_file, "%s", nestEnd);
         beutify();
-        if (nest_level > 1)
-        {
+        if (nest_level > 1) {
             fprintf(m_json_file, ",");
         }
     }
@@ -156,14 +154,11 @@ int json_handler::close_nesting()
  */
 void json_handler::beutify(bool only_tabs)
 {
-    if (only_tabs == false)
-    {
+    if (only_tabs == false) {
         fprintf(m_json_file, "\n");
     }
     int nest_level = m_nest_closer_types.size();
-    for(;nest_level>0;nest_level--)
-    {
+    for (; nest_level > 0; nest_level--) {
         fprintf(m_json_file, "\t");
     }
-
 }

JSON_handler.h

@@ -25,28 +25,31 @@
 #include <list>
 
 // enum for holding type of nesting
-typedef enum{
+typedef enum
+{
     NESTED_GENERAL, // {}
     NESTED_ARRAY    // []
-}eJSON_NESTED_TYPE;
+} eJSON_NESTED_TYPE;
 
 /** represents an JSON handler, At this phase, only writes to JSON. */
-class json_handler {
+class json_handler
+{
 protected:
-    FILE * m_json_file;
+    FILE *m_json_file;
     // This list is used later for closing the nesting
-    std::list<eJSON_NESTED_TYPE>    m_nest_closer_types;
+    std::list<eJSON_NESTED_TYPE> m_nest_closer_types;
     void beutify(bool only_tabs = false);
+
 public:
-    json_handler(const char * jsonfilename);
+    json_handler(const char *jsonfilename);
     ~json_handler();
 
     // Write a single object to JSON
-    void write_obj(const char * objectname, const char * format, ...);
+    void write_obj(const char *objectname, const char *format, ...);
 
     // Starts nesting, the type is used for deciding which charecter to be used for opening and closing
     // the nesting ('{}','[]')
-    void open_nesting(const char * objectname,eJSON_NESTED_TYPE type = NESTED_GENERAL);
+    void open_nesting(const char *objectname, eJSON_NESTED_TYPE type = NESTED_GENERAL);
 
     // returns the nested level left after closing
     int close_nesting();

Makefile.am

@@ -70,3 +70,26 @@ dist_man1_MANS = memtier_benchmark.1
 .PHONY: rebuild-man
 rebuild-man:
 	help2man --name="NoSQL benchmark tool" --no-info --no-discard-stderr --output=memtier_benchmark.1 $(builddir)/memtier_benchmark
+
+# Code formatting
+.PHONY: format format-check
+format:
+	@echo "Formatting C++ source files..."
+	@find $(srcdir) -name "*.cpp" -o -name "*.h" | grep -v deps/ | grep -v autom4te.cache/ | xargs clang-format -i
+	@echo "Done."
+
+format-check:
+	@echo "Checking C++ source file formatting..."
+	@FAILED=0; \
+	for file in $$(find $(srcdir) -name "*.cpp" -o -name "*.h" | grep -v deps/ | grep -v autom4te.cache/); do \
+		if ! clang-format --dry-run --Werror "$$file" 2>/dev/null; then \
+			echo "Needs formatting: $$file"; \
+			FAILED=1; \
+		fi; \
+	done; \
+	if [ $$FAILED -eq 1 ]; then \
+		echo ""; \
+		echo "Some files need formatting. Run: make format"; \
+		exit 1; \
+	fi; \
+	echo "All C++ files are properly formatted!"