Return exit code 1 if warnings are given (#76)

* Return exit code 1 if warnings are given
* Use a valid SensorView trace file in the ci
* Add documentation
---------

Signed-off-by: ClemensLinnhoff <clemens.linnhoff@partner.bmw.de>

Author: ClemensLinnhoff

.github/workflows/ci.yml

@@ -78,5 +78,5 @@ jobs:
       run: |
         source .venv/bin/activate
         pip install .
-        osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi -r rules
-        osivalidator --data data/20240221T141700Z_sv_300_2112_10_one_moving_object.osi -r rules --parallel
+        osivalidator --data data/20240604T065310Z_sv_370_244_20_generic_valid_sensor_view.osi -r rules
+        osivalidator --data data/20240604T065310Z_sv_370_244_20_generic_valid_sensor_view.osi -r rules --parallel

data/20240604T065310Z_sv_370_244_20_generic_valid_sensor_view.osi

@@ -118,6 +118,9 @@ Ranges of timestamps    Message
 [START_TIMESTAMP, END_TIMESTAMP]    PATH_TO_RULE(VALUE) does not comply in PATH_TO_OSI_FIELD
 ----
 
+The osivalidator will end the execution with the exit code 1, if warnings or errors are generated.
+If the trace file is valid and no warning or errors occurred, the execution is ended with exit code 0.
+
 == Understanding Validation Output
 
 To better understand the validation output let us use the example

doc/usage.adoc

@@ -199,6 +199,8 @@ def main():
 
     trace.close()
     display_results()
+    if get_num_logs() > 0:
+        exit(1)
 
 
 def process_message(message, timestep, data_type):
@@ -224,5 +226,9 @@ def display_results():
     return LOGGER.synthetize_results(LOGS)
 
 
+def get_num_logs():
+    return len(LOGS)
+
+
 if __name__ == "__main__":
     main()