Add error-handling functionality to example modules and build up a de…

…monstration

Signed-off-by: Andreas Heinrich <andreas.heinrich@rwth-aachen.de>

config/CMakeLists.txt

@@ -9,6 +9,7 @@ generate_config_run_script(CONFIG hil)
 generate_config_run_script(CONFIG sil-gen-pm)
 generate_config_run_script(CONFIG sil-ocpp)
 generate_config_run_script(CONFIG sil-ocpp-custom-extension)
+generate_config_run_script(CONFIG example)
 
 # install configs
 install(

config/config-example.yaml

@@ -0,0 +1,23 @@
+settings:
+  telemetry_enabled: true
+  logging_config_file: /home/andreas/everest-logging-config.conf
+active_modules:
+  store:
+    module: Store
+  example:
+    config_implementation:
+      example:
+        current: 42
+        enum_test: one
+        enum_test2: 2
+    connections:
+      kvs:
+        - module_id: store
+          implementation_id: main
+    module: Example
+  example_user:
+    connections:
+      example:
+        - module_id: example
+          implementation_id: example
+    module: ExampleUser

errors/example.yaml

@@ -0,0 +1,10 @@
+description: Example group of errors used by example modules to demonstrate error handling
+errors:
+  - name: ExampleErrorA
+    description: Example error A
+  - name: ExampleErrorB
+    description: Example error B
+  - name: ExampleErrorC
+    description: Example error C
+  - name: ExampleErrorD
+    description: Example error D

interfaces/example.yaml

@@ -16,3 +16,5 @@ vars:
   max_current:
     description: Provides maximum current of this supply in ampere
     type: number
+errors:
+  - $ref: '../errors/example.yaml#/errors'

interfaces/example_user.yaml

@@ -1,3 +1,5 @@
 description: >-
   This interface defines an example_user interface that uses the example
   interface
+errors:
+  - $ref: '../errors/example.yaml#/errors'

modules/examples/Example/example/exampleImpl.cpp

@@ -15,6 +15,16 @@ void exampleImpl::init() {
 
 void exampleImpl::ready() {
     publish_max_current(config.current);
+    std::this_thread::sleep_for(std::chrono::seconds(2));
+    Everest::error::ErrorHandle my_error_uuid = raise_example_ExampleErrorA("This error is raised to test the error handling");
+    std::this_thread::sleep_for(std::chrono::seconds(2));
+    mod->r_kvs->call_store("test", "test");
+    std::this_thread::sleep_for(std::chrono::seconds(2));
+    request_clear_error(Everest::error::ErrorHandle());
+    std::this_thread::sleep_for(std::chrono::seconds(10));
+    request_clear_error(my_error_uuid);
+    raise_example_ExampleErrorB("This error is raised to test the error handling", Everest::error::Severity::High);
+    request_clear_all_errors();
 }
 
 bool exampleImpl::handle_uses_something(std::string& key) {

modules/examples/ExampleUser/example_user/example_userImpl.cpp

@@ -6,10 +6,27 @@ namespace module {
 namespace example_user {
 
 void example_userImpl::init() {
+    Everest::error::ErrorCallback error_callback = [this](const Everest::error::Error& error) {
+        EVLOG_error << "received error from error manager: " << error.type;
+        this->received_error = error.uuid;
+    };
+    Everest::error::ErrorCallback error_cleared_callback = [](const Everest::error::Error& error) {
+        EVLOG_info << "received error cleared from error manager: " << error.type;
+    };
+    mod->r_example->subscribe_error_example_ExampleErrorA(
+        error_callback,
+        error_cleared_callback
+    );
+    mod->r_example->subscribe_all_errors(
+        error_callback,
+        error_cleared_callback
+    );
 }
 
 void example_userImpl::ready() {
     mod->r_example->call_uses_something("hello_there");
+    std::this_thread::sleep_for(std::chrono::seconds(6));
+    request_clear_error(this->received_error);
 }
 
 } // namespace example_user

modules/examples/ExampleUser/example_user/example_userImpl.hpp

@@ -47,6 +47,7 @@ class example_userImpl : public example_userImplBase {
 
     // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
     // insert your private definitions here
+    Everest::error::ErrorHandle received_error;
     // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
 };