How to Add Component Tests

How to Add Component Tests#

This guide shows how to configure unit testing for your Yanga components using Google Test.

Prerequisites#

A Yanga project with at least one component
A test platform configured with GTestCMakeGenerator

Steps#

1. Configure a test platform#

Add a platform with the GTestCMakeGenerator:

platforms:
  - name: gtest
    description: Build and run component tests
    generators:
      - step: GTestCMakeGenerator
        module: yanga.cmake.gtest
        config:
          mocking:
            enabled: true
            strict: false
            exclude_symbol_patterns:
              - "_*"

2. Add test sources to your component#

Define a testing section in your component configuration:

components:
  - name: my_component
    sources: ["src/my_component.c"]
    testing:
      sources:
        - "test/test_my_component.cpp"

3. Enable auto-mocking (optional)#

To automatically generate mocks for component dependencies:

components:
  - name: my_component
    sources: ["src/my_component.c"]
    testing:
      sources:
        - "test/test_my_component.cpp"
      mocking:
        enabled: true
        strict: true

4. Run the tests#

Build and run tests for your component:

yanga run --platform gtest --target my_component_test

Or run all tests:

yanga run --platform gtest