Fix test folder readme; add behavior folder readme

Signed-off-by: ClemensLinnhoff <Clemens.Linnhoff@partner.bmw.de>
openMSL · Mar 25, 2024 · ac862e1 · ac862e1
1 parent 17f020c
commit ac862e1
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/test/README.md b/test/README.md
@@ -1,5 +1,6 @@
 # *test* Folder
 
-The test folder contains integration and unit tests as defined in the OpenMSL [OSMP Test Architecture](https://github.com/openMSL/.github/blob/main/doc/osmp_test_architecture.md).
+The test folder contains behavior, integration and unit tests as defined in the OpenMSL [OSMP Test Architecture](https://github.com/openMSL/.github/blob/main/doc/osmp_test_architecture.md).
 
 While unit tests test individual functions of the model, integration tests test the model in combination with other connected FMUs.
+Behavior tests go one step further and evaluate the model output with a python script.
diff --git a/test/behavior/README.md b/test/behavior/README.md
@@ -0,0 +1,11 @@
+# *behavior* Folder
+
+As described in the overall [OSMP Test Architecture](https://openmsl.github.io/doc/OpenMSL/test-architecture/index.html), behavior tests are similar to integration tests, but additionally check the output of the model under test.
+Every test folder contains a System Structure Definition file (SSD) describing the test case, a README according to the OSMP [Test Architecture Readme Template](https://github.com/openMSL/.github/blob/main/doc/integration_test_readme_template.md) and all auxiliary data needed for the test.
+All tests in this folder are automatically simulated in the GitHub Action pipeline for every commit.
+This folder contains some examples for different test cases, as listed below.
+
+| File                   | Description                                                                                                             |
+|------------------------|-------------------------------------------------------------------------------------------------------------------------|
+| 001_detected_object    | This behavior test checks, if the sensor model detects an object inside the sensor's specified field of view.           |
+| 002_object_outside_fov | This behavior test checks, if the sensor model does not detects an object outside the sensor's specified field of view. |