documentation on the node

Author: Edwardius

deep_test/DEVELOPING.md

@@ -0,0 +1,38 @@
+# Developing deep_test
+
+## Building
+
+```bash
+colcon build --packages-select deep_test
+```
+
+## Running Tests
+
+```bash
+colcon test --packages-select deep_test
+colcon test-result --verbose
+```
+
+## Adding New Features
+
+### Test Fixtures
+This includes code that follows the definition of a fixture as per catch2.
+
+1. Add header to `include/test_fixtures/`
+2. Add implementation to `src/` if needed
+3. Include in `include/deep_test/deep_test.hpp`
+
+### Test Nodes
+This includes code that acts as helper ros nodes for testing. They should be inherently event-driven nodes (do not introduce arbitrary sleeps).
+
+1. Add header to `include/test_nodes/`
+2. Include in main header
+3. Keep nodes header-only when possible
+
+## CMake Function
+
+The `add_deep_test()` function automatically:
+- Links Catch2::Catch2WithMain
+- Links ROS dependencies (rclcpp, rclcpp_lifecycle)
+- Configures ament test registration
+- Sets up JUnit XML output

deep_test/README.md

@@ -0,0 +1,41 @@
+# deep_test
+
+A ROS 2 testing framework built on Catch2 that provides test fixtures and utilities for testing ROS nodes, services, and communication patterns.
+
+## Features
+
+- **TestExecutorFixture**: Manages ROS executor lifecycle for tests
+- **Test Nodes**: Pre-built nodes for testing publishers, subscribers, services, and clients
+- **CMake Integration**: Simple `add_deep_test()` function for creating tests
+- **Catch2 Integration**: Built on Catch2 for modern C++ testing
+
+## Quick Start
+
+```cpp
+#include <catch2/catch.hpp>
+#include <deep_test/deep_test.hpp>
+
+TEST_CASE_METHOD(deep_ros::test::TestExecutorFixture, "My ROS Test", "[ros]") {
+  auto node = std::make_shared<rclcpp::Node>("test_node");
+  add_node(node);
+  start_spinning();
+  
+  // Your test code here as sections
+  SECTION("My test") {
+    REQUIRE(node->get_name() == "test_node");
+  }
+}
+```
+
+## CMake Usage
+
+```cmake
+find_package(deep_test REQUIRED)
+
+add_deep_test(my_test
+  test/my_test.cpp
+  LIBRARIES 
+    my_package::my_library
+    std_msgs::std_msgs
+)
+```