[config] ecal api config path review #1869

Peguen · 2024-12-20T15:01:19Z

Description

Path processing and API changes regarding configuration and log paths.

API Changes

ecal_util.h

Renamed:
- GeteCALCOnfigPath() -> GeteCALConfigDir()
- GeteCALLogPath() -> GeteCALLogDir()
Removed:
- GeteCALActiveIniFile() -> use config object GetYamlFilePath() instead
- GeteCALUserSettingsPath() (cfg path in data path)

Logic Changes

GeteCALConfigDir() -> Checking for ecal.yaml in order: env(ECAL_CONFIG_DIR), local user paths (appdata/local, ~/.ecal) or system paths (etc/ecal, ProgramData/eCAL) ==> if nothing else specified, the default location of eCAL config dir will be the local user space
GeteCALLogDir() -> Same as GeteCALConfigDir(), env(ECAL_LOG_DIR) first and as fallback taking system temp path or as last resort /ecal_tmp path
Path returns will not simply create paths if they are not available. This now needs to be handled by the caller of the functions.

Misc

Log filter default in config/logging.h removed
Splitted path handling in new header/source file (previous was in config_initializer)
Using ecal-util functions for path processing
Added a functional test for ecal-util

…e and header.

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 20 out of 24. Check the log or trigger a new build to see more.

app/sys/sys_gui/src/widgets/import_from_cloud_widget/import_from_cloud_widget.cpp

ecal/core/cfg/gen/generate_configuration_yaml.cpp

ecal/core/src/config/ecal_path_processing.cpp

…pse-ecal/ecal into feature/ecal_api_config_path_review

github-actions

clang-tidy made some suggestions

ecal/core/src/config/ecal_path_processing.cpp

ecal/tests/cpp/ecal_utils_test/src/string_test.cpp

github-actions

clang-tidy made some suggestions

github-actions · 2025-01-07T13:22:12Z

ecal/core/src/config/ecal_path_processing.cpp

+  #endif
+  }
+
+  std::string eCALPlatformSpecificFolder(const std::string& path_, const std::string& linux_folder_name_ = ECAL_FOLDER_NAME_HOME_LINUX, const std::string& win_folder_name_ = ECAL_FOLDER_NAME_WINDOWS)


warning: parameter 'win_folder_name_' is unused [misc-unused-parameters]

Suggested change

std::string eCALPlatformSpecificFolder(const std::string& path_, const std::string& linux_folder_name_ = ECAL_FOLDER_NAME_HOME_LINUX, const std::string& win_folder_name_ = ECAL_FOLDER_NAME_WINDOWS)

std::string eCALPlatformSpecificFolder(const std::string& path_, const std::string& linux_folder_name_ = ECAL_FOLDER_NAME_HOME_LINUX)

github-actions · 2025-01-07T13:22:12Z

ecal/core/src/config/ecal_path_processing.cpp

+          }
+          else
+          {
+            std::cout << "[eCAL] Log path does not exist: " << path << std::endl;


warning: do not use 'std::endl' with streams; use '\n' instead [performance-avoid-endl]

Suggested change

std::cout << "[eCAL] Log path does not exist: " << path << std::endl;

std::cout << "[eCAL] Log path does not exist: " << path << '\n';

github-actions · 2025-01-07T13:22:12Z

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

+ * ========================= eCAL LICENSE =================================
+*/
+
+#include <gmock/gmock.h>


warning: 'gmock/gmock.h' file not found [clang-diagnostic-error]

#include <gmock/gmock.h> ^

github-actions · 2025-01-07T13:22:13Z

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

+
+#include <cstdlib>
+
+class ScopedEnvVar {


warning: class 'ScopedEnvVar' defines a non-default destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class ScopedEnvVar { ^

github-actions

clang-tidy made some suggestions

github-actions · 2025-01-07T15:08:50Z

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

+  const std::string env_ecal_log_value = "/path/to/log";
+
+  { // Check for config path
+    MockEnvVar mock_env_var;


warning: variable 'mock_env_var' of type 'MockEnvVar' can be declared 'const' [misc-const-correctness]

Suggested change

MockEnvVar mock_env_var;

MockEnvVar const mock_env_var;

…oper test path proc functions.

Peguen · 2025-01-13T09:27:13Z

Closed due to merge problem and too many files to review.

Peguen added 8 commits December 11, 2024 15:28

Intermediate impl.

cc9ee2a

Split ecal_config_initializer path and util functions to separate fil…

0df066c

…e and header.

WIP config path adaptions.

4b23137

Refactored path processing.

bfd3b4f

Added unique tmp path creation.

c4e013b

Fixed linux wrong variable name.

5109dc0

Config file writer adaption to usage for user.

2d75f8f

Merge branch 'master' into feature/ecal_api_config_path_review

0725ea4

Peguen added the cherry-pick-to-NONE Don't cherry-pick these changes label Jan 2, 2025

github-actions bot reviewed Jan 2, 2025

View reviewed changes

Peguen added 2 commits January 2, 2025 09:00

Implemented clangtidy suggestions.

7684b6d

Merge branch 'feature/ecal_api_config_path_review' of github.com:ecli…

911c5e1

…pse-ecal/ecal into feature/ecal_api_config_path_review

github-actions bot reviewed Jan 2, 2025

View reviewed changes

Peguen added 13 commits January 2, 2025 09:18

Removed const in env_path.

d6fe68e

Don't create directory on GeteCALLogDir().

48dac21

Deleted unused source file.

772da1b

Enabled gmock.

8f79247

Added some test for path processing. Refined logic for pathgetter.

cf698de

Force gmock on.

d5ed949

Try fix for gmock and const.

7e8765a

Fix createEcalDirStructure

4a103e0

Fix linux dirExists

e5764d2

Build gtest for gmock, disabled path test for now.

a4675fc

Removed deinit from ecal gtest submodule

deece82

Used correct namespace - linux build issues.

90e278d

linuxptp adaption to new api.

af70650

github-actions bot reviewed Jan 7, 2025

View reviewed changes

Prepare for mocking.

67d86cd

github-actions bot reviewed Jan 7, 2025

View reviewed changes

Mocking preparation for ecal_path_processing.cpp.

a011147

Peguen added 4 commits January 10, 2025 18:03

Added tests with mocking. Changed to Interfaces used to be able to pr…

8600251

…oper test path proc functions.

Fixed ecal_yaml configuration.

26d0606

Fixed file path for linuxptp.

3f6cf0e

Merge current master 2025-01-13

973596c

Peguen closed this Jan 13, 2025

Peguen deleted the feature/ecal_api_config_path_review branch January 13, 2025 09:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[config] ecal api config path review #1869

[config] ecal api config path review #1869

Peguen commented Dec 20, 2024 •

edited

Loading

github-actions bot left a comment

github-actions bot left a comment

github-actions bot left a comment

github-actions bot Jan 7, 2025

github-actions bot Jan 7, 2025

github-actions bot Jan 7, 2025

github-actions bot Jan 7, 2025

github-actions bot left a comment

github-actions bot Jan 7, 2025

Peguen commented Jan 13, 2025

	std::string eCALPlatformSpecificFolder(const std::string& path_, const std::string& linux_folder_name_ = ECAL_FOLDER_NAME_HOME_LINUX, const std::string& win_folder_name_ = ECAL_FOLDER_NAME_WINDOWS)
	std::string eCALPlatformSpecificFolder(const std::string& path_, const std::string& linux_folder_name_ = ECAL_FOLDER_NAME_HOME_LINUX)

	std::cout << "[eCAL] Log path does not exist: " << path << std::endl;
	std::cout << "[eCAL] Log path does not exist: " << path << '\n';

[config] ecal api config path review #1869

[config] ecal api config path review #1869

Conversation

Peguen commented Dec 20, 2024 • edited Loading

Description

API Changes

Logic Changes

Misc

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 left a comment

Choose a reason for hiding this comment

github-actions bot Jan 7, 2025

Choose a reason for hiding this comment

github-actions bot Jan 7, 2025

Choose a reason for hiding this comment

github-actions bot Jan 7, 2025

Choose a reason for hiding this comment

github-actions bot Jan 7, 2025

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

github-actions bot Jan 7, 2025

Choose a reason for hiding this comment

Peguen commented Jan 13, 2025

Peguen commented Dec 20, 2024 •

edited

Loading