Adapt examples and tests to changes required for multiple "provides"

hikinggrass · hikinggrass · commit b0c5eba486a5 · 2025-07-22T19:39:48.000+02:00
These changes are implemented in: everest-framework: EVerest/everest-framework#287 everest-utils: EVerest/everest-utils#195 Signed-off-by: Kai-Uwe Hermann <kai-uwe.hermann@pionix.de>
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -8,10 +8,10 @@ module(
 ###############################################################################
 
 bazel_dep(name = "everest-framework", version = "0.22.2")
-git_override(module_name="everest-framework", commit="41ae8d15cffd79c4b270f5e0e811f562594063bc", remote="https://github.com/EVerest/everest-framework")
+git_override(module_name="everest-framework", commit="ba28128e292842da5728a09c2e07e65a0be71da5", remote="https://github.com/EVerest/everest-framework")
 
 bazel_dep(name = "everest-utils", version = "0.6.0")
-git_override(module_name="everest-utils", commit="f1117f9d6a9a2fe29d350dd50ecc727a7101ead1", remote="https://github.com/EVerest/everest-utils")
+git_override(module_name="everest-utils", commit="8940f6971f7e165a6e50586595d0f4b53068da76", remote="https://github.com/EVerest/everest-utils")
 
 bazel_dep(name = "bazel_features", version = "1.21.0")
 bazel_dep(name = "bazel_skylib", version = "1.7.1")
diff --git a/config/config-example.yaml b/config/config-example.yaml
@@ -19,4 +19,11 @@ active_modules:
       example:
         - module_id: example
           implementation_id: example
+      example_multiple:
+        - module_id: example
+          implementation_id: example_multiple.0 # TODO: use .0 ... .127 index syntax
+        - module_id: example
+          implementation_id: example_multiple.1
+        # - module_id: example
+        #   implementation_id: example_multiple.2
     module: ExampleUser
diff --git a/dependencies.yaml b/dependencies.yaml
@@ -4,7 +4,7 @@
 ---
 everest-framework:
   git: https://github.com/EVerest/everest-framework.git
-  git_tag: v0.22.2
+  git_tag: ba28128e292842da5728a09c2e07e65a0be71da5
   options: [
     "BUILD_TESTING OFF",
     "everest-framework_USE_PYTHON_VENV ${PROJECT_NAME}_USE_PYTHON_VENV",
@@ -89,7 +89,7 @@ Josev:
 # everest-testing and ev-dev-tools
 everest-utils:
   git: https://github.com/EVerest/everest-utils.git
-  git_tag: v0.6.0
+  git_tag: 8940f6971f7e165a6e50586595d0f4b53068da76 # FIXME: v0.7.0
 # linux_libnfc-nci for RFID
 libnfc-nci:
   git: https://github.com/EVerest/linux_libnfc-nci.git
@@ -104,7 +104,7 @@ gtest:
   cmake_condition: "EVEREST_CORE_BUILD_TESTING"
 everest-sqlite:
   git: https://github.com/EVerest/everest-sqlite.git
-  git_tag: v0.1.2
+  git_tag: v0.1.3
 catch2:
   git: https://github.com/catchorg/Catch2.git
   git_tag: v3.4.0
diff --git a/interfaces/example.yaml b/interfaces/example.yaml
@@ -16,3 +16,5 @@ vars:
   max_current:
     description: Provides maximum current of this supply in ampere
     type: number
+errors:
+  - reference: /errors/example#/ExampleErrorA
diff --git a/modules/EvseManager/tests/ErrorHandlingTest.cpp b/modules/EvseManager/tests/ErrorHandlingTest.cpp
@@ -66,8 +66,9 @@ struct EvseManagerModuleAdapterStub : public module::stub::EvseManagerModuleAdap
         error_list{} {
     }
 
-    virtual std::shared_ptr<Everest::error::ErrorManagerImpl> get_error_manager_impl_fn(const std::string& str) {
-        return std::make_shared<Everest::error::ErrorManagerImpl>(
+    virtual std::vector<std::shared_ptr<Everest::error::ErrorManagerImpl>>
+    get_error_manager_impl_fn(const std::string& str) {
+        return {std::make_shared<Everest::error::ErrorManagerImpl>(
             error_type_map, std::make_shared<Everest::error::ErrorDatabaseMap>(), error_list,
             [this](const Everest::error::Error& error) {
                 if (error_raise.find(error.type) == error_raise.end()) {
@@ -83,7 +84,7 @@ struct EvseManagerModuleAdapterStub : public module::stub::EvseManagerModuleAdap
                 error_clear[error.type](error);
                 active_errors.remove(error);
             },
-            false);
+            false)};
     }
 
     virtual std::shared_ptr<Everest::error::ErrorManagerReq> get_error_manager_req_fn(const Requirement& req) {
@@ -100,8 +101,9 @@ struct EvseManagerModuleAdapterStub : public module::stub::EvseManagerModuleAdap
         return std::make_shared<Everest::error::ErrorFactory>(error_type_map);
     }
 
-    virtual std::shared_ptr<Everest::error::ErrorStateMonitor> get_error_state_monitor_impl_fn(const std::string&) {
-        return std::make_shared<Everest::error::ErrorStateMonitor>(error_database);
+    virtual std::vector<std::shared_ptr<Everest::error::ErrorStateMonitor>>
+    get_error_state_monitor_impl_fn(const std::string&) {
+        return {std::make_shared<Everest::error::ErrorStateMonitor>(error_database)};
     }
 };
 
diff --git a/modules/EvseManager/tests/EvseManagerStub.hpp b/modules/EvseManager/tests/EvseManagerStub.hpp
@@ -88,8 +88,9 @@ struct EvseManagerModuleAdapter : public ModuleAdapterStub {
             });
     }
 
-    virtual std::shared_ptr<Everest::error::ErrorManagerImpl> get_error_manager_impl_fn(const std::string& str) {
-        return std::make_shared<Everest::error::ErrorManagerImpl>(
+    virtual std::vector<std::shared_ptr<Everest::error::ErrorManagerImpl>>
+    get_error_manager_impl_fn(const std::string& str) {
+        return {std::make_shared<Everest::error::ErrorManagerImpl>(
             std::make_shared<Everest::error::ErrorTypeMap>(), std::make_shared<Everest::error::ErrorDatabaseMap>(),
             std::list<Everest::error::ErrorType>(),
             [this](const Everest::error::Error& error) {
@@ -106,7 +107,7 @@ struct EvseManagerModuleAdapter : public ModuleAdapterStub {
                 }
                 error_clear[error.type](error);
             },
-            false);
+            false)};
     }
 };
 
diff --git a/modules/examples/Example/CMakeLists.txt b/modules/examples/Example/CMakeLists.txt
@@ -15,6 +15,7 @@ target_sources(${MODULE_NAME}
     PRIVATE
         "example/exampleImpl.cpp"
         "store/kvsImpl.cpp"
+        "example_multiple/exampleImpl.cpp"
 )
 
 # ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1
diff --git a/modules/examples/Example/Example.cpp b/modules/examples/Example/Example.cpp
@@ -6,11 +6,13 @@ namespace module {
 
 void Example::init() {
     invoke_init(*p_example);
+    invoke_init(*p_example_multiple);
     invoke_init(*p_store);
 }
 
 void Example::ready() {
     invoke_ready(*p_example);
+    invoke_ready(*p_example_multiple);
     invoke_ready(*p_store);
 
     mqtt.publish("external/topic", "data");
diff --git a/modules/examples/Example/Example.hpp b/modules/examples/Example/Example.hpp
@@ -12,6 +12,7 @@
 
 // headers for provided interface implementations
 #include <generated/interfaces/example/Implementation.hpp>
+#include <generated/interfaces/example/ImplementationMultiple.hpp>
 #include <generated/interfaces/kvs/Implementation.hpp>
 
 // headers for required interface implementations
@@ -29,17 +30,20 @@ class Example : public Everest::ModuleBase {
 public:
     Example() = delete;
     Example(const ModuleInfo& info, Everest::MqttProvider& mqtt_provider, std::unique_ptr<exampleImplBase> p_example,
-            std::unique_ptr<kvsImplBase> p_store, std::unique_ptr<kvsIntf> r_kvs, Conf& config) :
+            std::unique_ptr<kvsImplBase> p_store, std::unique_ptr<exampleImplBaseMultiple> p_example_multiple,
+            std::unique_ptr<kvsIntf> r_kvs, Conf& config) :
         ModuleBase(info),
         mqtt(mqtt_provider),
         p_example(std::move(p_example)),
         p_store(std::move(p_store)),
+        p_example_multiple(std::move(p_example_multiple)),
         r_kvs(std::move(r_kvs)),
         config(config){};
 
     Everest::MqttProvider& mqtt;
     const std::unique_ptr<exampleImplBase> p_example;
     const std::unique_ptr<kvsImplBase> p_store;
+    const std::unique_ptr<exampleImplBaseMultiple> p_example_multiple;
     const std::unique_ptr<kvsIntf> r_kvs;
     const Conf& config;
 
diff --git a/modules/examples/Example/doc.rst b/modules/examples/Example/doc.rst
@@ -0,0 +1,22 @@
+.. _everest_modules_handwritten_Example:
+
+..  This file is a placeholder for an optional single file
+    handwritten documentation for the Example module.
+    Please decide whether you want to use this single file,
+    or a set of files in the doc/ directory.
+    In the latter case, you can delete this file.
+    In the former case, you can delete the doc/ directory.
+    
+..  This handwritten documentation is optional. In case
+    you do not want to write it, you can delete this file
+    and the doc/ directory.
+
+..  The documentation can be written in reStructuredText,
+    and will be converted to HTML and PDF by Sphinx.
+
+*******************************************
+Example
+*******************************************
+
+:ref:`Link <everest_modules_Example>` to the module's reference.
+Simple example module written in C++
diff --git a/modules/examples/Example/docs/index.rst b/modules/examples/Example/docs/index.rst
@@ -0,0 +1,23 @@
+.. _everest_modules_handwritten_Example:
+
+..  This file is a placeholder for optional multiple files
+    handwritten documentation for the Example module.
+    Please decide whether you want to use the doc.rst file
+    or a set of files in the doc/ directory.
+    In the latter case, you can delete the doc.rst file.
+    In the former case, you can delete the doc/ directory.
+    
+..  This handwritten documentation is optional. In case
+    you do not want to write it, you can delete this file
+    and the doc/ directory.
+
+..  The documentation can be written in reStructuredText,
+    and will be converted to HTML and PDF by Sphinx.
+    This index.rst file is the entry point for the module documentation.
+
+*******************************************
+Example
+*******************************************
+
+:ref:`Link <everest_modules_Example>` to the module's reference.
+Simple example module written in C++
diff --git a/modules/examples/Example/example/exampleImpl.cpp b/modules/examples/Example/example/exampleImpl.cpp
@@ -19,6 +19,8 @@ void exampleImpl::ready() {
 }
 
 bool exampleImpl::handle_uses_something(std::string& key) {
+    EVLOG_info << "got something, (no index) key: " << key;
+
     if (mod->r_kvs->call_exists(key)) {
         EVLOG_debug << "IT SHOULD NOT AND DOES NOT EXIST";
     }
diff --git a/modules/examples/Example/example_multiple/exampleImpl.cpp b/modules/examples/Example/example_multiple/exampleImpl.cpp
@@ -0,0 +1,50 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Pionix GmbH and Contributors to EVerest
+
+#include "exampleImpl.hpp"
+#include <thread>
+
+namespace module {
+namespace example_multiple {
+
+void exampleImpl::init() {
+}
+
+void exampleImpl::ready() {
+    publish_max_current(0, 10);
+    publish_max_current(1, 20);
+
+    const auto error_object0 =
+        this->error_factory->create_error("example/ExampleErrorA", "", "index0", Everest::error::Severity::High);
+    const auto error_object1 =
+        this->error_factory->create_error("example/ExampleErrorA", "", "index1", Everest::error::Severity::High);
+    this->raise_error(0, error_object0);
+    this->raise_error(1, error_object1);
+
+    std::this_thread::sleep_for(std::chrono::seconds(3));
+
+    this->clear_error(1, error_object1.type);
+
+    std::this_thread::sleep_for(std::chrono::seconds(3));
+
+    this->clear_error(0, error_object0.type);
+
+    std::this_thread::sleep_for(std::chrono::seconds(3));
+
+    this->raise_error(0, error_object0);
+    this->raise_error(1, error_object1);
+
+    std::this_thread::sleep_for(std::chrono::seconds(3));
+
+    this->clear_all_errors_of_impl(0);
+    this->clear_all_errors_of_impl(1);
+}
+
+bool exampleImpl::handle_uses_something(std::size_t index, std::string& key) {
+    EVLOG_info << "got something, index: " << index << " key: " << key;
+    // your code for cmd uses_something goes here
+    return true;
+}
+
+} // namespace example_multiple
+} // namespace module
diff --git a/modules/examples/Example/example_multiple/exampleImpl.hpp b/modules/examples/Example/example_multiple/exampleImpl.hpp
@@ -0,0 +1,61 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Pionix GmbH and Contributors to EVerest
+#ifndef EXAMPLE_MULTIPLE_EXAMPLE_IMPL_HPP
+#define EXAMPLE_MULTIPLE_EXAMPLE_IMPL_HPP
+
+//
+// AUTO GENERATED - MARKED REGIONS WILL BE KEPT
+// template version 3
+//
+
+#include <generated/interfaces/example/ImplementationMultiple.hpp>
+
+#include "../Example.hpp"
+
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+// insert your custom include headers here
+// ev@75ac1216-19eb-4182-a85c-820f1fc2c091:v1
+
+namespace module {
+namespace example_multiple {
+
+struct Conf {};
+
+class exampleImpl : public exampleImplBaseMultiple {
+public:
+    exampleImpl() = delete;
+    exampleImpl(Everest::ModuleAdapter* ev, const Everest::PtrContainer<Example>& mod, Conf& config) :
+        exampleImplBaseMultiple(ev, "example_multiple"), mod(mod), config(config){};
+
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+    // insert your public definitions here
+    // ev@8ea32d28-373f-4c90-ae5e-b4fcc74e2a61:v1
+
+protected:
+    // command handler functions (virtual)
+    virtual bool handle_uses_something(std::size_t index, std::string& key) override;
+
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+    // insert your protected definitions here
+    // ev@d2d1847a-7b88-41dd-ad07-92785f06f5c4:v1
+
+private:
+    const Everest::PtrContainer<Example>& mod;
+    const Conf& config;
+
+    virtual void init() override;
+    virtual void ready() override;
+
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+    // insert your private definitions here
+    // ev@3370e4dd-95f4-47a9-aaec-ea76f34a66c9:v1
+};
+
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+// insert other definitions here
+// ev@3d7da0ad-02c2-493d-9920-0bbbd56b9876:v1
+
+} // namespace example_multiple
+} // namespace module
+
+#endif // EXAMPLE_MULTIPLE_EXAMPLE_IMPL_HPP
diff --git a/modules/examples/Example/manifest.yaml b/modules/examples/Example/manifest.yaml
@@ -26,6 +26,10 @@ provides:
   store:
     interface: kvs
     description: This implements the kvs interface, mostly for testing multiple interfaces in one manifest
+  example_multiple:
+    interface: example
+    description: This implements the example interface multiple times in one provides
+    quantity: 2 # TODO: naming
 requires:
   kvs:
     interface: kvs
diff --git a/modules/examples/ExampleUser/ExampleUser.hpp b/modules/examples/ExampleUser/ExampleUser.hpp
@@ -28,11 +28,17 @@ class ExampleUser : public Everest::ModuleBase {
 public:
     ExampleUser() = delete;
     ExampleUser(const ModuleInfo& info, std::unique_ptr<example_userImplBase> p_example_user,
-                std::unique_ptr<exampleIntf> r_example, Conf& config) :
-        ModuleBase(info), p_example_user(std::move(p_example_user)), r_example(std::move(r_example)), config(config){};
+                std::unique_ptr<exampleIntf> r_example, std::vector<std::unique_ptr<exampleIntf>> r_example_multiple,
+                Conf& config) :
+        ModuleBase(info),
+        p_example_user(std::move(p_example_user)),
+        r_example(std::move(r_example)),
+        r_example_multiple(std::move(r_example_multiple)),
+        config(config){};
 
     const std::unique_ptr<example_userImplBase> p_example_user;
     const std::unique_ptr<exampleIntf> r_example;
+    const std::vector<std::unique_ptr<exampleIntf>> r_example_multiple;
     const Conf& config;
 
     // ev@1fce4c5e-0ab8-41bb-90f7-14277703d2ac:v1
diff --git a/modules/examples/ExampleUser/doc.rst b/modules/examples/ExampleUser/doc.rst
@@ -0,0 +1,22 @@
+.. _everest_modules_handwritten_ExampleUser:
+
+..  This file is a placeholder for an optional single file
+    handwritten documentation for the ExampleUser module.
+    Please decide whether you want to use this single file,
+    or a set of files in the doc/ directory.
+    In the latter case, you can delete this file.
+    In the former case, you can delete the doc/ directory.
+    
+..  This handwritten documentation is optional. In case
+    you do not want to write it, you can delete this file
+    and the doc/ directory.
+
+..  The documentation can be written in reStructuredText,
+    and will be converted to HTML and PDF by Sphinx.
+
+*******************************************
+ExampleUser
+*******************************************
+
+:ref:`Link <everest_modules_ExampleUser>` to the module's reference.
+Simple example module written in C++ and using the other example module
diff --git a/modules/examples/ExampleUser/docs/index.rst b/modules/examples/ExampleUser/docs/index.rst
diff --git a/modules/examples/ExampleUser/example_user/example_userImpl.cpp b/modules/examples/ExampleUser/example_user/example_userImpl.cpp
diff --git a/modules/examples/ExampleUser/manifest.yaml b/modules/examples/ExampleUser/manifest.yaml
diff --git a/modules/rust_examples/RsExample/BUILD.bazel b/modules/rust_examples/RsExample/BUILD.bazel
diff --git a/modules/rust_examples/RsExampleUser/BUILD.bazel b/modules/rust_examples/RsExampleUser/BUILD.bazel
diff --git a/modules/rust_examples/RsExampleUser/src/main.rs b/modules/rust_examples/RsExampleUser/src/main.rs
diff --git a/tests/include/ModuleAdapterStub.hpp b/tests/include/ModuleAdapterStub.hpp

Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,9 @@ struct EvseManagerModuleAdapter : public ModuleAdapterStub {`
`88`	`88`	`});`
`89`	`89`	`}`
`90`	`90`
`91`		`- virtual std::shared_ptr<Everest::error::ErrorManagerImpl> get_error_manager_impl_fn(const std::string& str) {`
`92`		`- return std::make_shared<Everest::error::ErrorManagerImpl>(`
	`91`	`+ virtual std::vector<std::shared_ptr<Everest::error::ErrorManagerImpl>>`
	`92`	`+ get_error_manager_impl_fn(const std::string& str) {`
	`93`	`+ return {std::make_shared<Everest::error::ErrorManagerImpl>(`
`93`	`94`	`std::make_shared<Everest::error::ErrorTypeMap>(), std::make_shared<Everest::error::ErrorDatabaseMap>(),`
`94`	`95`	`std::list<Everest::error::ErrorType>(),`
`95`	`96`	`[this](const Everest::error::Error& error) {`
`@@ -106,7 +107,7 @@ struct EvseManagerModuleAdapter : public ModuleAdapterStub {`
`106`	`107`	`}`
`107`	`108`	`error_clear[error.type](error);`
`108`	`109`	`},`
`109`		`- false);`
	`110`	`+ false)};`
`110`	`111`	`}`
`111`	`112`	`};`
`112`	`113`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ target_sources(${MODULE_NAME}`
`15`	`15`	`PRIVATE`
`16`	`16`	`"example/exampleImpl.cpp"`
`17`	`17`	`"store/kvsImpl.cpp"`
	`18`	`+ "example_multiple/exampleImpl.cpp"`
`18`	`19`	`)`
`19`	`20`
`20`	`21`	`# ev@c55432ab-152c-45a9-9d2e-7281d50c69c3:v1`