Added version option to ddsrouter tool (#239)

* Refs #14889: Added version option to ddsrouter tool

Signed-off-by: Anton Rey <aanton.rv@gmail.com>

* Refs #14889: Revision changes

Signed-off-by: Anton Rey <aanton.rv@gmail.com>

* Refs #14889: Rebase change

Signed-off-by: Anton Rey <aanton.rv@gmail.com>

Author: antonrv

ddsrouter_cmake/CMakeLists.txt

@@ -24,6 +24,7 @@ cmake_policy(VERSION 3.5...3.13)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/in_source_build_prevention.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/load_project_settings.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/read_version.cmake)
+include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/read_commit_hash.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/installation_paths.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/configure_project.cmake)
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/project/cmake_options.cmake)

ddsrouter_cmake/README.md

@@ -74,7 +74,7 @@ Those variables which default is `x` must be set, and those with `-` are not req
 | MODULE_VERSION_MINOR         | x (if not set, are taken from VERSION file)                             | Minor version                                                                                      |
 | MODULE_VERSION_PATCH         | x (if not set, are taken from VERSION file)                             | Patch version                                                                                      |
 | MODULE_VERSION               | ${MODULE_VERSION_MAJOR}.${MODULE_VERSION_MINOR}.${MODULE_VERSION_PATCH} | Module version                                                                                     |
-| MODULE_VERSION_STRING        | ${MODULE_VERSION}                                                       | Module version                                                                                     |
+| MODULE_VERSION_STRING        | v${MODULE_VERSION}                                                      | Module version                                                                                     |
 |------------------------------|-------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
 | MODULE_LICENSE_FILE_PATH     | ../LICENSE                                                              | Path to the license file                                                                           |
 | MODULE_RESOURCES_PATH        | (if not given, no resources will be installed)                          | Path of the resources to install                                                                   |

ddsrouter_cmake/cmake/project/configure_project.cmake

@@ -63,6 +63,12 @@ macro(configure_project)
         read_version(${MODULE_VERSION_FILE_PATH})
     endif()
 
+    # Read git commit hash if not already set
+    if( NOT DEFINED MODULE_COMMIT_HASH)
+
+        read_commit_hash()
+    endif()
+
     # Set CMake options
     configure_cmake_options()
 

ddsrouter_cmake/cmake/project/read_commit_hash.cmake

@@ -0,0 +1,37 @@
+# Copyright 2022 Proyectos y Sistemas de Mantenimiento SL (eProsima).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+###############################################################################
+# Commit hash Reader macro
+###############################################################################
+# Load commit hash
+
+# 
+# RETURN VARIABLES:
+# - MODULE_COMMIT_HASH    : commit-hash
+
+# No arguments
+
+
+macro(read_commit_hash)
+
+    execute_process(COMMAND
+        git rev-parse HEAD
+        WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+        OUTPUT_VARIABLE MODULE_COMMIT_HASH
+        ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
+
+    message(STATUS "Read commit hash ${MODULE_COMMIT_HASH}")
+
+endmacro()

ddsrouter_cmake/cmake/project/read_version.cmake

@@ -51,7 +51,8 @@ macro(read_version VERSION_FILE_NAME)
     endif()
 
     if(NOT DEFINED MODULE_VERSION_STRING)
-        set (MODULE_VERSION_STRING ${MODULE_VERSION})
+        set (MODULE_VERSION_STRING "v${MODULE_VERSION}")
+        message(STATUS "Set module version string ${MODULE_VERSION_STRING}")
     endif()
 
     # Finish macro

ddsrouter_cmake/templates/cpp/library/config.h.in

@@ -24,8 +24,11 @@
 #ifndef @MODULE_MACRO@_VERSION_MICRO
 #define @MODULE_MACRO@_VERSION_MICRO @PROJECT_VERSION_PATCH@
 #endif // ifndef @MODULE_MACRO@_VERSION_MICRO
-#ifndef @MODULE_MACRO@_VERSION_STR
-#define @MODULE_MACRO@_VERSION_STR "@PROJECT_VERSION@"
+#ifndef @MODULE_MACRO@_VERSION_STRING
+#define @MODULE_MACRO@_VERSION_STRING "@MODULE_VERSION_STRING@"
 #endif // ifndef @MODULE_MACRO@_VERSION_STR
+#ifndef @MODULE_MACRO@_COMMIT_HASH
+#define @MODULE_MACRO@_COMMIT_HASH "@MODULE_COMMIT_HASH@"
+#endif // ifndef @MODULE_MACRO@_COMMIT_HASH
 
 #endif // ifndef _@MODULE_MACRO@_LIBRARY_CONFIG_H_

tools/ddsrouter_tool/README.md

@@ -21,6 +21,7 @@ ddsrouter --help
 # -r --reload-time  Time period in seconds to reload configuration file. This is needed when FileWatcher functionality is not available (e.g. config file is a symbolic link).
 #                     Value 0 does not reload file. [Default: 0].
 # -d --debug        Activate debug Logs (be aware that some logs may require specific CMAKE compilation options).
+# -v --version      Print version, branch and commit hash
 ```
 
 ---

tools/ddsrouter_tool/src/cpp/main.cpp

@@ -41,8 +41,6 @@ int main(
         int argc,
         char** argv)
 {
-    logUser(DDSROUTER_EXECUTION, "Starting DDS Router Tool execution.");
-
     // Configuration File path
     std::string file_path = "";
 
@@ -60,6 +58,10 @@ int main(
     {
         return static_cast<int>(ui::ProcessReturnCode::success);
     }
+    else if (arg_parse_result == ui::ProcessReturnCode::version_argument)
+    {
+        return static_cast<int>(ui::ProcessReturnCode::success);
+    }
     else if (arg_parse_result != ui::ProcessReturnCode::success)
     {
         return static_cast<int>(arg_parse_result);
@@ -85,6 +87,8 @@ int main(
         return static_cast<int>(ui::ProcessReturnCode::required_argument_failed);
     }
 
+    logUser(DDSROUTER_EXECUTION, "Starting DDS Router Tool execution.");
+
     // Activate Debug
     if (activate_debug)
     {
@@ -98,7 +102,6 @@ int main(
         // Change it when Log Module is independent and with more extensive API.
         // Log::SetCategoryFilter(std::regex("(DDSROUTER)"));
     }
-
     // Encapsulating execution in block to erase all memory correctly before closing process
     try
     {

tools/ddsrouter_tool/src/cpp/user_interface/ProcessReturnCode.hpp

@@ -28,6 +28,7 @@ enum class ProcessReturnCode : int
 {
     success = 0,
     help_argument = 1,
+    version_argument = 2,
     incorrect_argument = 10,
     required_argument_failed = 11,
     execution_failed = 20,

tools/ddsrouter_tool/src/cpp/user_interface/arguments_configuration.cpp

@@ -21,6 +21,7 @@
 #include <string>
 #include <vector>
 
+#include <ddsrouter_core/library/config.h>
 #include <ddsrouter_utils/Log.hpp>
 #include <ddsrouter_utils/utils.hpp>
 
@@ -86,10 +87,25 @@ const option::Descriptor usage[] = {
         "  -d \t--debug\t  \t" \
         "Activate debug Logs (be aware that some logs may require specific CMAKE compilation options)." \
     },
+    {
+        optionIndex::VERSION,
+        0,
+        "v",
+        "version",
+        Arg::None,
+        "  -v \t--version\t  \t" \
+        "Print version, branch and commit hash." \
+    },
 
     { 0, 0, 0, 0, 0, 0 }
 };
 
+void print_version()
+{
+    std::cout << "DDSRouter " << DDSROUTER_CORE_VERSION_STRING << "\ncommit hash: " << DDSROUTER_CORE_COMMIT_HASH <<
+        std::endl;
+}
+
 ProcessReturnCode parse_arguments(
         int argc,
         char** argv,
@@ -149,6 +165,12 @@ ProcessReturnCode parse_arguments(
             return ProcessReturnCode::help_argument;
         }
 
+        if (options[optionIndex::VERSION])
+        {
+            print_version();
+            return ProcessReturnCode::version_argument;
+        }
+
         for (int i = 0; i < parse.optionsCount(); ++i)
         {
             option::Option& opt = buffer[i];