close testing gaps

Author: scholarsmate

.github/codecov.yml

@@ -17,6 +17,25 @@ coverage:
   precision: 2
   round: down
   range: "85...100"
+  status:
+    project:
+      default:
+        target: auto
+        threshold: 1%
+    patch:
+      default:
+        target: 80%
+
+flags:
+  native:
+    paths:
+      - core/src/lib/
+      - core/src/include/
+    carryforward: true
+  client:
+    paths:
+      - packages/client/src/
+    carryforward: true
 
 parsers:
   gcov:
@@ -33,4 +52,9 @@ comment:
 
 ignore:
   - core/src/examples
-  - core/src/tests/integration/generate_file.cpp
+  - core/src/tests
+  - packages/client/tests
+  - server/
+  - "**/node_modules"
+  - "**/*.test.*"
+  - "**/*.spec.*"

.github/workflows/tests.yml

@@ -106,3 +106,126 @@ jobs:
   #         os-name: ubuntu-22.04-arm64
   #         docker-image: ghcr.io/ctc-oss/omega-edit-build-arm64:ubuntu-22.04
   #         library-filename: libomega_edit.so
+
+  coverage:
+    name: Code Coverage 📊
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v6
+
+      - name: Setup cmake 🔧
+        uses: lukka/get-cmake@latest
+
+      - name: Install lcov 📦
+        run: sudo apt-get update && sudo apt-get install -y lcov
+
+      # ── C/C++ coverage ──────────────────────────────────────────────────
+      - name: Build with coverage instrumentation 🔨
+        run: |
+          cmake --preset ci-coverage
+          cmake --build --preset ci-coverage --config Debug
+
+      - name: Run C/C++ tests 🧪
+        run: ctest -C Debug --test-dir build-coverage/core --output-on-failure
+
+      - name: Collect C/C++ coverage with lcov 📈
+        run: |
+          lcov --capture --directory build-coverage --output-file coverage-native.info \
+            --rc branch_coverage=1 --ignore-errors mismatch
+          lcov --remove coverage-native.info \
+            '*/src/tests/*' '*/src/examples/*' '*/_deps/*' '/usr/*' '*/catch2/*' \
+            --output-file coverage-native.info --rc branch_coverage=1 --ignore-errors unused
+          lcov --list coverage-native.info
+
+      - name: Upload C/C++ coverage to Codecov 🔺
+        uses: codecov/codecov-action@v5
+        with:
+          files: coverage-native.info
+          flags: native
+          name: omega-edit-native
+          fail_ci_if_error: false
+
+      # ── TypeScript client coverage ──────────────────────────────────────
+      - name: Setup Node.js 🟢
+        uses: actions/setup-node@v6
+        with:
+          node-version: 20
+          cache: yarn
+          cache-dependency-path: yarn.lock
+
+      - name: Setup Python 🐍
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install Conan 📦
+        run: pip install conan
+
+      - name: Install uuid-dev 🔧
+        run: sudo apt-get install -y uuid-dev
+
+      - name: Detect Conan profile 🔧
+        run: conan profile detect --force
+
+      - name: Cache Conan packages 📦
+        uses: actions/cache@v4
+        with:
+          path: ~/.conan2
+          key: conan-coverage-${{ hashFiles('server/cpp/conanfile.py') }}
+          restore-keys: |
+            conan-coverage-
+
+      - name: Build C++ gRPC server for client tests 🔨
+        run: |
+          cmake -G Ninja -S . -B _build_core \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DBUILD_SHARED_LIBS=OFF \
+            -DBUILD_DOCS=OFF \
+            -DBUILD_EXAMPLES=OFF \
+            -DBUILD_TESTS=OFF
+          cmake --build _build_core --config Release
+          cmake --install _build_core/packages/core --prefix "$(pwd)/_install_core" --config Release
+          export OE_LIB_DIR="$(pwd)/_install_core/lib"
+          export OE_PREFIX="$(pwd)/_install_core"
+          cd server/cpp
+          conan install . --output-folder=build \
+            --build=missing \
+            -s build_type=Release \
+            -s compiler.cppstd=17 \
+            -c tools.cmake.cmaketoolchain:generator=Ninja
+          cmake --preset conan-release \
+            -DOE_LIB_DIR="$OE_LIB_DIR" \
+            -DCMAKE_PREFIX_PATH="$OE_PREFIX" \
+            || cmake -G Ninja -S . -B build \
+              -DCMAKE_BUILD_TYPE=Release \
+              -DCMAKE_TOOLCHAIN_FILE="build/conan_toolchain.cmake" \
+              -DOE_LIB_DIR="$OE_LIB_DIR" \
+              -DCMAKE_PREFIX_PATH="$OE_PREFIX"
+          cmake --build build --config Release
+          cd ../..
+          echo "CPP_SERVER_BINARY=$(pwd)/server/cpp/build/omega-edit-grpc-server" >> $GITHUB_ENV
+
+      - name: Yarn Install 🏗️
+        run: yarn
+
+      - name: Yarn Package - Server 📦
+        run: yarn workspace @omega-edit/server package
+        env:
+          CPP_SERVER_BINARY: ${{ env.CPP_SERVER_BINARY }}
+
+      - name: Yarn Prepare - Client
+        run: yarn workspace @omega-edit/client prepare
+
+      - name: Run client tests with coverage 🧪
+        run: yarn workspace @omega-edit/client test:coverage
+        env:
+          CPP_SERVER_BINARY: ''
+
+      - name: Upload TypeScript coverage to Codecov 🔺
+        uses: codecov/codecov-action@v5
+        with:
+          files: packages/client/coverage/lcov.info
+          flags: client
+          name: omega-edit-client
+          fail_ci_if_error: false

CMakePresets.json

@@ -201,6 +201,21 @@
         "BUILD_SHARED_LIBS": "ON",
         "BUILD_TESTS": "OFF"
       }
+    },
+    {
+      "name": "ci-coverage",
+      "displayName": "CI Coverage",
+      "description": "CI build with code coverage instrumentation (Debug, static, GCC/Clang)",
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/build-coverage",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "BUILD_DOCS": "OFF",
+        "BUILD_EXAMPLES": "OFF",
+        "BUILD_SHARED_LIBS": "OFF",
+        "BUILD_TESTS": "ON",
+        "BUILD_COVERAGE": "ON"
+      }
     }
   ],
   "buildPresets": [
@@ -273,6 +288,11 @@
       "name": "ci-docs",
       "displayName": "CI Documentation",
       "configurePreset": "ci-docs"
+    },
+    {
+      "name": "ci-coverage",
+      "displayName": "CI Coverage",
+      "configurePreset": "ci-coverage"
     }
   ]
 }

Makefile

@@ -46,8 +46,15 @@ update-version:
 	@echo "  git push origin v$(version)"
 	@echo "------------------------------------------------------------------------"
 
+coverage:
+	cmake -G $(GENERATOR) -S . -B _build-coverage -DBUILD_SHARED_LIBS=NO -DBUILD_DOCS=NO -DBUILD_EXAMPLES=NO -DBUILD_COVERAGE=YES -DCMAKE_BUILD_TYPE=Debug
+	cmake --build _build-coverage --config Debug
+	ctest -C Debug --test-dir _build-coverage/core --output-on-failure
+	@echo "Coverage data generated in _build-coverage/"
+	@echo "Run 'lcov --capture --directory _build-coverage --output-file coverage.info' to generate a report"
+
 clean:
-	rm -rf _build _install lib/$(LIBNAME)
+	rm -rf _build _build-coverage _install lib/$(LIBNAME) coverage.info
 
 all: lib/$(LIBNAME)
 	@echo $<

core/CMakeLists.txt

@@ -13,13 +13,25 @@ option(BUILD_SHARED_LIBS "Build shared libraries instead of static ones" ON)
 option(BUILD_TESTS "build tests" ON)
 option(BUILD_DOCS "build documentation" ON)
 option(BUILD_EXAMPLES "build examples" ON)
+option(BUILD_COVERAGE "build with code coverage instrumentation (GCC/Clang)" OFF)
 
 ## Let omega_edit_SHARED_LIBS override BUILD_SHARED_LIBS
 if (DEFINED omega_edit_SHARED_LIBS)
     set(BUILD_SHARED_LIBS "${omega_edit_SHARED_LIBS}")
 endif ()
 
-message(STATUS "Building ${PROJECT_NAME} ${PROJECT_VERSION} (shared: ${BUILD_SHARED_LIBS}, tests: ${BUILD_TESTS}, docs: ${BUILD_DOCS}, examples: ${BUILD_EXAMPLES})")
+message(STATUS "Building ${PROJECT_NAME} ${PROJECT_VERSION} (shared: ${BUILD_SHARED_LIBS}, tests: ${BUILD_TESTS}, docs: ${BUILD_DOCS}, examples: ${BUILD_EXAMPLES}, coverage: ${BUILD_COVERAGE})")
+
+# Code coverage instrumentation (GCC/Clang only)
+if (BUILD_COVERAGE)
+    if (CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
+        message(STATUS "Enabling code coverage instrumentation")
+        add_compile_options(--coverage -fprofile-arcs -ftest-coverage)
+        add_link_options(--coverage)
+    else ()
+        message(WARNING "BUILD_COVERAGE is only supported with GCC or Clang, ignoring")
+    endif ()
+endif ()
 
 # Common configurations
 set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)

core/src/lib/check.cpp

@@ -13,6 +13,7 @@
  **********************************************************************************************************************/
 
 #include "../include/omega_edit/check.h"
+#include "../include/omega_edit/session.h"
 #include "impl_/change_def.hpp"
 #include "impl_/internal_fun.hpp"
 #include "impl_/macros.h"
@@ -21,30 +22,62 @@
 
 int omega_check_model(const omega_session_t *session_ptr) {
     if (!session_ptr) { return -1; }
-    int64_t expected_offset = 0;
-    if (!session_ptr->models_.empty()) {
-        for (auto &&model_ptr: session_ptr->models_) {
-            assert(model_ptr);
-            for (const auto &segment: model_ptr->model_segments) {
-                assert(segment->change_ptr);
-                if (expected_offset != segment->computed_offset ||
-                    (segment->change_offset + segment->computed_length) > segment->change_ptr->length) {
-                    print_model_segments_(session_ptr->models_.back().get(), CLOG);
-                    return -1;
-                }
-                expected_offset += segment->computed_length;
+    if (session_ptr->models_.empty()) { return -1; }// session must have at least one model
+
+    for (size_t model_index = 0; model_index < session_ptr->models_.size(); ++model_index) {
+        const auto &model_ptr = session_ptr->models_[model_index];
+        if (!model_ptr) { return -1; }
+
+        int64_t expected_offset = 0;
+        for (const auto &segment: model_ptr->model_segments) {
+            // Each segment must reference a valid change
+            if (!segment || !segment->change_ptr) { return -1; }
+
+            // Segment offsets must be non-negative
+            if (segment->computed_offset < 0 || segment->computed_length < 0 || segment->change_offset < 0) {
+                print_model_segments_(model_ptr.get(), CLOG);
+                return -1;
             }
-        }
-        if (!session_ptr->models_.front()->model_segments.empty()) {
-            const auto first_serial =
-                    session_ptr->models_.front()->model_segments.front()->change_ptr->serial;
-            // First segment should be either the initial READ (serial 0) or the first user change (serial 1)
-            if ((first_serial != 0 && first_serial != 1) ||
-                0 != (session_ptr->models_.front()->model_segments.front()->change_ptr->kind &
-                      OMEGA_CHANGE_TRANSACTION_BIT)) {
+
+            // Segments must have positive length (zero-length segments are not valid in the model)
+            if (segment->computed_length == 0) {
+                print_model_segments_(model_ptr.get(), CLOG);
                 return -1;
             }
+
+            // Segments must be contiguous (no gaps or overlaps)
+            if (expected_offset != segment->computed_offset) {
+                print_model_segments_(model_ptr.get(), CLOG);
+                return -1;
+            }
+
+            // Segment must not extend beyond its parent change data
+            if (segment->change_offset + segment->computed_length > segment->change_ptr->length) {
+                print_model_segments_(model_ptr.get(), CLOG);
+                return -1;
+            }
+
+            // change_offset must not exceed the change length
+            if (segment->change_offset >= segment->change_ptr->length) {
+                print_model_segments_(model_ptr.get(), CLOG);
+                return -1;
+            }
+
+            expected_offset += segment->computed_length;
         }
+
+        // Checkpoint models (index > 0) must have a backing file
+        if (model_index > 0 && !model_ptr->file_ptr) { return -1; }
     }
+
+    // Cross-check: the back model's total segment length must match the session's computed file size
+    const auto computed_file_size = omega_session_get_computed_file_size(session_ptr);
+    const auto &back_model = session_ptr->models_.back();
+    const int64_t model_total_length = back_model->model_segments.empty()
+                                               ? 0
+                                               : back_model->model_segments.back()->computed_offset +
+                                                         back_model->model_segments.back()->computed_length;
+    if (model_total_length != computed_file_size) { return -1; }
+
     return 0;
 }