{
  "name": "BaseTest",
  "main": {
    "name": "BaseTest",
    "namespace": "sofa::testing",
    "module": "Sofa.framework.Testing",
    "include": "sofa/testing/BaseTest.h",
    "doc": "Base class for Sofa test fixtures.",
    "inherits": [],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "doSetUp",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "doTearDown",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "onSetUp",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "onTearDown",
        "return_type": "void",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      },
      {
        "name": "loadPlugins",
        "return_type": "void",
        "params": [
          {
            "name": "pluginNames",
            "type": "const int &"
          }
        ],
        "is_virtual": false,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `BaseTest` class in the SOFA framework is a base class for Sofa test fixtures, designed to help with setting up and tearing down tests within the testing environment. It inherits from Google Test's `::testing::Test`. The primary purpose of `BaseTest` is to provide a standardized initialization process for tests by managing plugins, seeding random number generators, and handling message logging.\n\n### Role in SOFA Ecosystem\n- **Initialization**: Ensures that the Sofa framework is properly initialized during test setup.\n- **Random Number Generation**: Seeds the random number generator using the seed value passed from Google Test's `UnitTest` instance. This ensures consistent behavior across test runs.\n- **Plugin Management**: Loads plugins specified in a list of plugin names, allowing for testing within the context of various Sofa modules and components.\n- **Logging**: Manages message logging to integrate with Google Test’s reporting mechanism by adding custom handlers that convert Sofa messages into Google Test failures or warnings.\n\n### Interactions with Other SOFA Components\n- `BaseTest` interacts with the plugin management system through the `PluginManager` class to load and initialize plugins required for testing specific components.\n- It handles message dispatching using `MessageDispatcher` from the `sofa.helper.logging` module, ensuring that Sofa’s logging messages are correctly integrated into Google Test's output.\n\n### Practical Usage Guidance\n- **Methods**:\n  - `doSetUp()`: Called during test setup and can be overridden in derived classes to add custom setup logic.\n  - `doTearDown()`: Called during teardown to perform cleanup operations. \n  - `loadPlugins(const std::initializer_list<std::string>& pluginNames)`: Loads specified plugins, which is useful for setting up the testing environment with specific Sofa modules and components.\n\n- **Data Fields**:\n  - No explicit data fields are defined in the class itself; however, it initializes message handlers (`m_fatal` and `m_error`) to manage logging.\n\nThis base test fixture provides a robust foundation for creating unit tests within the SOFA framework, ensuring consistent setup and teardown processes while integrating well with Google Test's testing infrastructure."
  },
  "maths": {
    "maths": "The `BaseTest` class in the SOFA framework is primarily designed for test initialization, plugin management, random number generation seeding, and logging integration within the testing environment. It does not directly involve any mathematical or physical modeling components intrinsic to the simulation capabilities of the SOFA framework. Here’s a detailed breakdown of its functionalities:\n\n### Initialization Process\n- **Sofa Framework Initialization**: The `BaseTest` ensures that the Sofa framework is properly initialized during test setup, which involves setting up necessary environment configurations and dependencies.\n\n### Random Number Generation\n- **Seeding**: The random number generator is seeded using a value from Google Test's `UnitTest::GetInstance()->random_seed()`, ensuring consistent behavior across multiple test runs. This ensures reproducibility of tests that rely on pseudo-random numbers:\n  \\[ seed = ::testing::UnitTest::GetInstance()->random_seed() \\\n\n### Plugin Management\n- **Loading Plugins**: The method `loadPlugins(const std::initializer_list<std::string>& pluginNames)` allows for loading specified plugins, which are essential for testing specific Sofa modules and components. This ensures that the test environment is set up with all necessary functionalities required for comprehensive testing:\n  \\[ m_loadedPlugins.emplace_back(pluginNames.begin(), pluginNames.end()) \\\n\n### Logging Integration\n- **Message Handlers**: `BaseTest` integrates message logging from the Sofa framework into Google Test's reporting mechanism by adding custom handlers. This ensures that Sofa messages are converted into Google Test failures or warnings, facilitating easier debugging and test result interpretation:\n  \\[ MessageDispatcher::addHandler( MainGtestMessageHandler::getInstance() ) \\\n\n### Standardized Setup and Teardown\n- **Setup and Teardown Methods**: The methods `doSetUp()` and `doTearDown()` provide hooks for custom setup and cleanup operations in derived test classes:\n  \\[ virtual void doSetUp(); \\\n  \\[ virtual void doTearDown(); \\\n\n### Practical Usage Guidance\n- **Initialization Process**:\n  - The `BaseTest` class ensures proper initialization of the Sofa framework by setting up message handlers and random number generation seeding, which are crucial for consistent test results.\n- **Plugin Management**: Loading necessary plugins through `loadPlugins()` helps in testing specific components and functionalities within the SOFA framework.\n- **Logging Integration**: Ensuring that Sofa messages are correctly integrated into Google Test’s output via custom message handlers facilitates easier interpretation of test results.\n\n### Interactions with Other Components\n- The `BaseTest` class interacts with:\n  - `PluginManager`: For loading and managing plugins required for testing specific components.\n  - `MessageDispatcher`: For handling Sofa messages within the Google Test framework.\n\nIn summary, while `BaseTest` does not directly involve mathematical or physical modeling, it provides a robust foundation for creating unit tests within the SOFA framework by ensuring consistent initialization processes and integrating with Google Test's testing infrastructure."
  },
  "summary": {
    "abstract": "`BaseTest` is a base class for Sofa test fixtures that ensures proper initialization of the framework during tests by managing plugins, seeding random number generators, and integrating logging with Google Test's infrastructure.",
    "sheet": "# BaseTest\n\n**Overview**\n\nThe `BaseTest` class serves as a foundation for creating unit tests within the SOFA framework. It provides standardized setup and teardown processes to ensure consistent test environments by managing plugins, seeding random number generators, and integrating logging with Google Test's infrastructure.\n\n**Parameters and Data**\n\nNo explicit data fields are defined in `BaseTest`. However, it initializes message handlers (`m_fatal` and `m_error`) for logging integration.\n\n**Dependencies and Connections**\n\n- **PluginManager**: For loading and managing plugins required for testing specific components.\n- **MessageDispatcher**: For handling Sofa messages within the Google Test framework.\n\n**Practical Notes**\n\n- The methods `doSetUp()` and `doTearDown()` provide hooks for custom setup and cleanup operations in derived test classes.\n- Ensure that necessary plugins are loaded using `loadPlugins(const std::initializer_list<std::string>& pluginNames)` to set up the testing environment with specific Sofa modules and components."
  }
}