[config] Implementation of new configuration management #1505

Peguen · 2024-04-04T13:40:37Z

Description

Introduced config management via structs which opens the possibilty for users to configure eCAL in code. In addition, evaluation of the inputs will be easily possible.

If assigned configuration values can be evaluated and are incorrect, the program will exit with an error.

Internally also the new config structs will be used.

…tializer.cpp

…lue.

…a types.

…unsigned int.

…_implementation

github-actions

clang-tidy made some suggestions

ecal/core/src/config/ecal_cmd_parser.cpp

ecal/tests/cpp/config_test/src/config_test.cpp

…_implementation

…passing.

github-actions

clang-tidy made some suggestions

github-actions · 2024-05-17T14:31:25Z

ecal/core/include/ecal/msg/capnproto/publisher.h

@@ -101,7 +101,7 @@ namespace eCAL
      * @param topic_name_  Unique topic name.
      * @param config_      Optional configuration parameters.
      **/
-      CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = {})
+      CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options)


warning: constructor does not initialize these fields: builder [cppcoreguidelines-pro-type-member-init]

CPublisher(const std::string& topic_name_, const eCAL::Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options) ^

github-actions · 2024-05-17T14:31:25Z

ecal/core/include/ecal/msg/publisher.h

@@ -63,7 +63,7 @@ namespace eCAL
     * @param data_type_info_  Topic data type information (encoding, type, descriptor).
     * @param config_          Optional configuration parameters.
    **/
-    CMsgPublisher(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = {}) : CPublisher(topic_name_, data_type_info_, config_)
+    CMsgPublisher(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options) : CPublisher(topic_name_, data_type_info_, config_)


warning: constructor does not initialize these fields: m_buffer [cppcoreguidelines-pro-type-member-init]

CMsgPublisher(const std::string& topic_name_, const struct SDataTypeInformation& data_type_info_, const Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options) : CPublisher(topic_name_, data_type_info_, config_) ^

github-actions · 2024-05-17T14:31:25Z

ecal/core/include/ecal/msg/publisher.h

@@ -74,7 +74,7 @@
     * @param topic_name_  Unique topic name.
     * @param config_      Optional configuration parameters.
    **/
-    explicit CMsgPublisher(const std::string& topic_name_, const Publisher::Configuration& config_ = {}) : CMsgPublisher(topic_name_, GetDataTypeInformation(), config_)
+    explicit CMsgPublisher(const std::string& topic_name_, const Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options) : CMsgPublisher(topic_name_, GetDataTypeInformation(), config_)


warning: constructor does not initialize these fields: m_buffer [cppcoreguidelines-pro-type-member-init]

explicit CMsgPublisher(const std::string& topic_name_, const Publisher::Configuration& config_ = eCAL::GetCurrentConfig().publisher_options) : CMsgPublisher(topic_name_, GetDataTypeInformation(), config_) ^

github-actions · 2024-05-17T14:31:25Z

ecal/core/src/config/ecal_config_initializer.cpp

+
+      // publisher options
+      auto& publisherOptions = publisher_options;
+      publisherOptions.shm.enable    = (iniConfig.get(PUBLISHER, "use_shm",    static_cast<int>(PUB_USE_SHM)) == 0) ? false : true;


warning: redundant boolean literal in ternary expression result [readability-simplify-boolean-expr]

Suggested change

publisherOptions.shm.enable = (iniConfig.get(PUBLISHER, "use_shm", static_cast<int>(PUB_USE_SHM)) == 0) ? false : true;

publisherOptions.shm.enable = iniConfig.get(PUBLISHER, "use_shm", static_cast<int>(PUB_USE_SHM)) != 0;

github-actions · 2024-05-17T14:31:25Z

ecal/core/src/config/ecal_config_initializer.cpp

+      // publisher options
+      auto& publisherOptions = publisher_options;
+      publisherOptions.shm.enable    = (iniConfig.get(PUBLISHER, "use_shm",    static_cast<int>(PUB_USE_SHM)) == 0) ? false : true;
+      publisherOptions.tcp.enable    = (iniConfig.get(PUBLISHER, "use_tcp",    static_cast<int>(PUB_USE_TCP)) == 0) ? false : true;


warning: redundant boolean literal in ternary expression result [readability-simplify-boolean-expr]

Suggested change

publisherOptions.tcp.enable = (iniConfig.get(PUBLISHER, "use_tcp", static_cast<int>(PUB_USE_TCP)) == 0) ? false : true;

publisherOptions.tcp.enable = iniConfig.get(PUBLISHER, "use_tcp", static_cast<int>(PUB_USE_TCP)) != 0;

github-actions · 2024-05-17T14:31:25Z

ecal/core/src/config/ecal_config_initializer.cpp

+      auto& publisherOptions = publisher_options;
+      publisherOptions.shm.enable    = (iniConfig.get(PUBLISHER, "use_shm",    static_cast<int>(PUB_USE_SHM)) == 0) ? false : true;
+      publisherOptions.tcp.enable    = (iniConfig.get(PUBLISHER, "use_tcp",    static_cast<int>(PUB_USE_TCP)) == 0) ? false : true;
+      publisherOptions.udp.enable    = (iniConfig.get(PUBLISHER, "use_udp_mc", static_cast<int>(PUB_USE_UDP_MC)) == 0) ? false : true;


warning: redundant boolean literal in ternary expression result [readability-simplify-boolean-expr]

Suggested change

publisherOptions.udp.enable = (iniConfig.get(PUBLISHER, "use_udp_mc", static_cast<int>(PUB_USE_UDP_MC)) == 0) ? false : true;

publisherOptions.udp.enable = iniConfig.get(PUBLISHER, "use_udp_mc", static_cast<int>(PUB_USE_UDP_MC)) != 0;

github-actions · 2024-05-17T14:31:25Z

ecal/core/src/ecal.cpp

-    std::vector<const char*> argv(args_.size());
-    std::transform(args_.begin(), args_.end(), argv.begin(), [](std::string& s) {return s.c_str();});
-    return Initialize(static_cast<int>(argv.size()), const_cast<char**>(argv.data()), unit_name_, components_);
+    eCAL::Configuration config(args_);


warning: parameter 'args_' is passed by value and only copied once; consider moving it to avoid unnecessary copies [performance-unnecessary-value-param]

ecal/core/src/ecal.cpp:28:

- #include <vector> + #include <utility> + #include <vector>

Suggested change

eCAL::Configuration config(args_);

eCAL::Configuration config(std::move(args_));

github-actions · 2024-05-17T14:31:26Z

ecal/tests/cpp/config_test/src/config_test.cpp

+
+TEST(ConfigDeathTest, user_config_death_test)
+{
+  eCAL::Configuration custom_config(0, nullptr);


warning: variable 'custom_config' of type 'eCAL::Configuration' can be declared 'const' [misc-const-correctness]

Suggested change

eCAL::Configuration custom_config(0, nullptr);

eCAL::Configuration const custom_config(0, nullptr);

…tructor. Some renaming.

…ubscriber config.

…mes.

github-actions

clang-tidy made some suggestions

ecal/core/src/config/ecal_config_initializer.cpp

ecal/core/src/ecal_global_accessors.cpp

ecal/core/src/ecal_global_accessors.h

github-actions · 2024-05-22T14:48:08Z

ecal/core/src/pubsub/ecal_publisher_config.cpp

-    Configuration::Configuration() :
-      share_topic_type(eCAL::Config::IsTopicTypeSharingEnabled()),
-      share_topic_description(eCAL::Config::IsTopicDescriptionSharingEnabled())
+    Configuration::Configuration() 


warning: constructor does not initialize these fields: tcp, share_topic_type, share_topic_description [cppcoreguidelines-pro-type-member-init]

ecal/core/include/ecal/config/ecal_publisher_config.h:137:

- TCP::Configuration tcp; + TCP::Configuration tcp{};

ecal/core/include/ecal/config/ecal_publisher_config.h:139:

- bool share_topic_type; //!< share topic type via registration - bool share_topic_description; //!< share topic description via registration + bool share_topic_type{}; //!< share topic type via registration + bool share_topic_description{}; //!< share topic description via registration

…_implementation

github-actions

clang-tidy made some suggestions

doc/rst/configuration/src/publisher_config/main.cpp

github-actions · 2024-05-24T09:29:27Z

ecal/core/src/pubsub/ecal_publisher_config.cpp

-    Configuration::Configuration() :
-      share_topic_type(eCAL::Config::IsTopicTypeSharingEnabled()),
-      share_topic_description(eCAL::Config::IsTopicDescriptionSharingEnabled())
+    Configuration::Configuration() 


warning: constructor does not initialize these fields: tcp, share_topic_type, share_topic_description [cppcoreguidelines-pro-type-member-init]

ecal/core/include/ecal/config/publisher.h:137:

- TCP::Configuration tcp; + TCP::Configuration tcp{};

ecal/core/include/ecal/config/publisher.h:139:

- bool share_topic_type; //!< share topic type via registration - bool share_topic_description; //!< share topic description via registration + bool share_topic_type{}; //!< share topic type via registration + bool share_topic_description{}; //!< share topic description via registration

…_implementation

Peguen added 30 commits February 20, 2024 16:23

First working implementation for config management.

382d9ef

Merge branch 'master' into feature/user_config_implementation

0e9c039

Resolved some merging problems.

49e8ade

Fixed copy paste issue values for receivingOptions in ecal_config_ini…

70366d5

…tializer.cpp

Config Adaptions: Set LimitSize default paramaeter to template MIN va…

00b2ec1

…lue.

Refactored options and config access.

eb31c72

Changed defines to constexpr in ecal_dev_ini.h

548037f

Removed doubled constexpr.

5b07971

Removed former ecal_config cpp and h from core/CMakesLists

9cd3594

Removed ms_t from registration_options and handling in using functions.

9e1be9a

Fixed ecal_registration cpp time config import.

c5ab1dc

Refactored config options in application.

05ec616

Added process_options.terminal_emulator to config.

a861b01

Refactored sys- and processoptions as sub to application options.

e35df5a

Refactored default config to use ecal_def.h defines.

4a0ce13

Refactored ini config to use ecal_def.h

153ee9e

Moved IpAddressV4 definitions to private space.

94f91ae

Removed unused fields.

b196ab4

Fixed some GH actions compiling issues.

afe2332

Removed unnecessary comments in header files.

4887b02

Changed #include <limits> to correct header.

c768ba9

Merge branch 'master' into feature/user_config_implementation

6306d99

Some updates regarding new configuration management to ecal_core.

b4690a0

Updated submodules

4694927

Checked out versions of thirdparty modules equal to master branch.

388f5bc

Implemented termination, when wrong values are assigned to custom dat…

9303795

…a types.

Changed g_ecal_config() return value (PathWarning)

848c572

Added basic configuration tests.

2370814

Added ECAL_API macro for config calls.

e20d510

Added operator overloading of == for LimitSize(LS), LS == int, LS == …

7cafa3e

…unsigned int.

Merge remote-tracking branch 'origin/master' into feature/user_config…

e3bb375

…_implementation

github-actions bot reviewed May 17, 2024

View reviewed changes

Peguen added 2 commits May 17, 2024 12:44

Merge remote-tracking branch 'origin/master' into feature/user_config…

ac9dbe9

…_implementation

Refactored to current publisher options. TimeoutAcknowledge test not …

fed863b

…passing.

github-actions bot reviewed May 17, 2024

View reviewed changes

Peguen added 9 commits May 21, 2024 09:00

Make clang tidy a bit more happy.

31b0c6e

Enable shm for pubsub acknowledge test.

295f998

Included ecal_subscriber_config

915a7f7

Renamend Configuration member.

a2aca3e

Moved config to globalgalactic space. Implemented default config cons…

cf2148c

…tructor. Some renaming.

Restructure eCAL Application Options and default init for publisher/s…

80ef2a0

…ubscriber config.

Use custom types in publisher config.

cafb419

Restructered config file structure, config namespaces and and file na…

25116ea

…mes.

Added comments to config structs from ini file.

f7b8470

github-actions bot reviewed May 22, 2024

View reviewed changes

Peguen added 7 commits May 23, 2024 12:11

Some file renaming.

f6f3dd5

Updated docu for config.

913fee0

Changes for transportlayer config.

fd80bad

Try taking .ini file in normal initializing, as it was before.

e126b12

Merge remote-tracking branch 'origin/master' into feature/user_config…

f876c26

…_implementation

Added doc for publisher config.

25dd3e0

Defaulted publisher test again.

7be0dd9

github-actions bot reviewed May 24, 2024

View reviewed changes

Peguen added 3 commits May 27, 2024 07:30

Removed unncessary constructor/destructor in custom config classes.

aa1d1ca

Some ecal_cmd_parser cleanup.

db16ff6

Merge remote-tracking branch 'origin/master' into feature/user_config…

9613db0

…_implementation

Peguen changed the title ~~[DRAFT][config] Implementation of new configuration management~~ [config] Implementation of new configuration management May 28, 2024

Peguen marked this pull request as ready for review May 28, 2024 11:37

Peguen added 2 commits May 28, 2024 15:49

Fix ecal_cmd_parser checkForValidConfigFilePath function.

11044f1

Fixed ecal_cmd_parser problem with path separator attachments.

a9a4a41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[config] Implementation of new configuration management #1505

[config] Implementation of new configuration management #1505

Peguen commented Apr 4, 2024

github-actions bot left a comment

github-actions bot left a comment

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot May 17, 2024

github-actions bot left a comment

github-actions bot May 22, 2024

github-actions bot left a comment

github-actions bot May 24, 2024

	publisherOptions.shm.enable = (iniConfig.get(PUBLISHER, "use_shm", static_cast<int>(PUB_USE_SHM)) == 0) ? false : true;
	publisherOptions.shm.enable = iniConfig.get(PUBLISHER, "use_shm", static_cast<int>(PUB_USE_SHM)) != 0;

	publisherOptions.tcp.enable = (iniConfig.get(PUBLISHER, "use_tcp", static_cast<int>(PUB_USE_TCP)) == 0) ? false : true;
	publisherOptions.tcp.enable = iniConfig.get(PUBLISHER, "use_tcp", static_cast<int>(PUB_USE_TCP)) != 0;

	publisherOptions.udp.enable = (iniConfig.get(PUBLISHER, "use_udp_mc", static_cast<int>(PUB_USE_UDP_MC)) == 0) ? false : true;
	publisherOptions.udp.enable = iniConfig.get(PUBLISHER, "use_udp_mc", static_cast<int>(PUB_USE_UDP_MC)) != 0;

	eCAL::Configuration config(args_);
	eCAL::Configuration config(std::move(args_));

	eCAL::Configuration custom_config(0, nullptr);
	eCAL::Configuration const custom_config(0, nullptr);

[config] Implementation of new configuration management #1505

Are you sure you want to change the base?

[config] Implementation of new configuration management #1505

Conversation

Peguen commented Apr 4, 2024

Description

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot May 17, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 22, 2024

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot May 24, 2024

Choose a reason for hiding this comment